Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Set-HypAdminConnection

August 9, 2024
Contributed by: 
C

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

Syntax

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

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.

Examples

EXAMPLE 1

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.

Set-HypAdminConnection -AdminAddress myserver.com
<!--NeedCopy-->

Parameters

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

Type: String
Position: Named
Default value: LocalHost. Once a value is provided by any cmdlet, this value becomes the default.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-BearerToken

Specifies the bearer token assigned to the calling user

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

-AdminClientIP

Specifies the client IP of the calling user

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

-TraceParent

Specifies the trace parent assigned for internal diagnostic tracing use

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

-TraceState

Specifies the trace state assigned for internal diagnostic tracing use

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

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 can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Set-HypAdminConnection
August 9, 2024
Contributed by: 
C
August 9, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.