Versions Compared

Version Old Version 7 New Version Current
Changes made by

wiki

wiki

Saved on

Key

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

Activities

Image Added


Close User Session

This activity disconnects or stops the session(s) for a user. 

...

The Close User Session activity parameters can be provided by manual inserted values or via IN arguments or variables:


Image RemovedImage Added


Parameters:

  • DNS Name (text box editor type) (type: string): the DNS name of the desktop for the session. If this parameter is set, the 'Username' will be ignored. E.g. 'MyMachine.MyDomain.com'.
  • Operation (combo box control) (type: string):  specify whether to disconnect or to stop the user session.
  • Username (text box editor type) (type: string): the username for the session.The accepted format is domain\username. E.g "FMRP\demouser".
 

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

  • Output Result (type: boolean): outputs a success code.


 

 


Create AppDisk

This activity creates a new AppDisk in Citrix Studio.  

...

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


Image RemovedImage Added


Parameters:

  • Catalog Name (text box editor type) (type: string): specify the name of the catalog the AppDisk machine is a member of.  E.g. 'AppDiskCitrixStudioCatalog'.
  • Description (text box editor type) (type: string):  specify the new AppDisk's description. E.g. 'Created by workflow'. 
  • Disk Size MB (text box editor type) (type: string): specify the new AppDisk's size in megabytes. E.g. '3072' for 3 GB.
  • Host Name (text box editor type) (type: string): specify the name of the hosting unit used for AppDisk. E.g. 'AppDisk' . 
  • Name (text box editor type) (type: string): specify the new AppDisk's name. This must be a unique name that is not being used by an existing AppDisk.  E.g 'AdobeApp'.
  • Run Asynchronously (combo box editor type) (type: string): set to 'True' if you don't want to wait for the operation to finish. 

...

  • Output Status (type: boolean): outputs whether the operation succeeded or not.

...

 


Create MCS Machine Catalog

...

The Create MCS Machine Catalog activity parameters can be provided by manual inserted values or via IN arguments or variables:


 Image RemovedImage Added

 



Input Parameters:

IdentityPool

  • AllowUnicode (combo box editor type) (type: string): allows the naming scheme to have characters other than alphanumeric characters.
  • Domain (text box editor type) (type: string): enter a value for the AD domain name for the pool. E.g. 'FMRP.intern'.
  • Naming Scheme (text box editor type) (type: string): specify the template name for AD accounts created in the pool. E.g. 'VM###' creates accounts called VM001, VM002.
  • Naming Scheme Type (text box editor type) (type: string): specify the type of the naming scheme.
  • OU (text box editor type) (type: string): specify the OU that computer accounts will be created into. E.g. 'OU=VMs,DC=FMRP,DC=intern'.

Image RemovedImage Added


 Parameters

  • Catalog Name (text box editor type) (type: string): the name of the catalog.
  • Description (text box editor type) (type: string): the name of the catalog.
  • Desktop Experience (combo box editor type) (type: string): specifies the desktop experience that the user will have. This option is available only for Desktop OS deployed machines. E.g. "Random" signifies that the users will connect to a new random desktop each time they log on. 
  •  Operating System (combo box editor type) (type: string): specifies the operating system for the Machine Catalog.

...

  • CleanOnBoot (combo box editor type) (type: string): specifies whether the virtual machines created from this provisioning scheme will be reset to their initial condition each time they are started.
  • Hosting Unit Name (text box editor type) (type: string): the name of the hosting unit. E.g. 'KVIBF_Testing' (VMware machines added with 'MCS' provisioning type).
  • Personal VDisk Drive Letter (text box editor type) (type: string): the letter for the vDisk drive.
  • Personal vDisk DriveSize (text box editor type) (type: string): the size of the personal vDisk.
  • UsePersonal vDisk Storage (combo box editor type) (type: string): specify whether personal vDisks are used for the VMs in this provisioning scheme.
  • VMCpuCount (text box editor type) (type: string): the number of processors used by virtual machines created from the provisioning scheme.
  • VMMemoryMB (text box editor type) (type: string): the maximum amount of memory used by virtual machines created from the provisioning scheme.

