configureOs400WebServerDefinition command

The configureOs400WebServerDefinition command creates a web server definition in a WebSphere® Application Server or deployment manager profile.

To run this command, your user profile must have *ALLOBJ authority. For more information about running this command, see the Using command line tools topic.

Use an http profile when your web server resides on a different node than the Application Server or deployment manager. This script will generate another script when you run it against an HTTP profile. Use the generated script to create the web server definition in an Application Server or deployment manager profile by running the generated script from the appserver-profile-dir/bin directory, where appserver-profile-dir is the location of your application server or deployment manager. For additional information, see the Selecting a web server topology diagram and roadmap article.

Syntax

The command syntax is as follows:

configureOs400WebServerDefinition
    -webserver.instance.name webserverInstanceName | 
    -webserver.name webserverName 
    [ -webserver.admin.userID userId ]
    [ -webserver.admin.password password ]
    [ -profileName profile1 ]
    [ -webserver.type webserverTpe ] 
    [ -webserver.host hostName | -webserver.node webserverNode ]
    [ -mapType mapType ] 
    [ -webserver.port webserverPort ] 
    [ -webserver.admin.port adminPort ]
    [ -was.admin.userId wasUserId ]
    [ -was.admin.password wasPassword ]
    [ -help | -? ]

Parameters

The following options are available for the configureOs400WebServerDefinition command:

-webserver.instance.name: This parameter is optional when -webserver.name is specified. The value webserverInstanceName specifies the name of the web server instance on the iSeries. The default value is webserverName.
-webserver.name: This parameter is optional when -webserver.instance.name is specified. The value of webserverName specifies the name of the web server definition. The default value is webserverType_webserverInstanceName.
-webserver.admin.userId: This is an optional parameter. The value userId specifies the user id of the HTTP Administrator on the host name of the web server.
-webserver.admin.password: This is an optional parameter. The value password specifies the password of the HTTP Administrator on the host name of the web server.
-profileName: This is an optional parameter. The value profile1 specifies the profile where the web server definition will be configured. The default value is default.
-webserver.type: This is an optional parameter. It specifies the type of the web server. The value is either IHS or DOMINO. The default value is IHS.
-webserver.host: This is an optional parameter. The hostName value specifies the host name of the web server. The default value is localhost.
-webserver.node: This is an optional parameter. The webserverNode value specifies the node name of the web server definition. The default value is hostName-node.
-mapType: This is an optional parameter. The value specifies which applications are mapped to the web server definition. You must map applications to a Web server so that the web server can serve requests to the application. The values allowed are: MAP_NONE, MAP_DEFAULT or MAP_ALL. The default value is MAP_ALL. MAP_DEFAULT will only map the default application.
-webserver.port: This is an optional parameter. The value specifies the listening port of the web server. The default is 80.
-webserver.admin.port: This is an optional parameter. The adminPort value specifies the admin port of the web server. The default administrative port for the iseries HTTP Administrative GUI is 2001.
-was.admin.userId: This is an optional parameter. The wasUserId value specifies the user ID of the WebSphere Application Server administrator when the server is running in secure mode.
-was.admin.password: This is an optional parameter. The wasPassword value specifies the password of the WebSphere Application Server administrator when the server is running in secure mode.

Usage scenario

The following examples demonstrate correct syntax:

Run on an http profile

configureOs400WebServerDefinition -profileName profile1.remote -webserver.instance.name WEB1 -webserver.name WEB1

The profile1.remote profile is an http profile created using the http profile template.

Example output:

Web server configuration file: profile_root
/config/WEB1/configureWEB1 was created for remote profile 
profile1.remote.

You need to copy the "profile_root
/config/WEB1/configureWEB1" script to the bin directory of the "Application 
Server" or "dmgr" profile and run it to create the web server definition 
"WEB1". Make sure you start the "Application Server" or "dmgr" before
you run the script.

The call created the following script in the profile1.remote profile:

profile_root/config/WEB1/configureWEB1

and indicated the steps needed to complete the web server definition creation.

Run on a non http profile

IHS Example

configureOs400WebServerDefinition -profileName profile1  -webserver.instance.name INSTANCE1 -webserver.name SERV1

Domino Example

configureOs400WebServerDefinition -profileName profile1 -webserver.type DOMINO  -webserver.instance.name DOMINO1