community.vmware.vmware_datastore_info module – Gather info about datastores available in given vCenter
Note
This module is part of the community.vmware collection (version 3.7.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_datastore_info.
Synopsis
This module can be used to gather information about datastores in VMWare infrastructure.
All values and VMware object names are case sensitive.
Parameters
Parameter |
Comments |
|---|---|
Cluster to search for datastores. If set, information of datastores belonging this clusters will be returned. This parameter is required, if |
|
Datacenter to search for datastores. This parameter is required, if |
|
Gather mount information of NFS datastores. Disabled per default because this slows down the execution if you have a lot of datastores. Only valid when Choices:
|
|
Gather mount information of VMFS datastores. Disabled per default because this slows down the execution if you have a lot of datastores. Only valid when Choices:
|
|
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. |
|
Name of the datastore to match. If set, information of specific datastores are returned. |
|
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. |
|
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. Default: |
|
Specify the properties to retrieve. If not specified, all properties are retrieved (deeply). Results are returned in a structure identical to the vsphere API. Example:
Only valid when |
|
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 |
|
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 |
|
Specify the output schema desired. The ‘summary’ output schema is the legacy output from the module The ‘vsphere’ output schema is the vSphere API class definition which requires pyvmomi>6.7.1 Choices:
|
|
Tags related to Datastore are shown if set to Choices:
|
|
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. |
|
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 Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Gather info from standalone ESXi server having datacenter as 'ha-datacenter'
community.vmware.vmware_datastore_info:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
datacenter_name: "ha-datacenter"
delegate_to: localhost
register: info
- name: Gather info from datacenter about specific datastore
community.vmware.vmware_datastore_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter_name: '{{ datacenter_name }}'
name: datastore1
delegate_to: localhost
register: info
- name: Gather some info from a datastore using the vSphere API output schema
community.vmware.vmware_datastore_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter_name: '{{ datacenter_name }}'
schema: vsphere
properties:
- name
- info.vmfs.ssd
- capability.vsanSparseSupported
- overallStatus
delegate_to: localhost
register: info
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
metadata about the available datastores Returned: always Sample: |