Image RemovedImage Added


Snapshot

  • Literal Path (text box editor type) (type: string): the path within a hosting unit provider to the VM for which to create a new snapshot. E.g. "XDHyp:\HostingUnits\KIVBF_Testing\KIVBF_Testing_Master.vm".
  • Snapshot Description (text box editor type) (type: string): the description to add to the snapshot.
  • Snapshot Name (text box editor type) (type: string): specifies the name to give to the snapshot.


 Image RemovedImage Added


 

 

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

  • Output Result  (type: boolean): outputs whether the operation succeeded or not.
 

 


Create Other Machine Catalog

...

The Create Other Machine Catalog activity parameters can be provided by manual inserted values or via IN arguments or variables:


 Image RemovedImage Added


Input Parameters:

...

The Create Physical Machine Catalog activity parameters can be provided by manual inserted values or via IN arguments or variables:


 Image RemovedImage Added


Input Parameters:

...

 

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

  • Output Result  (type: boolean): outputs whether the operation succeeded or not.

 

 



Create PVS Machine Catalog

...

The Create Physical Machine Catalog activity parameters can be provided by manual inserted values or via IN arguments or variables:


 Image RemovedImage Added


Input Parameters:

...

 

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

  • Output Result  (type: boolean): outputs whether the operation succeeded or not.

 

...



Delete Delivery Group

This activity deletes the specified delivery group.

...

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


 Image RemovedImage Added


Input Parameters:

...

  • Delivery Group Name (text box editor type) (type: string): the name of the delivery group you want to delete. E.g. 'AppDeliveryGroup' .

 


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

...

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


 Image RemovedImage Added


Input Parameters:

...

  • Catalog Name (text box editor type) (type: string): the name of the machine catalog.  E.g. 'OfficeAppCatalog' .

...


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

...

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


Image RemovedImage Added


Parameters:

  • DesktopGroupName (text box editor type) (type: string): the name of the desktop group for which to disable the maintenance mode.
     
 

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

  • Output Result  (type: boolean): outputs whether the operation succeeded or not.


  Execution:


 


Edit Delivery Group

This activity edits the name and description for the specified Delivery Group.

Activity Parameters

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


 Image RemovedImage Added


Input Parameters:

 Parameters

  • Delivery Group Name (text box editor type) (type: string): the name of the Delivery Group.  E.g. 'AppDeliveryGroup'.
  • New Delivery Group Description (text box editor type) (type: string): the new description for the Delivery Group.  E.g. 'New Description' .
  • New Delivery Group Name (text box editor type) (type: string): the new name for the Delivery Group.  E.g. 'OfficeAppDeliveryGroup' .
 


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

  • Output Result  (type: boolean): outputs whether the operation succeeded or not.
 


Edit Machine Catalog

This activity edits the name and description for the specified Machine Catalog.

Activity Parameters

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


 Image RemovedImage Added


Input Parameters:

 Parameters

  • Catalog Name (text box editor type) (type: string): the name of the Machine Catalog.  E.g. 'AppCatalog'.
  • New Catalog Description (text box editor type) (type: string): the new description for the Machine Catalog.  E.g. 'Catalog for office applications' .
  • New Catalog Name (text box editor type) (type: string): the new name for the Machine Catalog.  E.g. 'OfficeAppCatalog' .

 


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

  • Output Result  (type: boolean): outputs whether the operation succeeded or not.

Get  AppDisk

This activity gets the specified AppDisks found.  

Activity Parameters

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


Image RemovedImage Added


Parameters:

  • Connection (text box editor type) (type: object): the output from Connect To XenDesktop activity should be used as Input here. 
  • Name (text box editor type) (type: string): specify the AppDisk name. E.g 'AdobeApp'.  
     

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

  • Output AppDisk (type: collection<KeyValuePair<string,string>>): outputs a collection of type KeyValuePair containing the AppDisk properties. To use the elements of the collection, se the 'Get KeyValuePair' activity with the keys: 'AppDiskUid' , 'AppDiskName' etc. 
  • Output AppDisk Uid (type: string): outputs the AppDisk Uid.

