Product Documentation

Get-BrokerController

Oct 21, 2016

Gets Controllers running broker services in the site.

Syntax

Get-BrokerController [-Uid] <Int32> [-Property <String[]>] [-AdminAddress <String>] [<CommonParameters>]

Get-BrokerController [[-MachineName] <String>] [-ControllerVersion <String>] [-DesktopsRegistered <Int32>] [-DNSName <String>] [-LastActivityTime <DateTime>] [-LastStartTime <DateTime>] [-Metadata <String>] [-OSType <String>] [-OSVersion <String>] [-SID <String>] [-State <ControllerState>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-Property <String[]>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Gets Controllers from the current site that match the specified search criteria.

Controllers are server machines running instances of the broker service. The broker service is responsible for the brokering of user sessions to desktops or applications, and for power management of the underlying machines. An operational site must contain at least one Controller.

If no search criteria are specified, all Controllers in the site are obtained.

-------------------------- BrokerController Object

The BrokerController object represents a single instance of a controller running instances of the broker service. It contains the following properties:

-- ActiveSiteServices (System.String[])

The services active on the site

-- AssociatedHypervisorConnectionUids (System.Int32[])

The UIDs of the associated hypervisor connections

-- ControllerVersion (System.String)

The version of the controller

-- DesktopsRegistered (System.Int32)

The count of the desktops registered on the controller

-- DNSName (System.String)

The DNS name of the controller

-- LastActivityTime (System.DateTime?)

The last reported as active time of the controller

-- LastStartTime (System.DateTime?)

The last start-up time of the controller

-- MachineName (System.String)

The windows name of the controller

-- MetadataMap (System.Collections.Generic.Dictionary<string, string>)

The metadata for this command.

-- OSType (System.String)

The Operating System Type of the controller.

-- OSVersion (System.String)

The Operating System Version of the controller.

-- SID (System.String)

The SID of the controller.

-- State (Citrix.Broker.Admin.SDK.ControllerState)

The state of the controller.

-- Uid (System.Int32)

The UID of the controller itself.

Related topics

Get-BrokerDesktop

Parameters

-Uid<Int32>

Gets only Controllers with the specified unique ID.

Required? true
Default Value  
Accept Pipeline Input? false

-MachineName<String>

Gets only Controllers with the specified Windows name. ('domain\machine')

Required? false
Default Value  
Accept Pipeline Input? false

-ControllerVersion<String>

Gets only Controllers running the specified version of the broker service.

Required? false
Default Value  
Accept Pipeline Input? false

-DesktopsRegistered<Int32>

Gets only Controllers that have the specified number of desktops currently registered. This property is mainly of use with advanced filtering; see about_Broker_Filtering.

Required? false
Default Value  
Accept Pipeline Input? false

-DNSName<String>

Gets only Controllers with the specified DNS name ('machine.domain')

Required? false
Default Value  
Accept Pipeline Input? false

-LastActivityTime<DateTime>

Gets only Controllers last reported as active at the specified time. This property is mainly of use with advanced filtering; see about_Broker_Filtering.

Required? false
Default Value  
Accept Pipeline Input? false

-LastStartTime<DateTime>

Gets only Controllers that last started-up at the specified time. This property is mainly of use with advanced filtering; see about_Broker_Filtering.

Required? false
Default Value  
Accept Pipeline Input? false

-Metadata<String>

Gets records with matching metadata entries.

The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata "abc:x*" matches records with a metadata entry having a key name of "abc" and a value starting with the letter "x".

Required? false
Default Value  
Accept Pipeline Input? false

-OSType<String>

Gets only Controllers running the specified Operating System type.

Required? false
Default Value  
Accept Pipeline Input? false

-OSVersion<String>

Gets only Controllers running the specified Operating System version.

Required? false
Default Value  
Accept Pipeline Input? false

-SID<String>

Gets only Controllers with the specified SID.

Required? false
Default Value  
Accept Pipeline Input? false

-State<ControllerState>

Gets only Controllers currently in the specified state.

Valid values are: Failed, Off, On, and Active.

Required? false
Default Value  
Accept Pipeline Input? false

-ReturnTotalRecordCount<SwitchParameter>

When specified, this causes the cmdlet to output an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Broker_Filtering for details.

Required? false
Default Value False
Accept Pipeline Input? false

-MaxRecordCount<Int32>

Specifies the maximum number of records to return.

Required? false
Default Value 250
Accept Pipeline Input? false

-Skip<Int32>

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Required? false
Default Value 0
Accept Pipeline Input? false

-SortBy<String>

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Required? false
Default Value The default sort order is by name or unique identifier.
Accept Pipeline Input? false

-Filter<String>

Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.

Required? false
Default Value  
Accept Pipeline Input? false

-Property<String[]>

Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

None You cannot pipe input into this cmdlet.

Return Values

Citrix.Broker.Admin.SDK.Controller

Returns Controllers matching all specified selection criteria.

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> Get-BrokerController -State Active

Gets all Controllers in the site that are currently active (powered on and fully operational).

-------------------------- EXAMPLE 2 --------------------------

C:\PS> Get-BrokerController -Filter 'LastStartTime -gt "-30:00"'

Gets all Controllers in the site that started-up in the last 30 minutes.