Citrix

Product Documentation



Download full document

Citrix.Broker.Admin.V2

Apr. 15, 2014

Overview

Name Description
Broker AccessPolicy Controls client-connection-based access to desktop groups.
Broker Applications Describes how to publish and manage hosted applications.
Broker AssignmentPolicy Controls the automatic, permanent assignment of machines to users.
Broker Concepts Overview of the Citrix Broker.
Broker ConfigurationSlots Overview of assigning a collection of related settings to a desktop group.
Broker ControllerDiscovery Describes the way that machines providing published resources discover
Broker Desktops Describes desktop concepts and usage.
Broker EntitlementPolicy Controls end-user entitlement to desktop and application sessions provided
Broker ErrorHandling Describes broker errors generated by cmdlets and how to access them.
Broker Filtering Describes the common filtering options for XenDesktop cmdlets.
Broker Licensing Overview of broker licensing configuration.
Broker Machines Describes machine concepts and usage.
Broker Policies Overview of the site policies that control users' access to desktop and
Broker PostInstallPreConfiguration Describes how to configure the Citrix Broker Service port numbers, URL
Broker PowerManagement Describes power management of machines used for desktops and applications.
Broker RemotePC Overview of the Remote PC feature.

Cmdlets

Name Description
Add-BrokerApplication Adds applications to a desktop group.
Add-BrokerDesktopGroup Associate Remote PC desktop groups with the specified Remote PC catalog.
Add-BrokerMachine Adds one or more machines to a desktop group.
Add-BrokerMachineConfiguration Adds a machine configuration to a desktop group.
Add-BrokerMachinesToDesktopGroup Adds machines from a catalog to a desktop group.
Add-BrokerScope Add the specified catalog/desktop group to the given scope(s).
Add-BrokerTag Associate a tag with another object.
Add-BrokerUser Creates an association between a user and another broker object
Disconnect-BrokerSession Disconnect a session.
Export-BrokerDesktopPolicy Gets the site wide Citrix Group Policy settings.
Get-BrokerAccessPolicyRule Gets rules from the site's access policy.
Get-BrokerAppAssignmentPolicyRule Gets application rules from the site's assignment policy.
Get-BrokerAppEntitlementPolicyRule Gets application rules from the site's entitlement policy.
Get-BrokerApplication Get the applications published on this site.
Get-BrokerApplicationInstance Gets the running applications on the desktops.
Get-BrokerAssignmentPolicyRule Gets desktop rules from the site's assignment policy.
Get-BrokerCatalog Gets catalogs configured for this site.
Get-BrokerConfigurationSlot Gets configuration slots configured for this site.
Get-BrokerConfiguredFTA Gets any file type associations configured for an application.
Get-BrokerConnectionLog Get entries from the site's session connection log.
Get-BrokerController Gets Controllers running broker services in the site.
Get-BrokerDBConnection Gets the Citrix Broker Service's database connection string.
Get-BrokerDBSchema Gets SQL scripts to create or maintain the database schema for the Citrix Broker Service.
Get-BrokerDBVersionChangeScript Gets an SQL service schema update script for the Citrix Broker Service.
Get-BrokerDelayedHostingPowerAction Gets power actions that are executed after a delay.
Get-BrokerDesktop Gets desktops configured for this site.
Get-BrokerDesktopGroup Gets broker desktop groups configured for this site.
Get-BrokerDesktopUsage Get usage history of desktop groups.
Get-BrokerEntitlementPolicyRule Gets desktop rules from the site's entitlement policy.
Get-BrokerHostingPowerAction Gets power actions queued for machines.
Get-BrokerHypervisorAlert Gets hypervisor alerts recorded by the controller.
Get-BrokerHypervisorConnection Gets hypervisor connections matching the specified criteria.
Get-BrokerIcon Get stored icons.
Get-BrokerImportedFTA Gets the imported file type associations.
Get-BrokerInstalledDbVersion Gets Citrix Broker Service database schema version information.
Get-BrokerMachine Gets machines belonging to this site.
Get-BrokerMachineCommand Get the list of commands queued for delivery to a desktop.
Get-BrokerMachineConfiguration Gets machine configurations defined for this site.
Get-BrokerMachineStartMenuShortcutIcon Retrieves a Start Menu Shortcut icon from the specified machine.
Get-BrokerMachineStartMenuShortcuts Retrieves the Start Menu Shortcuts from the specified machine.
Get-BrokerPowerTimeScheme Gets power management time schemes for desktop groups.
Get-BrokerPrivateDesktop Get private desktops configured for this site.
Get-BrokerRebootCycle Gets one or more reboot cycles.
Get-BrokerRebootSchedule Gets one or more reboot schedules.
Get-BrokerRemotePCAccount Get RemotePCAccount entries configured for this site.
Get-BrokerResource Gets resources that a user can broker connections to.
Get-BrokerScopedObject Gets the details of the scoped objects for the Broker Service.
Get-BrokerServiceAddedCapability Gets any added capabilities for the Broker Service on the controller.
Get-BrokerServiceInstance Gets the service instance entries for the Broker Service.
Get-BrokerServiceStatus Determines the current state of the Broker Service on the controller.
Get-BrokerSession Gets a list of sessions.
Get-BrokerSharedDesktop Get shared desktops configured for this site.
Get-BrokerSite Gets the current XenDesktop broker site.
Get-BrokerTag Gets one or more tags.
Get-BrokerUnconfiguredMachine Gets machines that have registered but are not yet configured in this site.
Get-BrokerUser Gets broker users configured for this site.
Group-BrokerDesktop Groups and counts desktops with the same value for a specified property.
Group-BrokerMachine Groups and counts machines with the same value for a specified property.
Import-BrokerDesktopPolicy Sets the site wide Citrix Group Policy settings for the site.
New-BrokerAccessPolicyRule Creates a new rule in the site's access policy.
New-BrokerAppAssignmentPolicyRule Creates a new application rule in the site's assignment policy.
New-BrokerAppEntitlementPolicyRule Creates a new application rule in the site's entitlement policy.
New-BrokerApplication Creates a new published application.
New-BrokerAssignmentPolicyRule Creates a new desktop rule in the site's assignment policy.
New-BrokerCatalog Adds a new catalog to the site.
New-BrokerConfigurationSlot Creates a new configuration slot.
New-BrokerConfiguredFTA Creates a file type association with a published application.
New-BrokerDelayedHostingPowerAction Causes a power action to be queued after a delay.
New-BrokerDesktopGroup Create a new desktop group for managing the brokering of groups of desktops.
New-BrokerEntitlementPolicyRule Creates a new desktop rule in the site's entitlement policy.
New-BrokerHostingPowerAction Creates a new action in the power action queue.
New-BrokerHypervisorConnection Creates a new hypervisor connection.
New-BrokerIcon Creates a new icon.
New-BrokerMachine Adds a machine that can be used to run desktops and applications.
New-BrokerMachineCommand Creates a new command to deliver to a desktop.
New-BrokerMachineConfiguration Creates a new machine configuration associated with an existing configuration slot.
New-BrokerPowerTimeScheme Creates a new power time scheme for a desktop group.
New-BrokerRebootSchedule Creates a new reboot schedule for a desktop group.
New-BrokerRemotePCAccount Create a new RemotePCAccount.
New-BrokerTag Creates a new tag.
New-BrokerUser Creates a new broker user object
Remove-BrokerAccessPolicyRule Deletes a rule from the site's access policy.
Remove-BrokerAccessPolicyRuleMetadata Deletes AccessPolicyRule Metadata from the AccessPolicyRule objects
Remove-BrokerAppAssignmentPolicyRule Deletes an application rule from the site's assignment policy.
Remove-BrokerAppEntitlementPolicyRule Deletes an application rule from the site's entitlement policy.
Remove-BrokerApplication Deletes one or more applications, or an association of an application.
Remove-BrokerApplicationInstanceMetadata Deletes ApplicationInstance Metadata from the ApplicationInstance objects
Remove-BrokerApplicationMetadata Deletes Application Metadata from the Application objects
Remove-BrokerAssignmentPolicyRule Deletes a desktop rule from the site's assignment policy.
Remove-BrokerAssignmentPolicyRuleMetadata Deletes AssignmentPolicyRule Metadata from the AssignmentPolicyRule objects
Remove-BrokerCatalog Removes catalogs from the site.
Remove-BrokerCatalogMetadata Deletes Catalog Metadata from the Catalog objects
Remove-BrokerConfigurationSlot Removes a configuration slot.
Remove-BrokerConfigurationSlotMetadata Deletes ConfigurationSlot Metadata from the ConfigurationSlot objects
Remove-BrokerConfiguredFTA Deletes one or more configured file type associations.
Remove-BrokerControllerMetadata Deletes Controller Metadata from the Controller objects
Remove-BrokerDelayedHostingPowerAction Cancels one or more delayed power actions.
Remove-BrokerDesktopGroup Remove desktop groups from the system or remove them from a Remote PC catalog.
Remove-BrokerDesktopGroupMetadata Deletes DesktopGroup Metadata from the DesktopGroup objects
Remove-BrokerEntitlementPolicyRule Deletes a desktop rule from the site's entitlement policy.
Remove-BrokerEntitlementPolicyRuleMetadata Deletes EntitlementPolicyRule Metadata from the EntitlementPolicyRule objects
Remove-BrokerHostingPowerAction Cancel one or more pending power actions.
Remove-BrokerHostingPowerActionMetadata Deletes HostingPowerAction Metadata from the HostingPowerAction objects
Remove-BrokerHypervisorAlertMetadata Deletes HypervisorAlert Metadata from the HypervisorAlert objects
Remove-BrokerHypervisorConnection Removes a hypervisor connection from the system.
Remove-BrokerHypervisorConnectionMetadata Deletes HypervisorConnection Metadata from the HypervisorConnection objects
Remove-BrokerIcon Remove an icon.
Remove-BrokerIconMetadata Deletes Icon Metadata from the Icon objects
Remove-BrokerImportedFTA Deletes one or more imported file type associations.
Remove-BrokerMachine Removes one or more machines from its desktop group or catalog.
Remove-BrokerMachineCommand Cancel a pending command queued for delivery to a desktop.
Remove-BrokerMachineCommandMetadata Deletes MachineCommand Metadata from the MachineCommand objects
Remove-BrokerMachineConfiguration Deletes a machine configuration from the site or removes the association from a desktop group.
Remove-BrokerMachineConfigurationMetadata Deletes MachineConfiguration Metadata from the MachineConfiguration objects
Remove-BrokerMachineMetadata Deletes Machine Metadata from the Machine objects
Remove-BrokerPowerTimeScheme Deletes an existing power time scheme.
Remove-BrokerPowerTimeSchemeMetadata Deletes PowerTimeScheme Metadata from the PowerTimeScheme objects
Remove-BrokerRebootCycleMetadata Deletes RebootCycle Metadata from the RebootCycle objects
Remove-BrokerRebootSchedule Removes the reboot schedule.
Remove-BrokerRemotePCAccount Delete RemotePCAccounts from the system.
Remove-BrokerScope Remove the specified catalog/desktop group from the given scope(s).
Remove-BrokerSessionMetadata Deletes Session Metadata from the Session objects
Remove-BrokerSiteMetadata Deletes Site Metadata from the Site objects
Remove-BrokerTag Removes a tag from the system or clears a tag to object association.
Remove-BrokerTagMetadata Deletes Tag Metadata from the Tag objects
Remove-BrokerUser Remove broker user objects from another broker object
Rename-BrokerAccessPolicyRule Renames a rule in the site's access policy.
Rename-BrokerAppAssignmentPolicyRule Renames an application rule in the site's assignment policy.
Rename-BrokerAppEntitlementPolicyRule Renames an application rule in the site's entitlement policy.
Rename-BrokerApplication Renames an application.
Rename-BrokerAssignmentPolicyRule Renames a desktop rule in the site's assignment policy.
Rename-BrokerCatalog Renames a catalog.
Rename-BrokerDesktopGroup Renames a desktop group.
Rename-BrokerEntitlementPolicyRule Renames a desktop rule in the site's entitlement policy.
Rename-BrokerMachineConfiguration Renames a machine configuration.
Rename-BrokerPowerTimeScheme Changes the name of an existing power time scheme.
Rename-BrokerTag Rename one or more tags.
Reset-BrokerLicensingConnection Resets the broker's license server connection.
Reset-BrokerServiceGroupMembership Makes the broker load, from the specified Configuration Service instance, the addresses that the Service can be reached on.
Send-BrokerSessionMessage Sends a message to a session.
Set-BrokerAccessPolicyRule Modifies an existing rule in the site's access policy.
Set-BrokerAccessPolicyRuleMetadata Creates/Updates metadata key-value pairs for AccessPolicyRule
Set-BrokerAppAssignmentPolicyRule Modifies an existing application rule in the site's assignment policy.
Set-BrokerAppEntitlementPolicyRule Modifies an existing application rule in the site's entitlement policy.
Set-BrokerApplication Changes the settings of an application to the value specified in the command.
Set-BrokerApplicationInstanceMetadata Creates/Updates metadata key-value pairs for ApplicationInstance
Set-BrokerApplicationMetadata Creates/Updates metadata key-value pairs for Application
Set-BrokerAssignmentPolicyRule Modifies an existing desktop rule in the site's assignment policy.
Set-BrokerAssignmentPolicyRuleMetadata Creates/Updates metadata key-value pairs for AssignmentPolicyRule
Set-BrokerCatalog Sets the properties of a catalog.
Set-BrokerCatalogMetadata Creates/Updates metadata key-value pairs for Catalog
Set-BrokerConfigurationSlotMetadata Creates/Updates metadata key-value pairs for ConfigurationSlot
Set-BrokerControllerMetadata Creates/Updates metadata key-value pairs for Controller
Set-BrokerDBConnection Specifies the Citrix Broker Service's database connection string.
Set-BrokerDesktopGroup Adjusts the settings of a broker desktop group.
Set-BrokerDesktopGroupMetadata Creates/Updates metadata key-value pairs for DesktopGroup
Set-BrokerEntitlementPolicyRule Modifies an existing desktop rule in the site's entitlement policy.
Set-BrokerEntitlementPolicyRuleMetadata Creates/Updates metadata key-value pairs for EntitlementPolicyRule
Set-BrokerHostingPowerAction Changes the priority of one or more pending power actions.
Set-BrokerHostingPowerActionMetadata Creates/Updates metadata key-value pairs for HostingPowerAction
Set-BrokerHypervisorAlertMetadata Creates/Updates metadata key-value pairs for HypervisorAlert
Set-BrokerHypervisorConnection Sets the properties of a hypervisor connection.
Set-BrokerHypervisorConnectionMetadata Creates/Updates metadata key-value pairs for HypervisorConnection
Set-BrokerIconMetadata Creates/Updates metadata key-value pairs for Icon
Set-BrokerMachine Sets properties on a machine.
Set-BrokerMachineCatalog Moves one or more machines into a different catalog.
Set-BrokerMachineCommandMetadata Creates/Updates metadata key-value pairs for MachineCommand
Set-BrokerMachineConfiguration Sets the properties of a machine configuration.
Set-BrokerMachineConfigurationMetadata Creates/Updates metadata key-value pairs for MachineConfiguration
Set-BrokerMachineMaintenanceMode Sets whether the specified machine(s) are in maintenance mode.
Set-BrokerMachineMetadata Creates/Updates metadata key-value pairs for Machine
Set-BrokerPowerTimeScheme Modifies an existing power time scheme.
Set-BrokerPowerTimeSchemeMetadata Creates/Updates metadata key-value pairs for PowerTimeScheme
Set-BrokerPrivateDesktop Change the settings of a private desktop.
Set-BrokerRebootCycleMetadata Creates/Updates metadata key-value pairs for RebootCycle
Set-BrokerRebootSchedule Updates the values of one or more desktop group reboot schedules.
Set-BrokerRemotePCAccount Modify one or more RemotePCAccounts.
Set-BrokerSession Sets properties of a session.
Set-BrokerSessionMetadata Creates/Updates metadata key-value pairs for Session
Set-BrokerSharedDesktop Change the settings of a shared desktop.
Set-BrokerSite Changes the overall settings of the current XenDesktop broker site.
Set-BrokerSiteMetadata Creates/Updates metadata key-value pairs for Site
Set-BrokerTagMetadata Creates/Updates metadata key-value pairs for Tag
Start-BrokerCatalogPvdImagePrepare Start the PVD Image prepare process in the Broker for the machines in the specified catalog(s).
Start-BrokerMachinePvdImagePrepare Start the PVD Image prepare process in the Broker for the specified machine(s).
Start-BrokerNaturalRebootCycle Reboots all machines from the specified catalog when they are not in use.
Start-BrokerRebootCycle Creates and starts a reboot cycle for each desktop group that contains machines from the specified catalog.
Stop-BrokerRebootCycle Cancels the specified reboot cycle.
Stop-BrokerSession Stop or log off a session.
Test-BrokerAccessPolicyRuleNameAvailable Determine whether the proposed AccessPolicyRule Name is available for use.
Test-BrokerAppAssignmentPolicyRuleNameAvailable Determine whether the proposed AppAssignmentPolicyRule Name is available for use.
Test-BrokerAppEntitlementPolicyRuleNameAvailable Determine whether the proposed AppEntitlementPolicyRule Name is available for use.
Test-BrokerApplicationNameAvailable Determine whether the proposed Application Name is available for use.
Test-BrokerAssignmentPolicyRuleNameAvailable Determine whether the proposed AssignmentPolicyRule Name is available for use.
Test-BrokerCatalogNameAvailable Determine whether the proposed Catalog Name is available for use.
Test-BrokerDBConnection Tests whether a database is suitable for use by the Citrix Broker Service.
Test-BrokerDesktopGroupNameAvailable Determine whether the proposed DesktopGroup Name is available for use.
Test-BrokerEntitlementPolicyRuleNameAvailable Determine whether the proposed EntitlementPolicyRule Name is available for use.
Test-BrokerLicenseServer Tests whether or not a license server can be used by the broker.
Test-BrokerMachineNameAvailable Determine whether the proposed Machine MachineName is available for use.
Test-BrokerPowerTimeSchemeNameAvailable Determine whether the proposed PowerTimeScheme Name is available for use.
Test-BrokerRemotePCAccountNameAvailable Determine whether the proposed RemotePCAccount OU is available for use.
Update-BrokerImportedFTA Imports or updates all of the file type associations for the specified worker.
Update-BrokerNameCache Performs administrative operations on the user and machine name cache.
Back to Top