VMware: Modify CPU Properties
Description
VMware: Modify CPU Properties Plugin step modifies the CPU-related settings of a virtual machine.
Additional Prerequisites:
- The virtual machine should be powered off before executing this step. (If the virtual machine is powered on, this step does not provide any error and the changes will not be reflected after the execution of the step.)
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Name of the step. This name has to be unique in a single workflow. |
| Configuration: | ||
| 1 | vCenter Server Base URL | Specify the vCenter Server Base URL to connect to vCenter. (e.g.: https://vmware.example.com) Note: If vCenter IP is given instead of vCenter server name, it throws certificate error if the vCenter IP entry is not present in the Subject Alternative Name field of the certificate, because the certificate mostly contains entry of vCenter server in FQDN (Fully Qualified Domain Name) format. |
| 2 | Port | Specify the vCenter server port. (Default port is 443). This field should be an integer and value should be less than 65536. |
| 3 | Username | Specify a Username to authenticate vCenter server. |
| Password: | The password to authenticate vCenter server. | |
| 4 | Accept value as variable/static | Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Password field to appear as Text box. |
| 5 | vCenter Password | Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory. If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. Please Note: Field values can only be accessed when workflow is in running state. |
| Button: Test Connection | Verifies whether the connection is available or not. For the purpose of verification, fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed. |
Input Tab:
| No. | Field Name | Description |
|---|---|---|
| 1 | Virtual Machine Name/UUID | Specify the Name/UUID of the virtual machine to modify properties. This field data type is String. This field is mandatory. Note:s: • Refer Get VM UUID in the VMWare Plugin introduction for steps to fetch the VM UUID. • If two or more virtual machines with the same name appear in the vCenter Server inventory, then you may provide the UUID which is unique to each VM. • If VM name contains ‘%’ special character then to execute the plugin step, provide VM name by replacing ‘%’ character with ‘%25’. |
| 2 | Button: Get | On click of this button, if the connection is successfully established it populates the list of Virtual Machine Names on the vCenter server. Note: If VM name contains ‘%’ special character then on click of ‘Get’ button, the VM name is returned by replacing ‘%’ character with ‘%25’. You may leave it like that. |
| 3 | Cores Per Socket | Specify the new number of cores per socket. This field data type is integer. This field is mandatory. |
| 4 | Enable CPU Hot Add* | Allowed values: ‘Yes’ or ‘No’. If ‘Yes’ is specified then ‘CPU Hot Add’ will be enabled. If ‘No’ is specified then ‘CPU Hot Add’ will be disabled. |
| 5 | Enable CPU Hot Remove* | Allowed values: ‘Yes’ or ‘No’. If ‘Yes’ is specified then ‘CPU Hot Remove’ will be enabled. If ‘No’ is specified then ‘CPU Hot Remove’ will be disabled. |
Notes:
- Hot-adding multicore virtual CPUs is supported only with hardware version 8 virtual machines. Not all guest operating systems support CPU hot add and hot remove. You cannot use these settings if the guest is not supported.
- To use the CPU hot-add feature with hardware version 7 virtual machines, set the Number of cores per socket to 1.
- Ensure that the VMware Tools is installed on the virtual machine for enabling hot plug (add/remove) functionality with Linux guest operating systems. Ensure that the virtual machine has a guest operating system that supports CPU hot plug.
- You can set any number of Cores per Socket through this plugin step (uses REST API). But it will cause problems while powering on the virtual machine. Make sure the Cores Per Socket does not exceed the allowed limit.
Common Buttons:
| No. | Field Name | Description |
|---|---|---|
| 1 | OK | Click this button to check and save the field values. If any required field values are missing, it will display a validation error message; else, if all the required field values are provided, it will save the field values. |
| 2 | Cancel | Click this button to cancel the window and not save any values. |