Versions Compared

Version Old Version 6 New Version 7
Changes made by

wiki

wiki

Saved on

Key

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

...

 

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 disables the maintenance mode for a desktop deletes the specified delivery group.

Activity Parameters

The Disable Maintenance Mode The Delete Delivery Group 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

  • Delivery Group Name (text box editor type) (type: string): the name of the desktop delivery group for which to disable the maintenance modeyou want to delete. E.g. 'AppDeliveryGroup' .

 

...

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:

Image Removed
 

 

Get  AppDisk


...

Delete Machine Catalog

This activity deletes the specified machine catalog.

Activity Parameters

...

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

...

 Image Added

Input Parameters:

 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:

  • Output

...

  • Result  (type:

...

  • boolean):

...

  • outputs whether the operation succeeded or not.

Disable Maintenance Mode

This activity disables the maintenance mode for a desktop group.

Activity Parameters

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

Image Added

Parameters:

  • DesktopGroupName (text box editor type) (type: string):

...

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

Image Removed

Enable Maintenance Mode

This activity disables the maintenance mode for a desktop group.

Activity Parameters

...

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

Image Added
 


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 Removed

All of the input parameters are mandatory.

 Image Added

Input Parameters:

DesktopGroupName 

 Parameters

  • Delivery Group Name (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:

Image Removed

 

 

 

 

 

Get Registration State

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

Activity Parameters

The Get Registration State activity
  • 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 Removed

All of the input parameters are mandatory.

 Image Added

Input Parameters:

 Parameters

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

Image Removed

 

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:

 Image RemovedImage RemovedImage Removed

Get Machines

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

Activity Parameters

The Get Machines activity
  • 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:

  • CatalogName Connection (text box editor type) (type: stringobject): the name of the catalog that contains the machines to be retrievedthe output from Connect To XenDesktop activity should be used as Input here. 
  • 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. 

  • specify the AppDisk name. E.g 'AdobeApp'.  
     

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

Output 
  • Output AppDisk (type:
collection<psobject>
  • collection<KeyValuePair<string,string>>):
outputs a
  • 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.
    •  
    • 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

    OutputMachines output

    'Output AppDisk' output parameter, 

    For Each and GetKeyValuePair activities are

    GetKeyValuePair activity is used to extract the key

    value for  MachineName key:

     Image RemovedImage Removed

     

    Execution:

    Image Removed

    Get Sessions

    'AppDiskName' value, for example:

    Image Added

    Enable Maintenance Mode

    This activity

    retrieves the user sessions

    disables the maintenance mode for a desktop group.

    Activity Parameters

    The 

    Get Sessions 

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

    Image Removed

    Image Added

    All of the input parameters are mandatory.

    Parameters:

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

     

    • 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 
    • Output Result  (type:
    collection<psobject>
    • boolean):
    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:

     Image RemovedImage Removed

     

    Get Snapshot Path

    This activity returns the Master Image VM for the specified MCS Machine Catalog
    • outputs whether the operation succeeded or not.

     

    Execution:

    Image Added

     

     



     

     

     

    Get Registration State

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

    Activity Parameters

    The Get

    Snapshot Path activity

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

    Image Removed

    Image 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 Master Image VM
    • Output Machines (type:
    string
    • collection<Dictionary<string,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. 
    • 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 activity will return the snapshot path for the master image of the MCS_ByWF catalog:

    Image Removed 

     

    List AppDisks

    This activity lists all the AppDisks found.  

    Activity Parameters

    The List AppDisks activity

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

    Image Added

     

    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:

     Image AddedImage AddedImage Added



    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 Removed

    Image Added

    Parameters:

    Connection 
    • CatalogName (text box editor type) (type:
    object
    • string):
    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:

     Image RemovedImage Removed

    Execution: 

    Image Removed

    Remove AppDisk

    This activity removes the specified AppDisk.   

    Activity Parameters

    The Remove AppDisk activity
    • 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:

     Image AddedImage Added

     

    Execution:

    Image Added

    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 Removed

    Image Added

    All of the input parameters are mandatory.

    Parameters:

    AppDisk Uid 
    • UserName (text box editor type) (type:
    object
    • string):
    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 username for the session. For example, 'MyDomain\MyUsername'. 
     

     

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

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

    Execution: 

    Image Removed

    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 Removed

    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

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

     Image AddedImage Added

     

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

    Image Added 

     

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

     Image AddedImage Added


    Execution: 

    Image Added


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

    Image Added



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

     


    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 Added

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

     

    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.

    ...