Citrix Hypervisor is an enterprise-class virtualization platform developed by Citrix Systems. It allows organizations to create and manage virtualized environments for running multiple virtual machines (VMs) on a single physical server, thereby optimizing the use of hardware resources.

Prerequisites

  • OpsRamp Classic Gateway 15.0.0 and above.
  • OpsRamp Nextgen Gateway 15.0.0 and above
  • It is recommended to work with the latest Gateway version to full coverage of (Recent bug fixes, enhancements.. etc)
  • Customer need to provide Citrix Hypervisor master host IP address and credentials.
  • The Citrix Hypervisor host device should be reachable from the gateway and port (default port - 443) must be opened. 

Configure Citrix Hypervisor

Click here to Configure and Install the Citrix Hypervisor
  1. To select your client, navigate to All Clients, and click the Client/Partner dropdown menu.
    Note: You may either type your client’s name in the search bar or select your client from the list.
  2. Navigate to Setup > Account. The Account Details screen is displayed.
  3. Click Integrations. The Installed Integrations screen is displayed with all the installed applications.
    Note: If you do not have any installed applications, you will be navigated to the Available Integrations and Apps page with all the available applications along with the newly created application with the version.
  4. Click + ADD on the Installed Integrations page.
    Note: Search for the integration either by entering the name of the integration in the search bar or by selecting the category of the integration from the All Categories dropdown list.
  5. Click ADD in the Citrix Hypervisor application.
  6. In the Configuration screen, click + ADD. The Add Configuration screen appears.
  7. Enter the following BASIC INFORMATION:


Field NameDescriptionField Type
NameEnter the name for the configuration.String
Host Name / IP AddressEnter the Host Name / IP Address of the Citrix Hypervisor. It should be accessible from Gateway.String
Is SecureSelect this checkbox if you want the communication between your system and the specified endpoint to be secured using protocols such as HTTPS (HTTP over SSL/TLS).
Default Selection: When selected, it signifies that the connection is encrypted, providing an added layer of security to the data being transmitted.		Checkbox
PortPort

Example: You can enter 443 as a API port value.		dropdown
Citrix Hypervisor Host CredentialsSelect the credential associated with your Citrix Hypervisor account. If you want to use the existing credentials, select them from the Select Credentials dropdown. Else, click +ADD to create credentials. The SELECT CREDENTIAL window is displayed. Enter the following information.
  • Name: Enter the credential name.
  • Description: Enter the brief description of the credential.
  • User Name: Enter the Username.
  • Password: Enter the password.
  • Confirm Password: Confirm your password
  • Port:Select the port number from the dropdown.
  • Connection Timeout (ms):Specify the connection timeout in milliseconds.
Dropdown
  1. Click ADD
  2. CUSTOM ATTRIBUTES: Custom attributes are the user-defined data fields or properties that can be added to the preexisting attributes to configure the integration.
Field NameDescriptionField Type
Custom AttributeSelect the custom attribute from the dropdown. You can add attributes by clicking the Add icon (+).Dropdown
ValueSelect the value from the dropdown.Dropdown

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

  1. In the RESOURCE TYPE section, select:
    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
  2. In the DISCOVERY SCHEDULE section, select recurrence pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.

Now the configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.
12. Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.
Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.
13. Click NEXT.
14. (Optional) Click +ADD to create a new collector. You can either use the pre-populated name or give the name to your collector.
15. Select an existing registered profile.

  1. Click FINISH.
    The integration is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

Modify Citrix Hypervisor Integration

Click here to Modify the Configuration

Discover Resources in Citrix Hypervisor Integration

Click here to View the Citrix Hypervisor details
  1. Navigate to **Infrastructure > Search > Virtualization > Citrix Hypervisor. The Citrix Hypervisor page is displayed.
  2. Select the application on the Citrix Hypervisor page
  3. The RESOURCE page appears from the right.
  4. Click the ellipsis (…) on the top right and select View Details.
  5. Navigate to the Attributes tab to view the discovery details.

View resource metrics

To confirm Citrix Hypervisor monitoring, review the following:

  • Metric graphs: A graph is plotted for each metric that is enabled in the configuration.
  • Alerts: Alerts are generated for metrics that are configured as defined for integration.
  1. Click the Metrics tab to view the metric details for Citrix Hypervisor.