Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


Image Added 

 

 

Add  Add new virtual switch

This activity adds a new virtual switch. 

...


Execution: The example below is an execution where all properties are returned for the specified network adapter of the VM:

 

Get Network Connections

This activity retrieves the available network connections for the selected host.

Activity Parameters

The Get Network Connections activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Cluster (text box editor type) (type: string): the name of the Cluster (only necessary if 'Host' parameter is empty).
  • Datacenter Name (text box editor type) (type: string): the Datacenter name.
  • Datastore Name (text box editor type) (type: string): the Datastore name (optional).
  • Host (text box editor type) (type: string): the Host (ip address).

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

  • Output dvSwitches  (type: collection<collection<string>>): outputs a collection of distributed virtual switch properties and their corresponding values.To use the elements of the collection, use Get Element From Collection activity where the Input Collection parameter should be bind with this parameter.
  • Output Networks  (type:  collection<collection<string>>): outputs a collection of collections containing the Name and ID for each network. To use the elements of the collection, use Get Element From Collection activity where the Input Collection parameter should be bind with this parameter.
  • Output Port Group Keys  (type: collection<string>)outputs a collection of Port Group Keys. To use the elements of the collection, use Get Element From Collection activity where the Input Collection parameter should be bind with this parameter.
  • Output Port Groups  (type:  collection<collection<string>>)outputs a collection of Properties and their corresponding values.To use the elements of the collection, use Get Element From Collection activity where the Input Collection parameter should be bind with this parameter.

 

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


Execution: The example below is an execution where all network connections for host with IP 10.201.0.51:

 


Get Virtual Network Adapters 

This activity gets all the virtual network adapters for the specified host. 

Activity Parameters

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

Parameters:

  • Host ID (text box editor type) (type: string): the the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored. E.g "host-20".
    The value can also be obtained from activity: Get Host using the following steps:
    • use a Get Host activity to extract the HostID:
    • bind the obtained HostID (stored in variable) to the HostID field from Get Virtual Network Adapters activity:   
                            

    • Host IP (text box editor type) (type: string): the Host IP.

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

  • Output  (type: collection<dictionary<string,string>>): outputs a collection of dictionaries containing all the Virtual Adapters found with their details.

In order to extract the values from the NetworkAdapters collection, For Each and Get KeyValuePair activities should be used:


Execution: The example below is an execution where all virtual network adapters are returned for host with IP: 10.201.0.51:

 

 



Remove virtual switch

This activity removes a specified virtual switch. 

Activity Parameters

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

Parameters:

  • Device Name (text box editor type) (type: string): the name for the network adapter associated with this virtual switch.
  • Host ID (text box editor type) (type: string): the the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored. E.g "host-20".
    The value can also be obtained from activity: Get Host using the following steps:
    • use a Get Host activity to extract the HostID:
    • bind the obtained HostID (stored in variable) to the HostID field from Remove Virtual Switch activity:   

                         

    • Host IP (text box editor type) (type: string): the Host IP.
    • VSwitch Name (text box editor type) (type: string): the name for the virtual switch. 

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

  • Status(type: string): outputs the result status.