Share via

Commission and Decommission the HPC Basic Profile Web Service

  • Article

Applies To: Windows HPC Server 2008

The HPC Basic Profile Web Service is installed by default on the head node of your Windows HPC Server 2008 cluster, but the service is not activated by default. To start the service for the first time, you must commission the service.

To remove the changes that were made to the head node to commission the HPC Basic Profile Web Service, you can decommission the service.

  • Commissioning the HPC Basic Profile Web Service

  • Decommissioning the HPC Basic Profile Web Service

Commissioning the HPC Basic Profile Web Service

You can configure and activate the HPC Basic Profile Web Service by running the provided PowerShell script %CCP_HOME%\bin\hpcbpws.ps1. By default, the script configures the HPC Basic Profile Web Service to:

  • Operate on port 443 (the default port number for network traffic using the Secure Hypertext Transfer Protocol (HTTPS)).

  • Be externally accessible through the head node’s fully qualified domain name (FQDN). The default URL is based on the computer name of the head node (for example, https://<computerName>/HPCBasicProfile, where computerName is the FQDN of the head node).

To operate the web service on a different port number, or for the service to be accessible from an external network through a different FQDN (for example, if your head node is behind a firewall), you can specify the port and the externally addressable network address when you commission the service. This information is added to the HPC Basic Profile configuration file. For more information, including additional configuration options, see Understanding Configuration Options for the HPC Basic Profile Web Service.

Important

You must have an X.509 certificate for your service in the certificate store of the head node. The name that is used in the certificate must match the FQDN of the computer that the web service clients will be using to connect to the web service. In many cases, this will be the FQDN of the head node, but if the head node is behind a firewall, then it will be the URL that you specify to expose the service. For more information about certificates, see Securing the HPC Basic Profile Web Service.

To commission the HPC Basic Profile Web Service

  1. Log on to your head node as a user with Administrator privileges.

  2. Click Start, point to All Programs, click Microsoft HPC Pack, right-click HPC PowerShell, and then click Run as administrator.

  3. Run the hpcbpws.ps1 PowerShell script:

    Important

    The Windows PowerShell execution policy on your head node must allow scripts to run. For more information, see get-help about_signing.

    • To install the service using the current host name and the default port, type:

      hpcbpws.ps1 install

    • Alternately, to specify a URL and a port number for the service, type (where myExternalAddress is the URL you will use to expose the service, and portNumber is the port you will use):

      hpcbpws.ps1 install https://<myExternalAddress:portNumber>/HPCBasicProfile

  4. When prompted, select a certificate from the list of available certificates.

    Note

    If the required certificate is not available, or there are no certificates available, then exit the script and ensure that the appropriate certificate is available. For more information, see Securing the HPC Basic Profile Web Service.

Decommissioning the HPC Basic Profile Web Service

To remove the changes that were made to the head node to commission the HPC Basic Profile Web Service, run the %CCP_HOME%\bin\hpcbpws.ps1 script in its uninstall mode. Run this script in uninstall to:

  • Stop the HPCBP Web Service and not start the service if the computer is rebooted.

  • Remove the local firewall exception that provides access to the HPCBP Web Service.

  • Remove the previously installed https certificate binding (optional).

Important

The Windows PowerShell execution policy on your head node must allow scripts to run. In the HPC PowerShell window, see get-help about_signing for more details.

To decommission the HPC Basic Profile Web Service

  1. Log on to your head node as a user with Administrator privileges.

  2. Click Start, point to All Programs, click Microsoft HPC Pack, right click HPC PowerShell, and then click Run as administrator.

  3. Type hpcbpws.ps1 uninstall

  4. When prompted, either select a port binding to remove, or type 0 to skip.

Additional considerations

  • The contents of the certificate store can be examined through the Microsoft Management Console (MMC) by loading the certificate snap-in. If the required certificate is not available or there are no certificates available, you can create or import a certificate. For more information, see Securing the HPC Basic Profile Web Service.

Additional references