Citrix StoreFront SDK PowerShell Modules

Start-STFServerGroupJoin

November 20, 2023

Contributed by:

Start the Server Group join process

Syntax

Start-STFServerGroupJoin [-AuthorizerHostName] <String> [-Passcode] <String> [<CommonParameters>]

Start-STFServerGroupJoin [-IsAuthorizingServer] <SwitchParameter> [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Start the Server Group join process.

Parameters

Name	Description	Required?	Pipeline Input
AuthorizerHostName	The hostname of the authorizing server	true	false
Passcode	Passcode generated by the authorizing server	true	false
IsAuthorizingServer	This is the authorizing server	true	false

Input Type

System.String

Parameter AuthorizerHostName: The .NET System.String reference type

System.String

Parameter Passcode: The .NET System.String reference type

System.Management.Automation.SwitchParameter

Parameter IsAuthorizingServer: The .NET System.Management.Automation.SwitchParameter value type

Return Values

ClusterPasscodeResponse ClusterResponse

The .NET Citrix.DeliveryServices.ClusterService.Contract.ClusterPasscodeResponse reference type

The .NET Citrix.DeliveryServices.ClusterService.Contract.ClusterResponse reference type

Notes

When executed on a joining server the authorizing server and passcode is required.

Examples

EXAMPLE 1 Authorize a server to join

Start-STFServerGroupJoin -IsAuthorizingServer -Confirm:$false
Write-Host 'Use the Passcode to join to this server'
<!--NeedCopy-->

REMARKS

Starts the join process providing a pass code that can be taken to a ‘joiner’

server so it can join to the authorizing server.

OUTPUT

Passcode
Status StatusMessage
--------
------ -------------
83226368
PasscodeReady Passcode for authorization.

Use the Passcode to join to this server
<!--NeedCopy-->

EXAMPLE 2 Join an authorizing server

Start-STFServerGroupJoin -AuthorizerHostName serverA -Passcode 12345678 -Confirm:$false
<!--NeedCopy-->

REMARKS

Join the authorizing server ‘serverA’ using the passcode 12345678 that was

generated for it.

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

Start-STFServerGroupJoin

November 20, 2023

Contributed by:

November 20, 2023

Contributed by:

Start-STFServerGroupJoin

Syntax

Detailed Description

Related Commands

Parameters

Input Type

System.String

System.String

System.Management.Automation.SwitchParameter

Return Values

ClusterPasscodeResponse ClusterResponse

Notes

Examples

EXAMPLE 1 Authorize a server to join

EXAMPLE 2 Join an authorizing server

In this article