Citrix Virtual Apps and Desktops SDK

Set-HypAdminConnection

July 4, 2023

Contributed by:

Set the controller to be used by the cmdlets that form the Host service PowerShell snap-in.

Syntax

Set-HypAdminConnection [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Use this command to set the default controller address to be used by the cmdlets to communicate with the controller. Most Host service cmdlets take an ‘AdminAddress’ parameter that can be used to define the controller (when used, this overrides this setting). However, the Set-Location cmdlet in the Host service provider does not offer this option. Therefore, the controller address must be set using this cmdlet, if no other cmdlets have set the address previously in the current runspace.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
AdminAddress	Specifies the address of a XenDesktop controller to which the PowerShell snap-in connects. 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.
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

Input Type

Return Values

Examples

Example 1

c:\PS>Set-HypAdminConnection -AdminAddress myserver.com

<!--NeedCopy-->

Description

This command sets the controller address for the commands to be “myserver.com”. All commands run use this address until it is altered, either by another call to this command or by the use of the ‘AdminAddress’ parameter in another command in the Host service snap-in.

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

Set-HypAdminConnection

July 4, 2023

Contributed by:

July 4, 2023

Contributed by:

Set-HypAdminConnection

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Examples

Example 1

Description

In this article