Product Documentation

Installing Power and Capacity Management

Oct 09, 2015
To install the Power and Capacity Management components, use the installation (MSI) packages interactively (wizard-based) or in a silent installation.
Installation Package Description
XenAppPCMAgent.msi Installer for the agent
XenAppPCMAdmin.msi Combined installer for the administration components (database, reports, concentrator, and management console)
If you are not installing all the administration components at the same time on the same computer, install them in the following order:
  1. Database
  2. Reports (Reports is a subfeature of the database feature; therefore, you can install reports only if you are also installing the database component, or if you previously installed the database component)
  3. Concentrator
  4. Management console

Preparing for Installation

Although Power and Capacity Management planning encompasses many considerations, preparation tasks specific to the component installation include:

  • Identify the XenApp servers you want in the Power and Capacity Management farm. For optimal operation, Power and Capacity Management should register (discover) all servers in the XenApp farm. You can then change the server control mode to unmanaged or managed (base load) for servers that are not power controlled. This practice prevents the possibility of session load being sent to XenApp farm servers that Power and Capacity Management is not aware of.
  • Decide where to install the Power and Capacity Management components.
    • Install the agent on each XenApp server.
    • You can install all the administration components on a single computer. You can also install one or more individual administration components on separate computers.
    • The XenApp servers on which you install the agent, and the computers on which you install the concentrator and management console must all belong to the same Active Directory domain. Install the database component either in the same Active Directory domain as the other components or in a trusted domain.
    • You do not have to run the installation of the Power and Capacity Management database component on the server where Microsoft SQL Server is installed. You can either run the installation process physically on the SQL Server or you can run the installation from any domain member machine. If you run the installation of the database component from a different server than SQL Server, the server on which you install the database component does not need to stay powered on.
  • Choose a farm name and workload name. You specify the farm name when installing the concentrator and the agent, and the workload name when installing the agent.

System Requirements for Power and Capacity Management

Important: The following requirements apply when using Power and Capacity Management components for a farm comprising XenApp for Windows Server 2008 R2 servers.

Supported Platforms

The Enterprise and Platinum Editions of XenApp for Windows Server 2008 R2 support this version of XenApp Power and Capacity Management.

The Power and Capacity Management farm can comprise physical and virtual XenApp servers:
  • Wake-on-LAN (WoL) power control is supported for physical XenApp servers on the same subnet.
  • Power on commands to XenServer virtual computers hosting XenApp servers (in one or more XenServer clusters) are supported through the XenServer API.

You can host XenApp on Microsoft Hyper-V or VMWare platforms and install the Power and Capacity Management agent. However, only capacity monitoring, reporting, and load consolidation are supported; power management is not supported.

Component Requirements

Unless otherwise noted, 32-bit and 64-bit editions are supported.
Component Support and Requirements

Database

Requirements:
  • Microsoft .NET Framework 3.5
  • Microsoft SQL Server 2005, Microsoft SQL Server 2008, or Microsoft SQL Server 2008 R2; see CTX114501 for the latest supported versions
  • Microsoft SQL Server Reporting Services
  • Internet Information Services (IIS) 6.0 (required only if using Microsoft SQL Server 2005)

Use Microsoft Internet Explorer to view reports.

Concentrator

Supported operating system: Windows Server 2008 R2 (64-bit)

Requirement: Microsoft .NET Framework 3.5

Agent

Supported operating system: Windows Server 2008 R2 (64-bit)

Requirements:
  • Microsoft .NET Framework 3.5
  • XenApp for Windows Server 2008 R2

Management console

Supported operating systems:
  • Windows Server 2003
  • Windows Server 2008
  • Windows Server 2008 R2 (64-bit)
  • Windows XP
  • Windows Vista
  • Windows 7
Requirements:

Considerations for Installing the Concentrator

