Citrix Virtual Apps and Desktops SDK


Determine whether the proposed EntitlementPolicyRule Name is available for use.


Test-BrokerEntitlementPolicyRuleNameAvailable [-Name] <String[]> [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Detailed Description

This cmdlet checks whether proposed EntitlementPolicyRule Name is available for use. It returns a record for each Name indicating the availability of that Name, with $true indicating that the Name is unused and available for use, or $false if it is not available.


Name Description Required? Pipeline Input Default Value
Name The EntitlementPolicyRule Name to be tested. true true (ByValue, ByPropertyName)  
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


You can pipe a string that contains the Name to test.

Return Values


The cmdlet returns a result for each Name specified. An availability of “True” indicates the Name is available for use, and “False” if it is not available.


Example 1

C:\PS> Test-BrokerEntitlementPolicyRuleNameAvailable -Name Test1


Checks whether the Name “Test1” is available.

Example 2

C:\PS> Test-BrokerEntitlementPolicyRuleNameAvailable @("Test1","Test2","Test3")


Checks whether each of the specified names is available.