vRealize Operations (vROps) Management Pack for Citrix XenDesktop Installation & Configuration Guide

vRealize Operations Management Pack for Citrix XenDesktop

Installation & Configuration Guide

NOTE: This document supports the version of each product listed, as well as all subsequent versions until a new edition replaces it.

To check for more recent editions of this document,

visit http://support.bluemedora.com.

vRealize Operations Management Pack for Citrix XenDesktop Installation & Configuration Guide

Copyright © 2015 Blue Medora LLC. All rights reserved. 2

You can find the most up-to-date technical documentation on the Blue Medora support site at: http://support.bluemedora.com

The Blue Medora web site also provides the latest product updates. If you have comments about this documentation, submit your feedback to: [email protected]

Copyright © 2015 Blue Medora LLC. All rights reserved. U.S. and international copyright and intellectual property laws protect this product.

Blue Medora is a registered trademark or trademark of Blue Medora LLC in the United States and/or other jurisdictions.

The Citrix name (including Citrix XenDesktop) and logo are trademarks or registered trademarks of Cisco Systems, Inc. in the United States and/or other jurisdictions.

All other marks and names mentioned herein may be trademarks of their respective companies.

Blue Medora LLC 3225 N Evergreen Dr. NE STE 103 Grand Rapids, MI 49525 www.bluemedora.com



Table of Contents

1 vRealize Operations Management Pack for Citrix XenDesktop Installation & Configuration Guide ...............................................................................................................4

1.1 Intended Audience............................................................................................................... 4

2 Revision Notes..........................................................................................................................4

3 Installation and Configuration Requirements .......................................................................5 3.1 vCenter Operations (vCOps)/vRealize Operations (vROps) Requirements................... 5 3.2 Citrix XenDesktop Compatibility Requirements ................................................................. 5 3.3 vCenter Adapter Requirement............................................................................................ 5

4 Licensing Requirements..........................................................................................................5

5 Installing the Adapter..............................................................................................................6 5.1 Install the Adapter ................................................................................................................. 6

5.1.1 Prerequisites ................................................................................................................................. 6 5.1.2 Procedure .................................................................................................................................... 7

5.2 License the Management Pack .......................................................................................... 9

6 Configuring the Adapter.......................................................................................................10 6.1 Overview of Configuration Steps....................................................................................... 10 6.2 Add a Credential ................................................................................................................ 10

6.2.1 Prerequisites ............................................................................................................................... 11 6.2.2 Procedure .................................................................................................................................. 11

6.3 Add an Adapter Instance .................................................................................................. 12 6.3.1 Prerequisites ............................................................................................................................... 12 6.3.2 Procedure .................................................................................................................................. 12 6.3.3 What to do next ........................................................................................................................ 14

6.4 Manually Discover Resources ............................................................................................ 14 6.4.1 Prerequisites ............................................................................................................................... 14 6.4.2 Procedure .................................................................................................................................. 14 6.4.3 What to do next ........................................................................................................................ 18

6.5 Configure the Properties File .............................................................................................. 18 6.6 Validate Data Collection ................................................................................................... 19

6.6.1 Prerequisites ............................................................................................................................... 19 6.6.2 Procedure .................................................................................................................................. 19

7 Appendix I: Adapter Folders and Files ................................................................................20



1 vRealize Operations Management Pack for Citrix XenDesktop

Installation & Configuration Guide The vRealize Operations Management Pack for Citrix XenDesktop Installation and Configuration Guide describes how to install and configure the Citrix XenDesktop Management Pack for vCenter/vRealize Operations.

1.1 Intended Audience This information is intended for anyone who needs to install and configure the vRealize Management Pack for Citrix XenDesktop.

2 Revision Notes This guide is updated with each release of the product, or when necessary. The following table provides its revision history.

Revision Date Description REV-01 2015-APR-03 Initial version.



3 Installation and Configuration Requirements Before installing and configuring the Citrix XenDesktop adapter, ensure your system meets the following installation and configuration requirements:

3.1 vCenter Operations (vCOps)/vRealize Operations (vROps) Requirements The Citrix XenDesktop adapter is compatible with:

vCenter Operations (vCOps) 5.8+

vRealize Operations (vROps) 6.x.

3.2 Citrix XenDesktop Compatibility Requirements The Citrix XenDesktop adapter supports Citrix XenDesktop 7.6.

The applicable Citrix Receiver user name, password, and domain will be required to add a credential.

3.3 vCenter Adapter Requirement If using vCenter Operations version 5.8+, in order to connect to VMware, the vCenter adapter must be installed and configured before installing the Citrix XenDesktop adapter. Refer to VMware online help for instructions.

NOTE: The vCenter adapter is installed by default when using vRealize Operations.

