community.vmware.vmware_first_class_disk – Manage VMware vSphere First Class Disks
community.vmware.vmware_first_class_disk – Manage VMware vSphere First Class Disks
Note
This plugin is part of the community.vmware collection (version 1.7.0).
To install it use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_first_class_disk
.
New in version 1.7.0: of community.vmware
Synopsis
- This module can be used to manage (create, delete, resize) VMware vSphere First Class Disks.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
datacenter_name string |
The name of the datacenter. | |
datastore_name string / required |
Name of datastore or datastore cluster to be used for the disk. | |
disk_name string / required |
The name of the disk. | |
hostname string |
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 Environment variable support added in Ansible 2.6. | |
password string |
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6.
| |
port integer |
Default: 443 |
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
proxy_host string |
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 This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 | |
proxy_port integer |
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 | |
size string |
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 | |
state string |
|
If the disk should be present or absent. |
username string |
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6.
| |
validate_certs boolean |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to |
Notes
Note
- Tested on vSphere 7.0
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 | Returned | Description |
---|---|---|
first_class_disk dictionary |
changed |
First-class disk returned when created, deleted or changed
Sample: { "name": "1GBDisk" "datastore_name": "DS0" "size_mb": "1024" "state": "present" } |
Authors
- Mario Lenz (@mariolenz)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_first_class_disk_module.html