community.windows.win_format 模块 – 在 Windows 上格式化现有卷或现有分区上的新卷

注意

此模块是 community.windows 集合（版本 2.3.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.windows。

要在 playbook 中使用它，请指定：community.windows.win_format。

概要 

community.windows.win_format 模块在 Windows 上格式化现有卷或现有分区上的新卷

参数 

参数	注释
allocation_unit_size 整数	指定格式化卷时要使用的群集大小。如果在格式化分区时未指定群集大小，则会根据分区的大小选择默认值。此值必须是磁盘物理扇区大小的倍数。
compress 布尔值	在生成的 NTFS 卷上启用压缩。当 allocation_unit_size 大于 4096 时，不支持 NTFS 压缩。选项 `false` `true`
drive_letter 字符串	用于指定要格式化的卷的驱动器号。
file_system 字符串	用于指定格式化目标卷时要使用的文件系统。选项 `"ntfs"` `"refs"` `"exfat"` `"fat32"` `"fat"`
force 布尔值	指定对于非从新分区创建的卷或者如果源文件系统和目标文件系统不同，是否应强制执行格式化。选项 `false` ← (默认) `true`
full 布尔值	完全格式化会写入磁盘的每个扇区，比默认（快速）格式化花费的时间更长，并且不建议在精简配置的存储上使用。对于完全格式化，请指定 `true`。选项 `false` ← (默认) `true`
integrity_streams 布尔值	在生成的 ReFS 卷上启用完整性流。选项 `false` `true`
label 字符串	用于指定要格式化的卷的标签。
large_frs 布尔值	指定应使用大型文件记录系统 (FRS)。选项 `false` `true`
new_label 字符串	用于指定格式化卷的新文件系统标签。
path 字符串	用于指定要格式化的卷的路径。

注释 

注意

使用此模块需要 Microsoft Windows Server 2012 或 Microsoft Windows 8 或更高版本。要检查您的系统是否兼容，请参阅 https://docs.microsoft.com/en-us/windows/desktop/sysinfo/operating-system-version。
必须使用三个参数（drive_letter、path 和 label）之一来标识目标卷，但不能同时指定多个参数。
如果未指定 force 并且文件系统标签保持不变，则此模块是幂等的。
有关详细信息，请参阅 https://docs.microsoft.com/en-us/previous-versions/windows/desktop/stormgmt/format-msft-volume

另请参阅 

另请参阅

community.windows.win_disk_facts: 显示目标主机的已连接磁盘和磁盘信息。
community.windows.win_partition: 在 Windows Server 上创建、更改和删除分区。

示例 

- 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

作者

Varun Chopra (@chopraaa)