Citrix Virtual Apps and Desktops SDK

Rename-ConfigEdgeServer

March 11, 2024

Contributed by:

Renames an edge server

Syntax

Rename-ConfigEdgeServer
      [-InputObject] <EdgeServer>
      [-NewName] <String>
      [-PassThru]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Rename-ConfigEdgeServer
      [-Uid] <Guid>
      [-NewName] <String>
      [-PassThru]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Rename-ConfigEdgeServer
      [-Name] <String>
      [-NewName] <String>
      [-PassThru]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

The Rename-ConfigEdgeServer cmdlet changes the name of an edge server.

All edge servers in a site must have a unique name.

The following special characters are not allowed in the name: \ / ; : # . * ? = < > | [ ] ( ) “ ‘ `

Examples

EXAMPLE 1

Renames the edge server with the name “Old name” to “New Name”

Rename-ConfigEdgeServer -Name "Old name" -NewName "New Name"
<!--NeedCopy-->

EXAMPLE 2

Renames the edge server with the name “Old name” to “New Name”

 Get-ConfigEdgeServer "Old name" | Rename-ConfigEdgeServer -NewName "New name"
<!--NeedCopy-->

Parameters

-InputObject

Specifies the edge server to rename

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

-Uid

Specifies the UID of the edge server to rename

Type:	Guid
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-Name

Specifies the name of the edge server to rename

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-NewName

Specifies the new name of the edge server

Type:	String
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

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

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LoggingId

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.

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.Configuration.Sdk.EdgeServer

You can pipe edge servers to Rename-ConfigEdgeServer.

Outputs

None or Citrix.Configuration.Sdk.EdgeServer

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Configuration.Sdk.EdgeServer object.

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-ConfigEdgeServer

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Rename-ConfigEdgeServer

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-InputObject

-Uid

-Name

-NewName

-PassThru

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.Configuration.Sdk.EdgeServer

Outputs

None or Citrix.Configuration.Sdk.EdgeServer

Related Links

In this article