4 Licensing Requirements A license key will be provided when the adapter is purchased and must be added as a Citrix XenDesktop License within vCOps/vROps before the Management Pack can be configured and used. Refer to section 5.2, License the Management Pack, for details.



5 Installing the Adapter This section includes the following topics:

Install the Adapter

License the Management Pack

5.1 Install the Adapter The Citrix XenDesktop adapter is installed using a .pak file.

5.1.1 Prerequisites Obtain the management pack installation file from

http://www.bluemedora.com/vcops-trials.

Make a note of the build number in the .pak file name. The build number appears after the adapter name, for example: CitrixXenDesktopAdapter-1.0.pak.

Read the release notes that are included with the .pak file.

Back up any of our out-of-the box dashboards that have been customized, as they will be overwritten.



5.1.2 Procedure

1. Save the .pak file in a temporary folder.

2. Log in to vROps as the admin user.

3. Click the Home icon, then select the Administration navigation shortcut from the panel on the left (refer to Figure-1 below).

Figure-1. Home Administration

4. In the right panel, the Solutions tab will be displayed (refer to Figure-2

below).

Figure-2. Solutions tab



5. Click the Add icon ( ) to upload the .pak file to the vCOps/vROps server. In the dialog that appears (refer to Figure-3 below), browse to the location of the saved .pak file, then click Upload.

NOTE: The .pak file upload may take several minutes to complete. Status information appears in the Installation Details text box throughout the installation process.

Figure-3. Select the .pak file to upload

6. Click the Next button when the upload has finished. Read the End User License Agreement (EULA) and click the I accept the terms of this agreement checkbox to accept, then click the Next button.

7. Click the Finish button when the installation process is complete.

NOTE: The installation utility creates the citrix_xendesktop_adapter folder and citrix_xendesktop_adapter.jar file in the $ALIVE_BASE/user/plugins/inbound folder. Refer to Appendix 1, Adapter Folders and Files, for more information.



5.2 License the Management Pack The Management Pack requires a valid license for full operation. Complete the following steps to license the Management Pack.

NOTE: You must have a valid license key before you can begin the licensing process.

1. Log on to the vCenter Operations Manager Analytics Virtual Machine.

2. Navigate to: %ALIVE_BASE/user/plugins/inbound/Citrix_XenDesktop_adapter3/conf/

cd /usr/lib/vmware-vcops/user/plugins/inbound/Citrix_XenDesktop_adapter3/conf

3. In a text editor, edit the license.properties file to include the license key.

vi license.properties

NOTE: The License file is a java properties file, and the format should be similar to what you see above. There should be no spaces in the file, before, after, or in, the key.

4. Make sure that license.properties is readable and writeable by user admin and group admin. To do this you can use the following commands:

chmod 644 license.properties

chown admin:admin license.properties

NOTE: This should be the default vCOPs administrative user, but since many administrators ssh into a system via root or some other administrative user in order to manage the system, the permissions for this file are often incorrect.



6 Configuring the Adapter

To configure the Citrix XenDesktop adapter, you must add a credential and an adapter instance in vCOps/vROps. Depending on your configuration, you might need to perform additional steps.

This chapter includes the following topics:

Overview of Configuration Steps

Add a Credential

Add an Adapter Instance

Manually Discover Resources

Configure the Properties File

Validate Data Collection

6.1 Overview of Configuration Steps Configuring the adapter involves several steps:

1. Adding an adapter credential and instance.

2. Manually discovering resources if autodiscovery wasn’t selected when adding the adapter instance.

3. Configuring the properties file to customize sync intervals, etc. according to your preferences.

4. Validating the data collected by the adapter.

6.2 Add a Credential The Citrix XenDesktop adapter uses a user name, password, and domain to connect to the OpenData (OData) API on the specified Delivery Controller. You will need this information to create a credential for the adapter instance in vROps.

You can add the credential before you create the adapter instance and select the correct credential when you define the adapter instance, or you can add the credential when you define the adapter instance.



6.2.1 Prerequisites Install the Citrix XenDesktop adapter. Refer to section 5.1, Install the

Adapter, for details.

Ensure you have the correct OData user name, password, and domain available.

6.2.2 Procedure 1. Log in to vCOps/vROps as an administrator.

2. Click on the Administration navigation shortcut ( )

3. Click on Credentials in the navigator pane.

4. Click the Add icon ( ).

Figure-6. Manage Credential

5. In the Manage Credentials dialog that appears:

Select Citrix XenDesktop from the Adapter Type drop-down menu

Select XenDesktop Credentials from the Credential Kind drop-down menu

Type an appropriate name for the credential instance in the Credential name text box

Enter the OData user name, password, and domain

Click OK to add the credential for the XenDesktop adapter instance



6.3 Add an Adapter Instance You must create an adapter instance for the Citrix XenDesktop adapter. The adapter instance defines the adapter type and identifies the XenDesktop site from which the adapter instance retrieves data.

