Citrix Daas SDK

New-ConfigEdgeServer

August 9, 2024

Contributed by:

C C

Creates a new edge server object

Syntax

New-ConfigEdgeServer
   [-Description <String>]
   -MachineAddress <String>
   [-Name] <String>
   -Sid <String>
   -Uuid <Guid>
   [-ZoneUid <Guid>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

New-ConfigEdgeServer cmdlet creates a new edge server object.

An edge server is a machine which is running an agent service that performs a number of duties; these agent services are largely stateless and communicate back to the Citrix Workspace Cloud components in the cloud.

Examples

EXAMPLE 1

This command creates an edge server

New-ConfigEdgeServer W2K12R2 -MachineAddress "EdgeSrv.address.com" -Sid 21-3623811015-3361044348-30300820
<!--NeedCopy-->

Parameters

-Name

Specifies a name for the edge server.

Each edge server must have a unique name.

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

-MachineAddress

The address used when contacted by local components such as VDAs

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

-Sid

The Security Identifier value in tenant AD domain

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

-Uuid

The uuid used when being contacted from cloud components such as controllers

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

-Description

Optional value to specify a description for the edge server

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

-ZoneUid

Specifies the Zone affinity for the edge server

Type:	Guid
Position:	Named
Default value:	If no value is provided the edge server is placed in the Primary zone
Required:	False
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

None

You cannot pipe input into this cmdlet.

Outputs

Citrix.Configuration.Sdk.EdgeServer

The newly created edge server

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

New-ConfigEdgeServer

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

New-ConfigEdgeServer

Syntax

Description

Examples

EXAMPLE 1

Parameters

-Name

-MachineAddress

-Sid

-Uuid

-Description

-ZoneUid

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Configuration.Sdk.EdgeServer

Related Links

In this article