changes.
| |  | !coming-soon.gif! |
| | {panel:borderStyle=solid} |
| | | h3. Introduction to the Citrix Desktop Delivery Controller SDK |
| | |
 | | We are currently working on a public, fully scriptable, PowerShell-based SDK that can be used to automate and control the Desktop Delivery Controller in XenDesktop. We are planning to provide APIs that can return information about the farm's current configuration and set-up, show you real-time user activity and connection information, and also lets you add and remove virtual desktops and desktop groups from a farm - with these capabilities, you can fully automate a farm's operation through scripting or integration with custom applications or consoles. |
| | | The Citrix Desktop Delivery Controller PowerShell SDK provides a snap-in, XDCommands, for the Microsoft PowerShell v1.0 framework. The SDK consists of a number of "cmdlets" that allow you to script many of the administrative tasks you may need to perform on a regular basis. |
| | |
| | Please note that we are expecting to evolve our SDK strategy in the longer term, and any APIs released in the short term may undergo significant changes. |
| | {panel} |
| | | h3. Using the Citrix Desktop Delivery Controller SDK |
| | |
| | Installing the SDK registers the XdCommands snap-in assembly with the Microsoft PowerShell framework. The snap-in makes a number of new classes and "cmdlets" available to PowerShell scripts or interactive shell sessions. |
| | |
| | *Important*: To run scripts you may need to use the built-in "Set-ExecutionPolicy" cmdlet to adjust the PowerShell execution policy to a value such as "RemoteSigned". On a 64 bit platform, you must set the execution policy for the 32 bit PowerShell environment rather than the execution policy for the 64 bit PowerShell environment, so use the "Windows PowerShell(32)" shell instance to set the policy. |
| | |
| | h4. Loading the XdCommands Snap-in |
| | |
| | To use the snap-in in a script or interactive PowerShell shell session, load the snap-in into the PowerShell host process. To do this, run the built-in "Add-PSSnapin" cmdlet, as follows: |
| | |
| | Add-PSSnapin 'XdCommands' |
| | |
| | Alternatively, use the installed PowerShell console file, XdCommands.psc1, to start an interactive PowerShell shell session with the XdCommands snap-in pre-loaded. Citrix provides a shortcut on the Start menu to start such a session. This shortcut also runs the "XdAliases.ps1" PowerShell script that sets up aliases for most of the SDK cmdlets. This shortcut will not function properly until the PowerShell execution policy, as described above, is set appropriately. |
| | |
| | h3. [!btn_search.png! Download SDK|^XenDesktop_2_0_DDC_Powershell_SDK.msi] |
| | \\ |
| | |
| | h3. Getting Help |
| | |
| | Online help is available for all Desktop Delivery Controller SDK cmdlets. To obtain a list of cmdlets offered by the snap-in, run the built-in "Get-Command" cmdlet, as follows: |
| | |
| | Get-Command \-psSnapin XdCommands |
| | |
| | Online help for individual cmdlets is available using the built-in "Get-Help" cmdlet. For example, to view the online help for the "Get-XdDesktopGroup" cmdlet, run the following command: |
| | |
| | Get-Help Get-XdDesktopGroup |
| | |
| | For an overview of all cmdlets provided by the SDK, view the "about_XdCommands" help topic. To view this information, run the the following command: |
| | |
| | Get-Help about_XdCommands |