NOTE: If your environment is configured to support multiple sites, and they are monitored by vROps, you must create an adapter instance for each individual site.

6.3.1 Prerequisites Install the Citrix XenDesktop adapter. Refer to section 5.1, Install the

Adapter, for details.

Create a credential, or, if you plan to create a credential when you add the adapter instance, become familiar with creating credentials. Refer to section 6.2, Add a Credential, for details.


2. Click on the Administration navigation shortcut ( ). The Solutions view should automatically open.

3. Select the Citrix XenDesktop Adapter from the Solutions list.

Figure-7. Solutions List

4. Click the Configure (gear) icon ( ). The following dialog will appear.

NOTE: If adding multiple adapter instances, click the Add icon ( ) above the list of Instance Names on the left to add additional instances.



Figure-8. Adapter Settings

5. Enter/select the following information under Adapter, Basic, and Advanced Settings:

Display Name (name of the Adapter instance) Description (optional)

Delivery Controller

Site Name

Credential for signing into the data source (should be selectable if previously added; otherwise click Add ( ) to add a new credential)

Support Autodiscovery option

Click Save Settings to save your configuration.



NOTE: For the Support Autodiscovery option, if you select True, the adapter instance creates XenDesktop resources for you. If you select False, you must manually discover XenDesktop resources. The default setting is True.

6.3.3 What to do next If you set the Autodiscovery option to False, you’ll have to manually discover Citrix XenDesktop resources as described in the next section.

6.4 Manually Discover Resources With manual discovery, the Citrix XenDesktop adapter sends a request to the Delivery Controller to return resources, and you then select the resources to import into vCOps/vROps. The discovery mode that you configure determines whether the adapter imports only the selected resource, or the selected resource and all of its child resources.

6.4.1 Prerequisites Create a Citrix XenDesktop adapter instance. Refer to section 6.3, Add an Adapter Instance, for details.


2. Click the Administration navigation shortcut ( ).

3. Click Environment Overview from the navigator view.



Figure-9. Manually Discover Resources

4. Under Adapter Instances, select Citrix XenDesktop.

5. Click the Discover Resources icon ( ) to open the Discover Objects window.



Figure-10. Discover Objects

6. In the Discover Objects window, select the following information from the drop-down menus:

The Collector to use

NOTE: Unless you added additional collectors, the only available collector is your vCOps/vROps server.

Citrix XenDesktop Adapter for Adapter Type

The applicable Adapter Instance

Basic Discovery for Discovery Info

The Resource Kind(s) to discover

Whether Only New Objects (checkbox) should be collected



7. Click OK to start the discovery process.

8. The discovery process can take several seconds to several minutes. When it has finished, the Discovery Results window lists your resources as shown.

Figure-11. Discovery Results

9. Double-click each resource kind that contains resources to add.

10. Select options for each kind of resource (Refer to Table-1).



Table-1. Resource Options

Option Description Import Import the resources but do not start collecting data. Resources appear in the

resource list as Not Collecting and data is not stored and analysis is not performed.

Collect Import the resources and start collecting data. When you select the Collect check box, the Import check box is also selected.

11. Click OK. The Discovery Results window closes and the new resources appear

on the List tab.

6.4.3 What to do next If you did not select the option to start metric collection when you defined a resource, you can start metric collection after the resource is defined. To start collecting metrics for a resource, click the Start Collecting ( ) icon.

6.5 Configure the Properties File There are three (3) “settings” embedded within the adapter’s properties file that can be modified to configure the adapter for your particular preferences.

The following settings can be found in the xendesktop.properties file within the xendesktop_adapter/conf/ folder. You can modify the entries in the file itself, re-save the file, and they will be read in during the next collection.

create_relationship_between_applications_and_machines_in_the_same_delivery_group=true

Description: The XenDesktop platform does not create a relationship between Applications and Machines within the OData model, but this visual convenience is added when the property is set to true (default).

relationship_sync_interval=10

Description: On the adapter instance, you can set a collection interval (of how often the adapter instance queries the monitored target). Many resource relationships tend to “bog down” vCOps/vROps, so you can opt to only collect relationships every 10 collections (for example).

parallelize_odata_calls=true

Description: This setting allows for a quicker return on data calls. The default setting is true.



6.6 Validate Data Collection After you add a Citrix XenDesktop adapter instance, validate the data that the adapter collects in vCOps/vROps.

6.6.1 Prerequisites Add a XenDesktop adapter instance. Refer to section 6.3, Add an Adapter Instance, for details.

6.6.2 Procedure 1. Select the Environment Overview shortcut.

NOTE: If you enabled Auto Discovery for the adapter instance, the adapter creates resources as soon as it begins collecting metrics. If you disabled Auto Discovery for the adapter instance, you must discover resources manually.

