ServerManagement command group for the AdminTask object

You can use the Jython or Jacl scripting languages to manage servers with the wsadmin tool. The commands and parameters in the ServerManagement group can be used to create and manage application server, Web server, proxy server, generic server and Java virtual machine (JVM) configurations.

The ServerManagement command group for the AdminTask object includes the following commands:

changeServerSpecificShortName [z/OS]

Use the changeServerSpecificShortName command to the short name that is associated with a server.

Target object

None

Required parameters

-serverName
The name of the server whose short name you want to change.
-nodeName
The name of the node that contains the server.

Optional parameters

-specificShortName
The new short name for the server. Every server must have a unique specific short name. If this parameter is not specified, a unique specific short name is automatically assigned. The value for this parameter must be 8 characters or less in length, and all of the characters must be uppercase.

Examples

Batch mode example usage:

Interactive mode example usage:

createApplicationServer

Use the createApplicationServer command to create a new application server.

Target object

Specifies the name of the node (String, required)

Required parameters

-name
The name of the server that you want to create. (String, required)

Optional parameters

-templateName
The name of the template from which to base the server. (String, optional)
-genUniquePorts
Specifies whether the system generates unique HTTP ports for the server. The default value is true. Specify false if you do not want to generate unique HTTP ports for the server. (Boolean)
-templateLocation
The configuration Id that represents the location of a template. Specify the _Websphere_Config_Data_Id=templates/servertypes/APPLICATION_SERVER|servertype-metadata.xml configuration Id to create an application server. (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

createApplicationServerTemplate

The createApplicationServerTemplate command creates a new application server template.

Target object

None

Required parameters

-templateName
Specifies the name of the application server template that you want to create. (String, required)
-serverName
Specifies the name of the server from which to base the template. (String, required)
-nodeName
Specifies the node that corresponds to the server from which to base the template. (String, required)

Optional parameters

-description
Specifies the description of the template. (String)
-templateLocation
Specifies a configuration Id that represents the location to place the template. (String)
The following example displays the format of the configuration Id, where the display name is optional:
Websphere:_Websphere_Config_Data_Display_Name=display_name,_Websphere_Config_Data_Id=configuration_id
The configuration Id value is the application server template, which is templates\servertypes\APPLICATION_SERVER|servertype-metadata.xml

Examples

Batch mode example usage:

Interactive mode example usage:

createGenericServer

Use the createGenericServer command to create a new generic server in the configuration. A generic server is a server that the WebSphere Application Server manages, but did not supply. The createGenericServer command provides an additional step, ConfigProcDef, that you can use to configure the parameters that are specific to generic servers.

Target object

Specifies the name of the node (String, required)

Required parameters

-name
The name of the server that you want to create.

Optional parameters

-templateName
Picks up a server template. This step provides a list of application server templates for the node and server type. The default value is the default templates for the server type. (String, optional)
-genUniquePorts
Specifies whether the system generates unique HTTP ports for the server. The default value is true. Specify false if you do not want to generate unique HTTP ports for the server. (Boolean)
-templateLocation
The configuration Id that represents the location of a template. Specify the _Websphere_Config_Data_Id=templates/servertypes/GENERIC_SERVER|servertype-metadata.xml configuration Id to create a generic server. (ObjectName)
-startCommand
Indicates the path to the command that will run when this generic server is started. (String, optional)
-startCommandArgs
Indicates the arguments to pass to the startCommand when the generic server is started. (String, optional)
-executableTargetKind
Specifies whether a Java class name (use JAVA_CLASS) or the name of an executable JAR file (use EXECUTABLE_JAR) will be used as the executable target for this process. This field should be left blank for binary executables. This parameter is only applicable for Java processes. (String optional)
-executableTarget
Specifies the name of the executable target (a Java class containing a main() method or the name of an executable JAR), depending on the executable target type. This field should be left blank for binary executables. This parameter is only applicable for Java processes. (String, optional)
-workingDirectory
Specifies the working directory for the generic server.
-stopCommand
Indicates the path to the command that will run when this generic server is stopped. (String, optional)
-stopCommandArgs
Indicates the arguments to pass to the stopCommand parameter when the generic server is stopped. (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

createGenericServerTemplate

Use the createGenericServerTemplate command to create a server template based on a server configuration.

Target object

None.

Required parameters

-serverName
Specifies the name of the server of interest. (String, required)
-nodeName
Specifies the name of the node of interest. (String, required)
-templateName
Specifies the name of the template to create. (String, required)

Optional parameters

-description
Provides a description for the template to be created. (String, optional)
-templateLocation
Specifies a configuration Id that represents the location of the template. If this parameter is not specified, the system uses the default location. (String, optional)
The following example displays the format of the configuration Id, where the display name is optional:
Websphere:_Websphere_Config_Data_Display_Name=display_name,_Websphere_Config_Data_Id=configuration_id
The configuration Id value is the generic server template, which is templates\servertypes\GENERIC_SERVER|servertype-metadata.xml

Examples

Interactive mode example usage:

createProxyServer

Use the createProxyServer command to create a new proxy server in the configuration. The proxy server is a specific type of application server that routes HTTP requests to content servers that perform the work. The proxy server is the initial point of entry, after the firewall, for requests into the enterprise.

Target object

Specifies the name of the node (String, required)

Required parameters

-name
The name of the server to create. (String)

Optional parameters

-templateName
Picks up a server template. This step provides a list of application server templates for the node and server type. The default value is the default templates for the server type. (String)
-genUniquePorts
Specifies whether the system generates unique HTTP ports for the server. The default value is true. Specify false if you do not want to generate unique HTTP ports for the server. (Boolean)
-templateLocation
Specifies the location of the template on your system. Use the system defined location if you are unsure of the location. (String)
-specificShortName [z/OS]
Specifies the specific short name of the server. Each server should have a specific short name. The value of this parameter must be 8 uppercase characters or less. If you do not specify a value for the specificShortName parameter, the system generates a unique short name.
-genericShortName [z/OS]
Specifies the generic short name of the server. Each member of a cluster shares the same generic short name. Assign a unique generic short name to servers that do not belong to a cluster. The value of this parameter must be 8 uppercase characters or less. If you do not specify a value for the genericShortName parameter, the system generates a unique short name. (String)
-clusterName
Specifies the name of the cluster to which the system assigns the server. (String)
-bitmode [z/OS]
Specifies the bit mode for the server. Valid values are 31 and 64 bit.

Optional steps

-ConfigCoreGroup
coregroupName
Specifies the name of the core group to configure. (String)
-selectProtocols
list
Specifies a list of protocols that the proxy server supports. (String)

Examples

Batch mode example usage:

Interactive mode example usage:

createProxyServerTemplate

Use the createProxyServerTemplate command to create a new proxy server template based on an existing proxy server configuration.

Target object

None

Required parameters

-templateName
Specifies the name of the proxy server template to create. (String)
-serverName
Specifies the name of the proxy server of interest. (String)
-nodeName
Specifies the name of the node of interest. (String)

Optional parameters

-description
Specifies a description for the new server template. (String)
-templateLocation
Specifies a configuration Id that represents the location to place the template. Use the system defined location if you are unsure of the location. (String)
The following example displays the format of the configuration Id, where the display name is optional:
Websphere:_Websphere_Config_Data_Display_Name=display_name,_Websphere_Config_Data_Id=configuration_id
The configuration Id value is the proxy server template, which is templates\servertypes\PROXY_SERVER|servertype-metadata.xml

Examples

Batch mode example usage:

Interactive mode example usage:

createWebServer

Use the createWebServer command to create a Web server definition. This command creates a Web server definition using a template and configures the Web server definition properties. Web server definitions generate and propagate the plugin-config.xml file for each Web server. For IBM HTTP Server only, you can use Web server definitions to administer and configure IBM HTTP Server Web servers with the administrative console. These functions include: Start, Stop, View logs, View and Edit configuration files.

Target object

Specifies the name of the node (String, required).

Required parameters

-name
Specifies the name of the server. (String, required)
-serverConfig
Specifies the Web server definition properties. Use this parameter and associated options to specify configuration properties for the IBM HTTP Server. Specify the following values in order in a list with the -serverConfig parameter:
webPort
Specifies the port number of the Web server. This option is required for all Web servers. (Integer, required)
webInstallRoot
Specifies the install path directory for the Web server. This option is required for IBM HTTP Server Admin Function. (String, required)
pluginInstallRoot
Specifies the installation root directory where the plugin for the Web server is installed. This option is required for all Web servers. (String, required)
configurationFile
Specifies the file path for the IBM HTTP Server. This option is required for view and edit of the IBM HTTP Server Configuration file only. (String, required)
serviceName
Specifies the windows service name on which to start the IBM HTTP Server. This option is required for start and stop of the IBM HTTP Server Web server only. (String, required)
errorLogfile
Specifies the path for the IBM HTTP Server error log (error.log) (String, required)
accessLogfile
Specifies the path for the IBM HTTP Server access log (access.log). (String, required)
webProtocol
Specifies the IBM HTTP Server administration server running with an unmanaged or remote Web server. Options include HTTP or HTTPS. The default is HTTP. (String, required)
webAppMapping
Specifies configuration information for Web application mapping. (String, required)
-remoteServerConfig
Specifies additional Web server definition properties that are only necessary if the IBM HTTP Server Web server is installed on a machine remote from the application server. Specify the following values in order in a list with the remoteServerConfig parameter:
adminPort
Specifies the port of the IBM HTTP Server administrative server. The administration server is installed on the same machine as the IBM HTTP Server and handles administrative requests to the IBM HTTP Server Web server. (String, required)
adminProtocol
Specifies the administrative protocol title. Options include HTTP or HTTPS. The default is HTTP. (String, required)
adminUserID
Specifies the user ID, if authentication is activated on the Administration server in the admin configuration file (admin.conf). This value should match the authentication in the admin.conf file. (String, optional)
adminPasswd
Specifies the password for the user ID. The password is generated by the htpasswd utility in the admin.passwd file. (String, optional)

Optional parameters

-templateName
Specifies the name of the template that you want to use. Templates include the following: IHS, iPlanet, IIS, DOMINO, APACHE. The default template is IHS. (String, required)
-genUniquePorts
Specifies whether the system generates unique HTTP ports for the server. The default value is true. Specify false if you do not want to generate unique HTTP ports for the server. (Boolean)
-templateLocation
The configuration Id that represents the location of a template. Specify the _Websphere_Config_Data_Id=templates/servertypes/WEB_SERVER|servertype-metadata.xml configuration Id to create a generic server. (ObjectName)
-specificShortName [z/OS]
Specifies the specific short name of the server. All servers should have unique specific short names. If this parameter is not specified, the system automatically assigns a name. The value for this parameter must be 8 characters or less and all upper case letters. (String, optional)
-genericShortName [z/OS]
Specifies the generic short name of the server. All servers should have unique specific short names. If this parameter is not specified, the system automatically assigns a name. The value for this parameter must be 8 characters or less and all upper case letters. (String, optional)
-clusterName
Specifies the cluster of interest. (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

createWebServerTemplate

Use the createWebServerTemplate command to create a new Web server template based on an existing proxy server configuration.

Target object

None

Required parameters

-templateName
Specifies the name of the Web server template to create. (String)
-serverName
Specifies the name of the Web server of interest. (String)
-nodeName
Specifies the name of the node of interest. (String)

Optional parameters

-description
Specifies a description for the new server template. (String)
-templateLocation
Specifies a configuration Id that represents the location to place the template. Use the system defined location if you are unsure of the location. (String)
The following example displays the format of the configuration Id, where the display name is optional:
Websphere:_Websphere_Config_Data_Display_Name=display_name,_Websphere_Config_Data_Id=configuration_id
The configuration Id value is the Web server template, which is templates\servertypes\WEB_SERVER|servertype-metadata.xml

Examples

Batch mode example usage:

Interactive mode example usage:

deleteServer

Use the deleteServer command to delete a server.

Target object

None

Required parameters

-serverName
The name of the server to delete. (String, required)
-nodeName
The name of the node for the server that you want to delete. (String, required)

Optional parameters

Examples

Batch mode example usage:

Interactive mode example usage:

deleteServerTemplate

Use the deleteServerTemplate command to delete a server template. You cannot delete templates that are defined by the system. You can only delete server templates that you created. This command deletes the directory that hosts the server template.

Target object

The name of the template to delete. (ObjectName, required)

Required parameters

None.

Optional parameters

None.

Examples

Batch mode example usage:

Interactive mode example usage:

getServerType

The getServerType command returns the type of the server that you specify.

Target object

None

Optional parameters

-serverName
The name of the server. (String)
-nodeName
The name of the node. (String)

Examples

Batch mode example usage:

Interactive mode example usage:

listServers

The listServers command returns a list of servers.

Target object

None

Optional parameters

serverType
Specifies the type of the server. Used to filter the results. (String, optional)
nodeName
Specifies the name of the node. Used to filter the results. (String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

listServerTemplates

Use the listServerTemplates command to list server templates.

Target object

None

Optional parameters

-version
The version of the template that you want to list. (String, optional)
-serverType
Specify this option if you want to list templates for a specific server type. (String, optional)
-name
Specify this option to look for a specific template. (String, optional)
-queryExp
A key and value pair that you can use to find templates by properties. For example, com.ibm.websphere.nodeOperatingSystem=os390 (String[], optional)

Examples

Batch mode example usage:

Interactive mode example usage:

listServerTypes

Use the listServerTypes command to display all the current server types. For example, APPLICATION_SERVER, WEB_SERVER, GENERIC_SERVER

Target object

The node name for which you want to list the valid types. For example, the types that are only valid on z/OS will appear on a z/OS node. (String, optional)

Parameters and return values

Examples

Batch mode example usage:

Interactive mode example usage:

showServerInfo

The showServerInfo command returns the information for a server that you specify.

Target object

The configuration ID of the server. (required)

Parameters and return values

Examples

Batch mode example usage:

Interactive mode example usage:

showServerTypeInfo

The showServerTypeInfo command displays information about a specific server type.

Target object

Specifies a server type. For example: APPLICATION_SERVER (String, required)

Optional parameters

-version
Specifies the version of the templates that you want to list. For example, 6.0.0.0. (String, optional)
-serverType
Specifies if you want to list templates for a specific server type. (String, optional)
-name
Specifies whether to look for a specific template. (String, optional)
-queryExp
Specifies a key and value pair that you can use to find templates by properties. For example, com.ibm.websphere.nodeOperatingSystem=os390. (String[], optional)

Examples

Batch mode example usage:

Interactive mode example usage:

showTemplateInfo

Use the showTemplateInfo command to display the metadata information for a specific server template.

Target object

Specifies the configuration Id of the server type. (String, required)

Parameters and return values

Examples

Batch mode example usage:

Interactive mode example usage:




Related tasks
Using the AdminTask object for scripted administration
Related reference
Commands for the AdminTask object
Reference topic    

Terms of Use | Feedback

Last updated: Aug 29, 2010 10:43:27 PM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=v602web&product=was-nd-mp&topic=rxml_atservermanagement
File name: rxml_atservermanagement.html