ServerManagement


 

+

Search Tips   |   Advanced Search

 

Use the Jython or Jacl scripting languages to manage servers with wsadmin. The commands and parameters in the ServerManagement group can be used to create and manage appserver, Web server, proxy server, generic server and JVM configurations.

The ServerManagement includes the following commands:

 

createApplicationServer

Create a new appserver.

Target object

Name of the node (String, required)

Required parameters

-name

The name of the server 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 we 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_SERV ER|servertype-metadata.xml configuration Id to create an application server. (String, optional)

Batch mode...

Interactive mode...

 

createApplicationServerTemplate

The createApplicationServerTemplate command creates a new appserver template.

Required parameters

-templateName

Name of the appserver template that you want to create. (String, required)

-serverName

Name of the server from which to base the template. (String, required)

-nodeName

Node that corresponds to the server from which to base the template. (String, required)

Optional parameters

-description

Description of the template. (String)

-templateLocation

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 can be one of the following values:

  • To create a Web server template:

    templates\servertypes\WEB_SERVER|servertype-metadata.xml

  • To create an appserver template:

    templates\servertypes\APPLICATION_SERVER|servertype-metadata.xml

  • To create a generic server template:

    templates\servertypes\GENERIC_SERVER|servertype-metadata.xml

  • To create a proxy server template:

    templates\servertypes\PROXY_SERVER|servertype-metadata.xml

Batch mode...

Interactive mode...

 

createGenericServer

>createGenericServer command to create a new generic server in the configuration. A generic server is a server that the WAS manages, but did not supply. The createGenericServer command provides an additional step, ConfigProcDef, that we 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 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 we 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

Path to the command that will run when this generic server is started. (String, optional)

-startCommandArgs

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

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

Working directory for the generic server.

-stopCommand

Path to the command that will run when this generic server is stopped. (String, optional)

-stopCommandArgs

Arguments to pass to the stopCommand parameter when the generic server is stopped. (String, optional)

Batch mode...

Interactive mode...

 

createGenericServerTemplate

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

Required parameters

-serverName

Name of the server of interest. (String, required)

-nodeName

Name of the node of interest. (String, required)

-templateName

Name of the template to create. (String, required)

Optional parameters

-description

Provides a description for the template to be created. (String, optional)

-templateLocation

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 can be one of the following values:

  • To create a Web server template:

    templates\servertypes\WEB_SERVER|servertype-metadata.xml

  • To create an appserver template:

    templates\servertypes\APPLICATION_SERVER|servertype-metadata.xml

  • To create a generic server template:

    templates\servertypes\GENERIC_SERVER|servertype-metadata.xml

  • To create a proxy server template:

    templates\servertypes\PROXY_SERVER|servertype-metadata.xml

Interactive mode...

 

createProxyServer

Create a new proxy server in the configuration. The proxy server is a specific type of appserver 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 we do not want to generate unique HTTP ports for the server. (Boolean)

-templateLocation

Location of the template on the system. Use the system defined location if we are unsure of the location. (String)

-clusterName

Name of the cluster to which the system assigns the server. (String)

Optional steps

-ConfigCoreGroup

coregroupName

Name of the core group to configure. (String)

-selectProtocols

list

List of protocols that the proxy server supports. (java.util.List)

Batch mode...

Interactive mode...

 

createProxyServerTemplate

Create a new proxy server template based on an existing proxy server configuration.

Required parameters

-templateName

Name of the proxy server template to create. (String)

-serverName

Name of the proxy server of interest. (String)

-nodeName

Name of the node of interest. (String)

Optional parameters

-description

Description for the new server template. (String)

-templateLocation

Location of the template on the system. Use the system defined location if we are unsure of the location. (String)

Batch mode...

Interactive mode...

 

createServerTemplate

Use the createServerTemplate command to create a server using a template.

Required parameters

-serverName

Name of the server of interest. (String, required)

-nodeName

Name of the node of interest. (String, required)

-templateName

Name of the template to create. (String, required)

Optional parameters

-description

Provides a description for the template. (String, optional)

