Citrix

Produktdokumentation



Ganzes Dokument herunterladen

Install and Configure

Mar. 10, 2017

This topic contains instructions to install and configure the Citrix SCOM Management Pack for XenApp and XenDesktop. Perform all procedures in the documented order of precedence. Optional procedures are appropriately marked. Also covered are the instructions to uninstall and upgrade the product.

Preparing for the installation

Before installing the Citrix SCOM Management Pack for XenApp and XenDesktop, make sure the following general prerequisites are fulfilled:

  • Your environment meets the hardware and software requirements.
    For hardware, software requirements and/or other requirements, see System Requirements.
  • Licensing of Citrix SCOM Management Pack for XenApp and XenDesktop is covered. The licensing is covered when all conditions listed in Licensing are fulfilled.

To check if Subscription Advantage Date of the XenApp and XenDesktop Platinum license falls after the Subscription Advantage Eligibility date of Citrix SCOM Management Pack for XenApp and XenDesktop (one of the licensing conditions), do the following:

  1. Take note of the Subscription Advantage Eligibility date of the current product release. For information, see Licensing.
  2. Launch Citrix Studio.
  3. In the left pane of Citrix Studio, expand Citrix Studio (<SiteName>) > Configuration, and then click Licensing.
  4. In the Licensing Overview pane, under Licenses, search for the lines that have either value in the Product column:
    Citrix XenApp Platinum
    Citrix XenDesktop Platinum
  5. For each matching line from step 4, check if its Subscription Advantage Date value is bigger than the date (Subscription Advantage Eligibility date) from step 1.
  6. If at least one value is bigger, the license Subscription Advantage period covers the current version of Citrix SCOM Management Pack for XenApp and XenDesktop.
  • A computer is chosen on which a SCOM management server resides and where the server side of Citrix SCOM Management Pack for XenApp and XenDesktop will be installed. This computer is referred to as SCOM management server.
  • SCOM agent is installed on all the computers that host XenApp and XenDesktop Delivery Controllers, and these computers are configured as agent-managed computers in the SCOM management group.
  • The Action Account of SCOM agent has administrative privileges on all XenApp and XenDesktop Delivery Controllers.
  • A domain user account is chosen that you will use for remote monitoring of server OS machines and desktop OS machines. For multiple XenApp and XenDesktop Sites, you might need to use different accounts. This depends on the domain configuration.

Tip: Citrix recommends that you create a new, dedicated user account for exclusive use for the above-mentioned purposes.

The user account must have the following properties:

  • It has administrative privileges in all XenApp and XenDesktop Delivery Controllers and all server OS machines within the Site.
  • It has the Read Only Administrator role (or a role with higher privileges) assigned in XenApp and XenDesktop with the scope set to All.
The following image shows the creation of an administrator account in Citrix Studio. 

localized image

The following image shows the editing of an administrator account in Citrix Studio. 

localized image

This user account is referred to as <MPXAXDAgentAccount> in the remainder of this document.

  • Windows Remote Management 2.0 (WinRM 2.0) is enabled on all server OS machines. To enable WinRM on the local computer, open a Command Prompt window and run the winrm quickconfig command. 
  • WinRM 2.0 is correctly configured. For instructions on how to verify that the WinRM 2.0 configuration is correct, see Verifying WinRM communication.

For Citrix SCOM MP Analytics Service to transmit anonymous usage data, make sure that the SCOM management server has internet access.

For XenApp and XenDesktop machine and session performance monitoring, make sure the following additional prerequisites are fulfilled as well:

  • Computers are chosen where Citrix SCOM Management Pack for XenApp and XenDesktop Machine Agent will be installed. These computers are referred to as Citrix SCOM Management Pack for XenApp and XenDesktop proxy nodes (proxy nodes). The proxy nodes must meet minimum hardware requirements and must be running a supported operating system. 

Important: For information on how to properly designate the proxy nodes and plan their configuration, see Machine and session performance monitoring.

  • SCOM agent is installed on all the proxy nodes.
  • The <MPXAXDAgentAccount> user account has administrative privileges in the desktop OS machines and on the proxy nodes.
  • Windows Remote Management 2.0 (WinRM 2.0) is enabled on all desktop OS machines.
  • Receiving Windows PowerShell remote commands is enabled on all the computers that host XenApp and XenDesktop Delivery Controllers. For more information, see the Enable-PSRemoting (for Windows Server 2012 R2) or Enable-PSRemoting (for Windows Server 2012) webpage on the Microsoft TechNet website.
  • Firewall is configured as required by WinRM: on desktop OS machine as well as on the Delivery Controllers, incoming traffic is enabled on the TCP port that WinRM is using. By default, WinRM is configured to use port 5985.

Installing the product on the SCOM management server

The server-side part of Citrix SCOM Management Pack for XenApp and XenDesktop must be installed on the SCOM management server.

