-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
Get-BrokerTagUsage
-
-
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-BrokerTagUsage
Produces a usage report for one or more tags.
Syntax
Get-BrokerTagUsage [-TagUid] <Int32> [-Property <String[]>] [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
Get-BrokerTagUsage [[-TagName] <String>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-Property <String[]>] [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
<!--NeedCopy-->
Detailed Description
Returns one BrokerTagUsage for each input tag. Each BrokerTagUsage object summarizes the tag’s usage throughout the site.
Brokertagusage Object
Each BrokerTagUsage object summarizes on the usage of a single Tag.
-
TaggedApplicationGroups (System.Int32) The number of application groups that are tagged with this tag and that are visible to the calling delegated administrator.
-
TaggedApplications (System.Int32) The number of applications that are tagged with this tag and that are visible to the calling delegated administrator.
-
TaggedCatalogs (System.Int32) The number of catalogs that are tagged with this tag and that are visible to the calling delegated administrator.
-
TaggedDesktopGroups (System.Int32) The number of desktop groups that are tagged with this tag and that are visible to the calling delegated administrator.
-
TaggedMachines (System.Int32) The number of machines that are tagged with this tag and that are visible to the calling delegated administrator.
-
TagName (System.String) The name of the Tag.
-
TagRestrictedApplicationGroups (System.Int32) The number of application groups that have this tag restriction and that are visible to the calling delegated administrator.
-
TagRestrictedAutoscale (System.Int32) The number of desktop groups that have this tag restriction
-
TagRestrictedEntitlementPolicyRules (System.Int32) The number of desktop rules in the site’s entitlement policy that have this tag restriction and that are visible to the calling delegated administrator.
-
TagRestrictedRebootSchedules (System.Int32) The number of reboot schedules that have this tag restriction.
-
TagUid (System.Int32) The Uid of the Tag.
-
TagUUID (System.Guid) The UUID associated to the Tag.
-
TotalTaggedObjects (System.Int32) The total number of objects that are tagged with this tag.
-
TotalTagRestrictedObjects (System.Int32) The total number of objects that have this tag restriction.
-
UnknownTaggedObjects (System.Int32) The number of objects of all types that are tagged with this tag and that are *not* visible to the calling delegated administrator.
-
UnknownTagRestrictedObjects (System.Int32) The number of objects of all types that have this tag restriction and that are *not* visible to the calling delegated administrator.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| TagUid | Report on the tag identified by TagUid. | true | false | |
| TagName | Report on the tag identified by TagName. | 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 | |
| AdminClientIP | Internal use only. | 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.Tagusage
Summarizes the usage of a single tag.
Notes
If a tag is applied to an object, but that object would not be visible to the calling delegated administrator via the corresponding Get-Broker* cmdlet, then the object is not counted as an object of that type, but is instead reported as an ‘unknown’ object. For example, suppose that the caller has invoked Get-BrokerTagUsage MyTag, and that there are three desktop groups and no other objects tagged with MyTag. Two of the desktop groups are visible to the caller, but the other is not. In this case, TotalTaggedObjects is 3, TaggedDesktopGroups is 2, and UnknownTaggedObjects is 1.
Examples
Example 1
Get-BrokerTagUsage
<!--NeedCopy-->
Description
Reports on the usage of all tags in the site.
Example 2
Get-BrokerTagUsage MyTag
<!--NeedCopy-->
Description
Reports on the usage of the tag MyTag.
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.