In order to extract the values from the 'Output AppDisk' output parameter, GetKeyValuePair activity is used to extract the key 'AppDiskName' value, for example:

Enable Maintenance Mode

This activity disables the maintenance mode for a desktop group.

Activity Parameters

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


Image RemovedImage Added


All of the input parameters are mandatory.

Parameters:

  • DesktopGroupName (text box editor type) (type: string): the name of the desktop group for which to enable the maintenance mode.  
 

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

  • Output Result  (type: boolean): outputs whether the operation succeeded or not.

 


Execution:

 

 







 

 

 

Get Registration State

This  Get Registration State

This activity returns the registration state of the specified machine catalog.

Activity Parameters

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


Image RemovedImage Added


All of the input parameters are mandatory.

Parameters:

  • Catalog Name (text box editor type) (type: string): the name of the catalog from which you want to return information about the machines and their registration state.
 

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

  • Output Machines (type: collection<Dictionary<string,string>>): outputs a collection of dictionaries containing the machine names and their registration states.In order to use the output you can use the GetKeyValuePair activity with the keys:  MachineName, CatalogName and RegistrationState in an iteration activity.

 


Execution: The example below is an execution where the machines from catalog MCS_ByWF catalog are returned and key values MachineName and RegistrationState are extracted.

 


In order to extract the values from the output parameter, For Each and GetKeyValuePair activities are used to extract the key values for  MachineName and RegistrationState keys:

 



Get Machines

This activity retrieves servers from the specified worker group or delivery group.

Activity Parameters

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


Image RemovedImage Added


Parameters:

  • CatalogName (text box editor type) (type: string): the name of the catalog that contains the machines to be retrieved. 
  • DesktopGroup Name (text box editor type) (type: string): the name of the desktop group that contains the machine(s) you wish to retrieve.

NOTE. CatalogName and DesktopGroupName parameters are used to filter the results returned by this activity. 

 

 

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

  • Output (type: collection<psobject>): outputs a collection of PSObjects that represents the machines(s) retrieved. This can be used as an input for other activities that expect a collection of BrokerMachine objects.
  • Output Count (type: int32): outputs the number of the machines retrieved.
  • Output Machines Collection (type: collection<collection<KeyValuePair<String,String>>>): outputs a collection of collections containing the BrokerMachine Type items with their properties. To use the elements of the collection, use the 'Get KeyValuePair' activity.

 


In order to extract the values from the OutputMachines output parameter, For Each and GetKeyValuePair activities are used to extract the key value for  MachineName key:

  


Execution:

Get Sessions

This activity retrieves the user sessions.

Activity Parameters

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


Image RemovedImage Added


All of the input parameters are mandatory.

Parameters:

  • UserName (text box editor type) (type: string): the username for the session. For example, 'MyDomain\MyUsername'. 
 

 


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

  • Output (type: collection<psobject>): outputs a collection of PSObjects that represents the session(s) retrieved. This can be used as an input for other activities that expect a collection of BrokerSession objects.
  • Output Count (type: int32): outputs the number of the sessions retrieved.
  • Output Sessions Collection (type: collection<collection<KeyValuePair<String,String>>>): outputs a collection of collections containing the BrokerSession Type items with their properties. To use the elements of the collection, use the 'Get KeyValuePair' activity.

 


In order to extract the values from the OutputSessions output parameter, For Each and GetKeyValuePair activities are used to extract the first key value:

 

 


Get Snapshot Path

This activity returns the Master Image VM for the specified MCS Machine Catalog.

Activity Parameters

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


Image RemovedImage Added


All of the input parameters are mandatory.

Parameters:

  • Catalog Name (text box editor type) (type: string): the name of the catalog.  
 


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

  • Output Master Image VM(type: string): outputs a string containing the path of the master image vm for the desired catalog. The result of this activity may be used as input for all Snapshot Path type parameters under Citrix XenDesktop category. 

 


Execution: the activity will return the snapshot path for the master image of the MCS_ByWF catalog:

 

 


List AppDisks