When installing the concentrator, you specify the database (and the database instance, if you are not using the default instance). By default, the installer updates the database to give the concentrator necessary permissions. This action assumes that the user installing the concentrator has administrator privileges on the SQL Server instance to modify the permissions of the Power and Capacity Management database.

If the user installing the concentrator does not have administrator privileges on the SQL Server to modify the permissions of the Power and Capacity Management database:
  • In a wizard-based installation, select the Do not grant DB access to concentrator check box. (This check box appears only when you are not installing the concentrator and the database at the same time.)
  • In a silent installation, include the CTX_XAPCM_DO_NOT_ADD_ACCOUNT_TO_DB=yes property.

Then use SQL Server Management Studio to add the necessary permissions.

To add permissions to the database:
  1. Using SQL Server Management Studio, navigate to the main Security - Logins node.
  2. Add a new login for the concentrator identity. If you are running the concentrator as the default network service, this is domain-name\computer-name$. (If you are entering a machine account, do not use the Search button; instead, type the machine account name.)
  3. Navigate to the XenAppPCM database > Security > Users node.
  4. Add a new user. Citrix recommends the User Name be the same as the Login Name you specified in step 2. In the role membership list, select ConcentratorRole.

Installing a Second Concentrator

After installing the first concentrator on a machine, install another on a different computer. Ensure that you install only the concentrator. In the wizard based installation, deselect all other components. In a silent installation, include the ADDLOCAL=Concentrator property.

Interactively Installing Components

Interactively Installing the Agent

To interactively install the agent on a XenApp server, double-click XenAppPCMAgent.msi and follow the wizard prompts.

Interactively Installing the Administration Components

To interactively install the administration components (database, reports, concentrator, and management console), double-click XenAppPCMAdmin.msi and follow the wizard prompts.

By default, all administration components are selected, except reports.

Silently Installing Components

Silently Installing the Agent

