Activities

• VM Create CDRom
• VM Create Ethernet Device
• VM Create Virtual Disk
• VM Edit CDRom
• VM Edit Ethernet Device
• VM Edit Virtual Disk
• VM Get Virtual CDRom
• VM Get Virtual Disk
• VM Get Ethernet Device
• VM List Controllers
• VM List Virtual CDRoms
• VM List Virtual Disks
• VM List Ehernet Devices
• VM Remove Virtual CDRom
• VM Remove Virtual Disk
• VM Remove Ethernet Device

...

Image Added

 VM Create CDRom

This activity creates a new Virtual CDRom on the specified virtual machine.

...

• Output (type: string): outputs message.
• Output Status (type: boolean): outputs True if the operation succeeded otherwise False.

...

VM Create Ethernet Device

...

• Output (type: string): outputs message.
• Output Status (type: boolean): outputs True if the operation succeeded otherwise False.

...

• Capacity in KB (text box editor type) (type: int64): the disk size in kilobytes to allocate to the virtual machine disk.
• Controller Key (text box editor type) (type: int32): the object key that denotes the controller object for this device. You need a 'VirtualLsiLogicSASController' type Key. 
  The value can also be obtained from activity: VM List Controllers using the following steps:
  • use a VM List Controllers activity to extract the Controller Key:
    Image RemovedImage Added
  • Iterate through the list of returned controllers and select the desired controller key using Get Element From Collection activity and desired index:
    
    
  • bind the obtained Controller Key (stored in variable) to the Controller Key field from VM Create Virtual Disk activity. The value stored in ControllerKey variable is converted to Int32:
    
• Disk Mode (combo box control) (type: string): specify the disk persistence mode. Valid modes are: persistent->Changes are immediately and permanently written to the virtual disk, independent_nonpersistent->Same as nonpersistent, but not affected by snapshots, independent_persistent->Same as persistent, but not affected by snapshots.
• Disk Name (text box editor type) (type: string): the name of the Disk.
• Eagerly Scrub (combo box control) (type: string): specify to the underlying file system whether the virtual disk backing file should be scrubbed completely at this time.Virtual disks on some filesystems like VMFS3 are zeroed-out lazily so that disk creation time doesn't take too long. However, clustering applications and features like Fault Tolerance require that the virtual disk be completely scrubbed. This setting allows controlling the scrubbing policy on a per-disk basis.
• Split (combo box control) (type: string): the type of virtual disk file: split or monolithic. If true, the virtual disk is stored in multiple files, each 2GB.
• Thin Provisioned (combo box control) (type: string): specify to the underlying file system, whether the virtual disk backing file should be allocated lazily (using thin provisioning). This flag is only used for file systems that support configuring the provisioning policy on a per file basis, such as VMFS3.
• Write Through (combo box control) (type: string): whether writes should go directly to the file system or should be buffered.

...

• Output (type: string): outputs message.
• Output Status (type: boolean): outputs True if the operation succeeded otherwise False.

...

VM Edit CDRom

This activity edits the specified Virtual CDRom on the virtual machine.

...

The VM Edit CDRom activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

• Virtual Machine ID (text box editor type) (type: string): the virtual machine on which you want to edit the desired CDRom Device (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity)..
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    Image Added
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Edit Virtual CDRom activity:
    Image Added

Properties (parameters):

• Allow Guest Control (combo box control) (type: string): allow the guest to control whether the connectable device is connected.
• Connected (combo box control) (type: string): flag indicating the device is currently connected. Valid only while the virtual machine is running.
• Device Key (text box editor type) (type: int32): the unique key that distinguishes this device from other devices in the same virtual machine. Enter the ID or bind it to the output parameter from the
  The value can also be obtained from activity: VM Get Virtual CDRom activity.
• Device Type (combo box control) (type: string): the type of the CDRom.
• Exclusive Access  using the following steps:
  • use a VM List Virtual CDRoms activity to extract the Virtual Device Name. Iterate through the list of DeviceDetails or use the first virtual CDRom and extract the Name using Get Element From Collection activity and index 1:
    Image AddedImage Added
    
    
  • use a VM Get Virtual CDRom and bind the obtained DeviceName (stored in variable) to the Virtual Device Name parameter:
    Image Added
  • bind the obtained CDRom_Key (stored in variable) to the Device Key parameter in VM Edit Virtual CDRom activity:
    Image Added
• Device Type (combo box control) (type: string):  the type of the CDRom.
• Exclusive Access (combo box control) (type: string): whether or not the virtual machine has exclusive access to the CD-ROM device. Set this parameter only for Client Device type.
• ISO File Path (text box editor type) (type: string): the Datastore ISO File. Set this parameter only for the ISO CDRom Device type.
• Start Connected (combo box control) (type: string): flag to specify whether or not to connect the device when the virtual machine starts.
• Use Auto Detect (combo box control) (type: string): flag to indicate whether the network should be auto detected instead of directly specified. Set this parameter only for Client Device and Host Device types.

