Product Documentation

Get-BrokerScopedObject

Sep 29, 2015

Gets the details of the scoped objects for the Broker Service.

Syntax

Get-BrokerScopedObject -ScopeId <Guid> [-Property <String[]>] [-AdminAddress <String>] [<CommonParameters>]

Get-BrokerScopedObject [-Description <String>] [-ObjectId <String>] [-ObjectName <String>] [-ObjectType <ScopedObjectType>] [-ScopeName <String>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-Property <String[]>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Returns a list of directly scoped objects including the names and identifiers of both the scope and object as well as the object description for display purposes.

There will be at least one result for every directly scoped object. When an object is associated with multiple scopes the output contains one result per scope duplicating the object details.

No records are returned for the All scope, though if an object is not in any scope a result with a null ScopeId and ScopeName will be returned.

-------------------------- BrokerScopedObject Object

A scoped, or scopeable object configured in the broker.

-- Description (System.String)

Description of the object (possibly $null if the object type does not have a description).

-- ObjectId (System.String)

Unique identifier of the object.

-- ObjectName (System.String)

Display name of the object

-- ObjectType (Citrix.Broker.Admin.SDK.ScopedObjectType)

Type of the object this entry relates to.

-- ScopeId (System.Guid?)

Specifies the unique identifier of the scope.

-- ScopeName (System.String)

Specifies the display name of the scope.

Related topics

Parameters

-ScopeId<Guid>

Gets scoped object entries for the given scope identifier.

Required? true
Default Value  
Accept Pipeline Input? false

-Description<String>

Gets scoped object entries for objects with the specified description.

Required? false
Default Value  
Accept Pipeline Input? false

-ObjectId<String>

Gets scoped object entries for objects with the specified object identifier.

Required? false
Default Value  
Accept Pipeline Input? false

-ObjectName<String>

Gets scoped object entries for objects with the specified object identifier.

Required? false
Default Value  
Accept Pipeline Input? false

-ObjectType<ScopedObjectType>

Gets scoped object entries for objects of the given type.

Required? false
Default Value  
Accept Pipeline Input? false

-ScopeName<String>

Gets scoped object entries with the given scope name.

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

Return Values

Citrix.Broker.Sdk.ScopedObject

The Get-BrokerScopedObject command returns an object containing the following properties:

ScopeId <Guid?>

Specifies the unique identifier of the scope.

ScopeName <String>

Specifies the display name of the scope.

ObjectType <ScopedObjectType>

Type of the object this entry relates to.

ObjectId <String>

Unique identifier of the object.

ObjectName <String>

Display name of the object

Description <String>

Description of the object (possibly $null if the object type does not have a description).

Notes

If the command fails, the following errors can be returned.

Error Codes

-----------

PartialData

Only a subset of the available data was returned.

InvalidFilter

A filtering expression was included that could not be interpreted for this command.

PermissionDenied

You do not have permission to execute this command.

CommunicationError

There was a problem communicating with the remote service.

ExceptionThrown

An unexpected error occurred. For more details, see the Windows event logs on the controller or the XenDesktop logs.

Examples

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

c:\PS>Get-BrokerScopedObject -ObjectType Catalog 
 
                  ScopeId     : eff6f464-f1ee-4442-add3-99982e0cec01 
                  ScopeName   : Sales 
                  ObjectType  : Catalog 
                  ObjectId    : 1 
                  ObjectName  : MyExampleCatalog 
                  Description : Test Catalog 
 
                  ScopeId     : 304e0fa7-d390-47f0-a94f-7e956a324c41 
                  ScopeName   : Finance 
                  ObjectType  : Catalog 
                  ObjectId    : 1 
                  ObjectName  : MyExampleCatalog 
                  Description : Test Catalog 
 
                  ScopeId     : 
                  ScopeName   : 
                  ObjectType  : Catalog 
                  ObjectId    : 2 
                  ObjectName  : AnotherCatalog 
                  Description : Another catalog in no scopes

Gets all of the scoped objects with type Catalog. The example output shows a catalog object (MyExampleCatalog) in two scopes Sales and Finance, and another catalog (AnotherCatalog) that is not in any scope. The ScopeId and ScopeName values returned are null in the final record.