Citrix Virtual Apps and Desktops SDK

Rename-Brokeraccesspolicyrule

August 3, 2023

Contributed by:

Renames a rule in the site’s access policy.

Syntax

Rename-BrokerAccessPolicyRule [-InputObject] <AccessPolicyRule[]> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]

Rename-BrokerAccessPolicyRule [-Name] <String> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

The Rename-BrokerAccessPolicyRule cmdlet renames a rule in the site’s access policy. The Name property of the rule is changed.

An access policy rule defines a set of connection filters and access control rights relating to a desktop group. These allow fine-grained control of what access is granted to a desktop group based on details of, for example, a user’s endpoint device, its address, and the user’s identity.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
InputObject	The access policy rule to be renamed.	true	true (ByValue)
Name	The existing name of the access policy rule to be renamed.	true	true (ByPropertyName)
NewName	The new name for the access policy rule being renamed. The new name must not match that of any other existing rules in the policy.	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

Input Type

Citrix.Broker.Admin.Sdk.Accesspolicyrule

The access policy rule to be renamed.

Return Values

None Or Citrix.Broker.Admin.Sdk.Accesspolicyrule

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

Examples

Example 1

C:\PS> Rename-BrokerAccessPolicyRule 'Sales' -NewName 'TeleSales'
<!--NeedCopy-->

Description

Renames the access policy rule called Sales to TeleSales. The new name of the rule must be unique in the access 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-Brokeraccesspolicyrule

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Rename-Brokeraccesspolicyrule

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Broker.Admin.Sdk.Accesspolicyrule

Return Values

None Or Citrix.Broker.Admin.Sdk.Accesspolicyrule

Examples

Example 1

Description

In this article