Product Documentation

What's New

Dec 06, 2016

Citrix SCOM Management Pack for XenApp and XenDesktop version 3.9 introduces the following features:

  • Documentation in HTML format. The documentation for the Citrix SCOM Management Pack for XenApp and XenDesktop 3.9 is available in HTML format. To access the documentation of earlier versions, see Citrix SCOM Management Pack for XenApp and XenDesktop.

  • Support for Citrix XenApp and XenDesktop 7.12.  Citrix SCOM Management Pack for XenApp and XenDesktop supports XenApp and XenDesktop Version 7.12.

  • Citrix MP Analytics Service.  Citrix SCOM Management Pack for XenApp and XenDesktop uses Citrix MP Analytics Service to track and report product usage. The analytics service captures anonymous information regarding the overall usage of all Citrix SCOM Management Packs on the SCOM management server. For instructions on changing this setting after installation, see Reconfiguring Citrix SCOM MP Analytics.

  • New reports on Delivery Group and Site availability. Citrix SCOM Management Pack for XenApp and XenDesktop introduces new reports for monitoring availability of individual Delivery Groups and Sites. You can access the reports from Citrix Management Pack for XenApp and XenDesktop Reports. The reports are as follows:
    • Delivery Group - Availability : This report shows the availability of the selected Delivery Group in the XenApp and XenDesktop Site during the selected report duration. A Delivery group is available if it contains at least one machine that can provide a published resource (application or desktop).
    • Site - Infrastructure Availability: This report shows the availability of the XenApp and XenDesktop Site infrastructure during the selected report duration. The Site is available when the important Citrix Services are operational at Site level and all the configured Hypervisor connections are available.

For report details and parameter descriptions, see Citrix SCOM Management Pack for XenApp and XenDesktop Reference Guide, available from Optimize.

  • New monitor on number of available machines in the Server OS Delivery Group. Citrix SCOM Management Pack for XenApp and XenDesktop introduces a new monitor, % of Available Machines. It shows the number of available servers in Server OS Delivery Group. Available servers are machines that are running, registered with the Delivery Controller, and have a Load Evaluator Index less than 100%.

    For monitor details and parameter descriptions, see Citrix SCOM Management Pack for XenApp and XenDesktop Reference Guide, available from Optimize.
  • Improved CPU utilization. Citrix SCOM Management Pack Agent for XenApp and XenDesktop is improved to reduce CPU utilization considerably. For details, see Performance Overview

Known issues

The following is a list of known issues in this product version:

  • Issue ID: SCOM-1176
    Symptom:  The Citrix SCOM Management Pack Agent for XenApp and XenDesktop might not get upgraded during an upgrade invoked either locally on the XenApp and XenDesktop server or remotely from the SCOM Operations console. The upgrade procedure initially removes the Citrix SCOM Management Pack Agent for XenApp and XenDesktop Service. However, the previously installed agent package is not replaced and the earlier program version remains registered with the operating system.
    Action: Repeat the upgrade procedure.
  • Issue ID: SCOM-513
    Symptom: It may take up to 24 hours for the Citrix SCOM Management Pack Agent for XenApp and XenDesktop instances to detect renewal of an expired Platinum license in the XenApp and XenDesktop Site.
    Action: After such license renewal, to restore licensing coverage of XenApp and XenDesktop on Delivery Controllers (agent-managed computers) immediately, do the following:
    1. On a Delivery Controller, stop the Citrix MPXAXD Agent service by using an operating system tool.
    2. From the db subfolder of the Agent's data files folder(%ProgramData%\Citrix\XenDesktop MP Agent by default), remove the agent-license-info.json file.
    3. Start the Citrix MPXAXD Agent service again.
    4. Repeat steps 1 to 3 on each additional Delivery Controller.
  • Issue ID: SCOM-502
    Symptom: In the SCOM Operations console, when you attempt to run the Start Citrix Director task on a XenApp and XenDesktop alert that is not a session performance or logon alert, the invocation fails and SCOM reports the following error:
    Citrix Director URL not configured. Please configure the Citrix Director URL by using XenDesktop MP Configuration tool.
    Action: None. The error message is incorrect, so you can safely ignore it. You can run the Start Citrix Director task only on session performance alerts and logon alerts.
  • Issue ID: SCOM-430
    Symptom: After upgrading the product from version 3.6 or 3.5, the %ProgramData%\Comtrade folder is left on the local system. This issue occurs on the SCOM management server, on the Delivery Controllers (agent-managed), as well as on the proxy nodes.
    Action: Manually remove the residuary folder by using an operating system tool.
  • Issue ID: SCOM-143
    Symptom: In the SCOM Operations console, the ApplicationExcludeRegExtPattern and ApplicationIncludeRegExtPattern parameters of application discoveries (Application Discovery (n of 5)) are ignored. You therefore cannot exclude applications from the discovery process or include them into it.
    Action: None. There is no workaround available.
  • Issue ID: SCOM-86 (6297)
    Symptom: After Citrix SCOM Management Pack for XenApp and XenDesktop (both its server-side and agent-side parts) is installed and configured on the computer for the first time (without being upgraded from an earlier product version), and a valid XenApp and XenDesktop Platinum license cannot be retrieved, no license-related alerts are sent. Such alerts therefore cannot be monitored in the Monitoring view of the SCOM operations console.
    Action: None. There is no workaround available.
  • Issue ID: SCOM-78 (6204)
    Symptom: The Check Requirements and Configuration for Citrix MPXAXD Agent SCOM task and the Support /user <UserName> /domain <DomainName> /checkreq command both report an error with accessing the Windows PowerShell interface. Inspection of the password of the effective XenApp and XenDesktop monitoring account reveals non-ASCII characters in it.
    Action: Change the password of the problematic monitoring account so that it only contains ASCII characters.
  • Issue ID: SCOM-77 (6194)
    Symptom: In the output of the Check Requirements and Configuration for Citrix MPXAXD Agent task in the SCOM Operations console, site names that contain non-ASCII characters are not displayed correctly. For example, Spanish characters çñ appear as ╬¤ in the name of a XenApp and XenDesktop Site. No other symptoms exist.
    Action: None. Apart from the visual glitch, the functionality of the product is not affected in any way. You can therefore safely ignore the issue.
  • Issue ID: SCOM-210 (5380)
    Symptom: While a workflow is running, error messages (31551 and 31552) are logged into the Operations Manager event log on the management server. They contain the following description:
    Failed to store data in the Data Warehouse...
    This error occurs when the Default action account in SCOM does not have write permission on the data warehouse database and none of the XenDesktop controllers is discovered as Site Data Collector. This may happen when:

    • The Site Data Collector object switches from one XenDesktop Delivery Controller to another.
    • Collector object switches from one XenDesktop Delivery Controller to another.
    • None of XenDesktop Delivery Controllers is operational.

    This issue occurs only with some of the workflows, for example, Comtrade.Citrix. XenDesktop.EndUser.Reports.PublishConnectionsLogonsDW.Rule or Comtrade. Citrix.XenDesktop.EndUser.Reports.PublishApplicationInstanceDW.Rule.
    Action: Ensure that at least one Delivery Controller is active at all times.
  • Issue ID: SCOM-211 (5163)
    Symptom: The Delivery Group - Logon Details (Troubleshooting) report does not function if the Use business hours option is selected.
    Action: Clear the Use business hours option.
  • Issue ID: SCOM-212 (5162)
    Symptom: When launching Citrix Director by using the Start Citrix Director task in the Operations Manager Console for user logon or session alerts, Citrix Director is not opened for the users context if the user is anonymous. Anonymous users were introduced in XenApp and XenDesktop 7.6.
    Action: None. There is no workaround available.
  • Issue ID: SCOM-213 (5161)
    Symptom: The XenApp and XenDesktop 7.6 configuration with space characters in Site names is not supported. This is due to a recognized issue in the Citrix Monitoring Service with this kind of configuration. For more information, see the following webpage on the Citrix Support Knowledge Center website: http://support.citrix.com/article/CTX200325.
    Action: None. There is no workaround available.

