Product Documentation

What's new

May 21, 2017

Citrix SCOM Management Pack 3.12 for XenApp and XenDesktop introduces the following enhancements:

  • Support for Citrix XenApp and XenDesktop 7.14. Citrix SCOM Management Pack for XenApp and XenDesktop now supports XenApp and XenDesktop version 7.14.
  • Performance improvements. The product design is upgraded to support significant performance improvements:
    • The product now uses the SCOM SDK service and the Operations Manager Connector Framework to fetch discovered objects data from the XenApp and XenDesktop environment. This design change eliminates restrictions on the size of data transferred from the agent to the SCOM Management Server, thus enabling the product to monitor larger environments. For more information, see the Key monitoring scenarios section in Optimize. For information on configuring the product to monitor large environments, see Configuring SCOM Administrator section in Install and configure.
    • The design enhancements in the product enable monitoring with reduced memory footprint.
    • The machine, session, and application usage data collection speed is increased, improving the response times of the management pack. This is seen as a ten-fold increase in the rate at which updates in the XenApp and XenDesktop environment are available in the management pack.

For more information on the improvements in the scale of XenApp and XenDesktop environment supported, see Performance overview.

  • Enhanced handling of configuration data. Configuration data handling is now improved with encryption using a user-supplied key for improved security. For more information, see Configuring encryption password section in Install and configure.
  • TLS 1.2 support. Citrix SCOM Management Pack for XenApp and XenDesktop is enhanced to monitor XenApp and XenDesktop environments that have TLS (Transport Layer Security) protocol version 1.2 enabled.

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-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-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-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-1426
    Symptom: The Object and Counter names in all Performance views on the SCOM Management Server are not localized, but appear in English.
    Action: None. This issue does not impact product functionality.
    Applies to French, German, Japanese, Simplified Chinese and Spanish languages.
  • Issue ID: SCOM-78
    Symptom: If the password of the Citrix SCOM Management Pack for XenApp and XenDesktop Monitoring user account contains non-English characters the Check Requirements and Configuration for Citrix MPXAXD Agent task reports an error in the Citrix XenApp/XenDesktop Powershell Interface section as follows:
    “Could not get data from Citrix PowerShell interface.”
    Action: Change the password of Citrix SCOM Management Pack for XenApp and XenDesktop Monitoring user account to contain only English characters.
    Applies to French, German, Japanese, Simplified Chinese and Spanish languages.
  • Issue ID: SCOM-1391, SCOM-1384
    Symptom: In the SCOM Console, the output messages of all tasks are not localized, but appear in English.
    Action: None. This issue does not impact product functionality.
    Applies to French, German, Japanese, Simplified Chinese and Spanish languages.
  • Issue ID: SCOM-1156
    Symptom: Surrogate pair characters in the Citrix SCOM Management Pack for XenApp and XenDesktop reports appear incorrectly.
    Action: None. This issue does not impact product functionality.
    Applies to Japanese and Simplified Chinese languages.
  • Issue ID: SCOM-1222
    Symptom: If the XenApp and XenDesktop Site name contains Japanese or Simple Chinese characters, an error might occur when running the Check Requirements and Configuration for Citrix MPXAXD Agent or Check Requirements and Configuration for Citrix MPXAXD Machine Agent task.
    The Director URL for the Site is configured successfully, but the task might display the following error message:
    “Director URL is not configured for Site <sitename>. Please configure Director URL for this Site in 'XenApp and XenDesktop MP Configuration' tool and deploy new configuration using 'Update Configuration on Citrix MPXAXD Agent/Machine Agent' task in SCOM.” 
    Action: Avoid Japanese and Simplified Chinese characters in the XenApp and XenDesktop Site name.
    Applies to Japanese and Simplified Chinese languages.
  • Issue ID: SCOM-1617
    Symptom: Citrix SCOM Management Pack for XenApp and XenDesktop Agent does not support monitoring of Citrix VDA Services on Sites containing more than 100 VDAs for Server OS.
    Action: None. Disable the VDA Service monitors in such environments to avoid errors in the Operations Manager event log.
  • Issue ID: SCOM-1939
    Symptom: The Server OS Machine Memory Hard Page Faults alert displays an incorrect rule description. 
    Workaround: None.
  • Issue ID: SCOM-2058
    Symptom: The Server OS and Desktop OS Machine CPU Utilizations alerts do not trigger in localized environments.
    Workaround: Switch to the English environment.
  • Issue ID: SCOM-2067
    Symptom: Power managed Server OS machines that are powered off are not discovered. If a machine that is already discovered is powered off, the machine gets undiscovered.
    Workaround: None.
  • Issue ID: SCOM-2100
    Symptom: The reports - Delivery Group Server OS - Machine Performance, Server OS Machine - Performance (Plan and Manage), and Server OS Machine - Performance (Troubleshooting) can show incorrect load index values for certain Server OS Machines.
    Workaround: None
  • Issue ID: SCOM- 2090
    Symptom: The Citrix MPXAXD Agent Installation task run for upgrading to version 3.12 succeeds. However, it does not give any output sometimes. In addition, the upgraded Citrix MPXAXD Agent service could start incorrectly in slower environments, under the local system user.
    Workaround: Manually upgrade the agent to version 3.12, instead of using the task. If the service is running under a local system user, run the Update Configuration task.
  • Issue ID: SCOM-2137
    Symptom: Site level performance monitoring: Data collection for Sessions on Site, Connected Users on Site, and User Logon Performance might stop after running for a while.
    Workaround: Restart the Microsoft Monitoring Agent service on the Delivery Controller that acts as the Site Data Collector.

Fixed issues

The following issues are fixed in this release:
 
  • Issue ID: SCOM-1611
    Symptom: If multiple XenApp and XenDesktop Sites are monitored by SCOM Management servers in the same SCOM Management group, the Application-User Sessions reports might not be accurate. For every Site that is monitored, the report might contain duplicate entries for the selected applications. These entries might contain no data or incorrect data.

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 installation 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 2017.0517.

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).

Renewal after expired XenApp and XenDesktop License

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. 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.

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 versions 3.5 and later. 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.