-templateLocation

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 can be one of the following values:

  • To create a Web server template:

    templates\servertypes\WEB_SERVER|servertype-metadata.xml

  • To create an appserver template:

    templates\servertypes\APPLICATION_SERVER|servertype-metadata.xml

  • To create a generic server template:

    templates\servertypes\GENERIC_SERVER|servertype-metadata.xml

  • To create a proxy server template:

    templates\servertypes\PROXY_SERVER|servertype-metadata.xml

Sample output...

The command returns the object name of the template created.

Interactive mode example usage:

 

createServerType

Use the createServerType command to define a server type.

Required parameters

-version

Product version. (String, required)

-serverType

Server type of interest. (String, required)

-createTemplateCommand

Command to use to create a server template. (String, required)

-createCommand

Command to use to create a server. (String, required)

-configValidator

Name of the configuration validator class. (String, required)

Optional parameters

-defaultTemplateName

Name of the default template. The default value is default. (String, optional)

Sample output...

The command returns the object name of the server type created.

Batch mode...

Interactive mode...

 

createWebServer

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, we can use Web server definitions to administer and configure IBM HTTP Server Web servers with the admin 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

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

Port number of the Web server. This option is required for all Web servers. (Integer, required)

webInstallRoot

Install path directory for the Web server. This option is required for IBM HTTP Server Admin Function. (String, required)

pluginInstallRoot

Installation root directory where the plug-in for the Web server is installed. This option is required for all Web servers. (String, required)

configurationFile

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

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

Path for the IBM HTTP Server error log (error.log) (String, required)

accessLogfile

Path for the IBM HTTP Server access log (access.log). (String, required)

webProtocol

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 app 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 appserver. Specify the following values in order in a list with the remoteServerConfig parameter:

adminPort

Port of the IBM HTTP Server admin server. The administration server is installed on the same machine as the IBM HTTP Server and handles admin requests to the IBM HTTP Server Web server. (String, required)

adminProtocol

Administrative protocol title. Options include HTTP or HTTPS.

The default is HTTP. (String, required)

adminUserID

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

Password for the user ID. The password is generated by the htpasswd utility in the admin.passwd file. (String, optional)

Optional parameters

-templateName

Name of the template 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 we 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)

-clusterName

Cluster of interest. (String, optional)

Batch mode...

Interactive mode...

 

deleteServer

Delete a server.

Required parameters

-serverName

The name of the server to delete. (String, required)

-nodeName

The name of the node for the server to delete. (String, required)

Optional parameters

Batch mode...

Interactive mode...

 

deleteServerTemplate

Delete a server template. We cannot delete templates defined by the system. We 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)

Batch mode...

Interactive mode...

 

getJava Home

Get the Java home value.

Required parameters

-serverName

Name of the server. (String, required)

-nodeName

Name of the node. (String, required)

Batch mode ...

Interactive mode...

 

getServerType

The getServerType command returns the type of the server specified.

Optional parameters

-serverName

The name of the server. (String)

-nodeName

The name of the node. (String)

Batch mode...

Interactive mode...

 

listServers

The listServers command returns a list of servers.

Optional parameters

serverType

Type of the server. Used to filter the results. (String, optional)

nodeName

Name of the node. Used to filter the results. (String, optional)

Batch mode...

Interactive mode...

 

listServerTemplates

List server templates.

Optional parameters

-version

The version of the template to list. (String, optional)

-serverType

Specify this option 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 we can use to find templates by properties.

For example, com.ibm.websphere.nodeOperatingSystem=os390 (String[], optional)

Batch mode ...

Interactive mode...

 

listServerTypes

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

Batch mode...

Interactive mode...

 

setJVMDebugMode

Set the JVM debug mode for the appserver.

Required parameters

-serverName

The name of the server whose JVM properties will be modified. If there is only one server in the configuration, this parameter is optional. (String, required)

-nodeName

The node name where the server resides. If the server name is unique in the cell, this parameter is optional. (String, required)

-debugMode

Specifies whether to run the JVM in debug mode. The default is not to enable debug mode. (Boolean, required)

Interactive mode...

 

setGenericJVMArguments

Pass command line arguments to the Java virtual machine (JVM) code that starts the appserver process.

Required parameters

-serverName

