Citrix Virtual Apps and Desktops SDK

New-Configedgeserver

August 3, 2023

Contributed by:

Creates a new edge server object

Syntax

New-ConfigEdgeServer [-Name] <String> -MachineAddress <String> -Sid <String> -Uuid <Guid> [-Description <String>] [-ZoneUid <Guid>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed 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.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Name	Specifies a name for the edge server. Each edge server must have a unique name.	true	true (ByPropertyName)
MachineAddress	The address used when contacted by local components such as VDAs	true	true (ByPropertyName)
Sid	The Security Identifier value in tenant AD domain	true	true (ByPropertyName)
Uuid	The uuid used when being contacted from cloud components such as controllers	true	true (ByPropertyName)
Description	Optional value to specify a description for the edge server	false	true (ByPropertyName)
ZoneUid	Specifies the Zone affinity for the edge server	false	true (ByPropertyName)	If no value is provided the edge server is placed in the Primary zone
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.	false	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

None

You cannot pipe input into this cmdlet.

Return Values

Citrix.Configuration.Sdk.Edgeserver

The newly created edge server

Examples

Example 1

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

Description

This command creates an 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 3, 2023

Contributed by:

August 3, 2023

Contributed by:

New-Configedgeserver

Syntax

Detailed Description

Related Commands

Parameters

Input Type

None

Return Values

Citrix.Configuration.Sdk.Edgeserver

Examples

Example 1

Description

In this article