W3cubDocs

/Ansible 2.10

community.windows.win_initialize_disk – Initializes disks on Windows Server

Note

This plugin is part of the community.windows collection.

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 Choices/Defaults Comments
disk_number
integer
Used to specify the disk number of the disk to be initialized.
force
boolean
    Choices:
  • no
  • yes
Specify if initializing should be forced for disks that are already initialized.
online
boolean
    Choices:
  • no
  • yes ←
If the disk is offline and/or readonly update the disk to be online and not readonly.
path
string
Used to specify the path to the disk to be initialized.
style
string
    Choices:
  • gpt ←
  • mbr
The partition style to use for the disk. Valid options are mbr or gpt.
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)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/windows/win_initialize_disk_module.html