Citrix Virtual Apps and Desktops

Connection to Amulet Hotkey CoreStation (Preview)

Create and manage connections and resources describes the general wizards for creating a connection. The following information covers details specific to Amulet Hotkey CoreStation. You can currently create a connection to the Amulet Hotkey CoreStation using PowerShell commands.

Note:

Before creating a connection to Amulet Hotkey CoreStation, you need to first finish setting up your Amulet Hotkey CoreStation account.

Create a connection

You can create a connection to the Amulet Hotkey CoreStation using PowerShell commands.

When you create a connection using PowerShell command, provide the following information:

  • IP: Amulet Hotkey CoreStation IP Address
  • Username: Amulet Hotkey CoreStation username
  • Password: Amulet Hotkey CoreStation password

Example:

Get-ConfigZone
Get-HypHypervisorPlugin
New-Item `
    -ConnectionType "Custom" `
    -HypervisorAddress $IP `
    -Metadata @{"Citrix_Orchestration_Hypervisor_Secret_Allow_Edit"="false"} `
    -Path @("XDHyp:\Connections\$connectionName") `
    -Persist `
    -PluginId "AmuletHotkeyCoreStationFactory" `
    -Scope @() `
    -SecurePassword $Password `
    -UserName $UserName `
    -ZoneUid $ZoneUid `
    -SslThumbprint $SslThumbprint
New-BrokerHypervisorConnection -HypHypervisorConnectionUid $HypervisorConnectionID
<!--NeedCopy-->

Note:

The -SslThumbprint parameter is required only for private CA-signed certificates.

Certificate and thumbprint validation

For creating a successful connection to Amulet Hotkey CoreStation, the certificate must not have errors and the thumbprint must have a correct value. Following are the use cases related to the certificate and thumbprint validation:

  • Public CA-signed certificate has errors. The connection is not created successfully. See the error details and resolve the issue.
  • Public CA-signed certificate without errors. The connection is created successfully, and the SslThumbprints value is Null.
  • Private CA-signed certificate without errors and a sslthumbprint value. The connection is created successfully with a correct SslThumbprints value.
  • Private CA-signed Certificate with an incorrect thumbprint value. The connection is not created successfully.
  • Private CA-signed Certificate without errors. The connection is created successfully. The SSlThumbprints is Null when creating the connection. The SSlThumbprints value is updated to a value by the site service.

Manage connections

Fix certificate issues

Citrix Virtual Apps and Desktops blocks an Amulet Hotkey CoreStation connection when certificate issues arise, preventing you from delivering and managing workloads on associated Amulet Hotkey CoreStation nodes. You’ll see an error icon next to the connection in the Host connections list.

See the following table for specific issues and solutions.

Issue solution
A certificate error occurs to the public CA-signed certificate. Click the connection and select the Troubleshoot tab. View the error details and resolve the issue.
The received certificate is private CA-signed or expired.




Edit the host connection to update the certificate thumbprint. Details steps:
  1. Select the connection and click Edit Connection.
  2. On the Connection Properties page, click Edit settings.
  3. Enter the password to connect to the Amulet Hotkey CoreStation enclosure, and then click Save.
  4. On the Warning page that appears, compare the received thumbprint with the server’s for certificate validity.
  5. If they are the same, select Trust certificate and then click OK.

Update thumbprint value

After creating the connection, you can update the thumbprint value of a connection using the Set-Item PowerShell command. Follow the steps to update the thumbprint value.

  1. Get the connection details of a connection. For example:

    Get-Item -LiteralPath xdhyp:\connections\AmuletCon-101
    <!--NeedCopy-->
    
  2. Update the thumbprint value. For example:

    Set-Item -LiteralPath xdhyp:\connections\AmuletCon-101 -Username Administrator -SslThumbprint xxxxxxxxxxx12AD048480631BB7AB10D69xxxxx
    <!--NeedCopy-->
    
  3. Check the updated thumbprint value. For example:

    Get-Item -LiteralPath xdhyp:\connections\AmuletCon-101
    <!--NeedCopy-->
    

Note:

The update fails if you provide an incorrect thumbprint value in the Set-Item command.

Where to go next

More information

Connection to Amulet Hotkey CoreStation (Preview)