Name of the server that contains the JVM properties that are modified. If only one server exists in the configuration, this parameter is optional. (String, required)

-nodeName

Node name where the server resides. If the server name is unique in the cell, this parameter is optional. (String, required)

Optional parameters

-genericJvmArguments

Specifies that the command line arguments pass to the Java virtual machine code that starts the application server process. (String, optional)

Batch mode...

Interactive mode...

 

setJVMInitialHeapSize

Set the JVM initial heap size for the appserver.

Parameters and return values

-serverName

The name of the server whose JVM properties are modified. If there is only one server in the configuration, this parameter is optional. (String, required)

-nodeName

The node name where the server resides. If the server name is unique in the cell, this parameter is optional. (String, required)

-initialHeapSize

Initial heap size available to the JVM code, in megabytes. (Integer, required)

Interactive mode...

 

setJVMMaxHeapSize

Set the JVM maximum heap size for the appserver.

Parameters and return values

-serverName

The name of the server whose JVM properties are modified. If there is only one server in the configuration, (String, required)

-nodeName

The node name where the server locates. If the server name is unique in the cell, this parameter is optional. (String, required)

-maximumHeapSize

Maximum heap size available to the JVM code, in megabytes. (Integer, required)

Batch mode ...

Interactive mode...

 

setJVMMode

Set the Java virtual machine mode.

The mode can either be 64-bit or 32-bit. Local mode is allowed for disconnected modification of the server.

Parameters and return values

-serverName

The name of the server. (String, required)

-nodeName

The name of the node. (String, required)

Batch mode ...

Interactive mode...

 

setJVMProperties

Set the JVM configuration for the appserver.

Required parameters

-serverName

Name of the server for which the JVM properties will be modified. If there is only one server in the configuration, this parameter is optional. (String, required)

-nodeName

Node name where the server resides. If the server name is unique in the entire cell, this parameter is optional. (String, required)

Optional parameters

-classpath

Standard class path in which the JVM code looks for classes. (String, optional)

-bootClasspath

Bootstrap classes and resources for JVM code. This option is only available for JVM instructions that support bootstrap classes and resources. We can separate multiple paths by a colon (:) or semi-colon (;), depending on the operating system of the node. (String, optional)

-verboseModeClass

Specifies whether to use verbose debug output for class loading. The default is not to enable verbose class loading. (Boolean, optional)

-verboseModeGarbageCollection

Specifies whether to use verbose debug output for garbage collection.

The default is not to enable verbose garbage collection. (Boolean, optional)

-verboseModeJNI

Specifies whether to use verbose debug output for native method invocation. The default is not to enable verbose Java Native Interface (JNI) activity. (Boolean, optional)

-initialHeapSize

Initial heap size in megabytes that is available to the JVM code. (Integer, optional)

-maximumHeapSize

Maximum heap size available in megabytes to the JVM code. (Integer, optional)

-runHProf

This parameter only applies to WAS version. It specifies whether to use HProf profiler support. To use another profiler, specify the custom profiler settings using the hprofArguments parameter. The default is not to enable HProf profiler support. (Boolean, optional)

-hprofArguments

This parameter only applies to WAS version. It specifies command-line profiler arguments to pass to the JVM code that starts the appserver process. We can specify arguments when HProf profiler support is enabled. (String, optional)

-debugMode

Specifies whether to run the JVM in debug mode. The default is not to enable debug mode support. (Boolean, optional)

-debugArgs

Command line debug arguments to pass to the JVM code that starts the appserver process. We can specify arguments when the debug mode is enabled. (String, optional)

-genericJvmArguments

Command line arguments to pass to the JVM code that starts the appserver process. (String, optional)

-executableJarFileName

Specifies a full path name for an executable JAR file that the JVM code uses. (String, optional)

-disableJIT

Specifies whether to disable the just in time (JIT) compiler option of the JVM code. (Boolean, optional)

-osName

JVM settings for a given operating system. When started, the process uses the JVM settings for the operating system of the node. (String, optional)

Batch mode...

Interactive mode...

 

setJVMSystemProperties

Set the JVM system property for the process of the appserver.

Required parameters

-serverName

