Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 13 Next »

Activities

 

 

 

 

 

VM Create CDRom

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

Activity Parameters

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

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine on which you want to create the Virtual CDRom.
    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 Create CDRom activity:

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. 
  • Controller Key (text box editor type) (type: int32): the object key that denotes the controller object for this device. You need a 'VirtualIDEController' 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:
    • 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 CDRom activity. The value stored in ControllerKey variable is converted to Int32:
  • Device Name (text box editor type) (type: string): the name of the device on the remote system.
  • Exclusive Access (combo box control) (type: string)whether or not the virtual machine has exclusive access to the CD-ROM device.
  • 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.

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

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

 

 

VM Create Ethernet Device

This activity creates a new Ethernet Device on the specified virtual machine.

Activity Parameters

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

Parameters:

  • Cluster Name (text box editor type) (type: string): the name of the Cluster (only necessary if 'Host' parameter is empty).
  • Datacenter (text box editor type) (type: string): the datacenter root name.
  • Host (text box editor type) (type: string): the host on which you want to create the Virtual Ethernet Device.
  • Port Group Key (text box editor type) (type: string): the Port Group Key ID of the network adapter which you want to set for the new virtual machine. Only needed when the network is port group type. Bind the value to the output 'PortGroupKey' from 'GetNetworkAdapterProperties' activity.
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine on which you want to create the Ethernet Device.
    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 Create Ethernet Device activity:
  • VM Network Type (combo box control) (type: string): the network adapter type for the virtual machine.

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.
  • Network Name (text box editor type) (type: string): the 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): 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. If this value is set to TRUE, NetworkName is ignored.
  • Wake on LAN Enabled (combo box control) (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:

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

 

Execution: The example below is an execution where a new ethernet device is created for VM with ID vm-25:

VM Create Virtual Disk

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

Activity Parameters

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

Parameters:

  • Datastore Name (text box editor type) (type: string): the name of the Datastore on which you want to create the Virtual Disk or bind it to the output parameter collection 'Output' from VM List Datastores activity.
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine on which you want the new Virtual Disk to be created.
    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 Create Virtual Disk activity:

Properties (parameters):

  • 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:
    • 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.

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

  • 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.

Activity Parameters

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

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine on which you want to edit the desired CDRom Device.
    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 Edit Virtual CDRom activity:

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.
    The value can also be obtained from activity: VM Get Virtual CDRom 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:


    • use a VM Get Virtual CDRom and bind the obtained DeviceName (stored in variable) to the Virtual Device Name parameter:
    • bind the obtained CDRom_Key (stored in variable) to the Device Key parameter in VM Edit Virtual CDRom activity:
  • 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.

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

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

 

 

 

 

 

VM Edit Ethernet Device

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

Activity Parameters

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

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.
    The value can also be obtained from activity: VM Get Virtual Ethernet Device 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:


    • use a VM Get Virtual Ethernet Device and bind the obtained VirtualDeviceName (stored in variable) to the Virtual Device Name parameter:

    • bind the obtained EthernetDevice_Key (stored in variable) to the Device Key parameter in VM Remove 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.
    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 Edit Virtual Ethernet Device 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 (text box editor type) (type: string): the desired Mac Address for the Virtual Ethernet Device. Use this parameter only if you set the AddressType parameter to 'Manual'.
  • Connected (combo box control) (type: string): flag indicating the device is currently connected. Valid only while the virtual machine is running.
  • MAC Address Type (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 (text box editor type) (type: string)the 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): 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. If this value is set to TRUE, NetworkName is ignored.
  • Wake on LAN Enabled (combo box control) (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:

  • 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:

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:


    • 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 Edit Virtual Disk activity:
  • Virtual Machine ID (text box editor type) (type: string): 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:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Edit Virtual Disk activity:

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.
 

 

VM Get Virtual CDRom

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

Activity Parameters

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

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 CDRoms 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:


    • 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 CDRom 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 CDRom activity:

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

  • 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.

Activity Parameters

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

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 Disks 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:


    • 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 Disk 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 Disk activity:

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 Get Virtual Ethernet Device

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

Activity Parameters

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

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:

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.

Activity Parameters

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

Parameters:

  • Controller Type (combo box control) (type: string): the type of the controllers that you wish to be listed.Flowster Studio provides the following options:
    • VirtualIDEController
    • VirtualLsiLogicSASController
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine.
    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 List Controllers activity:

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

  • Output (type: collection>collection<string>>): outputs a collection of sub-collections containing information about Controller Devices.
  • Output Controller Keys (type: collection<int32>): outputs a collection of Controller Keys.

 

In order to extract the values from the ControllerDetails collection, For Each and Get Element From Collection activities should be used:

 

Execution: The example below is an execution where all controllers are listed for VirtualMachine with ID vm-25:

 

 

 

VM List Virtual CDRoms

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

Activity Parameters

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

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine.
    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 List Virtual CDRoms activity:

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

  • Output (type: collection>collection<string>>): outputs a collection of sub-collections containing information about Virtual CDRom Devices.
  • Output Controller Keys (type: collection<int32>): outputs a collection of Keys from the found Devices.
 

In order to extract the values from the DeviceDetails collection, For Each and Get Element From Collection activities should be used:

 

Execution: The example below is an execution where all virtual CDRoms are listed for VirtualMachine with ID vm-25:



 

VM List Virtual Disks

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

Activity Parameters

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

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine.
    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 List Virtual Disks activity:

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

  • Output (type: collection>collection<string>>): outputs a collection of sub-collections containing information about Virtual Disk Devices.
  • Output Devices Keys (type: collection<int32>): outputs a collection of Keys from the found Devices.

In order to extract the values from the VirtualDisksDetails collection, For Each and Get Element From Collection activities should be used:

 

Execution: The example below is an execution where all virtual disks are listed for VirtualMachine with ID vm-25:



 

VM List Virtual Ethernet Devices

This activity lists all the Virtual Ethernet Devices from the specified Virtual Machine.

Activity Parameters

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

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine.
    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 List Virtual Ethernet Devices activity:

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

  • Output (type: collection>collection<string>>): outputs a collection of sub-collections containing information about Virtual Ethernet Devices.
  • Output Devices Keys (type: collection<int32>): outputs a collection of Keys from the found Devices.
 

In order to extract the values from the EthernetDevicesDetails collection, For Each and Get Element From Collection activities should be used:

 

Execution: The example below is an execution where all virtual disks are listed for VirtualMachine with ID vm-25:

 

 

VM Remove Virtual CDRom

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

Activity Parameters

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

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 CDRom 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:


    • use a VM Get Virtual CDRom and bind the obtained DeviceName (stored in variable) to the Virtual Device Name parameter:

    • bind the obtained CDRom_Key (stored in variable) to the Device Key parameter in VM Remove CDRom activity:
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine from which you want to remove the desired CDRom Device.
    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 CDRom 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 Disk

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

Activity Parameters

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

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:


    • 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

This activity removes the desired Virtual Ethernet Device from the specified virtual machine.

Activity Parameters

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

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 Ethernet Device 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:


    • use a VM Get Virtual Ethernet Device and bind the obtained VirtualDeviceName (stored in variable) to the Virtual Device Name parameter:

    • bind the obtained EthernetDevice_Key (stored in variable) to the Device Key parameter in VM Remove Virtual Ethernet Device 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 Ethernet Device 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.
  • No labels