community.windows.win_initialize_disk module – Initializes disks on Windows Server

Note

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

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_initialize_disk.

Synopsis

Parameters

Parameter

Comments

disk_number

integer

Used to specify the disk number of the disk to be initialized.

force

boolean

Specify if initializing should be forced for disks that are already initialized.

Choices:

  • false ← (default)

  • true

online

boolean

If the disk is offline and/or readonly update the disk to be online and not readonly.

Choices:

  • false

  • true ← (default)

path

string

Used to specify the path to the disk to be initialized.

style

string

The partition style to use for the disk. Valid options are mbr or gpt.

Choices:

  • "gpt" ← (default)

  • "mbr"

uniqueid

string

Used to specify the uniqueid of the disk to be initialized.

Notes

Note

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

  • A minimum Operating System Version of Server 2012 or Windows 8 is required to use this module.

  • This module is idempotent if force is not specified.

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.

community.windows.win_format

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

Examples

- name: Initialize a disk
  community.windows.win_initialize_disk:
    disk_number: 1

- name: Initialize a disk with an MBR partition style
  community.windows.win_initialize_disk:
    disk_number: 1
    style: mbr

- name: Forcefully initiallize a disk
  community.windows.win_initialize_disk:
    disk_number: 2
    force: yes

Authors

  • Brant Evans (@branic)