You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.windows.win_format module – Formats an existing volume or a new volume on an existing partition on Windows

Note

This module is part of the community.windows collection (version 1.13.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.windows.

To use it in a playbook, specify: community.windows.win_format.

Synopsis

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

Parameters

Parameter	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. Choices: false true
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. Choices: "ntfs" "refs" "exfat" "fat32" "fat"
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. Choices: false ← (default) true
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. Choices: false ← (default) true
integrity_streams boolean	Enable integrity streams on the resulting ReFS volume. Choices: false true
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. Choices: false true
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

• Microsoft Windows Server 2012 or Microsoft Windows 8 or newer is required to use this module. To check if your system is compatible, see https://docs.microsoft.com/en-us/windows/desktop/sysinfo/operating-system-version.

• One of three parameters (drive_letter, path and label) are mandatory to identify the target volume but more than one cannot be specified at the same time.

• This module is idempotent if force is not specified and file system labels remain preserved.

• For more information, see https://docs.microsoft.com/en-us/previous-versions/windows/desktop/stormgmt/format-msft-volume

See Also

See also

community.windows.win_disk_facts

The official documentation on the community.windows.win_disk_facts module.

community.windows.win_partition

The official documentation on the community.windows.win_partition module.

Examples

- 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

Authors

• Varun Chopra (@chopraaa)

Collection links

Issue Tracker Repository (Sources) Communication