Citrix Virtual Apps and Desktops SDK

Set-ConfigEdgeServer

Changes the properties of an edge server

Syntax

Set-ConfigEdgeServer
   [-InputObject] <EdgeServer[]>
   [-Description <String>]
   [-IsHealthy <Boolean>]
   [-MachineAddress <String>]
   [-Sid <String>]
   [-Uuid <Guid>]
   [-ZoneUid <Guid>]
   [-PassThru]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-ConfigEdgeServer
   [-Uid] <Guid[]>
   [-Description <String>]
   [-IsHealthy <Boolean>]
   [-MachineAddress <String>]
   [-Sid <String>]
   [-Uuid <Guid>]
   [-ZoneUid <Guid>]
   [-PassThru]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-ConfigEdgeServer
   [-Name] <String[]>
   [-Description <String>]
   [-IsHealthy <Boolean>]
   [-MachineAddress <String>]
   [-Sid <String>]
   [-Uuid <Guid>]
   [-ZoneUid <Guid>]
   [-PassThru]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The Set-ConfigEdgeServer cmdlet sets properties of an edge server or a set of edge servers. The edge server can be specified by name or by one or more edge server instances can be passed to the command either by piping or by using the -InputObject parameter

Examples

EXAMPLE 1

Associates the edge server ‘EdgeSrv1’ to a zone specified by its UID

Set-ConfigEdgeServer EdgeSrv1 -ZoneUid d8fe27fa-f33c-47ee-b6b5-80241f536164
<!--NeedCopy-->

Parameters

-InputObject

Specifies the edge server objects to modify.

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

-Uid

Identifies the edge server to modify by its UID property.

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

-Name

Identifies the edge server to modify by name.

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

-Description

Supplies the new value of the Description property.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Length range: 0 to 256

-IsHealthy

Supplies the new value of the IsHealthy property.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2106

-MachineAddress

Supplies the new value of the MachineAddress property.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Length range: 1 to 255

-Sid

Supplies the new value of the SID property.

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

-Uuid

Supplies the new value of the Uuid property.

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

-ZoneUid

Allows moving the edge server to a new zone

Type: Guid
Position: Named
Default value: None
Required: False
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 the edge servers to be updated into this command.

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.

Set-ConfigEdgeServer