WebSphere Application Server Network Deployment, Version 6.0.x   Operating Systems: AIX, HP-UX, Linux, Solaris, Windows
             [TIP: Focusing the table of contents and search results]

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 servers and server configurations.

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

createApplicationServer

Use the createApplicationServer command to create a new application server.

Target object

Node name (optional)

Parameters and return values

-name
The name of the server that you want to create. (String)
-templateName
The name of the template from which to base the server. (String)
-genUniquePorts
Specifies that unique ports should be created for the server. (boolean)
-templateLocation
The location of a template. (ObjectName)

Examples

Batch mode example usage:

Interactive mode example usage:

createApplicationServerTemplate

The createApplicationServerTemplate command creates a new application server template.

Target object

None

Parameters and return values

-templateName
The name of the application server template that you want to create. (String)
-serverName
The name of the server from which to base the template. (String)
-nodeName
The node that corresponds to the server from which to base the template. (String)
-description
The description of the template. (String)
-templateLocation
The location where you want to place the template. (String)

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

None

Parameters and return values

-name
The name of the server that you want to create.
-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
The port for the server.
-templateLocation
The location of the server template.
-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:

createWebServer

Use the createWebServer command to create a Web server definition. This command is a two-step process. The first step creates a Web server definition using a template. The parameters of the second step configure 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 the Web server definitions allow you to administer and configure IBM HTTP Server Web servers using the administrative console. These functions include: Start, Stop, View logs, View and Edit configuration files.

Target object

None

Parameters and return values

nodeName
The name of the node. (String, required)
name
The name of the server. (String, required)
templateName
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
Indicates that you want to generate unique ports. (optional)
accessLogfile
The access log for viewing. The default is the path relative to the installation root, for example, logs/access_log. (String, optional)
webProtocol
Parameters for 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)
adminPort
The port of the IBM HTTP Server administrative server. (String, required)
adminUserID
The user ID. This value should match the one for authentication in the admin.conf. (String, required)
adminPasswrd
The administrative password. (String, required)
adminProtocol
The administrative protocol title. Options include HTTP or HTTPS. The default is HTTP. (String, required)
adminPortTitle (adminPort)
Port of IBM HTTP Server administration
adminUserIDTitle (adminUserID)
The user ID. This value should match the authentication in the admin.conf file.
adminPasswdTitle (adminPasswd)
password
AdminProtocolTitle (adminProtocol)
This parameter is required. The value is either HTTP or HTTPS. The default value is HTTP.

Examples

Batch mode example usage:

where -remoteServerConfig is 3rd step of the command

These parameters are only necessary if the IBM HTTP Server Web server is installed on a machine remote from WebSphere.
  • Admin Server Port - This is the port for the ADministration server. The administration server is installed on the same machine as the IBM HTTP Server. The administrative server handles administrative requests to the IBM HTTP Server Web server.
  • UserID - This is the userID for authentication, if authentication is activated on the Administration server in the admin configuration file (admin.conf).
  • Passwd - This is the password for the specified authentication UserID. The password is generated by htpasswd utility in the admin.passwd file.
  • Admin ServerProtocol - HTTP or HTTPS

Interactive mode example usage:

deleteServer

Use the deleteServer command to delete a server.

Target object

None

Parameters and return values

-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)

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)

Parameters and return values

Examples

Batch mode example usage:

Interactive mode example usage:

getJavaHome

Target object

Parameters and return values

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

Examples

getJVMMode

Target object

Parameters and return values

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

Examples

getServerType

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

Target object

None

Parameters and return values

-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

Parameters and return values

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

Examples

Batch mode example usage:

Interactive mode example usage:

listServerTemplates

Use the listServerTemplates command to list server templates.

Target object

None

Parameters and return values

-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/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:

setJVMDebugMode

Target object

Parameters and return values

-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)

Examples

setGenericJVMArguments

Target object

Parameters and return values