To install Citrix SCOM Management Pack for XenApp and XenDesktop on the SCOM management server, do the following:

1. Log on to the management server. Use a user account that has local administrative privileges and SCOM administrative privileges.
2. In Windows Explorer, locate the Citrix_SCOM_Management_Pack_for_XenAppXenDesktop_<Version>.exe file (where <Version> is the current software version), and double-click it to invoke the installation process. Wait for the Setup Wizard to appear.
3. In the Welcome page of the Setup Wizard, click Next.

localized image

4. In the View Relevant Product Configuration page, click Next.
5. In the License Agreement page of the Setup Wizard, read the end user license agreement carefully. If you accept the terms of the agreement, click Next.

localized image

6. In the Destination Folder page, define the Citrix SCOM Management Pack for XenApp and XenDesktop installation folder. Citrix recommends that you install Citrix SCOM Management Pack for XenApp and XenDesktop to the default folder.
Proceed as follows:

  • To install the product to the default folder listed in the Setup Wizard, no special actions are required.
  • To install the product to a different folder, follow the substeps:
    1. Click Change.
    2. In the Browse For Folder dialog box, browse to a desired installation folder, select it, and click OK.

7. In the Configure Post-Install Actions page of the Setup Wizard, decide whether the Setup Wizard should automatically import the included management packs into SCOM and whether it should initially enable Analytics Service.

localized image

  • Decide about the management pack import:
    • To let the Setup Wizard import the management packs, select the Automatically import the Management Pack option. Citrix recommends this choice.
    • To import the management packs into SCOM manually at a later time, leave the Automatically import the Management Pack option unselected. For instructions about how to import or reimport the management packs, see Manually importing included management packs into SCOM.
  • To enable the Analytics Service to start transmitting usage statistics after the product is installed, select the Enable the product to send anonymous usage statistics to Citrix option.

8. Click Install. The Setup Wizard displays the Installing the product page and starts copying the installation files.

9. After the installation completes, the installation completion page is displayed. Click Next.

10. In the Executing post-install actions page, attend the import process (if chosen earlier) and the installation of Citrix SCOM MP Analytics.

11. In the post-installation completion page, review the actions log, and click Finish to close the Setup Wizard.

localized image

Configuring the XenApp and XenDesktop monitoring accounts and profile in SCOM

To configure Run As accounts and the associated Run As profile in SCOM, do the following:

  1. Launch the SCOM Operations console and connect to the management server.
  2. In the Administration view, in the left pane, expand Run As Configuration, and then click Accounts.
  3. In the Tasks pane, expand Actions, and then click Create Run As Account.
  4. In the Create Run As Account Wizard window, click Next.
  5. In the General Properties page, in the Run As account type drop-down menu, leave the default selection (Windows).
  6. In the Display name text box, type a name that the SCOM Operations console will use to refer to the monitoring account. Click Next.
  7. In the Credentials page, type user name, password, and domain of the <MPXAXDAgentAccount> user account in the respective text boxes. Click Next.
  8. In the Distribution Security page, select a distribution security option.
    Citrix recommends that you select the More secure option. In this case, you must subsequently edit the Run As account configuration so that its Selected Computers list includes the XenApp and XenDesktop Delivery Controllers.
  9. Click Create to save the configuration data of the new account, then click Close to close the Create run As Account Wizard window.
  10. If you are configuring SCOM for multiple-site monitoring, repeat steps 3 to 9 for each XenApp and XenDesktop Site, each time specifying display name and credentials of the appropriate user account.
  11. In the Administration view, in the left pane, expand Run As Configuration, and then click Profiles.
  12. In the results pane, in the Name column, double-click Citrix XenApp and XenDesktop Monitoring Account.
  13. In the Run As Profile Wizard window, click Next and then click Next again.
  14. In the Run As Accounts page, click Add.
  15. In the Add a Run as Account dialog box, from the Run As account drop-down list, select the display name of the Run As account.
  16. Depending on whether you plan to monitor multiple XenApp and XenDesktop Sites and/or your security requirements, proceed as follows:
    1. For monitoring multiple-site environments or for increased security, select the A selected class, group, or object option (more secure). Then follow the steps:
      1. Click Select and then select Object.
      2. In the Object Search dialog box, from the Look for drop-down list, select Windows Computer and then click Search.
      3. In the Available items list, select the XenApp and XenDesktop Delivery Controller, and then click Add.
      4. Click OK to close the dialog box.
    2. For monitoring single-Site environments and for ordinary security, select the All targeted objects option (less secure).
  17. Click OK to close the Add a Run As Account dialog box.
  18. If you are configuring SCOM for multiple-site monitoring, repeat steps 14 to 17 for each XenApp and XenDesktop Site, each time using the appropriate Run As account.

localized image

