summaryrefslogtreecommitdiff
path: root/lib/ansible/modules/windows/win_partition.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/modules/windows/win_partition.py')
-rw-r--r--lib/ansible/modules/windows/win_partition.py117
1 files changed, 0 insertions, 117 deletions
diff --git a/lib/ansible/modules/windows/win_partition.py b/lib/ansible/modules/windows/win_partition.py
deleted file mode 100644
index 18d45282d4..0000000000
--- a/lib/ansible/modules/windows/win_partition.py
+++ /dev/null
@@ -1,117 +0,0 @@
-#!/usr/bin/python
-# -*- coding: utf-8 -*-
-
-# Copyright: (c) 2018, Varun Chopra (@chopraaa) <v@chopraaa.com>
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-ANSIBLE_METADATA = {
- 'metadata_version': '1.1',
- 'status': ['preview'],
- 'supported_by': 'community'
-}
-
-DOCUMENTATION = r'''
----
-module: win_partition
-version_added: '2.8'
-short_description: Creates, changes and removes partitions on Windows Server
-description:
- - The M(win_partition) module can create, modify or delete a partition on a disk
-options:
- state:
- description:
- - Used to specify the state of the partition. Use C(absent) to specify if a partition should be removed
- and C(present) to specify if the partition should be created or updated.
- type: str
- choices: [ absent, present]
- default: present
- drive_letter:
- description:
- - Used for accessing partitions if I(disk_number) and I(partition_number) are not provided.
- - Use C(auto) for automatically assigning a drive letter, or a letter A-Z for manually assigning a drive letter to a new partition.
- If not specified, no drive letter is assigned when creating a new partition.
- type: str
- disk_number:
- description:
- - Disk number is mandatory for creating new partitions.
- - A combination of I(disk_number) and I(partition_number) can be used to specify the partition instead of I(drive_letter) if required.
- type: int
- partition_number:
- description:
- - Used in conjunction with I(disk_number) to uniquely identify a partition.
- type: int
- partition_size:
- description:
- - Specify size of the partition in B, KB, KiB, MB, MiB, GB, GiB, TB or TiB. Use -1 to specify maximum supported size.
- - Partition size is mandatory for creating a new partition but not for updating or deleting a partition.
- - The decimal SI prefixes kilo, mega, giga, tera, etc., are powers of 10^3 = 1000. The binary prefixes kibi, mebi, gibi, tebi, etc.
- respectively refer to the corresponding power of 2^10 = 1024.
- Thus, a gigabyte (GB) is 1000000000 (1000^3) bytes while 1 gibibyte (GiB) is 1073741824 (1024^3) bytes.
- type: str
- read_only:
- description:
- - Make the partition read only, restricting changes from being made to the partition.
- type: bool
- active:
- description:
- - Specifies if the partition is active and can be used to start the system. This property is only valid when the disk's partition style is MBR.
- type: bool
- hidden:
- description:
- - Hides the target partition, making it undetectable by the mount manager.
- type: bool
- offline:
- description:
- - Sets the partition offline.
- - Adding a mount point (such as a drive letter) will cause the partition to go online again.
- type: bool
- required: no
- mbr_type:
- description:
- - Specify the partition's MBR type if the disk's partition style is MBR.
- - This only applies to new partitions.
- - This does not relate to the partitions file system formatting.
- type: str
- choices: [ fat12, fat16, extended, huge, ifs, fat32 ]
- gpt_type:
- description:
- - Specify the partition's GPT type if the disk's partition style is GPT.
- - This only applies to new partitions.
- - This does not relate to the partitions file system formatting.
- type: str
- choices: [ system_partition, microsoft_reserved, basic_data, microsoft_recovery ]
-
-notes:
- - A minimum Operating System Version of 6.2 is required to use this module. To check if your OS is compatible, see
- U(https://docs.microsoft.com/en-us/windows/desktop/sysinfo/operating-system-version).
- - This module cannot be used for removing the drive letter associated with a partition, initializing a disk or, file system formatting.
- - Idempotence works only if you're specifying a drive letter or other unique attributes such as a combination of disk number and partition number.
- - For more information, see U(https://msdn.microsoft.com/en-us/library/windows/desktop/hh830524.aspx).
-author:
- - Varun Chopra (@chopraaa) <v@chopraaa.com>
-'''
-
-EXAMPLES = r'''
-- name: Create a partition with drive letter D and size 5 GiB
- win_partition:
- drive_letter: D
- partition_size: 5 GiB
- disk_number: 1
-
-- name: Resize previously created partition to it's maximum size and change it's drive letter to E
- win_partition:
- drive_letter: E
- partition_size: -1
- partition_number: 1
- disk_number: 1
-
-- name: Delete partition
- win_partition:
- disk_number: 1
- partition_number: 1
- state: absent
-'''
-
-RETURN = r'''
-#
-'''