community.vmware.vmware_first_class_disk_info module – Gather info about VMware vSphere First Class Disks

Note

This module is part of the community.vmware collection (version 4.8.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.vmware.

To use it in a playbook, specify: community.vmware.vmware_first_class_disk_info.

Synopsis

  • This module can be used to gather information about VMware vSphere First Class Disks.

Parameters

Parameter

Comments

datacenter_name

string

The name of the datacenter.

datastore_name

string / required

Name of datastore or datastore cluster of the disk.

disk_name

string

The name of the disk. If not set return all found.

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 VMWARE_HOST will be used instead.

password

aliases: pass, pwd

string

The password of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

port

integer

The port number of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

Default: 443

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 VMWARE_PROXY_HOST will be used instead.

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 VMWARE_PROXY_PORT will be used instead.

username

aliases: admin, user

string

The username of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

validate_certs

boolean

Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

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: Gather info of 1GBDisk
  community.vmware.vmware_first_class_disk_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datastore_name: '{{ datastore_name }}'
    disk_name: '1GBDisk'
  register: disk_info
  delegate_to: localhost

- debug:
    var: disk_info.first_class_disks

- name: Gather info of all first class disks
  community.vmware.vmware_first_class_disk_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datastore_name: '{{ datastore_name }}'
  register: disk_info
  delegate_to: localhost

- debug:
    var: disk_info.first_class_disks

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

first_class_disks

list / elements=string

list of dictionary of First-class disk and their information

Returned: success

Sample: [{"consumer_ids": [], "consumption_type": "disk", "datastore_name": "DS0", "descriptor_version": 0, "name": "1GBDisk", "size_mb": "1024"}]

Authors

  • Nina Loser (@nina2244)