Use the following command to silently install the Power and Capacity Management agent on a XenApp server.
msiexec /i XenAppPCMAgent.msi /qn CTX_XAPCM_ACCEPT_EULA=yes   
CTX_XAPCM_FARM_NAME=farm-name 
[CTX_XAPCM_WORKLOAD_NAME=workload-name] 
[CTX_XAPCM_AGENT_NOSTART=yes] 
[CTX_XAPCM_AGENT_ACCOUNT=domain-account]  
[CTX_XAPCM_AGENT_PASSWORD=domain-account-password]
CTX_XAPCM_ACCEPT_EULA=yes
Accepts the license agreement. To read the EULA (End User License Agreement), launch the installation interactively and navigate to the license dialog.
If you omit this property, or if the specified value is not "yes," the installation fails.
CTX_XAPCM_FARM_NAME=farm-name
Farm name, up to 80 characters, and cannot contain: backslash (\), single quote ('), forward slash (/), double-quote ("), less-than (<), greater than (>), pipe (|), or equal (=). The collection of XenApp servers being managed by Power and Capacity Management is known as a farm. This farm may include some or all of the servers in a XenApp farm or may contain XenApp servers from different XenApp farms. The name must be unique.
If you omit this property, the installation fails.
CTX_XAPCM_WORKLOAD_NAME=workload-name
Workload name, up to 256 characters. A workload is a logical grouping of servers that all host the same application or set of applications. In XenApp terms, this is referred to as an application silo.
If you omit this property, "Unassigned" is used. (You cannot enable power management or load consolation for an unassigned workload.)
CTX_XAPCM_AGENT_NOSTART=yes
Prohibits the Agent service from starting during installation.
If you omit this property, or if the specified value is not "yes," the Agent service starts during installation.
CTX_XAPCM_AGENT_ACCOUNT=domain-account
Domain account with the following rights:
  • Citrix administrator for the XenApp instance
  • Log on as service
  • Shut down the system
  • Query rights for Active Directory (to locate the "Citrix XenAppPCM" SCP for the farm assigned to this agent)
If you specify this property, you must specify a domain account password with the CTX_XAPCM_AGENT_PASSWORD property. You must also supply a domain account with the CTX_XAPCM_CONCENTRATOR_ACCOUNT property when installing the concentrator (because the Concentrator service cannot use a built-in account if the Agent service is using a domain account and vice versa).
If you omit this property, the built-in "Local System" account is used. In this case, do not specify the CTX_XAPCM_AGENT_PASSWORD property.
CTX_XAPCM_AGENT_PASSWORD=domain-account-password
Password for the domain account. This property is valid only if you specified a domain account with the CTX_XAPCM_AGENT_ACCOUNT property.

Example of Silently Installing the Agent

The following command silently installs the agent with:
  • A farm name of "my_farm"
  • A workload name of "my_workload"
  • The agent service running under the domain account "my_domain\my_user" with the password "my_password"
msiexec /i XenAppPCMAgent.msi /qn  
CTX_XAPCM_ACCEPT_EULA=yes CTX_XAPCM_FARM_NAME=my_farm  
CTX_XAPCM_WORKLOAD_NAME=my_workload  
CTX_XAPCM_AGENT_ACCOUNT=my_domain\my_user  
CTX_XAPCM_AGENT_PASSWORD=my_password

Silently Installing the Administration Components

Use the following command to silently install one or more Power and Capacity Management administration components.
msiexec /i XenAppPCMAdmin.msi /qn CTX_XAPCM_ACCEPT_EULA=yes  
[ADDLOCAL=components]  
[CTX_XAPCM_FARM_NAME=farm-name]  
[CTX_XAPCM_DB_INSTANCE=db-instance] 
[CTX_XAPCM_DB_NAME=db-name] 
[CTX_XAPCM_REPORT_URL=report-url]  
[CTX_XAPCM_DO_NOT_ADD_ACCOUNT_TO_DB=yes]  
[CTX_XAPCM_CONCENTRATOR_ACCOUNT=domain-account]  
[CTX_XAPCM_CONCENTRATOR_PASSWORD=domain-account-password]
CTX_XAPCM_ACCEPT_EULA=yes
Accepts the license agreement. To read the EULA, launch the installation interactively and navigate to the license dialog.
If you omit this property, or if the specified value is not "yes," the installation fails.
ADDLOCAL=components
Comma-separated list of components to be installed. Valid values are:
  • DatabaseInstaller
  • Reports
  • Concentrator
  • Console
Reports is a subfeature of the database component; therefore, you can install reports only if you are also installing the database component, or if you previously installed the database component.
If you omit this property, the database, concentrator, and management console components are installed; reports is not installed.
CTX_XAPCM_FARM_NAME=farm-name
Use this property when installing the database component.
Farm name, up to 80 characters, and cannot contain: backslash (\), single quote ('), forward slash (/), double-quote ("), less-than (<), greater than (>), pipe (|), or equal (=) . The collection of XenApp servers being managed by Power and Capacity Management is known as a farm. This farm may include some or all of the servers in a XenApp farm, or it may contain XenApp servers from different XenApp farms. The name must be unique.
If you are installing the database component and omit this parameter, the installation fails.
CTX_XAPCM_DB_INSTANCE=db-instance
Use this property when installing the database, reports, and concentrator components.
Database instance name.
  • If you are installing the database component, this property specifies the instance name of the SQL Server instance in which the Power and Capacity Management database schema is to be installed. If you are using the default SQL instance on this computer, specify "." (dot); otherwise, specify the computer and instance name (for example, SQLServer\instance1).
  • If you already installed the database component and are installing the concentrator, this property specifies the instance name of the SQL Server instance in which the schema is installed. If the default SQL instance on this computer was used, specify "." (dot); otherwise, specify the computer and instance name (for example, SQLServer\instance1").
If you omit this property, "." is used.
CTX_XAPCM_DB_NAME=db-name
Use this property when installing the database, reports, and concentrator components.
Database name, up to 123 characters. and cannot contain: semicolon (;), question mark (?), colon (:), at (@), ampersand (&), equal (=), plus (+), dollar ($), backslash (\), asterisk (*), less-than (<), greater-than (>), pipe (|), double-quote ("), forward-slash (/), single-quote ('), back-tick (`), left square bracket ([), right square bracket (]).
If you omit this property, "XenAppPCM" is used.
CTX_XAPCM_REPORT_URL=report-url
Use this property when installing the reports component.
Report service URL, up to 512 characters.
  • If you are using the default SQL Server instance, specify the server URL - http[s]://server_name/ReportServer.
  • If you are using a named SQL Server 2005 instance, specify the server URL qualified with the instance name (http[s]://server_name/ReportServer$instance_name.
  • If you are using a named SQL Server 2008 instance, specify the server URL qualified with the instance name (http[s]://server_name/ReportServer_instance_name.
If you omit this property, "http://local_machine_name/ReportServer" is used.
CTX_XAPCM_DO_NOT_ADD_ACCOUNT_TO_DB=yes
Use this property when the person installing the concentrator does not have administrator rights to the database. In this case, the database administrator must manually add the correct account to the database.
If you omit this property, or if the specified value is not "yes," the database is configured to accept connections from the concentrator.
CTX_XAPCM_CONCENTRATOR_ACCOUNT=domain-account
Use this property when installing the concentrator.
Domain account with a userPrincipleName attribute within Active Directory with the following rights:
  • Log on as service
  • Read/write rights for Active Directory (to create the "Citrix XenAppPCM" SCP for the farm this concentrator manages); for example, read/write access to the Active Directory concentrator computer container (CN)
If you specify this property, you must specify a password with the CTX_XAPCM_CONCENTRATOR_PASSWORD property. You must also supply a domain account for the CTX_XAPCM_AGENT_ACCOUNT property when installing the agent (because the Concentrator service cannot use a built-in account if the Agent service is using a domain account and vice versa).
If you omit this property, the built-in "Network Service" account is used. In this case, do not specify the CTX_XPCM_CONCENTRATOR _PASSWORD property.
CTX_XAPCM_CONCENTRATOR_PASSWORD=domain-account-password
Use this property when installing the concentrator and only if you specified a domain account with the CTX_XAPCM_CONCENTRATOR_ACCOUNT property.
Password for the domain account.

Example of Silently Installing the Administration Components

The following command silently installs all the administration components with:
  • A farm name of "my_farm"
  • The default SQL Server instance on a server named "my_db" with a database name of "my_dbname"
  • Reporting services on "http://my_report_server/reportserver"
  • The concentrator running under the domain account "my_domain\my_user" with the password "my_password"
msiexec /i XenAppPCMAdmin.msi /qn  
CTX_XAPCM_ACCEPT_EULA=yes  
ADDLOCAL=Concentrator,Console,DatabaseInstaller,Reports 
CTX_XAPCM_FARM_NAME=my_farm  
CTX_XAPCM_DB_INSTANCE=my_db CTX_XAPCM_DB_NAME=my_dbname 
CTX_XAPCM_REPORT_URL=http://my_report_server/reportserver  
CTX_XAPCM_CONCENTRATOR_ACCOUNT=my_domain\my_user  
CTX_XAPCM_CONCENTRATOR_PASSWORD=my_password

Removing Components

To remove Power and Capacity Management components, use Windows Add/Remove Programs.

Removing the Concentrator

If you deployed a concentrator running as a domain user, removing the concentrator (using Add/Remove Programs) may not remove the database entry. If this occurs, the concentrator continues to appear in the Cluster Management window.

To remove the database entry:
  1. Using an account with database administrator privileges, open SQL Server Management Studio and connect to the XenAppPCM database.
  2. Open the Concentrators table.
  3. Select the row containing the concentrator you uninstalled and delete the row.