win_format – Formats an existing volume or a new volume on an existing partition on Windows

From Get docs
Ansible/docs/2.8/modules/win format module


win_format – Formats an existing volume or a new volume on an existing partition on Windows

New in version 2.8.


Synopsis

  • The win_format module formats an existing volume or a new volume on an existing partition on Windows

Parameters

Parameter Choices/Defaults Comments

allocation_unit_size

integer

Specifies the cluster size to use when formatting the volume.

If no cluster size is specified when you format a partition, defaults are selected based on the size of the partition.

compress

boolean

  • no
  • yes

Enable compression on the resulting NTFS volume.

NTFS compression is not supported where allocation_unit_size is more than 4096.

drive_letter

string

Used to specify the drive letter of the volume to be formatted.

file_system

string

  • ntfs
  • refs
  • exfat
  • fat32
  • fat

Used to specify the file system to be used when formatting the target volume.

force

boolean

  • no
  • yes

Specify if formatting should be forced for volumes that are not created from new partitions or if the source and target file system are different.

full

boolean

  • no
  • yes

A full format writes to every sector of the disk, takes much longer to perform than the default (quick) format, and is not recommended on storage that is thinly provisioned.

Specify true for full format.

integrity_streams

boolean

  • no
  • yes

Enable integrity streams on the resulting ReFS volume.

label

string

Used to specify the label of the volume to be formatted.

large_frs

boolean

  • no
  • yes

Specifies that large File Record System (FRS) should be used.

new_label

string

Used to specify the new file system label of the formatted volume.

path

string

Used to specify the path to the volume to be formatted.



Notes

Note


See Also

See also

win_disk_facts – Show the attached disks and disk information of the target host
The official documentation on the win_disk_facts module.
win_partition – Creates, changes and removes partitions on Windows Server
The official documentation on the win_partition module.


Examples

- 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: Full format the newly created partition as NTFS and label it
  win_format:
    drive_letter: D
    file_system: NTFS
    new_label: Formatted
    full: True

Status

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/win_format_module.html