vmware_datastore_facts - Gather facts about datastores available in given vCenter¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

Synopsis ¶

This module can be used to gather facts about datastores in VMWare infrastructure.
All values and VMware object names are case sensitive.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.6
PyVmomi

Parameters ¶

Parameter	Choices/Defaults	Comments
cluster		Cluster to search for datastores. If set, facts of datastores belonging this clusters will be returned. This parameter is required, if `datacenter` is not supplied.
datacenter		Datacenter to search for datastores. This parameter is required, if `cluster` is not supplied.
hostname str		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. Environment variable supported added in version 2.6.
name		Name of the datastore to match. If set, facts of specific datastores are returned.
password str		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. Environment variable supported added in version 2.6. aliases: pass, pwd
port int (added in 2.5)	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 `VMWARE_PORT` will be used instead. Environment variable supported added in version 2.6.
username str		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. Environment variable supported added in version 2.6. aliases: admin, user
validate_certs bool	Choices: no yes ←	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. Environment variable supported added in version 2.6. If set to `yes`, please make sure Python >= 2.7.9 is installed on the given machine.

Notes ¶

Note

Tested on vSphere 5.5, 6.0 and 6.5

Examples ¶

- name: Gather facts from standalone ESXi server having datacenter as 'ha-datacenter'
  vmware_datastore_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: '{{ datacenter_name }}'
    validate_certs: no
  delegate_to: localhost
  register: facts

- name: Gather facts from datacenter about specific datastore
  vmware_datastore_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: '{{ datacenter_name }}'
    name: datastore1
  delegate_to: localhost
  register: facts

Return Values ¶

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

Key	Returned	Description
datastores list	always	metadata about the available datastores Sample: [{'accessible': False, 'freeSpace': 39638269952, 'multipleHostAccess': False, 'capacity': 42681237504, 'name': 'datastore2', 'provisioned': 12289211488, 'url': 'ds:///vmfs/volumes/5a69b18a-c03cd88c-36ae-5254001249ce/', 'datastore_cluster': 'datacluster0', 'uncommitted': 9246243936, 'type': 'VMFS', 'maintenanceMode': 'normal'}]

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

Tim Rightnour (@garbled1)

Hint

If you notice any issues in this documentation you can edit this document to improve it.