W3cubDocs

/Ansible

community.vmware.vmware_datacenter_info module – Gather information about VMware vSphere Datacenters

Note

This module is part of the community.vmware collection (version 5.7.2).

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_datacenter_info.

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

This module can be used to gather information VMware vSphere Datacenters.

Parameters

Parameter	Comments
datacenter aliases: datacenter_name string	The name of the datacenter to gather information for. If not provided, will gather information about all datacenters from the VMware infra.
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`
properties list / elements=string	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: properties: [ “overallStatus” ] Only valid when `schema=vsphere`.
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.
schema string	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. Choices: `"summary"` ← (default) `"vsphere"`
show_tag boolean	Tags related to Datacenter are shown if set to `true`. Choices: `false` ← (default) `true`
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 information about all datacenters
  community.vmware.vmware_datacenter_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
  delegate_to: localhost

- name: Gather information about a particular datacenter
  community.vmware.vmware_datacenter_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: '{{ datacenter_name }}'
  delegate_to: localhost

- name: Gather information about a particular datacenter
  community.vmware.vmware_datacenter_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: '{{ datacenter_name }}'
    show_tag: true
  delegate_to: localhost

- name: Gather vSphere schema information
  community.vmware.vmware_datacenter_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: '{{ datacenter_name }}'
    schema: vsphere
    properties:
    - configStatus
    - overallStatus

Return Values

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

Key	Description
datacenter_info list / elements=string	Information about datacenter Returned: always Sample: `[{"configStatus": "gray", "moid": "datacenter-2", "name": "Asia-Datacenter1"}]`

Authors

Abhijeet Kasurde (@Akasurde)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_datacenter_info_module.html