19. Click Save to save the changes.
20. Click Close to close the Run As Profile Wizard window.
21. If you selected the More secure option in step 8, distribute the Run As accounts to the appropriate agent-managed computers: for each chosen account, do the following:
     a. In the Administration view, double-click the user account.
     b. In the Run As Account Properties dialog box, click the Distribution tab.
     c. Click Add.
     d. In the Computer Search dialog box, search for and add the computers. Click OK.

localized image

     e. In the Run As Account Properties dialog box, click Apply and then click OK.

After saving the updated Run As profile, it may take some time for the updated configuration to become active on the targets. The required time depends on the state of the SCOM agent (HealthService) instances and overall load on the SCOM infrastructure.

Configuring access to the shared folder for agent installation

Note: Steps of this procedure must be followed only once on a SCOM management server. In case you have previously installed and configured any of the following Citrix Management Pack products on the same computer, you may not need to repeat the steps:

  • Provisioning Services Management Pack
  • ShareFile Management Pack
  • StoreFront Management Pack
  • Web Interface Management Pack
  • XenApp Management Pack
  • XenMobile Management Pack

To configure access to the shared folder for agent installation, do the following:

  1. Log on to the SCOM management server. Use a user account that has local administrative privileges.
  2. Choose a local user account (local to the computer with the shared folder) or a domain user account that will have access to the shared folder, for the purpose of agent deployment and configuration.
    Tip: Citrix recommends creating a new, dedicated user account that you will use only for deployment of the Citrix SCOM Management Pack for XenApp and XenDesktop agent to managed computers.
  3. Using an operating system administrative tool, add the user account to the CitrixMPShareUsers user group.
  4. Launch the SCOM Operations console and connect to the management server.
  5. In the Administration view, in the left pane, expand Run As Configuration, and then click Accounts.
  6. In the Tasks pane, expand Actions, and then click Create Run As Account.
  7. In the Create Run As Account Wizard window, click Next.
  8. In the Run As account type drop-down menu, leave the default selection (Windows).

localized image

    9. In the Display name text box, type a name that the SCOM Operations console will use to refer to the newly created SCOM user account. Click Next.
    10. In the User name text box, type the user name of the operating system user account that you chose in step 2.

localized image

     11. In the Password and Confirm password text boxes, type the valid password of the operating system user account.
     12. In the Domain text box, update the value if needed. Click Next.
     13. Depending on the effective security policy in your SCOM environment, select either the Less secure or More secure option.

Note: Selecting More secure requires manual steps to be performed in SCOM for each newly added managed computer.

     14. Click Create.
     15. After the message about successful account creation appears, click Close.

localized image

     16. In the left pane, under Run As Configuration, click Profiles.
     17. In the Profiles list, double-click Citrix Management Pack Network Share Account.

localized image

     18. In the Run As Profile Wizard window, in the Introductory page, click Next. In the General Properties page, click Next.
     19. In the Run As Accounts page, click Add.
     20. In the Add a Run As Account dialog box, in the Run as account list, select the newly created SCOM user account.

localized image

     21. Select the A selected class, group, or object option.
     22. Click Select and then select Class.
     23. In the Class Search dialog box, in the Filter by (optional) text box, type Windows Computers.
     24. Click Search.
     25. In the Available items list, select All Windows Computers.

localized image

     26. Click OK to close the Class Search dialog box.
     27. Click OK to close the Add a Run As Account dialog box.
     28. Click Save to update the profile. This may take a while.
     29. Click Close to close the Run As Profile Wizard window.

Verifying the installation on the SCOM management server

To verify that the Citrix SCOM Management Pack for XenApp and XenDesktop installation on the management server is correct, do the following:

  1. Log on to the management server.
  2. Go to Start > Control Panel and click Programs and Features (actions of this step may differ on operating systems earlier than Windows Server 2016).
  3. Check for the presence of the following entry in the Name column:
    Citrix SCOM Management Pack for XenApp and XenDesktop
  4. To check if the CitrixMPShare shared folder is correctly configured, open a Command Prompt window and run the following commands in sequence (their outputs in case of success are also shown):
command Copy

net share | findstr -i CitrixMPShare

output Copy

CitrixMPShare
            %ProgramData%\Citrix\CitrixMPShare

command Copy

net use \\<ManagementServerHostName>\CitrixMPShare
   /USER:<DomainName>\<UserName>

output Copy

The command completed successfully

command Copy

dir \\<ManagementServerHostName>\CitrixMPShare

output Copy

<FolderContents>

In these instances, %ProgramData% refers to the actual value of this operating system variable. <ManagementServerHostName> is the name of the SCOM management server. <DomainName> is the domain or computer name and <UserName> is the name of the user account that you chose in step 2 of the procedure documented in Configuring access to the shared folder for agent installation. <FolderContents> is the list of the contents of the CitrixMPShare folder.

The shared folder is vital for installation of the Citrix SCOM Management Pack Agent for XenApp and XenDesktop and deployment of its configuration to the managed computers.

     5. Launch the SCOM Operations console.
     6. In the Monitoring view, expand the items in the left pane until they match the following figures (combined).

