community.windows.win_partition (2.2.0) — module

Install collection

Install with ansible-galaxy collection install community.windows:==2.2.0

Add to requirements.yml

  collections:
    - name: community.windows
      version: 2.2.0

Description

The M(community.windows.win_partition) module can create, modify or delete a partition on a disk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create a partition with drive letter D and size 5 GiB
  community.windows.win_partition:
    drive_letter: D
    partition_size: 5 GiB
    disk_number: 1

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Resize previously created partition to it's maximum size and change it's drive letter to E
  community.windows.win_partition:
    drive_letter: E
    partition_size: -1
    partition_number: 1
    disk_number: 1

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete partition
  community.windows.win_partition:
    disk_number: 1
    partition_number: 1
    state: absent

Inputs

    
state:
    choices:
    - absent
    - present
    default: present
    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

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.
    required: false
    type: bool

gpt_type:
    choices:
    - system_partition
    - microsoft_reserved
    - basic_data
    - microsoft_recovery
    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

mbr_type:
    choices:
    - fat12
    - fat16
    - extended
    - huge
    - ifs
    - fat32
    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

read_only:
    description:
    - Make the partition read only, restricting changes from being made to the partition.
    type: bool

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

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

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

partition_number:
    description:
    - Used in conjunction with I(disk_number) to uniquely identify a partition.
    type: int