Configure the Citrix XenServer connector

The Snow Integration Connector for Citrix XenServer is configured in Snow Integration Manager (SIM). For more information on SIM, refer to Snow Integration Manager.

Citrix XenServer

The Citrix XenServer connector uses an API connection.

  1. Enter a Site name for this collection of XenServer servers.

    xenserver_1.png
  2. To add one or more XenServer servers to scan for virtual machines, select Add.

    The Citrix XenServer dialog box appears.

    xenserver_2.png
  3. Enter the Name of the server.

  4. To use the typed name of the server instead of the default name, select the Use this name as datacenter name checkbox.

  5. Select whether HyperThreading is enabled on the hosts to ensure that correct processor core count is reported to Snow License Manager.

  6. Enter IP address, Port, User account, and Password to access the server.

    XenServer uses port 80 by default, so use that port on a default installation.

  7. To verify the connection, select Test.

  8. Select OK to save settings and close the Citrix XenServer dialog box.

  9. Select OK to save the settings.

To configure the Citrix XenServer connector for a scenario where the Pool Master is changed regularly; add all XenServer hosts, use the same Name for all hosts, and select the Use this name as datacenter name checkbox for all hosts.

When SIM goes through the list of hosts, it will only collect information from the current Pool Master.

XenServer Tools

The connector will be able to extract more information from virtual machines with XenServer Tools installed. Install XenServer Tools on all VMs to retrieve the maximum amount of information.

Hosts and virtual machines

If a VM is not running, it is not necessarily associated with any host. It is only when a VM is running that a host is defined. This means that a VM that is not running may in fact be associated with *no* host.

When the connector is trying to figure out which host a VM is associated with, the following logic is used:

  1. If the VM is running, the host is known and we use that.

  2. If the VM is not running, the host is inferred by the VM's affinity field (the preferred starting host).

  3. If the host could not be inferred, the VM is ignored.

XenServer connector and SSL

Configure the connector to communicate over HTTPS by specifying port 443 in the server settings.

A default XenServer installation uses a self-signed certificate for TLS/SSL.

To make the connector work over HTTPS, either replace the default certificate with one from a trusted certificate authority, or add XenServer’s self-signed certificate to the client machine’s trusted certificate store. For information on how to replace XenServer’s default certificate, refer to the XenServer documentation.

To trust the self-signed certificate, perform the following steps on the machine that the connector is running on:

  1. Start Internet Explorer using the running as administrator option.

  2. Navigate to the XenServer over HTTPS.

  3. If this warning is displayed, XenServer is not using a trusted certificate.

    CitrixXenServerCert1.png
  4. Select Continue to this website.

  5. Select the Security report icon in the URL, and then select View certificates.

    CitrixXenServerCert2.png
  6. In the Certificate dialog, select Install Certificate...

    CitrixXenServerCert3.png
  7. The Certificate Import Wizard is started.

    CitrixXenServerCert4.png
  8. Select Local Machine, and then select Next.

  9. Select Place all certificates in the following store.

    CitrixXenServerCert5.png
  10. Select Browse, and then select Trusted Root Certification Authorities.

    Select OK.

  11. Select Next.

  12. Select Finish to start the import.

    CitrixXenServerCert6.png
  13. A message box should be displayed informing that the import was successful.

  14. Restart Internet Explorer and verify that it is possible to navigate to the XenServer over HTTPS without getting a certificate warning.

Import Servers

The feature to import servers for the Citrix XenServer connector is introduced in Snow Integration Manager 5.17.

The Connector Configuration window displays the option in the Import CSV file section.

  1. Select your preferred Import mode.

    Note

    Import modes are described in detail below.

  2. Select Skip Header if you do not want to import the first line in the CSV file.

  3. Select Import.

  4. Select a file with the .csv extension.

    The list of servers that is displayed in Snow Integration Manager will be populated by servers from the CSV file.

    Note

    File-format constraints are given in the File format section below.

  5. Select OK to save the changes and complete the import.

File format

To import servers, a CSV file must be used and contain the following columns:

Column name

Accepted value

Example

Pool Name

text

Name of the pool 1

Pool name as datacenter name

Boolean (True or False)

True

IP address

IP address

10.12.124.23

Port

number

8800

Username

text

admin

Password

text

pass1

Hyperthreading enabled

Boolean (True or False)

False

Rules:

  • The columns must be in the following order, with an example row beneath the header in the following table:

    Pool Name

    Pool name as datacenter name

    IP address

    Port

    Username

    Password

    Hyperthreading enabled

    Name of the pool 1

    True

    10.12.124.23

    8800

    admin

    pass1

    False

  • Enter only one server per line

  • Data fields must be separated by a comma

  • Values can be omitted in the CSV file, but commas must still be used.

    Example row for a line where the IP address is omitted:

    Name of the pool 1, True,,8800,admin, pass1, False

  • Commas can be used as values and must then be enclosed in double quotation marks. For example, a row where the password pass,1 is used:

    Name of the pool 1, True, 10.12.124.23, 8800, admin, "pass,1", False

  • A double quotation mark can be used as value if another double quotation mark is written next to it and the entire value is enclosed in quotation marks. For example, a row where the password pass"1 is used:

    Name of the pool 1, True, 10.12.124.23, 8800, admin, "pass""1", False

    Note

    If Microsoft Excel is used to produce a CSV file, the resulting file should contain double quotation marks and commas as per our rules.

Import options

There are two import options available: Skip Header and Import Mode.

If the Skip Header checkbox is selected, the first line of the CSV file will be ignored. Use this option if the CSV file contains a header row with column names. Do not use this option if the CSV does not contain a header row.

Import Mode specifies how servers will be imported in relation to servers that already exist in Snow Integration Manager. One of three options can be chosen:

  • Append

    This option adds servers from the CSV file to the list of servers in Snow Integration Manager. Servers are not removed by use of this option.

  • Overwrite

    This option removes all servers from Snow Integration Manager before adding servers from the CSV file.

  • Update

    This option attempts to update the existing server list by matching existing servers with servers that are found in the CSV file. Servers are matched by the IP address field. If new servers are found in the CSV file, they will be added to the existing server list.

    Servers are not removed by use of this option.

    Note

    When Update mode is used, pool names for servers must be unique.