Skip to content

Latest commit

 

History

History
243 lines (207 loc) · 9.19 KB

vmware.vmware_rest.vcenter_vm_hardware_memory_info_module.rst

File metadata and controls

243 lines (207 loc) · 9.19 KB
Raw

vmware.vmware_rest.vcenter_vm_hardware_memory_info

Returns the memory-related settings of a virtual machine.

Version added: 0.1.0

Synopsis

  • Returns the memory-related settings of a virtual machine.

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
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.
vm
string
Virtual machine identifier.
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. Required with state=['get']

Notes

Note

- Tested on vSphere 7.0.3

Examples

- name: Look up the VM called test_vm1 in the inventory
  register: search_result
  vmware.vmware_rest.vcenter_vm_info:
    filter_names:
    - test_vm1

- name: Collect information about a specific VM
  vmware.vmware_rest.vcenter_vm_info:
    vm: '{{ search_result.value[0].vm }}'
  register: test_vm1_info

- name: Retrieve the memory information from the VM
  vmware.vmware_rest.vcenter_vm_hardware_memory_info:
    vm: '{{ test_vm1_info.id }}'
  register: _result

Return Values

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

Key Returned Description
value
dictionary
On success
Retrieve the memory information from the VM

Sample:
{'hot_add_enabled': 1, 'size_MiB': 1024}


Status

Authors

  • Ansible Cloud Team (@ansible-collections)