This activity lists all the AppDisks found.  

Activity Parameters

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


Image RemovedImage Added


Parameters:

  • Connection (text box editor type) (type: object): the output from Connect To XenDesktop activity should be used as Input here. 
     

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

  • Output (type: collection<PSObject>): outputs a collection of type Collection<System.Management.Automation.PSObject> that represents the AppDisk(s) retrieved. This can be used as input for the other activities that expect a collection of AppDisk objects. 
  • Output AppDisks Collection (type: collection<collection<KeyValuePair<string,string>>>): outputs a collection of collections containing the AppDisk type items with their properties. To use the elements of the collection, use the 'Get KeyValuePair' activity with the keys: 'AppDiskUid' , 'AppDiskName' , 'Description' , 'HostingUnitName' , etc. 
  • Output Count (type: Int32): outputs the number of AppDisks retrieved. 

In order to extract the values from the 'Output AppDisks Collection' output parameter, For Each and GetKeyValuePair activities are used to extract the key 'AppDiskName' value:

 


Execution: 


Remove AppDisk

This activity removes the specified AppDisk.   

Activity Parameters

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


Image RemovedImage Added


Parameters:

  • AppDisk Uid (text box editor type) (type: object): specify the AppDisk Uid or use the output 'AppDisk Uid' from the 'Get AppDisk' activity. E.g. '2c852601-477e-4bdb-bb9f-0c5d40a6147f'. 

  • Connection (text box editor type) (type: object): the output from Connect To XenDesktop activity should be used as Input here. 
     

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

  • Output Status (type: boolean): outputs whether the operation succeeded or not. 

Execution: 


Rollback Machine Update

MCS Machine Catalog

This activity updates the master VM Image of a MCS activity performs a rollback update for the specified Machine Catalog.

Activity Parameters

The Update MCS Machine Catalog The Rollback Machine Update activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image Removed


All of the input parameters are mandatory.Image Added


Input Parameters

Parameters:

  • Catalog Name (text box editor type) (type: string): the name of the catalog

    . 

    Snapshot Path (text box editor type) (type: string): the snapshot path of the master image vm. The accepted format should be written as in the given example:

    XDHyp:\HostingUnits\

    . E.g. 'AppCatalog'.


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

  • Output Result (type: boolean): outputs whether the operation succeeded or not.


Update MCS Machine Catalog

This activity updates the master VM Image of a MCS Machine Catalog.

Activity Parameters

The Update MCS Machine Catalog activity parameters can be provided by manual inserted values or via IN arguments or variables:


Image Added


All of the input parameters are mandatory.

Parameters:

  • Catalog Name (text box editor type) (type: string): the name of the catalog. 

  • Snapshot Path (text box editor type) (type: string): the snapshot path of the master image vm. The accepted format should be written as in the given example:

    XDHyp:\HostingUnits\KIVBF_Testing\KIVBF_Master_Testing.vm\KIVBF_Snapshot_Testing.snapshot\WF_KIVBF_Testing.snapshot\WF_KIVBF_Testing.snapshot\Citrix_XD_JustTestingMCSCat.snapshot\Snapshot_WF.snapshot


 The value also can be obtained from the Get Snapshot Path activity:
  • use a Get Snapshot Path activity to extract the Snapshot Path value:
    Image Removed 
  • bind the obtained snapshot path (stored in variable) to the Snapshot Path field from the Update MCS Machine Catalog activity:

          Image Removed

 

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

  • Output Result (type: boolean): outputs whether the operation succeeded or not.

 

Delete Delivery Group

This activity deletes the specified delivery group.

Activity Parameters

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

 Image Removed

Input Parameters:

 Parameters

  • Delivery Group Name (text box editor type) (type: string): the name of the delivery group you want to delete. E.g. 'AppDeliveryGroup' .

...

  • to extract the Snapshot Path value:
    Image Added 
  • bind the obtained snapshot path (stored in variable) to the Snapshot Path field from the Update MCS Machine Catalog activity:

          Image Added


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

...

  • Output Result (type: boolean): outputs whether the operation succeeded or not.