Product Documentation

Rename-AdminRole

Nov 11, 2015

Rename a role

Syntax

Rename-AdminRole [-InputObject] <Role> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Rename-AdminRole [-Id] <Guid> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Rename-AdminRole [-Name] <String> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

The Rename-AdminRole cmdlet changes the name of a role.

Role names must be unique, and you cannot modify the name of built-in roles.

Parameters

-InputObject<Role>

Specifies the role to rename (by object).

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)

-Id<Guid>

Specifies the role to rename (by id).

Required? true
Default Value  
Accept Pipeline Input? true (ByPropertyName)

-Name<String>

Specifies the role to rename (by name).

Required? true
Default Value  
Accept Pipeline Input? true (ByPropertyName)

-NewName<String>

Specifies the new name of the role.

Required? true
Default Value  
Accept Pipeline Input? false

-PassThru<SwitchParameter>

Returns the affected record. By default, this cmdlet does not generate any output.

Required? false
Default Value False
Accept Pipeline Input? false

-LoggingId<Guid>

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and 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.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller the PowerShell snap-in connects to. You can provide this as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value becomes the default.
Accept Pipeline Input? false

Input Type

Citrix.DelegatedAdmin.Sdk.Role You can pipe the role to be renamed into this command.

Return Values

None or Citrix.DelegatedAdmin.Sdk.Role

When you use the PassThru parameter, Rename-AdminRole generates a Citrix.DelegatedAdmin.Sdk.Role object. Otherwise, this cmdlet does not generate any output.

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> Rename-AdminRole -Name Supervisor -NewName HelpDeskLead

Renames the 'Supervisor' role to 'HelpDeskLead'.