vmware.vmware.vm_resource_info module – Gather information about the resources of one or more VMs.
Note
This module is part of the vmware.vmware collection (version 2.8.0).
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.
To use it in a playbook, specify: vmware.vmware.vm_resource_info.
Synopsis
This module gathers information about VM resources, like CPU and memory configuration.
It also returns identifying information about the ESXi host that the VM is on, as well as the resource pool that contains the VM.
Parameters
Parameter |
Comments |
|---|---|
If true, information is gathered about the VM(s) CPU configuration. Setting to false can speed up module results. Choices:
|
|
If true, information is gathered about the VM(s) CPU usage metrics. Setting to false can speed up module results. Choices:
|
|
If true, information is gathered about the VM(s) memory configuration. Setting to false can speed up module results. Choices:
|
|
If true, information is gathered about the VM(s) memory usage metrics. Setting to false can speed up module results. Choices:
|
|
The hostname or IP address of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
|
The MOID of the vm to gather info for Only one of name, moid, uuid is allowed |
|
The name of the vm to gather info for Only one of name, moid, uuid is allowed |
|
If using name and multiple VMs have the same name, specify which VM should be selected Choices:
|
|
The password of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable Default: |
|
The 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 |
|
The 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 |
|
If true, search by instance UUID instead of BIOS UUID. BIOS UUID may not be unique and may cause errors. Choices:
|
|
The username of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
|
The UUID of the vm to gather info for Only one of name, moid, uuid is allowed |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
All modules require API write access and hence are 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. Note having this variable set may cause a ‘false’ value for the ‘validate_certs’ option to be ignored in some cases. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’
Examples
- name: Gather VM Resource Info
vmware.vmware.vm_resource_info:
moid: "{{ vm_id }}"
- name: Gather VM Resource Info By Name
vmware.vmware.vm_resource_info:
name: "{{ vm_name }}"
name_match: first
- name: Gather Just Resource Config Info
vmware.vmware.vm_resource_info:
moid: "{{ vm_id }}"
gather_cpu_stats: false
gather_memory_stats: false
- name: Gather Just The Host and Resource Pool IDs For All VMs
vmware.vmware.vm_resource_info:
moid: "{{ vm_id }}"
gather_cpu_config: false
gather_memory_config: false
gather_cpu_stats: false
gather_memory_stats: false
# Note: although all gather parameters are set to false in the previous example, the output keys will still be present in the results. For example:
# "vms": [
# {
# "cpu": {},
# "esxi_host": {
# "moid": "host-64",
# "name": "10.10.10.129"
# },
# "memory": {},
# "moid": "vm-75373",
# "name": "ma1",
# "resource_pool": {
# "moid": "resgroup-35",
# "name": "Resources"
# },
# "stats": {
# "cpu": {},
# "memory": {}
# }
# }
# ]
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Information about CPU and memory for the selected VMs. Returned: Always Sample: |