Developer Documentation
Citrix Daas SDK

Get-HypServerAddressDetails

November 28, 2023
Contributed by: 
C

Gets all the available addresses for a hypervisor connection.

Syntax

Get-HypServerAddressDetails
   [-LiteralPath] <String>
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Use this cmdlet to retrieve all the available hypervisor connection addresses that can be used to connect to the same Server pool. When used in conjunction with Add-HypHypervisorAddress, you can easily populate a connection with all the addresses that can be used to provide full failover support for a Server connection.

If the addresses are https addresses, the command uses the certificates installed on the Servers to provide https addresses along with thumbprints and pem certs.

Examples

EXAMPLE 1

Gets the available addresses for the connection “MyConnection”.

Get-HypServerAddressDetails -LiteralPath XDHyp:\Connections\MyConnection

https:\\myserver.com
https:\\myServer1.com
<!--NeedCopy-->

EXAMPLE 2

Adds all the available addresses for the Server pool in “MyConnection” to the hypervisor connection.

Get-HypServerAddressDetails -LiteralPath XDHyp:\Connections\MyConnection | Add-HypHypervisorConnectionAddress -LiteralPath XDHyp:\Connections\MyConnectionPath
<!--NeedCopy-->

Parameters

-LiteralPath

Specifies the path within a Host Service provider to the hypervisor connection item to which to add the address. The path specified must be in one of the following formats:

<drive>:\Connections\<HypervisorConnectionName>

or <drive>:\Connections{HHypervisorConnection Uid>}

Type: String
Position: 1
Default value: None
Required: True
Accept pipeline input: True (ByValue)
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 can’t pipe objects to this cmdlet.

Outputs

HypervisorHostDetails

Get-HypServerAddressDetails returns a list of strings containing the available address and their certs/tumbprint info.

Notes

For this to work as required with https connections, the certificates installed on the Servers must be trusted by all controllers. Typically this means having the root certificate for the certificate trust chain installed on all controllers.

In the case of failure, the following errors can result.

Error Codes

InputConnectionsPathInvalid

The path provided is not to an item in a sub-directory of a hosting unit item.

SupportsEnumerateHypervisorHostDetailsCapabilityMissing

The hypervisor is missing EnumerateHypervisorHostDetailsCapability.

HypervisorConnectionObjectNotFound

The hypervisor connection at the path specified cannot be located.

HypervisorInMaintenanceMode

The hypervisor for the connection is in maintenance mode.

DatabaseError

An error occurred in the service while attempting a database operation.

DatabaseNotConfigured

The operation could not be completed because the database for the service is not configured.

DataStoreException

An error occurred in the service while attempting a database operation - communication with the database failed for

various reasons.

CommunicationError

An error occurred while communicating with the service.

InvalidFilter

A filtering expression was supplied that could not be interpreted for this cmdlet.

ExceptionThrown

An unexpected error occurred. For more details, see the Windows event logs on the controller being used or examine the Desktop logs.

Get-HypServerAddressDetails
November 28, 2023
Contributed by: 
C
November 28, 2023
Contributed by: 
C

In this article

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