localized image

localized image

     7. In the Administration view, expand Administration > Management Packs and click Installed Management Packs (the navigation pane structure may differ in SCOM versions earlier than 2016).
     8. Verify the following management pack versions are listed in the results pane:

Citrix Management Pack for XenApp and XenDesktop 3.9.49.0
Citrix Management Pack for XenApp and XenDesktop (EndUser) 3.9.49.0
Citrix Management Pack for XenApp and XenDesktop (EndUser) Reports 3.9.49.0
Citrix Management Pack for XenApp and XenDesktop Reports 3.9.49.0
Citrix Management Pack Library 1.0.17.0

Configuring SCOM agent to act as proxy on Delivery Controllers

SCOM agent on each computer where XenApp and XenDesktop Delivery Controller is installed must be configured to act as a proxy agent. This configuration enables the agent to relay or forward information from or about other computes and network devices to the SCOM management server.

To configure the SCOM agent instances to act as proxy agents, do the following:

  1. Launch the SCOM Operations console and connect to the management server.
  2. In the Administration view, expand Device Management, and then click Agent Managed.
  3. For each XenApp and XenDesktop (Delivery Controller) computer, follow the steps:
    1. Right-click the host name, and select Properties.
    2. Click the Security tab.
    3. Select the Allow this agent to act as proxy and discover managed objects on other computers option.
    4. Click OK.

Configuring Citrix Director URL

To enable opening Citrix Director in the user context from session alerts using the Start Citrix Director alert task, the URL of the Citrix Director web interface must be configured for each monitored Site.

To configure a Citrix Director URL, do the following:

  1. Log on to the management server. Use a user account that has local administrative privileges.
  2. Go to Start > All apps > Citrix (actions of this step may differ on operating systems earlier than Windows Server 2016).
  3. Click XenApp and XenDesktop MP Configuration.
  4. In the Citrix Management Pack Configuration window, in the Director URL tab, click Add.
  5. In the Add Director URL dialog box, type the following data in the respective text boxes:
    • Name of the Site
    • URL of the Citrix Director instance that is connected to and monitors this Site

localized image

     6. Click OK.
     7. Repeat steps 4 to 6 for each additional XenApp and XenDesktop Site you want to monitor.
     8. Optional. To modify the configuration data of an entry, click Modify. In the Modify Director URL dialog box, modify the data as required, and then click OK.
     9. Optional. To remove a Citrix Director URL configuration, click Remove and then click Yes.
     10. Click OK to apply the configuration changes and close the window.

Note: If you change a Citrix Director URL for the Site in which Citrix SCOM Management Pack Agent for XenApp and XenDesktop or Citrix SCOM Management Pack Machine Agent for XenApp and XenDesktop is already installed on the Delivery Controllers, you must run the Update Configuration on Citrix MPXAXD Agent or Update Configuration on Citrix MPXAXD Machine Agent task.

Installing the product on the Delivery Controllers

On the XenApp and XenDesktop Delivery Controllers, only Citrix SCOM Management Pack Agent for XenApp and XenDesktop must be installed.

To install Citrix SCOM Management Pack Agent for XenApp and XenDesktop on a Delivery Controller, do the following:

  1. Launch the SCOM Operations console and connect to the management server.
  2. In the Monitoring view, in the left pane, expand Citrix Library, and then click XenApp/XenDesktop Delivery Controller Computers.
  3. In the XenApp/XenDesktop Delivery Controllers pane, select a Delivery Controller from the XenApp/XenDesktop Delivery Controllers list.
  4. In the Tasks pane, expand MPXAXD Delivery Controller Computer Role Tasks, and then click Install Citrix MPXAXD Agent.
  5. In the Run Task - Install Citrix MPXAXD Agent dialog box, adjust the task parameters as follows:
    • UpgradeAgent: This option, when set to true, causes uninstallation of the existing Citrix SCOM Management Pack Agent for XenApp and XenDesktop from the agent-managed computer before the current version is installed. Before such uninstallation, SCOM agent must be put into maintenance mode.
      Default value: false
    • IgnorePrereqCheck: You may not alter this option.
      Default value: false
    • AgentInstallationSource: This option defines location of the Management Pack agent installation package and its configuration files. Specify the value according to relationship between the agent-managed computer and the SCOM management server:
      • If SCOM agent on the agent-managed computer reports only to the management server where Citrix SCOM Management Pack for XenApp and XenDesktop is installed, leave the value empty. The location is then automatically determined based on data retrieved from the agent-managed computer. In most cases, the retrieved location host name matches the host name of the management server where the installation task is invoked.
      • If the agent-managed computer is managed by some other management server or the computer hosts a multi-homed SCOM agent instance, specify the host name of the management server where Citrix SCOM Management Pack for XenApp and XenDesktop is installed.
      • If the agent-managed computer does not have access to the CitrixMPShare shared folder on the management server, specify the alternative location of the Management Pack agent installation package and its agent configuration files in the UNC format. A prerequisite is that these files are copied from the CitrixMPShare shared folder to a location the agent-managed computer has access to.
        Default value: (empty)
    • AgentInstallationDestination: This option defines the Management Pack agent's program installation directory on the agent-managed computer. If no value is specified, the Management Pack agent is installed to the %ProgramFiles%\Citrix\XenDesktop MP Agent directory.
      Default value: (empty)
  6. Click Run to invoke the installation process.
  7. Observe the output the task generates. If the task reports no errors, the installation on the agent-managed computer is correct.

