community.vmware.vmware_first_class_disk module – Manage VMware vSphere First Class Disks
Note
This module is part of the community.vmware collection (version 4.8.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.vmware
.
To use it in a playbook, specify: community.vmware.vmware_first_class_disk
.
Synopsis
This module can be used to manage (create, delete, resize) VMware vSphere First Class Disks.
Parameters
Parameter |
Comments |
---|---|
The name of the datacenter. |
|
Name of datastore or datastore cluster to be used for the disk. |
|
The name of the disk. |
|
The hostname or IP address of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable |
|
Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable |
|
Disk storage size, an integer plus a unit. There is no space allowed in between size number and unit. Allowed units are MB, GB and TB. Examples: size: 2048MB size: 10GB size: 1TB |
|
If the disk should be present or absent. Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Examples
- name: Create Disk
community.vmware.vmware_first_class_disk:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datastore_name: '{{ datastore_name }}'
disk_name: '1GBDisk'
size: '1GB'
state: present
delegate_to: localhost
- name: Delete Disk
community.vmware.vmware_first_class_disk:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datastore_name: '{{ datastore_name }}'
disk_name: 'FirstClassDisk'
state: absent
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
First-class disk returned when created, deleted or changed Returned: changed Sample: |