vcenter_vm_hardware_cpu
Updates the CPU-related settings of a virtual machine
Collection: vmware.vmware_rest
Full Name: vmware.vmware_rest.vcenter_vm_hardware_cpu
Synopsis
Updates the CPU-related settings of a virtual machine
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. | ||||
| cores_per_socket | int | 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 | int | 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 I(hot_add_enabled) is true, and may only be decreased if I(hot_remove_enabled) is true.
If unset, the value is unchanged. | | hot_add_enabled | bool | | | 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. | | hot_remove_enabled | bool | | | 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. |
| state | string | | present | Operation to perform; allowed values: present. |
| vm | string | yes | | Virtual machine identifier.
The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_info). This parameter is mandatory. |
Example
- 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