The task initially performs a prerequisite check. If any of the installation prerequisites are not fulfilled, the process is interrupted before the actual installation begins. In this case, invoke the Check Installation Prerequisites for Citrix MPXAXD Agent task to pinpoint the problematic prerequisite.

Tip: The Agent installation task can be run for multiple selected Delivery Controllers.

Configuring Citrix SCOM Management Pack for XenApp and XenDesktop for monitoring VDA services on server OS machines

Important: This section is applicable only if WinRM is configured to use non-default ports.

The Citrix SCOM Management Pack Agent for XenApp and XenDesktop monitors VDA services on the server OS machines remotely and it therefore connects to the server OS machines by using WinRM. By default, Citrix SCOM Management Pack Agent for XenApp and XenDesktop uses the default WinRM port (5985), and it does not utilize SSL. However, if this configuration changes on the server OS machines, you may need to manually update Windows Registry on the Citrix SCOM Management Pack Agent for XenApp and XenDesktop computer. Add or change the following values in the HKEY_LOCAL_MACHINE\SOFTWARE\Comtrade\XenDesktop MP Agent registry key:

  • WinRMPort (string value): port number that WinRM uses
  • WinRMUseSSL (string value): yes, no, true, or false

In case the listed values do not exist or are empty, Citrix SCOM Management Pack Agent for XenApp and XenDesktop follows its default behavior.

Verifying the installation and configuration on the Delivery Controllers

To verify that the XenApp and XenDesktop Management Pack installation and configuration on a Delivery Controller are correct, do the following:

  1. Launch the SCOM Operations console and connect to the management server.
  2. In the Monitoring view, in the left pane, expand Citrix Library, and click XenApp/XenDesktop Delivery Controller Computers.
  3. In the XenApp and XenDesktop Delivery Controller Computers pane, select a Delivery Controller from the XenApp and XenDesktop Delivery Controllers list.
  4. In the Tasks pane, expand Actions, and then click Check Requirements and Configuration for Citrix MPXAXD Agent.
  5. Observe the output the task generates. If all checks are denoted successful, the installation and configuration on the Delivery Controller are correct.

Installing the product on the proxy nodes

Important: Perform this procedure only if you plan to monitor performance of server OS machines, server OS sessions, or desktop OS sessions in your XenApp and XenDesktop environment.

For machine or session performance monitoring, Citrix SCOM Management Pack Agent for XenApp and XenDesktop must be installed on the proxy nodes.

To install Citrix SCOM Management Pack Agent for XenApp and XenDesktop on a proxy node, do the following:

  1. Log on to the proxy node. Use a user account that has local administrative privileges.
  2. Copy the MPXAXDMachineAgent.exe, Support.exe and Support.exe.config files from the \\<ManagementServeHostName>\CitrixMPShare\XenDesktop Machine MP shared folder to a location on the proxy node.
  3. Run the following command to check if the prerequisites for machine agent installation are fulfilled:
command Copy

Support /checkprereq

     4. If all prerequisites are denoted as fulfilled, run the following command to invoke the Machine Agent installation process:

command Copy

MPXAXDMachineAgent

     Wait for the Setup Wizard to appear.
     5. Follow instructions of the Setup Wizard. During the process:

  • In the Agent Service Account page, type the literal string of the <MPXAXDAgentAccount> user account into the corresponding text box.
  • In the Delivery Controllers page, specify the Delivery Controllers that should be monitored by this proxy node.

Configuring Citrix SCOM Management Pack Machine Agent for XenApp and XenDesktop

Important: Perform this procedure only if you have installed the product's Machine Agent on the proxy nodes.

If WinRM is configured to use a non-default port (a port different from 5985) on your desktop OS machines, you must specify a port that will be used for VDI monitoring. To do this, update the Port value in the following keys in Windows Registry:

  • For OS machines:
    HKEY_LOCAL_MACHINE\SOFTWARE\Comtrade\XenDesktop MP Machine Agent\WinRMProtocols
  • For Delivery Controllers:
    HKEY_LOCAL_MACHINE\SOFTWARE\Comtrade\XenDesktop MP Machine Agent\ControllerWinRMProtocol

Verifying the installation and configuration on the proxy nodes

