Skip to main content

VMWare: Power off VM

Description

VMware: Power Off VM plugin step powers off a powered-on or suspended virtual machine.

Configurations

No.Field NameDescription
1Step NameName of the step. This name has to be unique in a single workflow.
Configuration:
1vCenter Server Base URLSpecify 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, because the certificate contains entry of vCenter server in FQDN (Fully Qualified Domain Name) format.
2PortSpecify the vCenter server port. (Default port is 443).
This field should be an integer and value should be less than 65536.
3UsernameSpecify a Username to authenticate vCenter server.
Password:The password to authenticate vCenter server.
4Accept value as variable/staticLeave 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.
5PasswordPassword 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: that Field values can only be accessed when workflow is in running state.

6Button: Test ConnectionVerifies 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 NameDescription
1Virtual Machine Name/UUIDSpecify the Name/UUID of the virtual machine to modify memory size.
This field data type is String. This field is mandatory.

Notes:
• 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’.
2Button: GetOn 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.

Common Buttons:

No.Field NameDescription
1OKClick 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.
2CancelClick this button to cancel the window and not save any values.