Product Documentation

Rename-AdminScope

Nov 17, 2015

Rename a scope

Syntax

Rename-AdminScope [-InputObject] <Scope> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

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

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

Detailed Description

The Rename-AdminScope cmdlet changes the name of a scope.

Scope names must be unique, and you cannot modify the name of the built-in 'All' scope.

Parameters

-InputObject<Scope>

Specifies the scope to rename (by object).

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

-Id<Guid>

Specifies the scope to rename (by id).

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

-Name<String>

Specifies the scope to rename (by name).

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

-NewName<String>

Specifies the new name of the scope.

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.Scope You can pipe the scope to be renamed into this command.

Return Values

None or Citrix.DelegatedAdmin.Sdk.Scope

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

Examples

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

C:\PS> Rename-AdminScope -Name Sales -NewName SalesDesktops

Renames the 'Sales' scope to 'SalesDesktops'.