Execute Add
Execute Delete
Execute Get
Execute Info
Execute MacroSet
Execute Run
Execute RunByteArrayInput
Execute RunByteArrayOutput
Execute Run With Return
Execute Set
Execute Set List

Introduction

Generic activites from Citrix Provisioning Server directory allow the user to perform several commands on the Provisioning Server farm targets (Site, Collection, Views etc). Each generic activity allows the user to input a specific command with desired parameters. For further more information about the commands parameters and examples, please visit http://support.citrix.com/article/ctx139391 link to download a copy of SOAPServer Administrator's Guide - Provisioning Services 7.1.

Example - Commands List

Execute Add

ExecuteAdd AuthGroup
ExecuteAdd Collection
ExecuteAdd Device
ExecuteAdd DeviceWithPersonalvDisk
See more commands in SOAPServer Administrator's Guide - Provisioning Services 7.1 guide.

Execute Delete

ExecuteDelete AuthGroup
ExecuteDelete Collection
ExecuteDelete Device
ExecuteDelete DeviceDiskCacheFile
See more commands in SOAPServer Administrator's Guide - Provisioning Services 7.1 guide.

Execute Get

ExecuteGet AdDomains
ExecuteGet AuditActionParameters
ExecuteGet AuditActionProperties
ExecuteGet AuditActionSibling
See more commands in SOAPServer Administrator's Guide - Provisioning Services 7.1 guide.

Execute Info

ExecuteInfo Group
ExecuteInfo LocalServer
ExecuteInfo MapiErrorCode
ExecuteInfo Version
See more commands in SOAPServer Administrator's Guide - Provisioning Services 7.1 guide.

Execute MacroSet

ExecuteMacroSet Macro

Execute Run

ExecuteRun ActivateDevice
ExecuteRun AddDeviceToDomain
ExecuteRun AddDiskVersion
ExecuteRun ApplyAutoUpdate
See more commands in SOAPServer Administrator's Guide - Provisioning Services 7.1 guide.

Execute Run With Return

ExecuteRunWithReturn Boot
ExecuteRunWithReturn CommandActions
ExecuteRunWithReturn CreateDisk
ExecuteRunWithReturn CreateDiskStatus
See more commands in SOAPServer Administrator's Guide - Provisioning Services 7.1 guide.

Execute RunByteArrayInput

ExecuteRunByteArrayInput ImportDevices
ExecuteRunByteArrayInput ImportOemLicenses

Execute RunByteArrayOutput

ExecuteRunByteArrayOutput ArchiveAuditTrail
ExecuteRunByteArrayOutput ExportOemLicenses

ExecuteSet

ExecuteSet AuthGroup
ExecuteSet Collection
ExecuteSet Device
ExecuteSet Disk
See more commands in SOAPServer Administrator's Guide - Provisioning Services 7.1 guide.

Execute Set List

ExecuteSetList DeviceBootstraps
ExecuteSetList DeviceCustomProperty
ExecuteSetList DeviceDiskPrinters
ExecuteSetList DevicePersonality
See more commands in SOAPServer Administrator's Guide - Provisioning Services 7.1 guide.

Commands Parameters

Execute Add

Citrix PVS - SOAP Execute Add.

Activity Parameters

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

Parameters:

Command (combo box control) (type: string):select the command from the ExecuteAdd commands list. E.g "Store". This command adds a store to the system with the specified parameters.
Record (collection editor type) (type: string): the parameters for the ExecuteAdd Store command specified in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide. Follow the steps below to add the required parameters in the Record field:
- navigate to the ExecuteAdd Store parameters list in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide and extract the required parameters for this command (all records can be added as input, not just the required ones):
- open the Record collection editor and add the required records for this command.

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

Output GUID (type: string): outputs the resulting GUID of the object that you wish to add.
Output Status (type: string): outputs the activity execution result.

Execution:

Execute Delete

Citrix PVS - SOAP Execute Delete.

Activity Parameters

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

Parameters:

Command (combo box control) (type: string):select the command from the ExecuteDelete commands list. E.g "Store". This command deletes a store from the system with the specified parameters.
Record (collection editor type) (type: string): the parameters for the ExecuteDelete Store command specified in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide. Follow the steps below to add the required parameters in the Record field:
- navigate to the ExecuteDelete Store parameters list in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide and extract the required parameters for this command (all records can be added as input, not just the required ones):
- open the Record collection editor and add the required records for this command.

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

Output Status (type: string): outputs the activity execution result.

Execution:

Execute Get

Citrix PVS - SOAP Execute Get.

Activity Parameters

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

Parameters:

