PowerShell SDK for XenApp

Manage your XenApp farms with ease

The Citrix XenApp 6 and 6.5 PowerShell SDKs enable customers to manage XenApp 6 and 6.5 farms using Microsoft PowerShell scripting.

Remoting

All the commands now support a -ComputerName parameter which indicates to the cmdlet to execute remotely. This means that the snap-in can be installed anywhere and no additional configurations are needed in the client or server.

To accomplish this feature, a new WCF service (Citrix XenApp Commands Remoting) was introduced in XenApp, which essentially implements all the business logic of the cmdlets. This logic is contained in a separate assembly. In the case of server execution (when the commands are run on the server), it is loaded in the same process where PowerShell is running.

Default Computer Name

In order to facilitate running existing scripts remotely without having to make significant changes, a default computer name can be set in the client machine. To do this, a new set of cmdlets was introduced. When the default computer name is set, all the cmdlets will automatically remote to the server specified without having to explicitly use the -ComputerName parameter every time.

Object IDs

Since many cmdlets might be executing remotely, the calls to the back-end are minimized so that the remote execution performance will not degrade significantly when compared to local execution. One way to increase performance is using object IDs. Having the ID of the object minimizes the conversion calls that take place when operations are performed, for example, when deleting a batch of applications or folders. In order to minimize the changes to the existing public interface, the object names were overloaded with object id values. This means that anywhere where the cmdlets ask for a name, such as a server or an application name, the object ids can be passed instead. This feature is not necessarily intended to be used by the interactive user in the PowerShell console, but rather by developers that wish to write code with the SDK.

Citrix XenApp Commands

The XenApp cmdlets provide a consistent command line and scripting experience for XenApp farm administrators to perform all aspects of XenApp farm management. The tasks that can be performed using these cmdlets range from the farm and server initialization after installation of XenApp farm servers to daily maintenance and monitoring of the farm objects. The cmdlets form a complete set of management functionality that all farm management tasks can be performed by using the cmdlets only. The XenApp Commands is a superset of the functionality provided through the traditional graphical user interface, the Citrix Delivery Services Console.

Citrix Group Policy Provider

The Citrix Policy provider lets you examine, edit, clear, and copy policies and policy settings that are stored in any GPO. When the provider is loaded, it creates the LocalGpo and LocalFarmGpo drives to refer to the local Windows policy and any Citrix policy that is applied to the XenApp farm where the server is a member.

Citrix Common Commands

The Citrix Common Commands provide functionality common to all Citrix products. The Common Commands are exposed through the snap-in: Citrix.Common.Commands.

Note: Citrix account credentials are required to access certain SDK content.  If you do not have a Citrix account, please complete the Developer Registration process.

Watch related videos on the Citrix Developer YouTube channel.  

Share your ideas with us

SDK Documentation Feedback

We are working to improve our SDK deliverables to make them easier to use. Click the link below to take a quick survey and share your feedback with our team.

Open the survey  

Create your Citrix Developer account today
An account gives you access to all of the benefits of the Citrix Developer community.

You built a great solution integrating with Citrix APIs, now continue the next step of your journey with Citrix Ready.