Fixed issues

The following issue has been fixed in product version 3.9:

  • Restarting the Citrix SCOM Management Pack Agent for XenApp and XenDesktop while Citrix License Server is unavailable causes the agent to appear licensed though it is not functioning fully. The agent presents the data collected when the License Server was last running. The complete functionality of the agent is restored once the License Server is available.
    [SCOM-942]

Licensing

Licensing of Citrix SCOM Management Pack for XenApp and XenDesktop depends on licensing of the monitored product, XenApp and XenDesktop. For Citrix SCOM Management Pack for XenApp and XenDesktop to operate properly and remain fully functional, its licensing must be covered. During installataion or upgrade, no further actions are necessary on either the SCOM management server or the computers that host the product's Agent and Machine Agent instances.

Covered licensing means that the following conditions are fulfilled:

  • The XenApp and XenDesktop Site that you plan to monitor uses a Platinum license within either maintenance program: Subscription Advantage, Software Maintenance.
  • Subscription Advantage Date (of the Platinum license) falls after the Subscription Advantage Eligibility date that is embedded into binary files of the current version of Citrix SCOM Management Pack for XenApp and XenDesktop. For instructions on how to check this, see Install and Configure. In Citrix product documentation, Subscription Advantage Eligibility date may also be referred to as product burn-in date.

Important: The Subscription Advantage Eligibility date of this product release is 2016.1117.

Example: If the Subscription Advantage Date of your Platinum license for XenApp and XenDesktop is 2016.0531 (meaning 31 May 2016), and the Subscription Advantage Eligibility date of Citrix SCOM Management Pack for XenApp and XenDesktop is 2016.0518 (meaning 18 May 2016), the product remains fully functional after 31 May 2016, provided your XenApp and XenDesktop license remains valid (unexpired). If you upgrade to a later version of Citrix SCOM Management Pack for XenApp and XenDesktop whose Subscription Advantage Eligibility date is, for example, 2016.0710 (meaning 10 July 2016), Citrix SCOM Management Pack for XenApp and XenDesktop stops gathering and reporting new data (topology updates, incoming alerts, newly discovered objects).

Upgrading

Note: Product versions earlier than 3.6 were released under the name Comtrade Management Pack for Citrix XenApp and XenDesktop.

Upgrade is available for the following versions: 3.8, 3.7, 3.6, 3.5. During the upgrade process, the included management packs of an earlier product version are automatically upgraded; their prior removal is not required. Your management pack customization is preserved.

Caution:

  • Before upgrading from an earlier product version, ensure that licensing of this version of Citrix SCOM Management Pack for XenApp and XenDesktop is covered. For instructions on how to verify licensing coverage, see Preparing for Installation in Install and Configure.
  • Upgrading to an unlicensed version of Citrix SCOM Management Pack for XenApp and XenDesktop results in ceased process of gathering and reporting new data. The data already collected is preserved and remains available to SCOM. If this occurs, downgrading to the earlier (licensed) product version requires a complete uninstallation of the new product version (including removal of the included management packs from SCOM), followed by reinstallation of the earlier product version. The management pack removal from SCOM deletes all the operational data (alerts, events, performance data) while the reinstallation ensures continued availability of data in the SCOM data warehouse (reports).

For upgrade instructions, see Upgrade in Install and Configure.