Activities

Get Pool
Get Pool Host
List Pool Hosts
List Host VMs
Set HA State
Get HA State
Designate Pool
Enter Maintenance Mode
Get Maintenance mode
Guest ShutDown By Name
ShutDown Host By IP
Force ShutDown Host By IP

Get Pool

This activity retrives the pool information

Activity Parameters

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

Parameters:

Connection (text box editor type) (type: string): the Citrix Host Session. The Output from Connect to Citrix activity should be used as Input here.

The Read Only Output parameters block contains the possible output values that the activity will provide:

Output Pool (type: List<KeyValuePair<string,string>): outputs an object of type List<KeyValuePair<string,string>. You can access the following items using as key: Name, UUID, HA, Description, RefId.
For getting each item from the output object we recommend using the Custom ForEach activity of KeyValuePair<String,String>.

Execution:

Get Pool Host

This activity returns information about the pool host

Activity Parameters

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

Parameters:

Connection (text box editor type) (type: string): the Citrix Host Session. The Output from Connect to Citrix activity should be used as Input here.
Address (text box editor type) (type: string): enter the IP Address of the Host (e.g. 10.201.0.21)
Hostname (text box editor type) (type: string): enter the hostname of the host. Takes Precedence over IP address and can be obtained using List Pool Hosts activity.
UUID (text box editor type) (type: string): enter the UUID of the host. Takes Precedence over Hostname and can be obtained using List Pool Hosts activity.

The Read Only Output parameters block contains the possible output values that the activity will provide:

Output CPU Model (type: string): outputs the CPU Model.
Output Description (type: string): outputs the host description
Output Label Name (type: string): outputs the host label name
Output Pool (type: string): outputs true/false if the host is Master
Output Result (type: List<KeyValuePair<string,string>): outputs an object of type List<KeyValuePair<string,string>. You can access the following items using as key: name, description, is_enabled,cpu_model, is_pool_master.
For getting each item from the output object we recommend using the Custom ForEach activity of KeyValuePair<String,String>.
Output State (type: string): outputs the host state e.g. true, false, unknown.

List Pool Hosts

This activity retrives the pool information

Activity Parameters

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

Parameters:

Connection (text box editor type) (type: string): the Citrix Host Session. The Output from Connect to Citrix activity should be used as Input here.

The Read Only Output parameters block contains the possible output values that the activity will provide:

Output Host (type: List<KeyValuePair<string,string>): outputs an object of type List<KeyValuePair<string,string>. Key is Hostname and value is UUID.
For getting each item from the output object we recommend using the Custom ForEach activity of KeyValuePair<String,String>.

List Host VMs

This activity retrives a list of VM Hosts

Activity Parameters

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

Parameters:

Connection (text box editor type) (type: string): the Citrix Host Session. The Output from Connect to Citrix activity should be used as Input here.
Address (text box editor type) (type: string): enter the IP Address of the Host (e.g. 10.201.0.21)
Hostname (text box editor type) (type: string): enter the Hostname of target machine. In order to obtain hostname value you can use ListPoolHosts activity.
UUID (text box editor type) (type: string): enter the UUID of the host. Takes precedence over the Hostname. In order to obtain the UUID value you can use ListPoolHosts activity

The Read Only Output parameters block contains the possible output values that the activity will provide:

Output Count (type: string) : outputs the number of VMs
Output VMs List (type: List<KeyValuePair<string,List<KeyValuePair<string,string>>>): outputs an object of typeList<KeyValuePair<string,List<KeyValuePair<string,string>>>. You can access the items with the following keys power_state, name_label, name_description, uuid.
To retrive the items you will need 2 foreach activities as in the image above. The first one will need to be type KeyValuePair<string,List<KeyValuePair<string,string>>. In Iterator.key you will retrive the UUID for each VM in the host. Tthe second foreach will be <KeyValuePair<string,string> and will get as argument Iterator.Value from the first. This one will retrive in Iterator1,key power_state, name_label, name_description, uuid and in Iterator1.Value the values for each key.

To retrive the items

Set HA state

This activity enables High Availability for pool.

Activity Parameters

The Set HA state activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type) (type: string): the Citrix Host Session. The Output from Connect to Citrix activity should be used as Input here.
Pool UUID (text box editor type) (type: string): enter the Pool UUID. This parameter can be obtained by using GetPool activity
HA enabled (combo box control) (type: string): specify whether to enable or disable the High Availability

Note:

This activity doesn't return any parameter. To get the current HA state you can use GetHAState activity,:

Execution:

Get HA state

This activity returns the state of HA

Activity Parameters

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

Parameters:

