Virtual Server Management module utility workflows for VMware
The Utilities folder contains workflows grouped by environment. This section describes the following Virtual Server Management workflows in the VMware folder:
Add Disk Space workflow
This workflow adds disk space to a virtual machine when it is in a powered-off state. This workflow supports dynamic targeting.
Add Disk Space workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the name of the virtual server | Yes |
capacity in KB | Specifies the capacity of this virtual disk | Yes |
backing persistence mode | Specifies the disk persistence mode
| Yes |
backing file type split flag | Indicates the type of virtual disk file: split or monolithic
| No |
backing file thin provisioned flag | Indicates to the underlying file system whether the virtual disk backing file should be allocated lazily (using thin provisioning) | No |
backing write through flag | Indicates whether writes should go directly to the file system or should be buffered. | No |
shares | Specifies the number of shares allocated; determines resource allocation in case of resource contention | No |
shares level | Specifies the allocation level, which is a simplified view of shares
| No |
virtual center | Specifies the name or IP address of the virtual center on which the given VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Add Disk Space workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
Clone VM workflow
This workflow clones a VM. This workflow supports dynamic targeting.
Clone VM workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the display name of the VM | Yes |
datacenter | Specifies the name of the datacenter | Yes |
cloned vm name | Specifies the name for the cloned VM | Yes |
template | Specifies whether the new VM should be marked as a template | Yes |
power on | Specifies whether the new VM should be powered on after creation | Yes |
folder | Specifies the folder of the new VM | No |
virtual center | Specifies the name or IP address of the virtual center on which the new VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Clone VM workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
Create VM Snapshot workflow
This workflow creates a snapshot of the VM. This workflow supports dynamic targeting.
Create VM Snapshot workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the name of the virtual server | Yes |
snapshot name | Specifies the name for this snapshot Note The name does not need to be unique for this VM. | Yes |
memory | Specifies whether to include a dump of the internal state of the VM (basically a memory dump) in the snapshot | Yes |
quiesce | Specifies whether to use VMware Tools to quiesce the file system in the powered-on VM when the snapshot is taken | Yes |
virtual center | Specifies the name or IP address of the virtual center on which the given VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
snapshot description | Contains a description for this snapshot If omitted, a default description may be provided. | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Create VM Snapshot workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
Create VM workflow
Create VM workflow inputs
Input | Description | Required |
---|---|---|
cluster compute resource | Specifies the cluster name to which the host-system is attached | No |
folder | Specifies the folder of the new VM | No |
host | Specifies the DNS name of the target host for the VM
| No |
datacenter | Specifies the name of the datacenter where the VM is created | Yes |
vm name | Specifies the display name of the VM | Yes |
guest os | Specifies the guest operating system | Yes |
datastore | Specifies the datastore location to the configuration file for the VM (for example, the .vmx file) | Yes |
resource pool | Specifies the resource pool to which the VM is attached | No |
memory | Specifies the size of a VM's memory, in MB | No |
no of cpu | Specifies the number of virtual processors in a VM | No |
alternate SOAP URL | Specifies the virtual center server SOAP URL used to execute the request | No |
alternate transport | Specifies the virtual center server transport protocol used to execute the request | No |
alternate username | Specifies the user name used to handle the request | No |
alternate password | Specifies the password used to handle the request | No |
Note
You can invoke the request on a virtual center whose credentials are stored in the module configuration. The alternate SOAP URL, alternate transport, alternate user name, and alternate password are the parameters for the virtual center. The name of the virtual center from the request is used to extract the relevant parameters from module configuration. The parameters are called alternate because if the virtual center name is not passed in the request, then the default virtual center is selected (the one on which the VMware adapter has been activated).
Create VM workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
Delete Disk Space workflow
This workflow removes a virtual disk from a VM if the VM is powered off. This workflow supports dynamic targeting.
Delete Disk Space workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the name of the virtual server | Yes |
disk name | Specifies the name of the virtual disk to be removed | Yes |
virtual center | Specifies the name or IP address of the virtual center on which the given VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Delete Disk Space workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
Delete VM Snapshot workflow
This workflow removes a snapshot. This workflow supports dynamic targeting.
Delete Snapshot workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the name of the virtual server | Yes |
snapshot name | Specifies the name for this snapshot Note The name need not be unique for this VM. | Yes |
remove children | Sets a flag to specify removal of the entire snapshot subtree or not Valid values: true, false | Yes |
snapshot id | Specifies the snapshot ID internally generated by the virtual center Because the virtual center allows duplicate snapshot names, the snapshot ID is used. | Yes |
virtual center | Specifies the name or IP address of the virtual center on which the given VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Delete Snapshot workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully Valid values: success, failure |
status message | Provides a workflow-specific explanation for the value of success status |
Delete VM workflow
This workflow removes a VM, if the VM is in a powered-off state. This workflow supports dynamic targeting.
Delete VM workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the name of the virtual server | Yes |
virtual center | Specifies the virtual center on which the VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Delete VM workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
Get Task Status workflow
This workflow retrieves the status of a task. This workflow supports dynamic targeting.
Get Task Status workflow inputs
Input | Description | Required |
---|---|---|
virtual machine task id | Specifies the unique ID for each action submitted in the virtual center | Yes |
virtual center | Specifies the virtual center on which the VM is hosted | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Get Task Status workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
adapter response | Contains an XML file that provides the response from the adapter |
Get VM Configuration workflow
This workflow retrieves the configuration of a VM. This workflow supports dynamic targeting.
Get VM Configuration workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the VM whose configuration is to be queried | Yes |
virtual center | Specifies the name or IP address of the virtual center on which the VM is hosted | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Get VM Configuration workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
adapter response | Contains an XML file that provides the response from the adapter |
Get VM Power Status workflow
This workflow retrieves the power status of a VM. This workflow supports dynamic targeting.
Get VM Power Status workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the VM whose power status is to be queried | Yes |
virtual center | Specifies the name or IP address of the virtual center on which the VM is hosted | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Get VM Power Status workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
powerStatus | Returns the VM power status |
Poll VM Power Status workflow
This workflow polls for the power status of a VM. This workflow supports dynamic targeting.
Poll VM Power Status workflow inputs
Input | Description | Required |
---|---|---|
virtual machine task id | Specifies the unique ID for each action submitted in the virtual center | Yes |
check status | Specifies the expected VM power status
| Yes |
virtual center | Specifies the name or IP address of the virtual center on which the VM is hosted | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Poll VM Power Status workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
powerStatus | Returns the VM power status |
Poll Virtual Center Task Status workflow
This workflow polls the virtual center task status. This workflow supports dynamic targeting.
Poll Virtual Center Task Status workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the VM whose power status is to be queried | Yes |
virtual center | Specifies the name or IP address of the virtual center on which the VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Poll Virtual Center Task Status workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
Restart Guest OS workflow
This workflow restarts a guest operating system. This workflow supports dynamic targeting.
Restart Guest OS workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the display name of the VM | Yes |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
virtual center | Specifies the name or IP address of the virtual center on which the VM is hosted | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Restart Guest OS workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
power status | Provides the power state of the VM |
Resume VM workflow
This workflow resumes the activity of the specified VM. This workflow supports dynamic targeting.
Resume VM workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the display name of the VM | Yes |
virtual center | Specifies the name or IP address of the virtual center on which the VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Resume VM workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
power status | Provides the power state of the VM |
Revert VM Snapshot workflow
This workflow reverts the VM to a specified snapshot. This workflow supports dynamic targeting.
Revert VM Snapshot workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the display name of the VM | Yes |
snapshot name | Snapshot name to which the VM reverts | Yes |
snapshot id | Specifies the snapshot ID internally generated by the virtual center Because the virtual center allows duplicate snapshot names, the snapshot ID is used to identify names. | Yes |
virtual center | Specifies the name or IP address of the virtual center on which the VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Revert VM Snapshot workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully Valid values: success, failure |
status message | Provides a workflow-specific explanation for the value of success status |
Shutdown Guest OS workflow
This workflow shuts down a guest operating system. This workflow supports dynamic targeting.
Shutdown Guest OS workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the display name of the VM | Yes |
virtual center | Specifies the name or IP address of the virtual center on which the VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Shutdown Guest OS workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
power status | Provides the power state of the VM.
|
Start VM workflow
This workflow starts a VM. This workflow supports dynamic targeting.
Start VM workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the display name of the VM | Yes |
virtual center | Specifies the name or IP address of the virtual center on which the VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Start VM workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
power status | Provides the power state of the VM
|
Stop VM workflow
This workflow stops a VM and changes the VM power status to Stopped. This workflow supports dynamic targeting.
Stop VM workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the display name of the VM | Yes |
virtual center | Specifies the name or IP address of the virtual center on which the VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Stop VM workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
power status | Provides the power state of the VM |
Suspend VM workflow
This workflow suspends a VM. This workflow supports dynamic targeting.
Suspend VM workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the display name of the VM | Yes |
virtual center | Specifies the name or IP address of the virtual center on which the VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Suspend VM workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
power status | Provides the power state of the VM |
Update CPU Configuration workflow
This workflow updates the configuration of a VM's CPU. This workflow supports dynamic targeting.
Update CPU Configuration workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the name of the virtual server | Yes |
no of cpu | Specifies the number of virtual processors in a VM | Yes |
cpu allocation reservation | Specifies the amount of resource (in MHz) that is certain to be available to the VM or resource pool | No |
cpu allocation limit | Specifies the maximum resource utilization (in MHz) of a virtual machine or a resource pool, regardless of available resources | No |
cpu allocation shares | Specifies the number of shares allocated, which is used to determine resource allocation in case of resource contention | No |
cpu allocation level | Specifies the allocation level
| No |
virtual center | Specifies the name or IP address of the virtual center on which the specified VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Update CPU Configuration workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
Update Ethernet Adapter workflow
This workflow updates an ethernet adapter configuration. This workflow supports dynamic targeting.
Update Ethernet Adapter workflow inputs
Input | Description | Required | |||||||
---|---|---|---|---|---|---|---|---|---|
virtual machine | Specifies the name of the VM | Yes | |||||||
ethernet adapter | Specifies the name of the ethernet adapter to be udpated | Yes | |||||||
virtual center | Specifies the name or IP address of the virtual center on which the specified VM is hosted | No | |||||||
host system | Specifies the host system associated with the distributed virtual (DV) port group and DV switch | No | |||||||
device type | Specifies the device type
| No | |||||||
backing type | Valid values:
| No | |||||||
backing device name | Specifies the name of the device on the host system | No | |||||||
backing dv switch | Specifies the name of the DV switch | No | |||||||
backing dv portgroup | Specifies the name of the DV port group | No | |||||||
start connected | Specifies information about restrictions on removing this device while a VM is running | No | |||||||
allow guest control | Specifies information about restrictions on removing this device while a VM is running | No | |||||||
connected | Specifies information about restrictions on removing this device while a VM is running | No | |||||||
address type | Specifies the MAC address type
| No | |||||||
mac address | Specifies the MAC address assigned to the virtual network adapter | No | |||||||
wake on lan enabled | Indicates whether wake-on-LAN is enabled on this virtual network adapter | No | |||||||
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No | |||||||
connection details | Specifies the connection details for the VMware adapter
| No | |||||||
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No | |||||||
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No | |||||||
password | Specifies the password corresponding to the specified user name | No | |||||||
transport | Specifies the transport protocol for the message | No | Update Ethernet Adapter workflow outputs
|
Update Memory Configuration workflow
This workflow updates the memory configuration of a VM. This workflow supports dynamic targeting.
Update Memory Configuration workflow inputs
Input | Description | Required |
---|---|---|
vm name | Specifies the name of the virtual server | Yes |
memory | Specifies the size of a VM's memory, in MB | Yes |
memory allocation reservation | Specifies the amount of resource (in MB) that is guaranteed available to the VM or resource pool | No |
memory allocation limit | Specifies the maximum resource utilization (in MB) of a virtual machine or a resource pool, regardless of available resources | No |
memory allocation shares | Specifies the number of shares allocated which is used to determine resource allocation in case of resource contention | No |
memory allocation level | Specifies the allocation level
| No |
virtual center | Specifies the name or IP address of the virtual center on which the given VM is hosted | No |
delay | Specifies the number of seconds to wait before polling for the virtual center task status | No |
soap url | Specifies the URL for the remote soap service running on the VMware virtual center | No |
username | Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center | No |
password | Specifies the password corresponding to the specified user name | No |
transport | Specifies the transport protocol for the message | No |
Update Memory Configuration workflow outputs
Output | Description |
---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
Comments
Log in or register to comment.