VMware: Get VM Properties
Description
VMware: Get VM Properties plugin step fetches the properties of a virtual machine.
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Name of the step. This name has to be unique in a single workflow. |
| Configuration: | ||
| 2 | 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. |
| 3 | Port | Specify the vCenter server port. (Default port is 443). This field should be an integer and value should be less than 65536. |
| 4 | Username | Specify a Username to authenticate vCenter server. |
| Password: | The password to authenticate vCenter server. | |
| 5 | 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. |
| 6 | Password | Specify the 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: that Field values can only be accessed when workflow is in running state. |
| 7 | 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 fetch the properties. The 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. |
Ouput Tab
| No. | Field Name | Description |
|---|---|---|
| 1 | Accept Output as JSON | Enable checkbox to fetch property values as JSON output. Leave this unchecked to fetch Properties and their values as a tabular output fields. |
| 2 | JSON Output | Specify an output field name to hold all of the VM properties and their values in JSON format. |
| Output Table Fields: | If ‘Accept Fields as JSON’ is not selected then the fields in this table are mandatory. | |
| 3 | Field Name | On click of the cell in the output table, if the connection is successfully established it populates the list of VM properties. Select one or more properties as rows of the table. The data type is string. This field is optional. |
| 4 | Output Field | Specify an output field in each row to hold the returned values of the properties selected in the Field Name column. |
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 then it will display a validation error message else if all the required field values are provided then it will save the field values. |
| 2 | Cancel | Click this button, to cancel the window and does not save any values. |