(dist)

Configure a web server plug-in using the pct tool

The WCT command invokes a command-line tool specified by the -tool parameter. We can use the WCT command and specify the pct tool to configure a web server to use an application server as a hosting server.

(v8552)

Supported configurations: The LINUX operating system supports only the command line for the pct tool. The GUI of the pct tool is not supported.

Configure a web server to use an application server as a hosting server.

Location of the WCT command

The product includes the following script that sets up the environment and invokes the WCT command.

  • WCT_install_root\WCT\wctcmd.bat

  • WCT_install_root/WCT/wctcmd.sh

Syntax of the WCT command when invoking the pct tool

wctcmd.bat
      -tool pct
      -defLocPathname definition_location_pathname
      -defLocName definition_location_name
      -importDefinitionLocation
      -removeDefinitionLocation definition_location_name
      -listDefinitionLocations
      -createDefinition
      -deleteDefinition webserver_definition_name
      -listDefinitions
      -response response_file

./wctcmd.sh       -tool pct
      -defLocPathname definition_location_pathname
      -defLocName definition_location_name
      -importDefinitionLocation
      -removeDefinitionLocation definition_location_name
      -listDefinitionLocations
      -createDefinition
      -deleteDefinition webserver_definition_name
      -listDefinitions
      -response response_file

Parameters of the WCT command when invoking the pct tool

-tool pct

Name of the tool to launch as it is registered with the WCT command

Required.

-defLocName definition_location_name

Logical name of the plug-in runtime root location

This parameter is required when creating or delete a definition.

-defLocPathname definition_location_pathname

Absolute path name of the existing plug-in runtime root location

Required when creating or delete a definition.

(v8550) -importDefinitionLocation

Specifies to import a web server plug-ins runtime location into the tool registry

A new definition is created as part of this operation.


Usage example:

    wctcmd.bat -tool pct -importDefinitionLocation -defLocPathname C:\data\IBM\WebSphere\Plugins -defLocName DefinitionLocationName -response C:\IBM\WebSphere\tools\WCT\responsefile.txt

    ./wctcmd.sh -tool pct -importDefinitionLocation -defLocPathname /opt/IBM/WebSphere/Plugins -defLocName DefinitionLocationName -response /opt/IBM/WebSphere/tools/WCT/responsefile.txt

(v8550) -listDefinitionLocations

Specifies to generate a list of all definition locations

Usage example:

    wctcmd.bat -tool pct -listDefinitionLocations

    ./wctcmd.sh -tool pct -listDefinitionLocations

-removeDefinitionLocation

The pct tool should remove a definition location

This parameter is used when you remove a definition location.

Usage example:

    wctcmd.bat -tool pct -removeDefinitionLocation -defLocPathname C:\data\IBM\WebSphere\Plugins

    ./wctcmd.sh -tool pct -removeDefinitionLocation -defLocPathname /opt/IBM/WebSphere/Plugins

or

    wctcmd.bat -tool pct -removeDefinitionLocation -defLocName DefinitionLocationName

    ./wctcmd.sh -tool pct -removeDefinitionLocation -defLocName DefinitionLocationName

-createDefinition

Specifies that you are creating a new web server definition

Usage example:

    wctcmd.bat -tool pct -createDefinition -defLocName DefinitionLocationName -response C:\IBM\WebSphere\tools\WCT\responsefile.txt

    ./wctcmd.sh -tool pct -createDefinition -defLocName DefinitionLocationName -response /opt/IBM/WebSphere/tools/WCT/responsefile.txt

-deleteDefinition webserver_definition_name

Unique web server plug-in definition to be deleted

This parameter is used when you delete an existing definition.

The definition_name is required. Either one of the following parameters is also required:

  • defLocName definition_location_name

  • defLocPathname definition_location_pathname

If both parameter values are supplied, the first one is used. If the first value supplied does not pass the validation check, the command fails with an error message.