...

• Output (type: string): outputs message.
• Output Status (type: boolean): outputs True if the operation succeeded otherwise False.

...

• .

...

Image Removed

...

VM Edit Ethernet Device

This activity edits the desired Ethernet Device from the specified virtual machine.

...

The VM Edit Ethernet Device activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

• Datacenter (text box editor type) (type: string): the datacenter root name.
• Device Key (text box editor type) (type: int32): the unique key that distinguishes this device from other devices in the same virtual machine. Enter the ID or bind it to the output parameter from the
  The value can also be obtained from activity: VM Get Virtual Ethernet Device activity.
• Host (text box editor type) (type: string): the host on which you want to edit the Virtual Ethernet Device.
• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to edit (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).

Properties (parameters):

• Allow Guest Control (combo box control) (type: string): allow the guest to control whether the connectable device is connected.
• Change MAC Address  using the following steps:
  • use a VM List Virtual Ethernet Devices activity to extract the Virtual Device Name. Iterate through the output collection of detials or use the first virtual ethernet device and extract the Name using Get Element From Collection activity and index 1:
    Image AddedImage Added
    
    
  • use a VM Get Virtual Ethernet Device and bind the obtained VirtualDeviceName (stored in variable) to the Virtual Device Name parameter:
    
    Image Added
  • bind the obtained EthernetDevice_Key (stored in variable) to the Device Key parameter in VM Remove Virtual Ethernet Device activity:
    Image Added
• Host (text box editor type) (type: string): the desired Mac Address for host on which you want to edit the Virtual Ethernet Device. Use this parameter only if you set the AddressType parameter to 'Manual'.Connected 
• Virtual Machine ID (combo text box controleditor type) (type: string):  flag indicating the device is currently connected. Valid only while the virtual machine is running.MAC Address Type the virtual machine you want to edit.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    Image Added
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Edit Virtual Ethernet Device activity:
    Image Added

Properties (parameters):

