vmware.vmware_rest.vcenter_vm_hardware_cpu module – Updates the CPU-related settings of a virtual machine.

Note

This module is part of the vmware.vmware_rest collection (version 4.10.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_rest. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: vmware.vmware_rest.vcenter_vm_hardware_cpu.

New in vmware.vmware_rest 0.1.0

DEPRECATED
Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

DEPRECATED

Removed in:: version 5.0.0
Why:: This module has been moved to the new vmware.vmware collection
Alternative:: Use vmware.vmware.vm instead.

Synopsis

Updates the CPU-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	Comments
cores_per_socket integer	New number of CPU cores per socket. The number of CPU cores in the virtual machine must be a multiple of the number of cores per socket. If unset, the value is unchanged.
count integer	New number of CPU cores. The number of CPU cores in the virtual machine must be a multiple of the number of cores per socket. The supported range of CPU counts is constrained by the configured guest operating system and virtual hardware version of the virtual machine. If the virtual machine is running, the number of CPU cores may only be increased if hot_add_enabled is true, and may only be decreased if hot_remove_enabled is true. If unset, the value is unchanged.
hot_add_enabled boolean	Flag indicating whether adding CPUs while the virtual machine is running is enabled. This field may only be modified if the virtual machine is powered off. If unset, the value is unchanged. Choices: `false` `true`
hot_remove_enabled boolean	Flag indicating whether removing CPUs while the virtual machine is running is enabled. This field may only be modified if the virtual machine is powered off. If unset, the value is unchanged. Choices: `false` `true`
session_timeout float added in vmware.vmware_rest 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.
state string	Choices: `"present"` ← (default)
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 runs 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	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. Choices: `false` `true` ← (default)
vm string / required	Virtual machine identifier. The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.

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: Dedicate one core to the VM
  vmware.vmware_rest.vcenter_vm_hardware_cpu:
    vm: '{{ test_vm1_info.id }}'
    count: 1
  register: _result

Return Values

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

Key	Description
id dictionary	moid of the resource Returned: On success
value dictionary	Dedicate one core to the VM Returned: On success Sample: `{"cores_per_socket": 1, "count": 1, "hot_add_enabled": 0, "hot_remove_enabled": 0}`

Status

This module will be removed in version 5.0.0. [deprecated]
For more information see DEPRECATED.

Authors

Ansible Cloud Team (@ansible-collections)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/vmware/vmware_rest/vcenter_vm_hardware_cpu_module.html