Rename-ConfigEdgeServer
Renames an edge server
Syntax
Rename-ConfigEdgeServer
[-InputObject] <EdgeServer>
[-NewName] <String>
[-PassThru]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Rename-ConfigEdgeServer
[-Uid] <Guid>
[-NewName] <String>
[-PassThru]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Rename-ConfigEdgeServer
[-Name] <String>
[-NewName] <String>
[-PassThru]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
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"
EXAMPLE 2
Renames the edge server with the name "Old name" to "New Name"
Get-ConfigEdgeServer "Old name" | Rename-ConfigEdgeServer -NewName "New name"
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 |
| Length range: | 1 to 128 |
| Disallowed characters: | \/#?<>\|[] |
-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 |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
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.