Skip to content

Latest commit

 

History

History
370 lines (336 loc) · 16.8 KB

vmware.vmware_rest.vcenter_resourcepool_info_module.rst

File metadata and controls

370 lines (336 loc) · 16.8 KB
Raw

vmware.vmware_rest.vcenter_resourcepool_info

Retrieves information about the resource pool indicated by resourcePool.

Version added: 0.3.0

Synopsis

  • Retrieves information about the resource pool indicated by resourcePool.

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 resource pool for the resource pool to match the filter.
If unset or empty, resource pools in any cluster 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.
datacenters
list / elements=string
Datacenters that must contain the resource pool for the resource pool to match the filter.
If unset or empty, resource pools 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
hosts
list / elements=string
Hosts that must contain the resource pool for the resource pool to match the filter.
If unset or empty, resource pools in any host 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 resource pools must have to match the filter (see name).
If unset or empty, resource pools with any name match the filter.

aliases: filter_names
parent_resource_pools
list / elements=string
Resource pools that must contain the resource pool for the resource pool to match the filter.
If unset or empty, resource pools in any resource pool 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_resourcepool_info.
resource_pool
string
Identifier of the resource pool for which information should be retrieved.
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_resourcepool_info. Required with state=['get']
resource_pools
list / elements=string
Identifiers of resource pools that can match the filter.
If unset or empty, resource pools 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_resourcepool_info.
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.
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 the existing resource pools
  vmware.vmware_rest.vcenter_resourcepool_info:
  register: resource_pools
- name: Get the existing resource pool
  vmware.vmware_rest.vcenter_resourcepool_info:
    resource_pool: '{{ resource_pools.value[0].resource_pool }}'
  register: my_resource_pool
- name: Create a generic resource pool
  vmware.vmware_rest.vcenter_resourcepool:
    name: my_resource_pool
    parent: '{{ resource_pools.value[0].resource_pool }}'
  register: my_resource_pool
- name: Read details from a specific resource pool
  vmware.vmware_rest.vcenter_resourcepool_info:
    resource_pool: '{{ my_resource_pool.id }}'
  register: my_resource_pool

Return Values

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

Key Returned Description
id
string
On success
moid of the resource

Sample:
resgroup-1009
value
dictionary
On success
Read details from a specific resource pool

Sample:
{'cpu_allocation': {'expandable_reservation': 1, 'limit': -1, 'reservation': 0, 'shares': {'level': 'NORMAL'}}, 'memory_allocation': {'expandable_reservation': 0, 'limit': 1000, 'reservation': 0, 'shares': {'level': 'NORMAL'}}, 'name': 'my_resource_pool', 'resource_pools': []}


Status

Authors

  • Ansible Cloud Team (@ansible-collections)