Note
This plugin is part of the community.windows collection (version 1.2.0).
To install it use: ansible-galaxy collection install community.windows.
To use it in a playbook, specify: community.windows.win_format.
| 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. This value must be a multiple of the physical sector size of the disk. | |
| compress boolean |
| 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 |
| Used to specify the file system to be used when formatting the target volume. |
| force boolean |
| 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 |
| 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 |
| Enable integrity streams on the resulting ReFS volume. |
| label string | Used to specify the label of the volume to be formatted. | |
| large_frs boolean |
| 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. |
Note
See also
The official documentation on the community.windows.win_disk_facts module.
The official documentation on the community.windows.win_partition module.
- 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
- name: Full format the newly created partition as NTFS and label it
community.windows.win_format:
drive_letter: D
file_system: NTFS
new_label: Formatted
full: True
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/windows/win_format_module.html