Usage example:

    wctcmd.bat -tool pct -defLocPathname C:\data\IBM\WebSphere\Plugins -defLocName DefinitionLocationName -deleteDefinition WebServerDefinitionName

    ./wctcmd.sh -tool pct -defLocPathname /opt/IBM/WebSphere/Plugins -defLocName DefinitionLocationName -deleteDefinition WebServerDefinitionName

(v8550) -listDefinitions

Specifies to generate a list of all definitions

Usage example:

    wctcmd.bat -tool pct -listDefinitions -defLocName DefinitionLocationName

    ./wctcmd.sh -tool pct -listDefinitions -defLocName DefinitionLocationName

-response response_file

Response file containing tool arguments

This parameter is required when creating a definition.

  • Command-line arguments are case sensitive.

  • If an argument accepts a value containing spaces, the value must be enclosed in double quotes (" ").

Parameters of the pct tool

General parameters

Parameter Values

configType

Configuration type

local_standalone

WebSphere Application Server and web server on same machine

remote

WebSphere Application Server and web server on separate machines

local_distributed

Profile on WebSphere Application Server is federated to a deployment manager

wasExistingLocation

Location of the WAS installation home directory

This option is valid only for a local configuration type.

Location of the WAS installation home directory

webServerSelected

Specifies the web server to be configured

Specify only one web server to configure.

apache22

Apache Web Server Version 2.2

domino7

Lotus Domino Web Server Version 7.0

Not supported on HP-UX or Solaris x64 (x86_64)

domino8

Lotus Domino Web Server Version 8.0

Not supported on HP-UX or Solaris x64 (x86_64)

ihs

IBM HTTP Server Version 7.0

iis6

Microsoft Internet Information Services Version 6

Supported on Windows

iis7

Microsoft Internet Information Services Version 7

Supported on Windows

iis8

Microsoft Internet Information Services Version 8

Supported on Windows

sunone

Sun Java System Web Server Version 6.1 or Sun Java System Web Server Version 7.0

ihsAdminPort

Specifies the HTTP administration port number

Specify this value only when configuring IHS.

HTTP administration port number

ihsAdminUserID

Specifies the IHS administrator user ID for the IHS administration server

Specify this value only when configuring IHS.

IHS administrator user ID for the IHS administration server

ihsAdminUserGroup

User group for the IHS administration server

Specify this value only when configuring IHS.

User group for the IHS administration server

webServerConfigFile1

First web server configuration file

The specified file must exist.

apache

httpd.conf

Restriction: To successfully configure the server, the name of the configuration file must be retained as httpd.conf.

domino7

notes.jar

domino8

notes.jar

ihs

httpd.conf

Restriction: To successfully configure the server, the name of the configuration file must be retained as httpd.conf.

sunone

magnus.conf

webServerConfigFile2

Second web server configuration file

The specified file must exist.

domino7

names.jar

domino8

names.jar

sunone

obj.conf

webServerPortNumber

Specifies the web server port for the web server to be configured

Web server port for the web server to be configured

dominoUserID

Specifies the Domino Version 7.0 or 8.0 user ID

Domino Version 7.0 or 8.0 user ID

webServerDefinition

Specifies the web server definition name

No spaces are allowed in the web server definition name.

Web server definition name with no spaces

wasMachineHostName

Specifies the WAS machine hostname

This specification can be omitted for a local_standalone installation type.

For a remote installation type:

"hostname"

Installation will use the hostname hostname on the machine.

For a local installation type:

""

The hostname of the target installation machine will be used.

If we use the WCT comand to create multiple web servers and run WCT on the web server machines as required, the hostname of each web server is a derived hostname - based on the same type for which you query the operating system for the hostname.

Running WCT this way results in the creation of two script files with the same hostname that will be used to create the node and the serverIndex.xml file.

With two web servers on the same machine, you will have two network IP addresses, for which you may want to have unique hostnames.