Important: Perform this procedure only if you have installed the product's Machine Agent on the proxy nodes.

After the installation, the Citrix SCOM Management Pack Machine Agent for XenApp and XenDesktop computers are discovered in the Monitoring view of the SCOM Operations console as XenApp/XenDesktop Machine Monitoring Proxy Computes inside Citrix Library. To check if Machine Agent is fully operational, execute the Check Requirements and Configuration for Citrix XAXD Machine Agent task.

Verifying WinRM communication

Important: Perform this procedure only if you have installed the product's Machine Agent on the proxy nodes.

Citrix SCOM Management Pack Machine Agent for XenApp and XenDesktop communicates with Delivery Controllers and server OS machines by using WinRM protocol and Kerberos authentication. The following checks help you determine if WinRM is correctly configured.

  • Proxy nodes:
    On the proxy node, to check if Kerberos authentication on the WinRM client is enabled, run the following command:
command Copy

winrm get winrm/config/Client

Inspect the command output. If the value of the Kerberos parameter in the Auth group is not true, run the following command:

command Copy

winrm set winrm/config/client/auth @{Kerberos="true"}

  • Server OS machines or desktop OS machines:
    On the proxy node, to verify if WinRM client on the computer can access the OS machine, log on by using the <MPXAXDAgentAccount> user account, and run the following command:
command Copy

winrm identify -r:http://<OSmachineHostName>:5985 -auth:Kerberos

     In case of success, the command output should be similar to the following:

output Copy

IdentifyResponse

ProtocolVersion = http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd

ProductVendor = Microsoft Corporation

ProductVersion = OS: 6.1.7600 SP: 0.0 Stack: 2.0

     In case of failure, proceed as follows:

  • If the command reports the Access denied error, it indicates that the <MPXAXDAgentAccount> user account does not have administrative privileges on the OS machine. Reconfigure the user account accordingly.
  • On the OS machine, run the following command to check Kerberos authentication is enabled for WinRM:
command Copy

winrm get winrm/config/Service

     Inspect the command output. If the value of the Kerberos parameter in the Auth group is not true, run the following command:

command Copy

winrm set winrm/config/service/auth @{Kerberos="true"}

  • Delivery Controllers:
    On the proxy node, log on by using the <MPXAXDAgentAccount> user account, and run the following command:
command Copy

winrm identify -r:http://<DeliveryControllerHostName>:5985
-auth:Kerberos

     In case of success, the command output should be similar to the following:

output Copy

IdentifyResponse

ProtocolVersion = http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd

ProductVendor = Microsoft Corporation

ProductVersion = OS: 6.1.7600 SP: 0.0 Stack: 2.0

     In case of failure, proceed as follows:

  • If the command reports the Access denied error, it indicates that the <MPXAXDAgentAccount> user account does not have administrative privileges on the Delivery Controller. Reconfigure the user account accordingly.
  • On the Delivery Controller, run the following command to check Kerberos authentication is enabled for WinRM:
command Copy

winrm get winrm/config/Service

Inspect the command output. If the value of the Kerberos parameter in the Auth group is not true, run the following command:

command Copy

winrm set winrm/config/service/auth @{Kerberos="true"}

Reconfiguring Citrix SCOM MP Analytics

Transmission of product usage data using the Citrix SCOM MP Analytics Service can be reconfigured anytime.

Note: Reconfiguring the Citrix SCOM MP Analytics Service affects the collection of data for all Citrix SCOM Management Pack products that are installed on the same SCOM management server.

To reconfigure the analytics service, do the following:

  1. Log on to the management server. Use a user account that has local administrative privileges.
  2. Go to Start > All apps > Citrix (actions of this step may differ on operating systems earlier than Windows Server 2016).
  3. Click Citrix SCOM MP Analytics Service Configuration.
  4. In the Citrix SCOM MP Analytics Service Configuration window, select or clear the Enable the product to send anonymous usage statistics to Citrix option.
  5. Click Close to apply configuration changes and close the window.

Uninstallation

This section contains instructions that you must follow to effectively uninstall Citrix SCOM Management Pack for XenApp and XenDesktop. Perform all procedures in the documented order of precedence. Optional procedures are appropriately marked.

Uninstalling the product from the Delivery Controllers

To uninstall XenApp/XenDesktop Management Pack Agent from a Delivery Controller(an agent-managed computer), do the following:

  1. Launch the SCOM Operations console and connect to the management server.
  2. In the Monitoring view, expand Citrix Library, and then click XenApp/XenDesktop Delivery Controller Computers.
  3. In the XenApp/XenDesktop Delivery Controller Computers pane, select a Delivery Controller from the XenApp/XenDesktop Delivery Controller Computers list.
  4. In the Tasks pane, expand Actions, and then click Uninstall Citrix MPXAXD Agent.
  5. In the Run Task - Uninstall Citrix MPXAXD Agent dialog box, click Run to invoke the uninstallation process.
  6. Repeat steps 3 to 5 for each additional Delivery Controller.
