Citrix Virtual Apps and Desktops SDK

Remove-ConfigEdgeServer

Removes edge servers from the site

Syntax

Remove-ConfigEdgeServer
      [-InputObject] <EdgeServer[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-ConfigEdgeServer
      [-Uid] <Guid[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-ConfigEdgeServer
      [-Name] <String[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Remove edge servers from the site

Examples

EXAMPLE 1

Removes an edge server with the specified name

Remove-ConfigEdgeServer -Name W2K12R1
<!--NeedCopy-->

EXAMPLE 2

Removes all edge servers from the zone named Secondary

Get-ConfigEdgeServer -ZoneName Secondary | Remove-ConfigEdgeServer
<!--NeedCopy-->

Parameters

-InputObject

Specifies the edge server objects to delete

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 delete

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 delete

Type: String[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
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 the edge servers to be deleted to Remove-ConfigEdgeServer.

Outputs

None

By default, this cmdlet returns no output.

Remove-ConfigEdgeServer