Because the hostname was derived and you received no prompt for the web server hostname, the WCT tool and associated configurewebserverx.bat/sh script will create a node and a serverIndex.xml file with the same hostname.

To verify the two Web Servers created on the same machine have two different network IP addresses, go to the console and do the following:

  1. Servers > Web Servers > webserverName

  2. Click Ports

  3. If a managed node, Click WEBSERVER_ADDRESS. If an unmanaged node, Click WEBSERVER_ADMIN_ADDRESS

  4. Change the IP addresses (hostname).

  5. Click OK and Save.

Advanced parameters (available in silent installations only)

Parameter Values

mapWebserverToApplications

Whether or not to map all the existing deployed applications to the web server

If this not set to a valid option, the installer will set it to true and continue the installation.

true

The web server definition is mapped as a target to the existing deployed applications such as snoop and hit count. (Recommended)

false

No applications are mapped to the web server definition.

webServerHostName

In advanced scenarios where a user has multiple web server hostnames on a machine, specifies the web server hostname used to configure

""

Installation will resolve to the hostname detected on the machine. (Recommended)

"hostname"

Installation will use the hostname hostname on the machine.

webServerInstallArch

Specifies the web server installation architecture

"32"

Valid for 32-bit web server installations

"64"

Valid for 64-bit web server installations

""

Architecture of the web server machine will be used

profileName

Name of the WAS profile to be configured

"profile_name"

We must enter the name of an existing WebSphere Application Server profile.

Leaving the string empty will result in the installer using the default profile.

This option is valid only in local installation scenarios.

ihsAdminPassword

User password to the IHS administrative server to be configured

Specify this value only when configuring IHS.

"IHS_admin_password"

We must enter the password of the user that will be used to configure the IHS administrative server.

enableAdminServerSupport

Whether or not to configure the IHS administrative server

Specify this value only when configuring IHS.

true

Support will be enabled and the IHS administrative server will be configured.

false

Support will not be enabled and the IHS administrative server will not be configured.

enableUserAndPass

Whether or not to enable support to configure the IHS administrative server with a user ID and password as credentials

Specify this value only when configuring IHS.

true

Support to configure the IHS administrative server with a given user ID and password will be enabled.

The additional relevant credentials must be supplied.

false

Support to configure the IHS administrative server with a given user ID and password will not be enabled.

No additional values are required.

webServerType

Type of web server to be configured

Specify only one web server to configure.

APACHE

Apache Web Server Version 2.2

DOMINO

Lotus Domino Web Server Version 7.0 or Version 8.0

Not supported on HP-UX or Solaris x64 (x86_64)

IHS

IBM HTTP Server Version 7.0

IIS

Microsoft Internet Information Services Version 6, Version 7, or Version 8

Supported on Windows

SUNJAVASYSTEM

Sun Java System Web Server Version 6.1 or Version 7.0

ihsWindowsStartupType

Startup type of the IHS administrative service that is to be created on Windows

Specify this value only when configuring IHS.

For use with Windows operating systems only.

auto

Service will automatically start when the system is booted up.

demand

Service will start only when requested.

ihsAdminWinUserID

Specifies the ID of the user that will be used to configure the IHS administrative server on Windows

Specify this value only when configuring IHS.

For use with Windows operating systems only.

"IHS_admin_user_ID"

We must enter the name that will be used to configure the IHS administrative server.

ihsAdminWinPassword

Password of the user that will be used to configure the IHS administrative server on Windows

Specify this value only when configuring IHS.

For use with Windows operating systems only.

"IHS_admin_password"

We must enter the password of the user that will be used to configure the IHS administrative server.

enableWinService

Whether or not to configure the IHS administrative server to run as a Windows service

Specify this value only when configuring IHS.

For use with Windows operating systems only.

true

Support to configure the IHS administrative server as a Windows service will be enabled

false

Support to configure the IHS administrative server as a Windows service will not be enabled.