• Allow Guest Control (combo box control) (type: string): the MAC address type. Manual->Statically assigned MAC address, Generated->Automatically generated MAC address or Assigned->MAC address assigned by VirtualCenter.Network Name allow the guest to control whether the connectable device is connected.
• Change MAC Address (text box editor type) (type: string):  the Network Name the desired Mac Address for the Virtual Ethernet Device. If left empty it will set the first network found in the current environment.Start Use this parameter only if you set the AddressType parameter to 'Manual'.
• Connected (combo box control) (type: string): flag to specify whether or not to connect  flag indicating the device when is currently connected. Valid only while the virtual machine startsis running.Use Auto Detect 
• MAC Address Type (combo box control) (type: string):  flag to indicate whether the network should be auto detected instead of directly specified. If this value is set to TRUE, NetworkName is ignored.Wake on LAN Enabled (combo box controlthe MAC address type. Manual->Statically assigned MAC address, Generated->Automatically generated MAC address or Assigned->MAC address assigned by VirtualCenter.
• Network Name (text box editor type) (type: string): whether wake-on-LAN is enabled on this virtual network adapter. Clients can set this property to selectively enable or disable wake-on-LAN.

The Read Only Output variable are the possible output values that the activity will provide:

• Outputthe Network Name for the Ethernet Device. If left empty it will set the first network found in the current environment.
• Start Connected (combo box control) (type: string): outputs message of the editing action.Output Status flag to specify whether or not to connect the device when the virtual machine starts.
• Use Auto Detect (combo box control) (type: booleanstring): outputs True if the operation succeeded otherwise False.

VM Edit Virtual Disk

This activity edits the specified Virtual Disk on the virtual machine.

Activity Parameters

The VM Edit Virtual Disk activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image Removed

Parameters:

• Device Key (text box editor type flag to indicate whether the network should be auto detected instead of directly specified. If this value is set to TRUE, NetworkName is ignored.
• Wake on LAN Enabled (combo box control) (type: int32): the unique key that distinguishes this device from other devices in the same virtual machine. Enter the ID or bind it to the output parameter from the VM Get Virtual Disk activity.string): whether wake-on-LAN is enabled on this virtual network adapter. Clients can set this property to selectively enable or disable wake-on-LAN.

The Read Only Output variable are the possible output values that the activity will provide:

• Output (type: string): outputs message of the editing action.
• Output Status (type: boolean): outputs True if the operation succeeded otherwise False.

VM Edit Virtual Disk

This activity edits the specified Virtual Disk on the virtual machine.

Activity Parameters

The VM Edit Virtual Disk activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image Added

Parameters:

• Device Key (text box editor type) (type: int32): the unique key that distinguishes this device from other devices in the same virtual machine.
  The value can also be obtained from activity: VM Get Virtual Disk using the following steps:
  • use a VM List Virtual Disks activity to extract the Virtual Device Name. Iterate through the list of DeviceDetails or use the first virtual disk and extract the Name using Get Element From Collection activity and index 1:
    Image AddedImage Added
    
    
  • use a VM Get Virtual Disk and bind the obtained VirtualDeviceName (stored in variable) to the Virtual Device Name parameter:
    
    Image Added
  • bind the obtained VirtualDisk_Key (stored in variable) to the Device Key parameter in VM Edit Virtual Disk activity:
    Image Added
• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to edit (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity)..
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    Image Added
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Edit Virtual Disk activity:
    Image Added

Properties (parameters):

• Capacity in KB (text box editor type) (type: int64): the capacity of the virtual disk.
• Disk Mode (combo box control) (type: string): specify the disk persistence mode. Valid modes are: persistent->Changes are immediately and permanently written to the virtual disk, independent_nonpersistent->Same as nonpersistent, but not affected by snapshots, independent_persistent->Same as persistent, but not affected by snapshots.
• Eagerly Scrub (combo box control) (type: string): specify to  the underlying filesystem whether the virtual disk backing file should be scrubbed completely at this time.Virtual disks on some filesystems like VMFS3 are zeroed-out lazily so that disk creation time doesn't take too long. However, clustering applications and features like Fault Tolerance require that the virtual disk be completely scrubbed. This setting allows controlling the scrubbing policy on a per-disk basis.
• Split (combo box control) (type: string): the type of virtual disk file: split or monolithic. If true, the virtual disk is stored in multiple files, each 2GB.
• Thin Provisioned (combo box control) (type: string): specify to the underlying file system, whether the virtual disk backing file should be allocated lazily (using thin provisioning). This flag is only used for file systems that support configuring the provisioning policy on a per file basis, such as VMFS3.
• Write Through (combo box control) (type: string): whether writes should go directly to the file system or should be buffered.

The Read Only Output variable are the possible output values that the activity will provide:

• Output (type: string): outputs the result message.
• Output Status (type: boolean): outputs True if the operation succeeded otherwise False.

...

output values that the activity will provide:

• Output (type: string): outputs the result message.
• Output Status (type: boolean): outputs True if the operation succeeded otherwise False.

VM Get Virtual CDRom

This activity returns the desired Virtual CDRom ID found on the specified Virtual Machine.

...

• Output (type: int32): outputs the ID of the Virtual CDRom Device.

...

VM Get Virtual Disk

This activity returns the desired Virtual Disk ID found on the specified Virtual Machine.

...

• Output (type: int32): outputs the ID of the Virtual Disk Device.

...

VM Get Virtual Ethernet Device

...

The VM Get Virtual Ethernet Device activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

• Virtual Device Name (text box editor type) (type: string): the virtual device name. 
  The value can also be obtained from activity: VM List Virtual Ethernet Devices using the following steps:
  • use a VM List Virtual Ethernet Devices activity to extract the Virtual Device Name. Iterate through the output collection of details or use the first virtual ethernet device and extract the Name using Get Element From Collection activity and index 1:
    
    
    
  • bind the obtained VirtualDeviceName (stored in variable) to the Virtual Device Name parameter:
    
    
• Virtual Machine ID (text box editor type) (type: string): the virtual machine on which the Virtual Ethernet Device can be found.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Get Virtual Ethernet Device activity:
    Image RemovedImage Added

The Read Only Output variable are the possible output values that the activity will provide:

• Output (type: int32): outputs the ID of the Virtual Disk Device.

...

VM List Controllers

This activity lists the specified Controllers.

...

...

VM List Virtual CDRoms

This activity lists all the Virtual CDRoms from the specified Virtual Machine.

...

VM List Virtual Disks

This activity lists all the Virtual Disks from the specified Virtual Machine.

...

VM List Virtual Ethernet Devices

...

VM Remove Virtual CDRom

This activity removes the desired Virtual CDRom from the specified virtual machine.

...

• Output Status (type: boolean): outputs True if the operation succeeded otherwise False.

VM Remove Virtual Disk

This activity removes the desired Virtual Disk from the specified virtual machine.

...

• Device Key (text box editor type) (type: int32): the unique key that distinguishes this device from other devices in the same virtual machine.
  The value can also be obtained from activity: VM Get Virtual Disk using the following steps:
  • use a VM List Virtual Disks activity to extract the Virtual Device Name. Iterate through the list of DeviceDetails or use the first virtual CDRom disk and extract the Name using Get Element From Collection activity and index 1:
    
    
    
  • use a VM Get Virtual Disk and bind the obtained VirtualDeviceName (stored in variable) to the Virtual Device Name parameter:
    
    
  • bind the obtained VirtualDisk_Key (stored in variable) to the Device Key parameter in VM Remove Virtual Disk activity:
    
• Virtual Machine ID (text box editor type) (type: string): the virtual machine which contains the Virtual Disk that you want to remove.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Remove Virtual Disk activity:
    

...

The Read Only Output variable are the possible output values that the activity will provide:

• Output Status (type: boolean): outputs True if the operation succeeded otherwise False.

VM Remove Virtual Ethernet Device

...