Connection (text box editor type) (type: string): the Citrix Host Session. The Output from Connect to Citrix activity should be used as Input here.
Pool UUID (text box editor type) (type: string): enter the Pool UUID. This parameter can be obtained by using GetPool activity

The Read Only Output parameters block contains the possible output values that the activity will provide:

Output state (type: string): outputs the current Ha state e.g. true, false, unknown.

Execution:

Designate Pool

This activity designates a new pool master.

Activity Parameters

The Designate Pool activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type) (type: string): the Citrix Host Session. The Output from Connect to Citrix activity should be used as Input here.
New Master UUID (text box editor type) (type: string): enter the new Pool Master UUID. This parameter can be obtained by using GetPool activity

No output.

Note:

After you use this activity you will need to reconnect to XenServer with the new master. Before reconnecting we recoment you use a Delay activity.

Enter Maintenance Mode

This activity changes the maintenance mode of a host if it's not Pool Master.

Activity Parameters

The Enter Maintenance Mode activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type) (type: string): the Citrix Host Session. The Output from Connect to Citrix activity should be used as Input here.
Address (text box editor type) (type: string): enter the IP Address of the Host (e.g. 10.201.0.21)
Hostname (text box editor type) (type: string): enter the Hostname of target machine. In order to obtain hostname value you can use ListPoolHosts activity.
UUID (text box editor type) (type: string): enter the UUID of the host. Takes precedence over the Hostname. In order to obtain the UUID value you can use ListPoolHosts activity

The Read Only Output parameters block contains the possible output values that the activity will provide:

Output operation status (type: boolean): outputs true/false if the operation succeded

Note:

The Output operation status is not the Maintenance status of the host. To get the maintenance mode you can use Pools#Get Maintenance mode activity.
If host you want to enter in maintenance mode is pool master use Designate Pool to make another host the master before using this activity.

Get Maintenance mode

This activity returns the maintenance status of host.

Activity Parameters

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

Parameters:

Connection (text box editor type) (type: string): the Citrix Host Session. The Output from Connect to Citrix activity should be used as Input here.
Hostname (text box editor type) (type: string): enter the Hostname of target machine. In order to obtain hostname value you can use ListPoolHosts activity.
UUID (text box editor type) (type: string): enter the UUID of the host. Takes precedence over the Hostname. In order to obtain the UUID value you can use ListPoolHosts activity

The Read Only Output parameters block contains the possible output values that the activity will provide:

Output state (type: string): outputs the current maintenance state e.g. true, false, unknown.

Execution:

Guest ShutDown By Name

This activity shuts down Citrix Guest.

Activity Parameters

The Guest ShutDown By Name activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type) (type: string): the Citrix Host Session. The Output from Connect to Citrix activity should be used as Input here.
VM name (text box editor type) (type: string): enter the VM Name to be shutdown. You can retrieve this parameter by using ListHostVms activity.
UUID (text box editor type) (type: string): enter the UUID of the VM. Takes precedence over the VM name. In order to obtain the UUID value you can use ListHostVms activity.

The Read Only Output parameters block contains the possible output values that the activity will provide:

Output state (type: string): outputs the current power state of VM (on/off).

ShutDown Host By IP

This activity shuts down Citrix Host.

Activity Parameters

The ShutDown Host By IP activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type) (type: string): the Citrix Host Session. The Output from Connect to Citrix activity should be used as Input here.
Hostname or IP (text box editor type) (type: string): enter the Hostname or the IP address of target machine - example: "10.10.10.10" or "Citrix.example.local" to shutdown. In order to optain hostname value you can use ListPoolHosts activity.
UUID (text box editor type) (type: string): enter the UUID of the host. Takes precedence over the Hostname. In order to obtain the UUID value you can use ListPoolHosts activity

The Read Only Output parameters block contains the possible output values that the activity will provide:

Output state (type: string): outputs the current power state of host (on/off).

Force ShutDown Host By IP

This activity force shuts down Citrix Host.

Activity Parameters

The Force ShutDown Host By IP activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type) (type: string): the Citrix Host Session. The Output from Connect to Citrix activity should be used as Input here.
Hostname or IP (text box editor type) (type: string): enter the Hostname or the IP address of target machine - example: "10.10.10.10" or "Citrix.example.local" to shutdown. In order to obtain hostname value you can use ListPoolHosts activity.
UUID (text box editor type) (type: string): enter the UUID of the host. Takes precedence over the Hostname. In order to obtain the UUID value you can use ListPoolHosts activity

The Read Only Output parameters block contains the possible output values that the activity will provide:

Output state (type: string): outputs the current power state of host (on/off).

Browser not supported