Configuring a web server plug-in using the pct tool

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

Procedure

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

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

This parameter is required.

-defLocName definition_location_name

Specifies the logical name of the plug-in runtime root location

This parameter is required when you create or delete a definition.

-defLocPathname definition_location_pathname

Specifies the absolute path name of the existing plug-in runtime root location

This parameter is required when you create or delete a definition.

-importDefinitionLocation

Specifies that you want 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

-listDefinitionLocations

Specifies that you want to generate a list of all definition locations

Usage example:

wctcmd.bat -tool pct -listDefinitionLocations

./wctcmd.sh -tool pct -listDefinitionLocations

-removeDefinitionLocation

Specifies that 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

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

Specifies the 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

-listDefinitions

Specifies that you want 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

Specifies the response file containing tool arguments

This parameter is required when you create a definition.

Notes:

Command-line arguments are case-sensitive.
If an argument accepts a value containing spaces, the value must be enclosed in double quotation marks (" ").

-logLevel integer_value

Indicates the granularity of the log output. The argument value can be an integer from 1 to 7, where 7 is the finest log level.

Parameters of the pct tool

General parameters

Parameter	Values
configType Specifies the 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 Specifies the location of the WebSphere Application Server installation home directory This option is valid only for a local configuration type.	Location of the WebSphere Application Server 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 64-bit configuration not supported on Windows apache24 Apache Web Server Version 2.4 64-bit configuration not supported on Windows domino Lotus® Domino® Web Server Not supported on HP-UX or Solaris x64 (x86_64) ihs IBM® HTTP Server 64-bit configuration not supported on Windows iis8 Microsoft Internet Information Services Version 8 Supported on Windows sunone Oracle iPlanet Web Server (Sun Microsystems Sun ONE) Supported only on HP-UX and Solaris
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
webServerConfigFile1 Specifies the 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. domino 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 Specifies the second web server configuration file The specified file must exist.	domino 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 user ID	Domino 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 WebSphere Application Server machine hostname This specification can be omitted for a local_standalone installation type.	For a remote installation type: "`hostname`" Installation uses the `hostname` hostname on the machine. For a local installation type: "" The hostname of the target installation machine will be used. Attention: If you use the WCT command 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 is used to create the node and the serverIndex.xml file. With two web servers on the same machine, you have two network IP addresses, for which you might 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 creates a node and a serverIndex.xml file with the same hostname. To make sure that the two Web Servers you created on the same machine have two different network IP addresses, go to the administrative console and do the following: Servers > Web Servers > webserverName Click Ports If a managed node, Click WEBSERVER_ADDRESS. If an unmanaged node, Click WEBSERVER_ADMIN_ADDRESS Change the IP addresses (hostname). Click OK and Save.

Advanced parameters (available in silent installations only)

Parameter	Values
mapWebserverToApplications Specifies whether or not to map all the existing deployed applications to the web server If this not set to a valid option, the installer sets 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 that is used to configure	"" Installation resolves to the hostname detected on the machine. (Recommended) "`hostname`" Installation uses 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 For Apache Web Server and IBM HTTP Server, 64-bit configuration is not supported on Windows. "" Architecture of the web server machine will be used
profileName Specifies the name of the WebSphere Application Server profile to be configured	"`profile_name`" You 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 Specifies the user password to the IHS administrative server to be configured Specify this value only when configuring IHS.	"`IHS_admin_password`" You must enter the password of the user that will be used to configure the IHS administrative server.
enableAdminServerSupport Specifies 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 Specifies 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 Specifies the type of web server to be configured Specify only one web server to configure.	APACHE Apache Web Server Version 2.2 or Version 2.4 64-bit configuration not supported on Windows DOMINO Lotus Domino Web Server Not supported on HP-UX or Solaris x64 (x86_64) IHS IBM HTTP Server 64-bit configuration not supported on Windows IIS Microsoft Internet Information Services Version 8 Supported on Windows SUNJAVASYSTEM Oracle iPlanet Web Server (Sun Microsystems Sun ONE) Supported only on HP-UX and Solaris
ihsWindowsStartupType Specifies the 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 starts 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`" You must enter the name that will be used to configure the IHS administrative server.
ihsAdminWinPassword Specifies the 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`" You must enter the password of the user that will be used to configure the IHS administrative server.
ihsAdminCreateUserAndGroup Specifies whether to use an existing UNIX user ID and group or whether to create a new user ID and group. This value is required only if the `ihsAdminPort` parameter is set and is used in combination with the `ihsAdminUnixUserID` and `ihsAdminUnixUserGroup` parameters.	true Creates a new UNIX user and group, which were defined with the `ihsAdminUnixUserID` and the `ihsAdminUnixUserGroup` parameters. false Uses the existing UNIX user and group that were defined with the `ihsAdminUnixUserID` and the `ihsAdminUnixUserGroup` parameters. Ensure the user and group values are valid.
ihsAdminUnixUserID Specifies the user ID to use with the IHS administrative server on UNIX. This value is required only if the `ihsAdminPort` parameter is set and is used in combination with the `ihsAdminUnixUserGroup` and `ihsAdminCreateUserAndGroup` parameters.	The UNIX user ID to use with the IHS administrative server
ihsAdminUnixUserGroup Specifies the name of the UNIX user group to use when configuring the IHS administrative server. This value is required only if the `ihsAdminPort` parameter is set and is used in combination with the `ihsAdminUnixUserID` and `ihsAdminCreateUserAndGroup` parameters.	The UNIX group of the UNIX user ID to use with the IHS administrative server
enableWinService Specifies 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.

Note: After you run the WCT command, the web server is configured to use an application server as the hosting server. The WCT command also creates a new response file in the directory that contains the configuration files. This response file might contain two undocumented entries, defLocPathname and profilePath, which are not functionally supported by the product. The new response file contains the information that is used to create the web server configuration.

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/AppServer
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=auto
ihsWindowsUserID=user1
mapWebServerToApplications=true
profileName=AppSrv01
wasExistingLocation=D:\\IBM\\WebSphere\\AppServer
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=auto
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

You can use the pct tool If your machine has multiple hostnames and IP addresses. However, the hostname must be set after the configuration of the web server through the PCT graphical user interface by using the following process:

Click Ports.
Click WEBSERVER_ADDRESS. If it is an unmanaged mode, click WEBSERVER_ADMIN_ADDRESS.
Change the hostname.
Click OK to save.