Citrix Virtual Apps and Desktops SDK

New-BrokerGpoPolicy

Create a new GPO policy.

Syntax


New-BrokerGpoPolicy [-Name] <String> -PolicySetGuid <Guid> [-Description <String>] [-IsEnabled <Boolean>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

The New-BrokerGpoPolicy cmdlet creates a new GPO policy.

Parameters

Name Description Required? Pipeline Input Default Value
Name Specifies the new policy name. The name must not exist in the specified policy set. true true (ByPropertyName)  
PolicySetGuid Specifies the policy set the new policy will be in. If the GUID is not specified, the new policy is created in the default site policy set. true true (ByPropertyName) None
Description Specifies the description of the policy. false true (ByPropertyName)  
IsEnabled Specifies whether policy is enabled. false true (ByPropertyName) true
LoggingId Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets. 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  
AdminClientIP Internal use only. 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

You cannot pipe input into this cmdlet.

Return Values

Citrix.Broker.Admin.Sdk.Gpopolicy

The newly created GPO policy.

Notes

The priority of the new policy is assigned with the lowest priority.

Examples

Example 1


C:\PS> New-BrokerGpoPolicy -Name "Policy0"

<!--NeedCopy-->

Description

Create a policy named Policy0 in the default site policy set.

New-BrokerGpoPolicy