Command (combo box control) (type: string):select the command from the ExecuteGet commands list. E.g "Collection". This command returns records of a desired object: collection, device etc.according to the specified parameters.
Property Name (text box editor type) (type: string): enter the name of the property for which you want a separate output.
Fields (text box editor type) (type: string): enter fields to be returned by ExecuteGet activity according to the selected command.
- navigate to the ExecuteGet Collection parameters list in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide and extract the fields to be returned for this command :
Record (collection editor type) (type: string): the parameters for the ExecuteGet Collection command specified in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide. Follow the steps below to add the required parameters in the Record field:
- navigate to the ExecuteGet Collection parameters list in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide and extract the required parameters for this command (all records can be added as input, not just the required ones):
- open the Record collection editor and add the required records for this command.

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

Output Collection (type: collection<collection<string>>): outputs collection with items made of 2 columns sub-collection (name, value).
Output GUID (type: string): outputs the resulting GUID.
Output Property Value (type: string): outputs the value of the property specified in the 'Property Name' parameter.
Output Row Count (type: int32): outputs row count of the returned values.
Output Status (type: string): outputs the activity execution result.

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

Execution:

Execute Info

Citrix PVS - SOAP Execute Info.

Activity Parameters

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

Parameters:

Command (combo box control) (type: string):select the command from the ExecuteInfo commands list. E.g "Group". This command returns records of a desired object: user, domain etc. according to the specified parameters.
Fields (text box editor type) (type: string): enter fields to be returned by ExecuteInfo activity according to the selected command.
- navigate to the ExecuteInfo Group parameters list in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide and extract the fields to be returned for this command :
Record (collection editor type) (type: string): the parameters for the ExecuteInfo Group command specified in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide. Follow the steps below to add the required parameters in the Record field:
- navigate to the ExecuteInfo Group parameters list in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide and extract the required parameters for this command (all records can be added as input, not just the required ones):
- open the Record collection editor and add the required records for this command.

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

Output records (type: Array<Array<KeyValuePair<string,string>>>): outputs an array of arrays containing KeyValue pairs with the returned records.
Output status (type: string): outputs the activity execution result.

In order to extract the values from the GroupInfo output collection, For Each of type Array(Of KeyValuePair(Of String,String)) and GetKeyValuePair activities should be used to extract the Name key:

Execution:

Execute Run

Citrix PVS - SOAP Execute Run.

Activity Parameters

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

Parameters:

Command (combo box control) (type: string):select the command from the ExecuteRun commands list. E.g "EnableCollection". This command enables a collection and the child devices according to the specified parameters.
Record (collection editor type) (type: string): the parameters for the ExecuteRun EnableCollection command specified in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide. Follow the steps below to add the required parameters in the Record field:
- navigate to the ExecuteRun EnableCollection parameters list in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide and extract the required parameters for this command (all records can be added as input, not just the required ones):
- open the Record collection editor and add the required records for this command.

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

Output Status (type: string): outputs the activity execution result.

Execution:

Execute Run With Return

Citrix PVS - SOAP Execute Run With Return.

Activity Parameters

The Execute Run With Return activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Command (combo box control) (type: string) : select the command from the ExecuteRunWithReturn commands list. E.g "ListDirectories".
Record (collection editor type) (type: string): the parameters for the ExecuteRunWithReturn ListDirectories command specified in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide. Follow the steps below to add the required parameters in the Record field:
- navigate to the ExecuteRunWithReturn ListDirectories parameters list in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide and extract the required parameters for this command (all records can be added as input, not just the required ones):
- open the Record collection editor and add the required records for this command.

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

Output result (type: string): outputs the activity execution result.
Output Status (type: string): outputs the activity execution status.

Execution:

Execute Set

Citrix PVS - SOAP Execute Set.

Activity Parameters

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

Parameters:

Command (combo box control) (type: string): select the command from the ExecuteSet commands list. E.g "farmView".
Fields (text box editor type) (type: string): the fields for ExecuteSet command.
Record (collection editor type) (type: string): the parameters for the ExecuteSet FarmView command specified in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide. Follow the steps below to add the required parameters in the Record field:
- navigate to the ExecuteSet FarmView parameters list in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide and extract the required parameters for this command (all records can be added as input, not just the required ones):
- open the Record collection editor and add the required records for this command.

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

Output Status (type: string): outputs the activity execution result.

Execution:

Command (combo box control) (type: string) : select the command from the ExecuteRunWithReturn commands list. E.g "ListDirectories".
Record (collection editor type) (type: string): the parameters for the ExecuteRunWithReturn ListDirectories command specified in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide. Follow the steps below to add the required parameters in the Record field:
- navigate to the ExecuteRunWithReturn ListDirectories parameters list in the SOAPServer Administrator's Guide - Provisioning Services 7.1 guide and extract the required parameters for this command (all records can be added as input, not just the required ones):
- open the Record collection editor and add the required records for this command.

Browser not supported