Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-BrokerTag

August 3, 2023
Contributed by: 
C

Gets one or more tags.

Syntax


Get-BrokerTag [-Uid] <Int32> [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Get-BrokerTag [[-Name] <String>] [-Description <String>] [-IsUsedByGpo <Boolean>] [-Metadata <String>] [-ScopeId <Guid>] [-ScopeName <String>] [-UUID <Guid>] [-ApplicationUid <Int32>] [-ApplicationGroupUid <Int32>] [-CatalogUid <Int32>] [-DesktopUid <Int32>] [-DesktopGroupUid <Int32>] [-MachineUid <Int32>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Gets tags that match all of the supplied criteria.

Brokertag Object

The BrokerTag object represents a single instance of a Tag associated to other objects. It contains the following properties:

  • Description (System.String) Description of the tag

  • IsUsedByGpo (System.Boolean?) Indicate if the tag is used by group policy

  • MetadataMap (System.Collections.Generic.Dictionary<string, string>) The metadata for this command.

  • Name (System.String) The name of the Tag

  • Scopes (Citrix.Fma.Sdk.DelegatedAdminInterfaces.ScopeReference[]) The list of the delegated admin scopes to which the tag belongs.

  • Uid (System.Int32) The Uid of the Tag

  • UUID (System.Guid) The UUID associated to the Tag

Parameters

Name Description Required? Pipeline Input Default Value
Uid Gets the tag identified by Uid true false  
Name Gets tags that match the specified name. false false  
Description Gets tags with the specified description. false false  
IsUsedByGpo Gets tags that are used by group policy. false false  
Metadata 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”. false false    
ScopeId Gets tags that are associated with the given scope identifier. false false  
ScopeName Gets tags that are associated with the given scope name. false false  
UUID Gets tags associated with a given UUID. false false  
ApplicationUid Gets tags associated with the specified application. false false  
ApplicationGroupUid Get tags associated with the specified application group. false false  
CatalogUid Gets tags associated with the specified catalog. false false  
DesktopUid Gets tags associated with the specified desktop. false false  
DesktopGroupUid Gets tags associated with the specified desktop group. false false  
MachineUid Gets tags associated with the specified machine. false false  
ReturnTotalRecordCount 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. false false False
MaxRecordCount Specifies the maximum number of records to return. false false 250
Skip Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. false false 0
SortBy 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. false false The default sort order is by name or unique identifier.
Filter Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details. false false  
FilterScope Gets only results allowed by the specified scope id. false false  
Property 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. false false  
AdminAddress 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. false false Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken Specifies the bearer token assigned to the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  

Input Type

None

Input cannot be piped to this cmdlet.

Return Values

Citrix.Broker.Admin.Sdk.Tag

Returns matching tags.

Examples

Example 1 


C:\PS> Get-BrokerTag

<!--NeedCopy-->

Description

Enumerate all tags.

Example 2 


C:\PS> Get-BrokerTag -Uid 5

<!--NeedCopy-->

Description

Get a single specific tag with a Uid of 5.

Example 3 


C:\PS> $machine = Get-BrokerMachine DOMAIN\Machine

C:\PS> Get-BrokerTag -MachineUid $machine.Uid

<!--NeedCopy-->

Description

Get tags associated with machine DOMAIN\Machine.

Get-BrokerTag
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.