Skip to content

Latest commit

 

History

History
344 lines (310 loc) · 15.4 KB

vmware.vmware_rest.vcenter_host_info_module.rst

File metadata and controls

344 lines (310 loc) · 15.4 KB
Raw

vmware.vmware_rest.vcenter_host_info

Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec.

Version added: 0.1.0

Synopsis

  • Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec.

Requirements

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

  • vSphere 7.0.3 or greater
  • python >= 3.6
  • aiohttp

Parameters

Parameter Choices/Defaults Comments
clusters
list / elements=string
Clusters that must contain the hosts for the hosts to match the filter.
If unset or empty, hosts in any cluster and hosts that are not in a cluster match the filter. If this field is not empty and standalone is true, no hosts will match the filter.
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_cluster_info.
connection_states
list / elements=string
Connection states that a host must be in to match the filter (see I()
If unset or empty, hosts in any connection state match the filter.
datacenters
list / elements=string
Datacenters that must contain the hosts for the hosts to match the filter.
If unset or empty, hosts in any datacenter match the filter.
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_datacenter_info.

aliases: filter_datacenters
folders
list / elements=string
Folders that must contain the hosts for the hosts to match the filter.
If unset or empty, hosts in any folder match the filter.
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_folder_info.

aliases: filter_folders
hosts
list / elements=string
Identifiers of hosts that can match the filter.
If unset or empty, hosts with any identifier match the filter.
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_host_info.
names
list / elements=string
Names that hosts must have to match the filter (see name).
If unset or empty, hosts with any name match the filter.

aliases: filter_names
session_timeout
float
added in 2.1.0
Timeout settings for client session.
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
The default value is 300s.
standalone
boolean
    Choices:
  • no
  • yes
If true, only hosts that are not part of a cluster can match the filter, and if false, only hosts that are are part of a cluster can match the filter.
If unset Hosts can match filter independent of whether they are part of a cluster or not. If this field is true and clusters os not empty, no hosts will match the filter.
vcenter_hostname
string / required
The hostname or IP address of the vSphere vCenter
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
vcenter_password
string / required
The vSphere vCenter password
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
vcenter_rest_log_file
string
You can use this optional parameter to set the location of a log file.
This file will be used to record the HTTP REST interaction.
The file will be stored on the host that run the module.
If the value is not specified in the task, the value of
environment variable VMWARE_REST_LOG_FILE will be used instead.
vcenter_username
string / required
The vSphere vCenter username
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
vcenter_validate_certs
boolean
    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.

Notes

Note

- Tested on vSphere 7.0.3

Examples

- name: Get a list of the hosts
  vmware.vmware_rest.vcenter_host_info:
  register: my_hosts

Return Values

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

Key Returned Description
value
list
On success
Get a list of the hosts

Sample:
[{'connection_state': 'CONNECTED', 'host': 'host-1013', 'name': 'esxi1.test', 'power_state': 'POWERED_ON'}]


Status

Authors

  • Ansible Cloud Team (@ansible-collections)