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

 

 

Add Disk Space workflow outputs

 

Back to top

 Clone VM workflow

This workflow clones a VM. This workflow supports dynamic targeting.

Clone VM workflow inputs

 

 

Clone VM workflow outputs

 

Back to top

 Create VM Snapshot workflow

This workflow creates a snapshot of the VM. This workflow supports dynamic targeting.

Create VM Snapshot workflow inputs

 

 

Create VM Snapshot workflow outputs

 

Back to top

 Create VM workflow

 

Create VM workflow inputs

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

 

Back to top

 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

 

 

Delete Disk Space workflow outputs

 

Back to top

 Delete VM Snapshot workflow

This workflow removes a snapshot. This workflow supports dynamic targeting.

Delete Snapshot workflow inputs

 

 

Delete Snapshot workflow outputs

 

Back to top

 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

 

 

Delete VM workflow outputs

 

Back to top

 Get Task Status workflow

This workflow retrieves the status of a task. This workflow supports dynamic targeting.

Get Task Status workflow inputs

 

 

Get Task Status workflow outputs

 

Back to top

 Get VM Configuration workflow

This workflow retrieves the configuration of a VM. This workflow supports dynamic targeting.

Get VM Configuration workflow inputs

 

 

Get VM Configuration workflow outputs

 

Back to top

 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

 

 

Get VM Power Status workflow outputs

 

Back to top

 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

 

 

Poll VM Power Status workflow outputs

 

Back to top

 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

 

 

Poll Virtual Center Task Status workflow outputs

 

Back to top

 Restart Guest OS workflow

This workflow restarts a guest operating system. This workflow supports dynamic targeting.

Restart Guest OS workflow inputs

 

 

Restart Guest OS workflow outputs

 

Back to top

 Resume VM workflow

This workflow resumes the activity of the specified VM. This workflow supports dynamic targeting.

Resume VM workflow inputs

 

 

Resume VM workflow outputs

 

Back to top

 Revert VM Snapshot workflow

This workflow reverts the VM to a specified snapshot. This workflow supports dynamic targeting.

Revert VM Snapshot workflow inputs

 

 

Revert VM Snapshot workflow outputs

 

Back to top

 Shutdown Guest OS workflow

This workflow shuts down a guest operating system. This workflow supports dynamic targeting.

Shutdown Guest OS workflow inputs

 

 

Shutdown Guest OS workflow outputs

 

Back to top

 Start VM workflow

This workflow starts a VM. This workflow supports dynamic targeting.

Start VM workflow inputs

 

 

Start VM workflow outputs

 

Back to top

 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

 

 

Stop VM workflow outputs

 

Back to top

 Suspend VM workflow

This workflow suspends a VM. This workflow supports dynamic targeting.

Suspend VM workflow inputs

 

 

Suspend VM workflow outputs

 

Back to top

 Update CPU Configuration workflow

This workflow updates the configuration of a VM's CPU. This workflow supports dynamic targeting.

Update CPU Configuration workflow inputs

 

 

Update CPU Configuration workflow outputs

 

Back to top

 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
Supported values:

  • VirtualE1000
  • VirtualPCNet32 (default)
  • VirtualVmxnet

No

backing type

Valid values:

  • VirtualEthernetCardDistributedVirtualPortBackingInfo
  • VirtualEthernetCardNetworkBackingInfo

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
Valid values: true, false

No

allow guest control

Specifies information about restrictions on removing this device while a VM is running
Valid values: true, false

No

connected

Specifies information about restrictions on removing this device while a VM is running
Valid values: true, false

No

address type

Specifies the MAC address type
Valid values:

  • Manual
  • Statically assigned MAC address: generated
  • Automatically generated MAC address: assigned
  • MAC address assigned by VirtualCenter.

No

mac address

Specifies the MAC address assigned to the virtual network adapter
Clients can set this property to any of the allowed address types. The server might override the specified value for generated or assigned if it does not fall in the right ranges or is determined to be a duplicate.

No

wake on lan enabled

Indicates whether wake-on-LAN is enabled on this virtual network adapter
Clients can set this property to selectively enable or disable wake-on-LAN.

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

<connection-parameters>
 <soap-url></soap-url>
 <transport></transport>
 <user-name></user-name>
 <password></password>
</connection-parameters>

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

Back to top

 Update Memory Configuration workflow

This workflow updates the memory configuration of a VM. This workflow supports dynamic targeting.

Update Memory Configuration workflow inputs

 

 

Update Memory Configuration workflow outputs

 

Back to top

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*