Tip: The Agent uninstallation task can be run for multiple selected Delivery Controllers.

Uninstalling the product from the proxy nodes

Important: Perform this procedure only if there is the product's Machine Agent is installed on the proxy nodes.

To determine which computers are the proxy nodes, do the following:

  1. Launch the SCOM Operations console and connect to the management server.
  2. In the Monitoring view, expand Citrix Library, and then click XenApp/XenDesktop Machine Monitoring Proxy Computers.
  3. In the XenApp and XenDesktop Machine Monitoring Proxy Computers pane, find the list of proxy nodes under XenApp and XenDesktop Machine Monitoring Proxy Computers.

To uninstall Citrix SCOM Management Pack Agent for XenApp and XenDesktop from a proxy node (an agent-managed computer), do the following:

  1. Log on to the proxy node. Use a user account that has local administrative privileges.
  2. Make sure no product folders or files are in use by any user.
  3. Go to Start > Control Panel and click Programs and Features (actions of this step may differ on operating systems earlier than Windows Server 2016).
  4. Right-click Citrix SCOM Management Pack Agent for XenApp and XenDesktop and select Uninstall.
  5. In the Programs and Features dialog box, click Yes to confirm uninstallation.

Removing dependent management packs (customizations)

Important: Perform this procedure only if you have customized the management packs included in the product.

To remove the customizations that you made to the management packs included in Citrix SCOM Management Pack for XenApp and XenDesktop, do the following:

  1. Launch the SCOM Operations console and connect to the management server.
  2. In the Administration view, expand Administration > Management Packs and click Installed Management Packs (the navigation pane structure may differ in SCOM versions earlier than 2016).
  3. In the results pane, locate the management packs that depend on the management packs included in Citrix SCOM Management Pack Agent for XenApp and XenDesktop.
  4. For each such dependent management pack (except for Microsoft.SystemCenter.SecureReferenceOverride), follow the steps:
    1. Right-click it and then click Delete.
    2. On the message stating that deleting the management pack might affect the scoping of some user roles, click Yes.

Removing included management packs

To remove the management packs included in Citrix SCOM Management Pack for XenApp and XenDesktop, do the following:

  1. Launch the SCOM Operations console and connect to the management server.
  2. In the Administration view, expand Administration > Management Packs and click Installed Management Packs (the navigation pane structure may differ in SCOM versions earlier than 2016).
  3. Remove references to the included management packs from the Microsoft.SystemCenter.SecureReferenceOverride management pack. To do this, perform the following steps:
    1. Identify which included management packs are referenced. In the Administration > Management Packs context of the SCOM Operations console, right-click Microsoft.SystemCenter.SecureReferenceOverride and select Properties. In the dialog box, click the Dependencies tab.
    2. For each such referenced management pack, find out its ID. Right-click the referenced management pack. In the dialog box, take note of the value in the ID text box on the General tab.
    3. Export the Microsoft.SystemCenter.SecureReferenceOverride management pack.
    4. Make a copy of the file you exported the management pack to.
    5. Edit the originally exported file: use the IDs to find and remove all dependencies to the management packs from the Manifest > References context (the Reference elements) and the Monitoring > Overrides context (the SecureReferenceOverride elements), and then save the changes.
      For better tracking, increase the management pack version by adjusting the value of the Version element within the Identity element.
    6. Import back the altered Microsoft.SystemCenter.SecureReferenceOverride management pack from the modified file.
  4. In the results pane, right-click Citrix Management Pack for XenApp and XenDesktop (EndUser) Reports, and then select Delete.
  5. On the message stating that deleting the management pack might affect the scoping of some user roles, click Yes.
  6. Repeat steps 4 and 5 with the following management packs (in the presented order of precedence):
    1. Citrix Management Pack for XenApp and XenDesktop (EndUser)
    2. Citrix Management Pack for XenApp and XenDesktop Reports
    3. Citrix Management Pack for XenApp and XenDesktop
  7. Check if other Citrix SCOM Management Pack products are installed on the management server. If none of them is installed, repeat steps 4 and 5 with Citrix Management Pack Library.

Uninstalling the product from the SCOM management server

