Citrix Virtual Apps and Desktops SDK

New-BrokerGpoPolicy

March 11, 2024

Contributed by:

Create a new GPO policy.

Syntax

New-BrokerGpoPolicy
   [-Description <String>]
   [-IsEnabled <Boolean>]
   [-Name] <String>
   -PolicySetGuid <Guid>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The New-BrokerGpoPolicy cmdlet creates a new GPO policy.

Examples

EXAMPLE 1

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

New-BrokerGpoPolicy -Name "Policy0"
<!--NeedCopy-->

Parameters

-Name

Specifies the new policy name. The name must not exist in the specified policy set.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-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.

Type:	Guid
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-Description

Specifies the description of the policy.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-IsEnabled

Specifies whether policy is enabled.

Type:	Boolean
Position:	Named
Default value:	True
Required:	False
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-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.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You cannot pipe input into this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.GpoPolicy

The newly created GPO policy.

Notes

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

New-BrokerGpoPolicy

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

New-BrokerGpoPolicy

Syntax

Description

Examples

EXAMPLE 1

Parameters

-Name

-PolicySetGuid

-Description

-IsEnabled

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Broker.Admin.SDK.GpoPolicy

Notes

Related Links

In this article