vmware.vmware.appliance_info module – Gather appliance information

Note

This module is part of the vmware.vmware collection (version 1.7.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 vmware.vmware. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: vmware.vmware.appliance_info.

Synopsis

  • This module gather VCenter appliance information.

Requirements

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

  • vSphere Automation SDK

Parameters

Parameter

Comments

hostname

string

The hostname or IP address of the vSphere vCenter 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 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.

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.

Choices:

  • "summary"

  • "access"

  • "networking"

  • "firewall"

  • "time"

  • "services"

  • "update"

  • "syslog"

  • "all" ← (default)

Default: ["all"]

protocol

string

The connection to protocol.

Choices:

  • "http"

  • "https" ← (default)

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 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)

Attributes

Attribute

Support

Description

check_mode

Support: full

The check_mode support.

Notes

Note

  • All modules require API write access and hence is not supported on a free ESXi license.

  • All variables and VMware object names are case sensitive.

  • Modules may rely on the ‘requests’ python library, which does not use the system certificate store by default. You can specify the certificate store by setting the REQUESTS_CA_BUNDLE environment variable. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Examples

- name: Gather all appliance info
  vmware.vmware.appliance_info:
    hostname: "https://vcenter"
    username: "username"
    password: "password"

Return Values

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

Key

Description

appliance

dictionary

Information about appliance.

Returned: On success

Sample: {"appliance": {"access": {"consolecli": false, "dcui": false, "shell": {"enabled": "False", "timeout": "0"}, "ssh": true}, "firewall": {"inbound": [{"address": "1.2.3.6", "interface_name": "*", "policy": "ACCEPT", "prefix": "32"}, {"address": "1.2.4.5", "interface_name": "nic0", "policy": "IGNORE", "prefix": "24"}]}, "networking": {"network": {"dns_servers": [], "hostname": ["vcenter.local"], "nics": {"nic0": {"ipv4": "{configurable : True, mode : STATIC, address : 10.185.246.4, prefix : 26, default_gateway : 10.185.246.1}", "ipv6": "None", "mac": "00:50:56:cd:e7:2e", "name": "nic0", "status": "up"}}}, "proxy": {"ftp": {"enabled": "False", "password": "None", "port": "-1", "server": "", "username": "None"}, "http": {"enabled": "True", "password": "None", "port": "80", "server": "http://localhost", "username": "None"}, "https": {"enabled": "False", "password": "None", "port": "-1", "server": "", "username": "None"}, "noproxy": ["localhost", "127.0.0.1"]}}, "services": {"appliance-shutdown": {"description": "/etc/rc.local.shutdown Compatibility", "state": "STOPPED"}}, "summary": {"build_number": "21560480", "health": {"cpu": "green", "database": "green", "memory": "green", "overall": "green", "storage": "green", "swap": "green"}, "hostname": ["vcenter.local"], "product": "VMware vCenter Server", "sso": {}, "uptime": "12531937.54", "version": "8.0.1.00000"}, "syslog": {"forwarding": []}, "time": {"time_sync": {"current": {"date": "Tue 03-26-2024", "seconds_since_epoch": "1711465124.5183642", "time": "02:58:44 PM", "timezone": "UTC"}, "mode": "NTP", "servers": ["time.google.com"]}, "time_zone": "Etc/UTC"}}}

Authors

  • Ansible Cloud Team (@ansible-collections)