vcenter_cluster_info
Retrieves information about the cluster corresponding to cluster
Collection: vmware.vmware_rest
Full Name: vmware.vmware_rest.vcenter_cluster_info
Synopsis
Retrieves information about the cluster corresponding to cluster
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| vcenter_hostname | string | yes | The hostname or IP address of the vSphere vCenter | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead. | ||||
| vcenter_username | string | yes | The vSphere vCenter username | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead. | ||||
| vcenter_password | string | yes | The vSphere vCenter password | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead. | ||||
| vcenter_validate_certs | bool | true | Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) 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 runs the module. | ||||
| If the value is not specified in the task, the value of | ||||
| environment variable C(VMWARE_REST_LOG_FILE) will be used instead. | ||||
| session_timeout | float | 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. | ||||
| cluster | string | Identifier of the cluster. | ||
| The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_cluster_info). Required with I(state=[‘get’]) | ||||
| clusters | list | Identifiers of clusters that can match the filter. | ||
| If unset or empty, clusters 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 M(vmware.vmware_rest.vcenter_cluster_info). | ||||
| datacenters | list | Datacenters that must contain the cluster for the cluster to match the filter. | ||
| If unset or empty, clusters 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 M(vmware.vmware_rest.vcenter_datacenter_info). | ||||
| folders | list | Folders that must contain the cluster for the cluster to match the filter. | ||
| If unset or empty, clusters 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 M(vmware.vmware_rest.vcenter_folder_info). | ||||
| names | list | Names that clusters must have to match the filter (see I(name)). | ||
| If unset or empty, clusters with any name match the filter. |
Example
yaml
- name: Build a list of all the clusters
vmware.vmware_rest.vcenter_cluster_info:
register: all_the_clusters
- name: Retrieve details about the first cluster
vmware.vmware_rest.vcenter_cluster_info:
cluster: '{{ all_the_clusters.value[0].cluster }}'
register: my_cluster_info