Installing the Microsoft HPC Pack Web Components
Updated: June 29, 2011
Applies To: Windows HPC Server 2008 R2
In Windows HPC Server 2008 R2 SP2 or later, you can install and configure the HPC Pack 2008 R2 web components. The web components include the following:
-
The Windows HPC Server Web Portal, which cluster users can use to submit and manage jobs
-
An interface to the HPC Job Scheduler Service using an HTTP web service that is based on the representational state transfer (REST) model
Note |
|---|
| The HPC Pack 2008 R2 web components can only be installed on the head node of the cluster. |
To install the HPC Pack 2008 R2 web components, you must use the installation file HpcWebComponents.msi. HpcWebComponents.msi is included in the HPC2008R2SP2-Update-x64.zip file available at the Microsoft Download Center, or you can locate the file on the full installation media for HPC Pack 2008 R2 with SP2 or later.
To install the web components, perform the following steps:
-
Run HpcWebComponents.msi
-
Choose an SSL certificate for the HPC web components
-
Configure the web components
-
Validate the installation of the Windows HPC Server Web Portal
First, run the HpcWebComponents.msi installation program on the head node computer. Follow the steps in the wizard.
Note |
|---|
If you have configured the head node of your cluster for high availability in the context of a failover cluster, run HpcWebComponents.msi first on the active head node, and then on the passive head node. |
To communicate with web clients over Secure Sockets Layer (SSL), the HPC web components use an SSL certificate that is bound to the port that is used for communication (port 443 by default). If a certificate is not already bound to this port, you must specify the thumbprint of a X.509 certificate during the configuration of the web components. It is recommended that you obtain a trusted certificate from an appropriate certification authority, but you can generate and install a temporary certificate for testing purposes. If you choose to generate and install a temporary certificate for use with the web components, see How to: Create Temporary Certificates for Use During Development. Optionally, when you run the configuration script Set-HPCWebComponents.ps1 (which is installed when you run HpcWebComponents.msi), you can choose to generate and install a self-signed certificate, which you may also find useful for testing or proof-of-concept deployments.
Important |
|---|
|
To configure the Windows HPC Server Web Portal and the REST interface, you must run the provided HPC PowerShell script %CCP_HOME%\bin\Set-HPCWebComponents.ps1. When you run the script, you specify parameters as indicated in the following table:
| Parameter | Description | ||
|---|---|---|---|
|
-Service <ComponentType> |
Configures the component specified by <ComponentType>. Valid values are Portal or REST. You can omit “-Service”.
|
||
|
-enable | -disable |
Enables or disables a component. |
||
|
-Port <PortNumber> |
Configures the component to use the specified port <PortNumber>. If the parameter is not specified, the script configures port 443 by default. |
||
|
-Certificate <CertThumbprint> |
Binds the SSL certificate specified using the thumbprint <CertThumbprint>.
|
||
|
-AuthenticationMethod <Method> |
Configures the component to use a specified authentication method. Valid values are Basic or NTLM. If the parameter is not specified, the script configures Basic authentication by default. |
Choose one of the following two procedures to set up the web components:
-
Configure the web components on a single head node
-
Configure the web components on a head node configured for high availability in a failover cluster
Important You must configure the web components to use identical certificates and port bindings on both head nodes of the failover cluster.
-
Click Start, point to All Programs, click Microsoft HPC Pack, right-click HPC PowerShell, and then click Run as administrator.
-
To view the current port configurations for SSL certificates, type the following command:
netsh http show sslcert
In the command output, note any IP:port bindings.
-
If you need to delete an existing SSL certificate binding to the port <PortNumber> that you plan to use for the web components, type the following:
netsh http delete sslcert 0.0.0.0:<PortNumber>
-
To change the directory to the location of the script, type:
cd $env:CCP_HOME\bin -
To configure the Windows HPC Server Web Portal, run the
Set-HPCWebComponents.ps1HPC PowerShell script using the–Service Portalparameter:-
If no existing SSL certificate is bound on the default port 443, to run the script so that the available certificates are displayed, type:
.\Set-HPCWebComponents.ps1 –Service Portal -enable-
When prompted, type the number of a certificate in the list of available certificates. If you want the script to generate and configure the portal with a self-signed certificate, type 0.
-
When prompted, type the number of a certificate in the list of available certificates. If you want the script to generate and configure the portal with a self-signed certificate, type 0.
-
To run the script by specifying port <PortNumber> and the thumbprint <CertThumbprint> of an SSL certificate, type:
.\Set-HPCWebComponents.ps1 –Service Portal –enable –certificate <CertThumbprint> -Port <PortNumber>
Important If an SSL certificate is already bound on the port <PortNumber>, you must either specify that certificate when you run the script, or choose a different certificate and port binding.
-
If no existing SSL certificate is bound on the default port 443, to run the script so that the available certificates are displayed, type:
-
To configure the REST interface, run the
Set-HPCWebComponents.ps1HPC PowerShell script using the–Service RESTparameter:-
If no existing SSL certificate is bound on the default port 443, to run the script so that the available certificates are displayed and the REST service uses Basic authentication, type:
.\Set-HPCWebComponents.ps1 –Service Portal -enable-
When prompted, type the number of a certificate in the list of available certificates. If you want the script to generate and configure the portal with a self-signed certificate, type 0.
-
When prompted, type the number of a certificate in the list of available certificates. If you want the script to generate and configure the portal with a self-signed certificate, type 0.
-
To run the script by specifying the NTLM authentication method, port <PortNumber>, and the thumbprint <CertThumbprint> of an SSL certificate, type:
.\Set-HPCWebComponents.ps1 -Service REST -enable –AuthenticationMethod NTLM –certificate <CertThumbprint> -Port <PortNumber>
Important If an SSL certificate is already bound on the port <PortNumber>, you must either specify that certificate when you run the script, or choose a different certificate and port binding.
-
If no existing SSL certificate is bound on the default port 443, to run the script so that the available certificates are displayed and the REST service uses Basic authentication, type:
-
On the active head node, click Start, point to All Programs, click Microsoft HPC Pack, right-click HPC PowerShell, and then click Run as administrator.
-
To configure the web components on the active head node of the failover cluster, follow steps 2 – 6 in the preceding procedure to configure the HPC Server Web Portal and the REST interface.
-
If you generated and configured a self-signed certificate on the active head node for the web components, export the certificate as a .cer file and import it on the other head node by performing the following steps:
-
On the active head node, click Start, click Run, and then type mmc to start the Microsoft Management Console.
-
On the File menu, click Add/Remove Snap-in. The Add or Remove Snap-ins dialog box appears.
-
In Available snap-ins, click Certificates, and then click Add.
-
Select Computer account, and then click Next.
-
Select Local computer, and then click Finish. Click OK.
-
In the Microsoft Management Console, in the console tree, expand Certificates, expand Personal, and then expand Certificates.
-
Right-click the self-signed certificate that was created in the previous step (with a name of the form MyHeadNode.contoso.com), and then click Export. The Certificate Export Wizard appears.
-
Accept the default selections in the wizard and specify a file name and a location on the failover disk of the failover cluster (or on portable storage media). Do not export the private key.
- On the Completing the Certificate Export Wizard page, click Finish.
- Using Failover Cluster Manage, move (fail over) the clustered instance to the other head node in the failover cluster.
- On the head node that is now active, Click Start, click Run, and then type mmc to start the Microsoft Management Console.
- On the File menu, click Add/Remove Snap-in. The Add or Remove Snap-ins dialog box appears.
- In Available snap-ins, click Certificates, and then click Add.
- Select Computer account, and then click Next.
- Select Local computer, and then click Finish. Click OK.
- In the Microsoft Management Console, in the console tree, expand Certificates, and then expand Personal.
- Right-click Certificates, and then click Import. The Certificate Import Wizard appears.
- Follow the pages of the wizard to import the .cer file from the location where you stored it, into the Personal certificate store.
-
On the active head node, click Start, click Run, and then type mmc to start the Microsoft Management Console.
-
If you configured a certificate other than a self-signed certificate for the web components on the active head node, ensure that you have imported this certificate on the other (inactive) head node of the failover cluster.
-
If you have not already done so, fail over to the other head node in the failover cluster (the head node on which you have not already run the
Set-HPCWebComponents.ps1script). -
To start HPC PowerShell. click Start, point to All Programs, click Microsoft HPC Pack, right-click HPC PowerShell, and then click Run as administrator.
-
To configure the web components on the active second node of the failover cluster, follow steps 2 – 6 in the preceding procedure to configure the HPC Server Web Portal and the REST interface.
Important -
Ensure that you configure the same certificate and port bindings that you configured on the other head node in the failover cluster.
-
If the script generated and configured a self-signed certificate on the other head node, do not type 0 to generate a self-signed certificate on the current head node. Type the number that corresponds to the name of the certificate that you imported from the other head node.
-
Ensure that you configure the same certificate and port bindings that you configured on the other head node in the failover cluster.
-
Run the
Set-HPCWebComponents.ps1HPC PowerShell script so that the available certificates are displayed. Type:.\Set-HPCWebComponents.ps1 Portal -enable-
When prompted, type the number of a certificate in the list of available certificates. Choose the number that corresponds to the certificate that you configured on the other head node in the failover cluster.
Important If the script generated and configured a self-signed certificate on the other head node, do not type 0 to generate a self-signed certificate on the current head node. Type the number that corresponds to the name of the certificate that you imported from the other head node.
-
When prompted, type the number of a certificate in the list of available certificates. Choose the number that corresponds to the certificate that you configured on the other head node in the failover cluster.
To confirm that the Windows HPC Server Portal is configured properly, open a browser, then browse to the portal at the following address:
-
On a single head node (one that is not configured for high availability): https://<HeadNodeName>:<PortNumber>/hpcportal. where <HeadNodeName> is the computer name of the head node and <PortNumber> is the port that is bound by the SSL certificate
-
On a head node configured for high availability: https://<FQVN>:<PortNumber>/hpcportal, where <FQVN> is the fully qualified virtual name of the failover cluster for the head nodes and <PortNumber> is the port that is bound by the SSL certificate. Example: VirtHN.contoso.com.
Note |
|---|
| You must enable AJAX (active scripting) in your browser to view the portal content. For more information, see How to enable scripting in your browser (http://go.microsoft.com/fwlink/p/?LinkId=217076). |
-
If you generated a self-signed certificate to configure HPC Server Web Portal, you may see certificate errors or warnings in your browser when you try to access the portal. To avoid this, you can export the self-signed certificate from the Personal certificate store of the local computer account on head node, and import it in the Trusted Root Certification Authorities certificate store on the computer where you are accessing the portal.
-
If you configured the portal on a head node configured for high availability in the context of a failover cluster, the state of the web portal does not persist if the head node fails over. Any clients that connect to the portal must refresh their connections.
-
For information about creating a job submission page that lets users submit a job from the HPC Server Web Portal, see the Windows HPC Server 2008 R2 SP2 Test Focus Guide (http://technet.microsoft.com/library/hh184316(WS.10).aspx).

Note 