2. Under Inventory Trees, select All Objects, then expand the Citrix XenDesktop objects list.

Figure-12. Citrix XenDesktop Objects



| |-- open_source_license.txt | |-- reskndmetrics | | |-- XenDesktop-Application-Connection-Summary.xml | | |-- XenDesktop-Application-Instance-Summary.xml | | |-- XenDesktop-Application-Resource-Information.xml | | |-- XenDesktop-Application-Session-Connection-State-Count-Summary.xml | | |-- XenDesktop-Catalog-Connection-Summary.xml | | |-- XenDesktop-Catalog-Load-Index-Summary.xml | | |-- XenDesktop-Catalog-Resource-Information.xml | | |-- XenDesktop-Catalog-Session-Connection-State-Count-Summary.xml | | |-- XenDesktop-Catalog-Session-Count-Summary.xml | | |-- XenDesktop-Delivery-Group-Connection-Summary.xml | | |-- XenDesktop-Delivery-Group-Load-Index-Summary.xml | | |-- XenDesktop-Delivery-Group-Resource-Information.xml | | |-- XenDesktop-Delivery-Group-Session-Connection-State-Count-Summary.xml | | |-- XenDesktop-Delivery-Group-Session-Count-Summary.xml | | |-- XenDesktop-Desktop-Connection-Summary.xml | | |-- XenDesktop-Desktop-Instance-Summary.xml | | |-- XenDesktop-Desktop-Resource-Information.xml | | |-- XenDesktop-Desktop-Session-Connection-State-Count-Summary.xml | | |-- XenDesktop-Hypervisor-Connection-Summary.xml | | |-- XenDesktop-Hypervisor-Load-Index-Summary.xml | | |-- XenDesktop-Hypervisor-Resource-Information.xml | | |-- XenDesktop-Hypervisor-Session-Connection-State-Count-Summary.xml | | |-- XenDesktop-Hypervisor-Session-Count-Summary.xml | | |-- XenDesktop-Site-Connection-Summary.xml | | |-- XenDesktop-Site-Load-Index-Summary.xml | | |-- XenDesktop-Site-Overview.xml | | |-- XenDesktop-Site-Session-Connection-State-Count-Summary.xml | | |-- XenDesktop-Site-Session-Count-Summary.xml | | |-- XenDesktop-VDA-Machine-Connection-Summary.xml | | |-- XenDesktop-VDA-Machine-Health.xml | | |-- XenDesktop-VDA-Machine-Load-Index-Summary.xml | | |-- XenDesktop-VDA-Machine-Resource-Information.xml | | |-- XenDesktop-VDA-Machine-Session-Connection-State-Count-Summary.xml | | |-- XenDesktop-VDA-Machine-Session-Count-Summary.xml | | |-- XenDesktop-VMware-Datastore-Health.xml | | `-- XenDesktop-VMware-VM-Health.xml | |-- scripts | | `-- allVMs.sdm | |-- version.txt | `-- xendesktop.properties `-- lib |-- com.fasterxml-aalto-xml-0.9.9.jar |-- com.fasterxml.jackson.core-jackson-annotations-2.4.2.jar |-- com.fasterxml.jackson.core-jackson-core-2.4.2.jar |-- com.fasterxml.jackson.core-jackson-databind-2.4.2.jar |-- com.fasterxml.jackson.dataformat-jackson-dataformat-xml-2.4.2.jar |-- com.fasterxml.jackson.module-jackson-module-jaxb-annotations-2.4.2.jar |-- commons-codec-commons-codec-1.9.jar



|-- commons-io-commons-io-2.4.jar |-- commons-logging-commons-logging-1.2.jar |-- guava-18.0.jar |-- joda-time-1.4.jar |-- jruby-core-1.7.19.jar |-- jruby-stdlib-1.7.19.jar |-- org.apache.commons-commons-lang3-3.3.2.jar |-- org.apache.httpcomponents-httpclient-4.2.6.jar |-- org.apache.httpcomponents-httpcore-4.2.5.jar |-- org.apache.olingo-odata-client-api-4.0.0-beta-01.jar |-- org.apache.olingo-odata-client-core-4.0.0-beta-01.jar |-- org.apache.olingo-odata-client-proxy-4.0.0-beta-01.jar |-- org.apache.olingo-odata-commons-api-4.0.0-beta-01.jar |-- org.apache.olingo-odata-commons-core-4.0.0-beta-01.jar |-- org.codehaus.woodstox-stax2-api-3.1.4.jar `-- org.slf4j-slf4j-api-1.7.7.jar

vRealize Operations (vROps) Management Pack for Citrix XenDesktop Installation & Configuration Guide

Software

Transcript of vRealize Operations (vROps) Management Pack for Citrix XenDesktop Installation & Configuration Guide