Citrix Virtual Apps and Desktops 2411 SDK

Remove-BrokerEntitlementPolicyRule

December 4, 2024

Contributed by:

Deletes a desktop rule from the site’s entitlement policy.

Syntax

Remove-BrokerEntitlementPolicyRule
      [-InputObject] <EntitlementPolicyRule[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-BrokerEntitlementPolicyRule
      [-Name] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

The Remove-BrokerEntitlementPolicyRule cmdlet deletes a desktop rule from the site’s entitlement policy.

A desktop rule in the entitlement policy defines the users who are allowed per-session access to a machine from the rule’s associated desktop group to run a full desktop session.

Deleting a rule does not affect existing sessions launched using the rule, but users cannot reconnect to those sessions if they are subsequently disconnected.

Examples

EXAMPLE 1

Deletes the desktop rule called Temp Workers from the entitlement policy. Existing desktop sessions launched using the rule are not affected, but users cannot reconnect to sessions if they are subsequently disconnected.

Remove-BrokerEntitlementPolicyRule 'Temp Workers'
<!--NeedCopy-->

EXAMPLE 2

Deletes all desktop rules from the entitlement policy applying to the Customer Support desktop group. This effectively removes all access to the desktops published from this group. Existing desktop sessions are not affected, but users cannot reconnect to sessions if they are subsequently disconnected.

$dg = Get-BrokerDesktopGroup 'Customer Support'
Get-BrokerEntitlementPolicyRule -DesktopGroupUid $dg.Uid | Remove-BrokerEntitlementPolicyRule
<!--NeedCopy-->

Parameters

-InputObject

The desktop rule to be deleted from the entitlement policy.

Type:	EntitlementPolicyRule[]
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-Name

The name of the desktop rule to be deleted from the entitlement policy.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	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.

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

Citrix.Broker.Admin.SDK.EntitlementPolicyRule

The desktop rule to be deleted from the entitlement policy.

Outputs

None

By default, this cmdlet returns no output.

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

Remove-BrokerEntitlementPolicyRule

December 4, 2024

Contributed by:

December 4, 2024

Contributed by:

Remove-BrokerEntitlementPolicyRule

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-InputObject

-Name

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.Broker.Admin.SDK.EntitlementPolicyRule

Outputs

None

Related Links

In this article