Product Documentation

Install and configure

Nov 27, 2017

This chapter contains instructions that you must follow to install and configure Citrix SCOM Management Pack for StoreFront. Perform all procedures in the documented order of precedence.

Note: Citrix recommends that you use the same versions of the Citrix SCOM Management Pack and of the Citrix SCOM Management Pack Agent to ensure that all features work correctly.

Preparing for the installation

Before installing the Citrix SCOM Management Pack for StoreFront, make sure the following prerequisites are fulfilled:

  • Your environment meets the software requirements. For software requirements, see System Requirements
  • A computer is chosen on which a SCOM management server resides and where the server side of the Citrix SCOM Management Pack for StoreFront will be installed. This computer is referred to as SCOM management server.
  • SCOM agent is installed on all the computers that host StoreFront, and these computers are configured as agent-managed computers in the SCOM management group.
  • A probing user account for actively monitoring the StoreFront computers is chosen. This must be a domain user account.
  • With stores configured to allow access by authenticated users only, the Username and password method is configured as the authentication method (the authentication service uses explicit authentication). For more information, see the Create and configure the authentication service webpage.

Installing the product on the SCOM management server

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

To install the Citrix SCOM Management Pack for StoreFront 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_StoreFront_<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.
  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.
  6. In the Destination Folder page, define the Citrix SCOM Management Pack for StoreFront installation folder. Citrix recommends that you install Citrix SCOM Management Pack for StoreFront 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 sub-steps:
    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.
    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.
  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.
    If you let the Setup Wizard to automatically import the management packs, click Next. Else, click Finish to close the Setup Wizard.
  10. If you let the Setup Wizard to automatically import the management packs, it displays the Executing post-install actions page. Attend the import process.
  11. In the post-installation completion page, review the management packs import log, and click Finish to close the Setup Wizard.

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 previously installed and configured any of the following Citrix Management Pack products on the same computer, you may not need to repeat the steps:

  • Citrix SCOM Management Pack for Provisioning Services 
  • Citrix SCOM Management Pack for ShareFile
  • Citrix SCOM Management Pack for Web Interface
  • Citrix SCOM Management Pack for XenApp and XenDesktop
  • Citrix SCOM Management Pack for XenApp
  • Citrix SCOM Management Pack for XenMobile
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.
    Important: Citrix recommends creating a new, dedicated user account that you will use only for deployment of the Citrix SCOM Management Pack for StoreFront Agent to managed computers.
  3. Using an operating system administrative tool, add the user account to the local CitrixMPShareUsers user group.
  4. Launch the SCOM Operations console. 
  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).
  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.
  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.
  16. In the left pane, under Run As Configuration, click Profiles
  17. In the Profiles list, double-click Citrix Management Pack Network Share Account.
  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.
  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.
  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 StoreFront 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 StoreFront
  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.

Note The shared folder is vital for installation of the Citrix SCOM Management Pack for StoreFront Agent 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 figure.

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 StoreFront  1.12.91.0
Citrix Management Pack Library 1.0.38.0

Configuring SCOM agent to act as proxy on StoreFront computers

SCOM agent on each computer where StoreFront 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 StoreFront 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 encryption password

The encryption password is required to generate a key that is used to encrypt the configuration data. Set the encryption password on the first run of the StoreFront MP Configuration tool.
To set the encryption password:

  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. Select StoreFront MP Configuration.
  4. Go to the Configuration encryption tab.
  5. Click Set.
  6. In the dialog for inserting the password, type the password and click Set

Note: Setting the encryption password is a prerequisite to saving the configuration data. If the encryption password is not set, the configuration tool automatically starts on the Configuration encryption tab.

Figure Configuration encryption tab of the Citrix Management Pack Configuration tool

localized image

The encryption password must be shared with the Citrix SCOM Management Pack for StoreFront Agent to be used to decrypt the configuration data. To share the encryption password, while running the Install Citrix MPSF Agent task, override the Encryption password parameter with the password you set in Step 3. See the Installing the product on the StoreFront computers section. 

To update the encryption password:

  1. In the StoreFront MP Configuration tool, go to the Configuration encryption tab. 
  2. Click Update
  3. In the dialog for inserting the password, type the password and click Update.

If you update or set the encryption password after the agent is installed, run the Update Configuration on Citrix MPSF Agent task. Override the Encryption password parameter in these tasks with the updated password.

Setting up probing user accounts for StoreFront availability

For monitoring the StoreFront store services availability, setting up an account that will be used for probing is required.