To uninstall Citrix SCOM Management Pack for XenApp and XenDesktop from the SCOM management server, do the following:

  1. Log on to the management server. Use a user account that has local administrative privileges and SCOM administrative privileges.
  2. Make sure no product folders or files are in use by any user.
  3. Go to Start > Control Panel and click Programs and Features (actions of this step may differ on operating systems earlier than Windows Server 2016).
  4. Right-click Citrix SCOM Management Pack for XenApp and XenDesktop and select Uninstall. Wait for the Setup Wizard to appear.
  5. In the Welcome page of the Setup Wizard, click Uninstall.
  6. In the Uninstalling the product page, the Setup Wizard reports the uninstallation progress.
  7. In the Completion page of the Setup Wizard, click Finish.
  8. Delete the %ProgramData%\Citrix\CitrixMPShare\XenDesktop Machine MP and %ProgramData%\Citrix\CitrixMPShare\XenDesktop MP folders.
    Caution: This action permanently deletes the Agent configuration data. You will be unable to reuse it at a later time.
  9. Check if other Citrix SCOM Management Pack products are installed on the management server. If none of them is installed, follow the steps:
    1. Stop sharing the CitrixMPShare shared folder.
    2. Delete the %ProgramData%\Citrix\CitrixMPShare folder.
    3. Using an operating system administrative tool, delete the local CitrixMPShareUsers user group.

Uninstalling Citrix SCOM MP Analytics from the SCOM management server

Note: Uninstalling the Citrix SCOM MP Analytics Service stops collection of analytics data from all Citrix Management Pack products installed on the system.

To uninstall Citrix SCOM MP Analytics from the SCOM management server, do the following:

  1. Log on to the management server. Use a user account that has local administrative privileges.
  2. Make sure no product folders or files are in use by any user.
  3. Go to Start > Control Panel and click Programs and Features (actions of this step may differ on operating systems earlier than Windows Server 2016).
  4. Right-click Citrix SCOM MP Analytics and select Uninstall.
  5. In the Programs and Features dialog box, click Yes to confirm uninstallation.

Upgrade

Upgrade from version 3.5

To upgrade Citrix SCOM Management Pack for XenApp and XenDesktop from version 3.5, do the following:

     1. Prepare your environment for installation of the new product version. For instructions, see Preparing for the installation.

     2. Install the product (its server-side part) on the SCOM management server. For instructions, see Installing the product on the SCOM management server. The installation process upgrades the product and preserves local configuration data.

     3. Verify the installation of the product (its server-side part) on the SCOM management server. For instructions, see Verifying the installation on the SCOM management server.

     4. On the SCOM management server, copy the mpxaxd_config.dat file from the %ProgramData%\ComTrade\MPShare\XenDesktop MP directory to the %ProgramData%\Citrix\CitrixMPShare\XenDesktop MP directory.

     5. On the SCOM management server, move the mpxaxd_config.dat file from the %ProgramData%\ComTrade\MPShare\XenDesktop Machine MP directory to the %ProgramData%\Citrix\CitrixMPShare\XenDesktop Machine MP directory.

     6. Configure access to the shared folder for agent installation. For instructions, see Configuring access to the shared folder for agent installation.

     7. Install the product (one agent-side part) on the Delivery Controllers. For instructions, see Installing the product on the Delivery Controller.
Important: In the Run Task - Install Citrix MPXAXD Agent dialog box, set the UpgradeAgent task parameter to the true value.

localized image

     8. Verify the installation and configuration of the product (one agent-side part) on the Delivery Controllers. For instructions, see Verifying the installation and configuration on the Delivery Controllers.

     9. (this step is applicable only when installed Machine Agent is part of the deployment of your earlier product version)

Install the product (the other agent-side part) on the proxy nodes. For instructions, see Installing the product on the proxy nodes. The installation process upgrades the product and preserves local configuration data.

     10. (this step is applicable only when installed Machine Agent is part of the deployment of your earlier product version)
Verify the installation and configuration of the product (the other agent-side part) on the proxy nodes. For instructions, see Verifying the installation and configuration on the proxy nodes.

Upgrade from version other than 3.5

To upgrade Citrix SCOM Management Pack for XenApp and XenDesktop from versions other than 3.5, do the following:

     1. Prepare your environment for installation of the new product version. For instructions, see Preparing for the installation.

     2. Install the product (its server-side part) on the SCOM management server. For instructions, see Installing the product on the SCOM management server.
Note: The installation process upgrades the product and preserves local configuration data.

     3. Verify the installation of the product (its server-side part) on the SCOM management server. For instructions, see Verifying the installation on the SCOM management server.

     4. Install the product (one agent-side part) on the Delivery Controllers. For instructions, see Installing the product on the Delivery Controllers.
Important: In the Run Task - Install Citrix MPXAXD Agent dialog box, set the UpgradeAgent task parameter to the true value.

localized image

     8. Verify the installation and configuration of the product (one agent-side part) on the Delivery Controllers. For instructions, see Verifying the installation and configuration on the Delivery Controllers.

     9. (this step is applicable only when installed Machine Agent is part of the deployment of your earlier product version)

Install the product (the other agent-side part) on the proxy nodes. For instructions, see Installing the product on the proxy nodes.
Note: The installation process upgrades the product and preserves local configuration data.

     10. (this step is applicable only when installed Machine Agent is part of the deployment of your earlier product version)
Verify the installation and configuration of the product (the other agent-side part) on the proxy nodes. For instructions, see Verifying the installation and configuration on the proxy nodes.

Back to Top