Example of using the pct tool to configure an IHS Web Server to use an application server as a hosting server:

  • wctcmd.bat -tool pct -defLocPathname C:\data\IBM\WebSphere\Plugins -defLocName someDefinitionLocationName -createDefinition -response C:\IBM\WebSphere\tools\WCT\responsefile.txt

  • ./wctcmd.sh -tool pct -defLocPathname /opt/IBM/WebSphere/Plugins -defLocName someDefinitionLocationName -createDefinition -response /opt/IBM/WebSphere/tools/WCT/responsefile.txt

The following is an example of the content of a response file for an IHS local plug-in configuration. The valid values for the webServerOS parameter, which is used to specify the web server operating system, are Windows, Linux, Solaris, AIX , HPUX, OS390, and OS400.

configType=local_standalone
enableAdminServerSupport=true
enableUserAndPass=true
enableWinService=false
ihsAdminCreateUserAndGroup=true
ihsAdminPassword=******
ihsAdminPort=8008
ihsAdminUnixUserGroup=grp101
ihsAdminUnixUserID=user1
mapWebServerToApplications=true
profileName=AppSrv01
wasExistingLocation=/opt/IBM/WebSphere/AppServer85
webServerConfigFile1=/opt/IBM/HTTPServer/conf/httpd.conf
webServerDefinition=webserver1
webServerHostName=local.ibm.com
webServerOS=operating_system_value
webServerPortNumber=80
webServerSelected=ihs

configType=local_standalone
enableAdminServerSupport=true
enableUserAndPass=true
enableWinService=true
ihsAdminPassword=******
ihsAdminPort=8008
ihsAdminUserID=admin1
ihsWindowsPassword=******
ihsWindowsStartupType=Automatic
ihsWindowsUserID=user1
mapWebServerToApplications=true
profileName=AppSrv01
wasExistingLocation=D:\\IBM\\WebSphere\\AppServer85
webServerConfigFile1=D:\\IBM\\HTTPServer\\conf\\httpd.conf
webServerDefinition=webserver1
webServerHostName=local.ibm.com
webServerInstallArch=32
webServerPortNumber=80
webServerSelected=ihs

The following is an example of the content of a response file for an IHS remote plug-in configuration. The valid values for the webServerOS parameter, which is used to specify the web server operating system, are Windows, Linux, Solaris, AIX, HPUX, OS390, and OS400.

configType=remote
enableAdminServerSupport=true
enableUserAndPass=true
enableWinService=false
ihsAdminCreateUserAndGroup=true
ihsAdminPassword=******
ihsAdminPort=8008
ihsAdminUnixUserGroup=grp101
ihsAdminUnixUserID=user1
mapWebServerToApplications=true
wasMachineHostname=192.168.1.2
webServerConfigFile1=/opt/IBM/HTTPServer/conf/httpd.conf
webServerDefinition=webserver1
webServerHostName=remote.ibm.com
webServerOS=operating_system_value
webServerPortNumber=80
webServerSelected=ihs

configType=remote
enableAdminServerSupport=true
enableUserAndPass=true
enableWinService=true
ihsAdminPassword=******
ihsAdminPort=8008
ihsAdminUserID=admin1
ihsWindowsPassword=******
ihsWindowsStartupType=Automatic
ihsWindowsUserID=user1
mapWebServerToApplications=true
wasMachineHostname=192.168.1.2
webServerConfigFile1=D:\IBM\HTTPServer\conf\httpd.conf
webServerDefinition=webserver1
webServerHostName=remote.ibm.com
webServerInstallArch=32
webServerOS=windows
webServerPortNumber=80
webServerSelected=ihs


What to do next

Best practice: We can use the pct tool If the machine has multiple hostnames and IP addresses. However, the hostname must be set after the configuration of the web server through the PCT GUI using the following process:

  1. Click Ports.

  2. Click WEBSERVER_ADDRESS. If it is an unmanaged mode, click WEBSERVER_ADMIN_ADDRESS.

  3. Change the hostname.

  4. Click OK to save.
best-practices