Citrix Hypervisor

Connecting Citrix Hypervisor to Citrix Cloud

When connecting your Citrix Hypervisor to the Citrix Cloud site, use the Connector Appliance for Cloud Services.

This article guides you through installing a Connector Appliance on a Citrix Hypervisor server. However, you can instead choose to install on any supported hypervisor in that resource location. For more information, see Connector Appliance for Cloud Services.

Best practices

The following best practices ensure continuous availability and enable the connectors to balance the load.

  • For each resource location, install and register two or more Connector Appliances.
  • If possible, install Connector Appliances on a server outside of the Citrix Hypervisor 8 Cloud pool that you are updating through Citrix Cloud.
  • When deploying your Connector Appliances in a Citrix Hypervisor 8 Cloud pool, ensure that the Connector Appliances are installed to shared storage so that they can run on any server in the pool.
  • If you have multiple Citrix Hypervisor 8 Cloud pools in your resource location, install Connector Appliances in each pool for greater redundancy.

Obtain the Connector Appliance

To download the Connector Appliance software from within Citrix Cloud:

  1. Sign in to Citrix Cloud.

  2. From the menu in the top left of the screen, select Resource Locations.

    If you do not already have a resource location, click the plus icon (+) or select Add a Resource Location.

  3. In the resource location where you want to register the Connector Appliance, click the Connector Appliances plus icon (+).

    The Install Connector Appliance task opens.

  4. From the Hypervisor list in Step 1, choose Citrix Hypervisor. Click Download Image.

  5. Review the Citrix End User Service Agreement and, if you agree, select Agree and Continue.

  6. When prompted, save the provided Connector Appliance XVA file.

  7. Keep the Install Connector Appliance task open. After installing the Connector Appliance, you input your registration code into Step 2 of this task.

You can also get to the Install Connector Appliance task from the Connectors page. Select the plus icon (+) to add a connector and choose to add a Connector Appliance.

Install Connector Appliance on your Citrix Hypervisor server

To import the Connector Appliance to a Citrix Hypervisor server by using the Citrix Hypervisor Center.

  1. Connect to your Citrix Hypervisor server or pool by using the Citrix Hypervisor Center on a system that has access to the downloaded Connector Appliance XVA file.

  2. Select File > Import.

  3. Specify or browse to the path where the Connector Appliance XVA file is located. Click Next.

  4. Select the Citrix Hypervisor server where you want to host the Connector Appliance. Alternatively, you can select the pool to host the Connector Appliance in and Citrix Hypervisor chooses a suitable available server. Click Next.

    Ensure that the selected server or pool is in the same resource location as the Citrix Hypervisor pools that you want to administer through Citrix Cloud.

  5. Specify the storage repository to use for your Connector Appliance. Click Import.

  6. Click Add to add a virtual network interface. From the Network list, select the network for the Connector Appliance to use. Click Next.

  7. Review the options to use to deploy the Connector Appliance. If any are incorrect, use Previous to change these options.

  8. Ensure that Start the new VM(s) automatically as soon as the import is complete is selected. Click Finish.

After the Connector Appliance is deployed and has successfully started up, its console displays a landing page that contains the Connector Appliance IP address. Use this IP address to connect to the Connector Appliance and continue the installation process.

Register your Connector Appliance with Citrix Cloud

Register a Connector Appliance with Citrix Cloud to provide a channel for communication between Citrix Cloud and the resource location that contains your Citrix Hypervisor servers.

After you install your Connector Appliance on a Citrix Hypervisor server and start it, the appliance console displays the IP address of the Connector Appliance. The console also displays an SSL fingerprint that you can use to validate your connection to the Connector Appliance UI.

  1. Copy the Connector Appliance IP address to your browser address bar.

    The Connector Appliance administration page uses a self-signed certificate. As a result, you might see a message about the connection not being secure. To verify the connection to your Connector Appliance, you can compare the SSL fingerprint in the console with the fingerprint the browser receives from the webpage.

    For example, in the Google Chrome browser, complete the following steps:

    1. Click the Not Secure marker next to the address bar.
    2. Select Certificate. The Certificate window opens.
    3. Go to the Details tab and find the Thumbprint field.

    If the value of the Thumbprint field matches the SSL fingerprint in the console, you can confirm that your browser is connecting directly to the Connector Appliance administration page.

  2. If your browser requires an extra step to confirm that you want to continue to the site, complete this step now.

    The Create new password webpage opens.

  3. Create a password for your Connector Appliance administration page and click Set password.

    The password you set must meet the following requirements:

    • 8 or more characters long
    • Contains both upper and lower case letters
    • Contains at least one non-alphabetic character
    • Ensure that you store this password in a safe place for future use.
  4. Sign in with the password you set.

    The Register your Connector with Citrix Cloud webpage opens.

  5. Important: Do not add a proxy to your connector. Proxies are not supported with this preview.

  6. Click Register Connector to open the registration task.

  7. Choose a name for your Connector Appliance. This name can help you distinguish between the various Connector Appliances that exist in your resource location. After you register your Connector Appliance, the name cannot be changed.

  8. Enter the name in the Connector Appliance name field and click Next.

    The webpage provides a code to use to register with Citrix Cloud. This code expires in 15 minutes.

  9. Use the Copy button to copy the code to the clipboard.

  10. Return to the Resource Locations webpage on the Citrix Cloud site.

  11. Paste the code into Step 2 of the Install Connector Appliance task. Click Confirm Details.

    Citrix Cloud verifies that the Connector Appliance is present and can be contacted. If the registration code has expired, you are prompted to generate a new code.

  12. Click Register.

    The page shows whether the registration was successful. If the registration failed, you are prompted to try again.

  13. Click Close.

The Connector Appliance administration page also enables you to take other actions for the Connector Appliance. For more information, see Connector Appliance for Cloud Services.

Verify that your Connector Appliance is ready

After your Connector Appliance is installed and registered, it takes several minutes for the Connector Appliance to ensure that it is up to date and to set up all the required features.

To verify that the Connector Appliance is ready to be used, you can check in the following locations:

  • The Connector Appliance administration page shows a green check mark next to the Registered with Citrix Cloud text when the Connector Appliance is ready to use.
  • In Citrix Cloud, go to Resource Locations > Connectors. This page shows a green bar next to a Connector Appliance that is ready to use.

If you attempt to add your pool to the Hypervisor Management service before the Connector Appliances are ready, you might experience an error.

Next Steps

  1. For each resource location, we advise that you install and register two or more Connector Appliances. This configuration ensures continuous availability and enables the connectors to balance the load. Repeat the steps in Install Connector Appliance on your Citrix Hypervisor server and Register your Connector Appliance with Citrix Cloud to set up more connectors.

  2. Log in to Citrix Cloud and request access to the Hypervisor Management service preview. In My Services, locate Hypervisor Management and click Request Trial.

  3. Use the Citrix Cloud Hypervisor Management service to add pools and administer updates to them. For more information, see Administering from Citrix Cloud.

Connecting Citrix Hypervisor to Citrix Cloud