-serverName
The 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
The node name where the server resides. If the server name is unique in the cell, this parameter is optional. (String, required)
-genericJvmArguments
Specifies that the command line arguments pass to the Java virtual machine code that starts the application server process. (String, optional)

Examples

setJVMInitialHeapSize

Target object

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
Specifies the initial heap size available to the JVM code, in megabytes. (Integer, required)

Examples

setJVMMaxHeapSize

Target object

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
Specifies the maximum heap size available to the JVM code, in megabytes. (Integer, required)

Examples

setJVMMode

Target object

Parameters and return values

-serverName
The name of the server. (String, required)
-nodeName
The name of the node. (String, required)
-mode
The Java virtual machine mode. Valid values include 64bit or 31bit. (String, required)

Examples

setJVMProperties

Target object

Parameters and return values

-serverName
The 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
The node name where the server resides. If the server name is unique in the entire cell, this parameter is optional. (String, required)
-classpath
The standard class path in which the Java virtual machine (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. You 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
Specifies the initial heap size in megabytes that is available to the JVM code. (Integer, optional)
-maximumHeapSize
Specifies the maximum heap size available in megabytes to the JVM code. (Integer, optional)
-runHProf
This parameter only applies to WebSphere Application Server 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 WebSphere Application Server version. It specifies command-line profiler arguments to pass to the JVM code that starts the application server process. You 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
Specifies the command line debug arguments to pass to the JVM code that starts the application server process. You can specify arguments when the debug mode is enabled. (String, optional)
-genericJvmArguments
Specifies the command line arguments to pass to the JVM code that starts the application server 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
Specifies the JVM settings for a given operating system. When started, the process uses the JVM settings for the operating system of the node. (String, optional)

Examples

setJVMSystemProperties

Target object

Parameters and return values

-serverName
Specifies the 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
The node name where the server resides. If the server name is unique in the cell, this parameter is optional. (String, required)
-propertyName
The property name. (String, required)
-propertyValue
The property value. (String, required)

Examples

setProcessDefinition

Target object

Parameters and return values

-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)
-executableName
The executable name that is invoked to start the process. This parameter is only applicable to WebSphere Application Server version. (String, optional)
-executableArguments
The arguments that are passed to the process when it is started. This parameter is only applicable to WebSphere Application Server version. (String, optional)
-workingDirectory
The file system directory that the process uses for the current working directory. (String, optional)
-executableTargetKind
The type of the executable target. Valid values include JAVA_CLASS and EXECUTABLE JAR. (String, optional)
-executableTarget
The 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)

Examples

setTraceSpecification

Target object

Parameters and return values

-serverName
Specifies the name of the server whose trace specification will be set. 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)
-traceSpecification
The trace specification. (String, required)

Examples

showJVMProperties

Target object

Parameters and return values

-serverName
The 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
The 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 you specify this parameter, the value of this property is returned. If you 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, required)

Examples

showJVMSystemProperties

Target object

Parameters and return values

-serverName
Specifies the 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
The node name where the server resides. If the server name is unique in the cell, this parameter is optional. (String, required)
-propertyName
If you specify this parameter, the value of specified property is returned. If you do not specify this parameter, all properties will return in a list where each element is a property name and value pair. (String, optional)

Examples

showProcessDefinition

Target object

Parameters and return values

-serverName
The 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
The node name where the server resides. If the server name is unique in the cell, this parameter is optional. (String, required)
-propertyName
If you 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 you specify this parameter, the property value of the property name that you specified is returned. (String, optional)

Examples

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

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

Parameters and return values

-version
Specify the version of the templates that you want to list. For example, 6.0.0.0. (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:

showTemplateInfo

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

Target object

The server type, for example: APPLICATION_SERVER (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: Mar 8, 2007 8:14:28 PM CST
http://publib.boulder.ibm.com/infocenter/wasinfo/v6r0/index.jsp?topic=/com.ibm.websphere.nd.doc/info/ae/ae/rxml_atservermanagement.html

© Copyright IBM Corporation 2006. All Rights Reserved.
This information center is powered by Eclipse technology. (http://www.eclipse.org)