Citrix Virtual Apps and Desktops SDK

Rename-Brokerentitlementpolicyrule

August 3, 2023

Contributed by:

Renames a desktop rule in the site’s entitlement policy.

Syntax

Rename-BrokerEntitlementPolicyRule [-InputObject] <EntitlementPolicyRule[]> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Rename-BrokerEntitlementPolicyRule [-Name] <String> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

The Rename-BrokerEntitlementPolicyRule cmdlet renames a desktop rule in the site’s entitlement policy. The Name property of the rule is changed.

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.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
InputObject	The desktop rule in the entitlement policy to be renamed.	true	true (ByValue)
Name	The existing name of the desktop rule in the entitlement policy to be renamed.	true	true (ByPropertyName)
NewName	The new name of the desktop rule in the entitlement policy being renamed. The new name must not match that of any other existing rule in the policy (irrespective of whether it is a desktop or application rule).	true	false
PassThru	This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.	false	false	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.	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

Citrix.Broker.Admin.Sdk.Entitlementpolicyrule

The desktop rule in the entitlement policy being renamed.

Return Values

None Or Citrix.Broker.Admin.Sdk.Entitlementpolicyrule

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.EntitlementPolicyRule object.

Examples

Example 1

C:\PS> Rename-BrokerEntitlementPolicyRule 'Prod Dev' -NewName 'Product Development'
<!--NeedCopy-->

Description

Renames the desktop rule in the entitlement policy called Prod Dev to Product Development. The new name of the rule must be unique in the entitlement policy.

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

Rename-Brokerentitlementpolicyrule

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Rename-Brokerentitlementpolicyrule

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Broker.Admin.Sdk.Entitlementpolicyrule

Return Values

None Or Citrix.Broker.Admin.Sdk.Entitlementpolicyrule

Examples

Example 1

Description

In this article