Name of the server whose JVM system properties will be set. If there is only one server in the configuration, this parameter is optional. (String, required)

-nodeName

Node name where the server resides. If the server name is unique in the cell, this parameter is optional. (String, required)

-propertyName

Property name. (String, required)

-propertyValue

Property value. (String, required)

Batch mode...

Interactive mode...

 

setProcessDefinition

Set the process definition of an appserver.

Required parameters

-serverName

The name of the server for which you want to modify the process definition. If there is only one server in the entire configuration, this parameter is optional. (String, required)

-nodeName

The node name where the server resides. If the server name is unique in the entire cell, this parameter is optional. (String, required)

Optional parameters

-executableName

Executable name that is invoked to start the process. This parameter is only applicable to WAS version. (String, optional)

-executableArguments

Arguments that are passed to the process when it is started. This parameter is only applicable to WAS version. (String, optional)

-workingDirectory

File system directory that the process uses for the current working directory. (String, optional)

-executableTargetKind

Type of the executable target. Valid values include JAVA_CLASS and EXECUTABLE JAR. (String, optional)

-executableTarget

Name of the executable target. The executable target is a Java class containing a main() method, or the name of an executable JAR file. (String, optional)

Batch mode...

Interactive mode...

 

setTraceSpecification

Set the trace spec for the server. If the server is running new trace spec the change takes effect immediately. This command also saves the trace spec in configuration.

Required parameters

-serverName

Name of the server whose trace spec will be set. If there is only one server in the configuration, this parameter is optional. (String, required)

-nodeName

Node name where the server resides. If the server name is unique in the cell, this parameter is optional. (String, required)

-traceSpecification

Trace specification. (String, required)

Batch mode ...

Interactive mode...

 

showJVMProperties

List the JVM configuration for the server of the application process.

Required parameters

-serverName

Name of the Server whose JVM properties are shown. If there is only one server in the entire configuration, then this parameter is optional. (String, required)

-nodeName

Node name where the server locates. If the server name is unique in the entire cell, then this parameter is optional. (String, required)

-propertyName

If we specify this parameter, the value of this property is returned.

If we do not specify this parameter, all JVM properties will return in list format. Each element in the list is a property name and value pair. (String, optional)

Optional parameters

-propertyName

If we specify this parameter, the value of this property is returned.

If we do not specify this parameter, all JVM properties will return in list format. Each element in the list is a property name and value pair. (String, optional)

Batch mode...

Interactive mode...

 

showJVMSystemProperties

Show the JVM system properties for the process of the appserver.

Required parameters

-serverName

Name of the server whose JVM properties will be shown. If there is only one server in the configuration, this parameter is optional. (String, required)

-nodeName

Node name where the server resides. If the server name is unique in the cell, this parameter is optional. (String, required)

Optional parameters

-propertyName

If we specify this parameter, the value of specified property is returned. If we do not specify this parameter, all properties will return in a list where each element is a property name and value pair. (String, optional)

Batch mode...

Interactive mode...

 

showProcessDefinition

Show the process definition of the server.

Required parameters

-serverName

Name of the server for which the process definition is shown. If only one server exists in the configuration, this parameter is optional. (String, required)

-nodeName

Node name where the server resides. If the server name is unique in the cell, this parameter is optional. (String, required)

Optional parameters

-propertyName

If we do not specify this parameter, all the process definitions of the server are returned in a list format where each element in the list is property name and value pair. If we specify this parameter, the property value of the property name specified is returned. (String, optional)

Batch mode...

Interactive mode...

 

showServerInfo

The showServerInfo command returns the information for a server specified.

Target object: The configuration ID of the server. (required)

Parameters and return values

Returns: A list of metadata.

Batch mode...

Interactive mode...

 

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

Version of the templates to list. For example, 6.0.0.0. (String, optional)

-serverType

Specifies 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 we can use to find templates by properties. For example, com.ibm.websphere.nodeOperatingSystem=os390. (String[], optional)

Batch mode...

Interactive mode...

 

showTemplateInfo

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

Batch mode...

Interactive mode...




 

Related tasks


Use AdminTask for scripted administration

 

Related


Commands for AdminTask