To set up a probing user account, do the following:

  1. Choose an appropriate probing user account for actively monitoring the StoreFront agent-managed computers. The user account does not require administrative privileges, but must have logon rights on the store. Citrix recommends that you use a dedicated user account.
  2. Log on to the management server. Use a user account that has local administrative privileges.
  3. Go to Start > All apps > Citrix (actions of this step may differ on operating systems earlier than Windows Server 2016).
  4. Click StoreFront MP Configuration.
  5. In the Citrix Management Pack Configuration window, in the StoreFront availability tab, click Add.
  6. In the Add StoreFront store services probe user account dialog box, type the following data in the respective text boxes:
    • Properties of the probing user account:
      • User name 
      • Password
localized image

     7. Click OK.
     8. Optional. To modify the user name or password for a probing user account configuration, click Modify. In the Modify StoreFront store services probe user account dialog box, modify the data as required, and then click OK.
     9. Optional. To remove a probing user account configuration, click Remove and then click Yes.
     10. Click OK to apply the configuration changes and close the window.

Note: If you modify user name or password for a probing user account configuration when the Citrix SCOM Management Pack for StoreFront Agent is already installed on the StoreFront computes, run the Update Configuration on Citrix MPSF Agent task from the SCOM Operations console to refresh the local configuration data.

Installing the product on the StoreFront computers

On the StoreFront computers, only the Citrix SCOM Management Pack for StoreFront Agent must be installed.

To install the Management Pack agent on a StoreFront computer, 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 StoreFront Computers.
  3. In the StoreFront Computers pane, select a StoreFront computer from the StoreFront Computers list.
  4. In the Tasks pane, expand StoreFront Computer Role Tasks, and then click Install Citrix MPSF Agent.
  5. In the Run Task - Install Citrix MPSF 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 for StoreFront Agent 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 
    • Encryption password: Override this parameter with the encryption password you set in Step 3 of the Configuring encryption password section.
      Default value: (empty)
    • 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 the Citrix SCOM  Management Pack for XenApp and XenDesktop is installed, leave the value empty. The location is 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 the 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. 
    • AgentInstallationDestination: This option defines the Management Pack agent's program installation folder on the agent-managed computer. If no value is specified, the Management Pack agent is installed to the %ProgramFiles%\Citrix\StoreFront MP Agent folder.
      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 StoreFront computer is correct.
    Tip: 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 MPSF Agent task to pinpoint the problematic prerequisite.
    Tip: The Agent installation task can be run for multiple selected StoreFront computers.

Verifying the installation and configuration on the StoreFront computers

To verify that the Management Pack agent installation and configuration on a StoreFront computer 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 StoreFront Computers.
  3. In the StoreFront Computers pane, select the StoreFront computer (on which StoreFront Management Pack Agent was just installed) from the StoreFront Computers list.
  4. In the Tasks pane, expand Actions, and then click Check Requirements and Configuration for Citrix MPSF Agent.
  5. Observe the output the task generates. If all checks are denoted successful, the installation and configuration on the StoreFront computer are correct.

Uninstallation

This chapter contains instructions that you must follow to effectively uninstall Citrix SCOM Management Pack for StoreFront. Perform all procedures in the documented order of precedence.

Uninstalling the product from the StoreFront computers

To uninstall Citrix SCOM Management Pack for StoreFront Agent from a StoreFront 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 StoreFront Computers
  3. In the StoreFront Computers pane, select a StoreFront computer from the StoreFront Computers list.
  4. In the Tasks pane, expand Actions, and then click Uninstall Citrix MPSF Agent.
  5. In the Run Task - Uninstall Citrix MPSF Agent dialog box, click Run to invoke the uninstallation process.
  6. Repeat steps 3 to 5 for each additional StoreFront computer. 

Tip: The Agent uninstallation task can be run for multiple selected StoreFront computers.

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 the Citrix SCOM Management Pack for StoreFront, 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 StoreFront Management Pack.
  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 StoreFront, 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.
      Tip: 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 StoreFront, 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. 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 StoreFront 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 StoreFront 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\StoreFront MP folder.
    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.

Upgrading

To upgrade Citrix SCOM Management Pack for StoreFront from an earlier version, do the following: 

  1. Prepare your environment for installation of the new product version. For information, 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: Installation process upgrades the product while preserving 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. (this step is applicable only to upgrade from version 1.4) On the SCOM management server, move the mpsf_config.dat file from the %ProgramData%\ComTrade\MPShare\StoreFront MP folder to the %ProgramData%\Citrix\CitrixMPShare\StoreFront MP folder.
  5. (this step is applicable only to upgrade from version 1.4) Configure access to the shared folder for agent installation. For instructions, see Configuring access to the shared folder for agent installation.
  6. Install the product (its agent-side part) on the StoreFront computers. For instructions, see Installing the product on the StoreFront computers.
    Important In the Run Task - Install Citrix MPSF Agent dialog box, set the UpgradeAgent task parameter to true.
localized image

 7. Verify the installation and configuration of the product (its agent-side part) on the StoreFront computers. For instructions, see Verifying the installation and configuration on the StoreFront computers.