Activities
Add Machine to Existing Catalog
This activity adds an existing machine from a given Hypervisor connection to a specified catalog.
Activity Parameters
The Add Machine to Existing Catalog activity parameters can be provided by manual inserted values or via IN arguments or variables:
All of the input parameters are mandatory.
Parameters:
- Catalog Name (text box editor type) (type: string): the name of the catalog you wish to add the machine to.
- Hypervisor Connection Path (text box editor type) (type: string): the Hypervisor connection path from where you wish to add the machine. Should be in the form 'xdhyp:\HostingUnits\'.
- Machine Account Name (text box editor type) (type: string): the name of the ad account you wish to associate the newly added machine with.
- Machine UID (text box editor type) (type: string): the uid by which the specified Hypervisor identifies the machine. For example: a xenserver vm's UID.
- User name (text box editor type) (type: string): the user you wish to associate with the newly added machine.
Execution:
Add Machine to Pooled Catalog
This activity adds a random machine to a pooled catalog out of a specified identity pool.
Activity Parameters
The Add Machine to Pooled Catalog activity parameters can be provided by manual inserted values or via IN arguments or variables:
All of the input parameters are mandatory.
Parameters:
- Catalog Name (text box editor type) (type: string): the name of the catalog you wish to add the machine to.
- Hypervisor Name (text box editor type) (type: string): the Hypervisor name.
- Identity Pool (text box editor type) (type: string): the name of the identity pool.
The Read Only Output variable are the possible output values that the activity will provide:
- Success Code (type: string): outputs a success code.
Add Machines to Desktop Group
This activity adds unassigned (either to a user or group) machines from a specified catalog to a specified desktop group, up to a given number.
Activity Parameters
The Add Machine to Desktop Group activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Catalog Name (text box editor type) (type: string): the name of the catalog you wish to add the machine(s) to.
- Desktop Group Name (text box editor type) (type: string): the desktop group name.
- Number of Machines (text box editor type) (type: string): this activity will add as many machines as possible from the catalog to the desktop group, up to the specified number.
Execution:
Add Unassigned Machine to Desktop Group
This activity adds a machine to the specified desktop group.
Activity Parameters
The Add Unassigned Machine to Desktop Group activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Desktop Group Name (text box editor type) (type: string): the desktop group name
- Machine Name (text box editor type) (type: string): the name of the machine you wish to add to the desktop group.
Execution:
Add Users or Groups to Desktop Group
This activity adds users or groups to all Broker Entitlement Policy Rules attached to a specified desktop group.
Activity Parameters
The Add Users or Groups to Desktop Group activity parameters can be provided by manual inserted values or via IN arguments or variables:
All of the input parameters are mandatory.
Parameters:
- Desktop Group Name (text box editor type) (type: string): the name of the group you wish to add the users or groups to.
- Group or User Name (text box editor type) (type: string): the group or user name that you wish to add to the specified desktop group encased in ''. If you wish to add more than one user, encase each entity in '' and separate them by ,. Ex: "user1,user2".
Execution:
Add Machines To Streamed Desktop Catalog
This activity adds machines to a streamed desktop catalog.
Activity Parameters
The Add Machines to Streamed Desktop Catalog activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Catalog Name (text box editor type) (type: string): the name of the catalog you wish to add the machines to.
- Hypervisor Name (text box editor type) (type: string): the Hypervisor connection name.
- PVS Name (text box editor type) (type: string): the name of the PVS.
- PVS Site (text box editor type) (type: string): the site of the PVS.
- PVS Collection (text box editor type) (type: string): the PVS collection name.
- PVS Domain (text box editor type) (type: string): the PVS domain.
- PVS Port (text box editor type) (type: string): the PVS port.
The Read Only Output variable are the possible output values that the activity will provide:
- PowerShell Script: outputs a PowerShell script.
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 Desktop Group
This activity creates a new Desktop Group.
Activity Parameters
The Create Desktop Group activity parameters can be provided by manual inserted values or via IN arguments or variables:
All of the input parameters are mandatory.
Parameters:
- Catalog Name (text box editor type) (type: string): the name of the catalog you wish to add the machines to.
- Desktop Kind (text box editor type) (type: string): valid values are Private, Shared, PrivateApp, and SharedApp.
- Desktop Group Name (text box editor type) (type: string): the name of the desktop group.
- Group or User Name (text box editor type) (type: string): If Desktop Kind is 'Shared' please enter a group or user name that you wish to add to the specified desktopgroup encased in ''. If you wish to add more than one user, encase each entity in '' and separate them by ,. Ex: "user1,user2".
- Number of Machines (text box editor type) (type: string): the maximum number of machines that will be added from the catalog to the desktop group.
- Published Name (text box editor type) (type: string): display name of the created desktop group.
Execution:
Get Desktop Group
This activity retrieves a collection of desktop groups (names and PSObjects).
Activity Parameters
The Get Desktop Group activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Desktop Group Name (text box editor type) (type: string): the name of the group you wish to retrieve. May contain wildcards under PowerShell rules in which case the activity might retrieve more than one group.
The Read Only Output variable are the possible output values that the activity will provide:
- Desktop Group (type: collection<psobject>): outputs a collection of PSObjects that represents the group(s) retrieved. This can be used as an input for other activities that expect a collection of Citrix.Broker.Admin.SDK.DesktopGroup.
- Desktop Group Names (type: collection>string>): outputs a Collection that represents the name(s) of the group(s) retrieved.
- Number of Desktops (type: int32): outputs the number of the group(s) retrieved.
In order to extract the values from the DesktopGroupNames output collection, For Each and Log Track Data activities should be used:
Execution:
Remove Users or Groups from Desktop Group
This activity remove users or groups from all Broker Entitlement Policy Rules attached to a specified desktop group.
Activity Parameters
The Remove Users or Groups from Desktop Group activity parameters can be provided by manual inserted values or via IN arguments or variables:
All of the input parameters are mandatory.
Parameters:
- Desktop Group Name (text box editor type) (type: string): the name of the group you wish to remove the users or groups to.
- Group or User Name (text box editor type) (type: string): the group or user name that you wish to remove from the specified desktopgroup encased in ''. If you wish to remove more than one user, encase each entity in '' and separate them by ,. Ex: "user1,user2".
Execution:
