ServerManagement command group for the AdminTask object

Operating Systems: i5/OS
Personalize 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 server, Web server, proxy server, generic server and JVM configurations. The ServerManagement command group for the AdminTask object includes the following commands:

createApplicationServer
createApplicationServerTemplate
createGenericServer
createWebServer
deleteServer
deleteServerTemplate
getJavaHome
getJVMMode
getServerType
listServers
listServerTemplates
listServerTypes
setJVMDebugMode
setGenericJVMArguments
setJVMInitialHeapSize
setJVMMaxHeapSize
setJVMMode
setJVMProperties
setJVMSystemProperties
setProcessDefinition
setTraceSpecification
showJVMProperties
showJVMSystemProperties
showProcessDefinition
showServerInfo
showServerTypeInfo
showTemplateInfo

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 that unique ports should be created for the server. (Boolean, optional)
-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)

Examples

Batch mode example usage:

Using Jacl:

$AdminTask createApplicationServer ndnode1 {-name test1 -templateName default}

Using Jython string:

AdminTask.createApplicationServer(ndnode1, '[-name test1 -templateName default]")

Using Jython list:

AdminTask.createApplicationServer(ndnode1, ['-name', 'test1', 
'-templateName', 'default'])

Interactive mode example usage:

Using Jacl:

$AdminTask createApplicationServer {-interactive}

Using Jython string:

AdminTask.createApplicationServer ('[-interactive]')

Using Jython list:

AdminTask.createApplicationServer (['-interactive'])

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

To create a Web server template:
templates\servertypes\WEB_SERVER|servertype-metadata.xml
To create an application server 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

Examples

Batch mode example usage:

Using Jacl:

$AdminTask createApplicationServerTemplate {-templateName newTemplate -serverName server1 
-nodeName ndnode1 -description "This is my new template" -templateLocation 
Websphere:_Websphere_Config_Data_Display_Name=APPLICATION_SERVER,_Websphere_Config_Data_Id=
templates/servertypes/APPLICATION_SERVER|servertype-metadata.xml}

Using Jython string:

AdminTask.createApplicationServerTemplate('[-templateName newTemplate -serverName server1 -nodeName ndnode1 
-description "This is my new template" -templateLocation Websphere:_Websphere_Config_Data_Display_Name=
APPLICATION_SERVER,_Websphere_Config_Data_Id=templates/servertypes/APPLICATION_SERVER|servertype-metadata.xml]')

Using Jython list:

AdminTask.createApplicationServerTemplate(['-templateName', 
'newTemplate', '-serverName', 'server1', '-nodeName', 
'ndnode1', '-description', "This is my new template"])

Interactive mode example usage:

Using Jacl:

$AdminTask createApplicationServerTemplate {-interactive}

Using Jython string:

AdminTask.createApplicationServerTemplate ('[-interactive]')

Using Jython list:

AdminTask.createApplicationServerTemplate (['-interactive'])

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, used to 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: The port for the server. (Integer, optional)
-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:

Using Jacl:

$AdminTask createGenericServer jim667BaseNode {-name jgeneric 
-ConfigProcDef {{"/usr/bin/myStartCommand" "arg1 arg2" "" "" 
"/tmp/workingDirectory" "/tmp/stopCommand" "argy argz"}}}

Using Jython string:

AdminTask.createGenericServer('jim667BaseNode', '[-name jgeneric 
-ConfigProcDef [[/usr/bin/myStartCommand "arg1 arg2" "" "" 
/tmp/workingDirectory /tmp/StopCommand "argy argz"]]]')

Using Jython list:

AdminTask.createGenericServer('jim667BaseNode', ['-name', 'jgeneric', '-ConfigProcDef', 
[['/usr/bin/myStartCommand', "arg1 arg2" "" "", '/tmp/workingDirectory', '/tmp/StopCommand', "argy argz"]]])

Interactive mode example usage:

Using Jacl:

$AdminTask createGenericServer {-interactive}

Using Jython string:

AdminTask.createGenericServer ('[-interactive]')

Using Jython list:

AdminTask.createGenericServer (['-interactive'])

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 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 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 options within the serverConfig parameter:

-webPort: 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: 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: 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: 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 options within the remoteServerConfig parameter:

-adminPort: 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)
-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)
-adminProtocol: Specifies the administrative protocol title. Options include HTTP or HTTPS. The default is HTTP. (String, required)

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: Indicates that you want to generate unique ports. (Boolean, optional)
-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: Specifies the cluster of interest. (String, optional)

Examples

Batch mode example usage:

Using Jacl:

$AdminTask createWebServer myNode {-name wsname -serverConfig {{80  /opt/path/to/ihs  
/opt/path/to/plugin  /opt/path/to/plugin.xml  windows service  /opt/path/to/error.log  
/opt/path/to/access.log  HTTP}} -remoteServerConfig {{8008 user password HTTP}}

Using Jython list:

print AdminTask.createWebServer(myNode, ['-name', wsname,
'-serverConfig',[['80','/opt/path/to/ihs',
'/opt/path/to/plugin','/opt/path/to/plugin.xml',
'windows service','/opt/path/to/error.log',
'/opt/path/to/access.log','HTTP']],'-remoteServerConfig',
[['8008','user','password','HTTP']]])

Using Jython string:

AdminTask.createWebServer(['myNode',-name wsname -serverConfig [80 /opt/path/to/ihs 
/opt/path/to/plugin /opt/path/to/plugin.xml windows service /opt/path/to/error.log
/opt/path/to/access.log HTTP] -remoteServerConfig [8008 user password HTTP]]')

Interactive mode example usage:

Using Jacl:
```
$AdminTask createWebServer -interactive
```

Using Jython string:

AdminTask.createWebServer ('[-interactive]')

Using Jython list:

AdminTask.createWebServer (['-interactive'])

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:

Using Jacl:

$AdminTask deleteServer {-serverName server_name -nodeName node_name}

Using Jython string:

AdminTask.deleteServer('[-serverName server_name -nodeName node_name]')

Using Jython list:

AdminTask.deleteServer(['-serverName', 'server_name', '-nodeName', 'node_name'])

Interactive mode example usage:

Using Jacl:
```
$AdminTask deleteServer {-interactive}
```

Using Jython string:

AdminTask.deleteServer ('[-interactive]')

Using Jython list:

AdminTask.deleteServer (['-interactive'])

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:

Using Jacl:

$AdminTask deleteServerTemplate template_name(templates/serverTypes/APPLICATION_SERVER/servers
/newTemplate|server.xml#Server_1105015708079)

Using Jython string:

AdminTask.deleteServerTemplate('template_name(templates/serverTypes/APPLICATION_SERVER/servers
/newTemplate|server.xml#Server_1105015708079)')

Using Jython list:

AdminTask.deleteServerTemplate('template_name(templates/serverTypes/APPLICATION_SERVER/servers
/newTemplate|server.xml#Server_1105015708079)')

Interactive mode example usage:

Using Jacl:

$AdminTask deleteServerTemplate {-interactive}

Using Jython string:

AdminTask.deleteServerTemplate ('[-interactive]')

Using Jython list:

AdminTask.deleteServerTemplate (['-interactive'])

getJavaHome

Use the getJavaHome command to get the Java home value.

Target object None.

Required parameters

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

Examples

Batch mode example usage:

Using Jacl:

$AdminTask getJavaHome {-nodeName mynode -serverName myserver}

Using Jython string:

AdminTask.getJavaHome ('[-nodeName mynode -serverName myserver]')

Using Jython list:

AdminTask.getJavaHome (['-nodeName' 'mynode' '-serverName' 'myserver'])

Interactive mode example usage:

Using Jacl:
```
$AdminTask getJavaHome {-interactive}
```

Using Jython string:

AdminTask.getJavaHome ('[-interactive]')

Using Jython list:

AdminTask.getJavaHome (['-interactive'])

getJVMMode

Use the getJVMMode command to get information about the mode of the Java virtual machine.

Target object None

Required parameters

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

Examples

Batch mode example usage:

Using Jacl:

$AdminTask getJVMMode {-nodeName mynode -serverName myserver}

Using Jython string:

AdminTask.getJVMMode ('[-nodeName mynode -serverName myserver]')

Using Jython list:

AdminTask.getJVMMode (['-nodeName', 'mynode', '-serverName', 'myserver'])

Interactive mode example usage:

Using Jacl:
```
$AdminTask getJVMMode {-interactive}
```
Using Jython string:
```
AdminTask.getJVMMode ('[-interactive]')
```
Using Jython list:
```
AdminTask.getJVMMode (['-interactive'])
```

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:

Using Jacl:

$AdminTask getServerType {-serverName test2 -nodeName ndnode1}

Using Jython string:

AdminTask.getServerType('[-serverName test2 -nodeName ndnode1]')

Using Jython list:

AdminTask.getServerType(['-serverName', 'test2', '-nodeName', 'ndnode1'])

Interactive mode example usage:

Using Jacl:
```
$AdminTask getServerType {-interactive}
```

Using Jython string:

AdminTask.getServerType ('[-interactive]')

Using Jython list:

AdminTask.getServerType (['-interactive'])

listServers

The listServers command returns a list of servers.

Target object None

Optional parameters

serverType: Timeype 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:

Using Jacl:

$AdminTask listServers {-serverType APPLICATION_SERVER -nodeName ndnode1}

Using Jython string:

AdminTask.listServers('[-serverType APPLICATION_SERVER -nodeName ndnode1]')

Using Jython list:

AdminTask.listServers(['-serverType', 'APPLICATION_SERVER', 
'-nodeName', 'ndnode1'])

Interactive mode example usage:

Using Jacl:
```
$AdminTask listServers {-interactive}
```

Using Jython string:

AdminTask.listServers ('[-interactive]')

Using Jython list:

AdminTask.listServers (['-interactive'])

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

Examples

Batch mode example usage:

Using Jacl:

$AdminTask listServerTemplates {-version 6.0.0.0 -serverType APPLICATION_SERVER}

Using Jython string:

AdminTask.listServerTemplates('[-version 6.0.0.0 -serverType APPLICATION_SERVER]')

Using Jython list:

AdminTask.listServerTemplates(['-version', '6.0.0.0', 
'-serverType', 'APPLICATION_SERVER'])

Interactive mode example usage:

Using Jacl:

$AdminTask listServerTemplates {-interactive}

Using Jython string:

AdminTask.listServerTemplates ('[-interactive]')

Using Jython list:

AdminTask.listServerTemplates (['-interactive'])

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

Parameters: None
Returns: A list of server types that you can define on a node. If you do not specify the target object, this command returns all of the server types defined in the entire cell.

Examples

Batch mode example usage:

Using Jacl:
```
$AdminTask listServerTypes ndnode1
```
Using Jython string:
```
AdminTask.listServerTypes(ndnode1)
```
Using Jython list:
```
AdminTask.listServerTypes(ndnode1)
```

Interactive mode example usage:

Using Jacl:

$AdminTask listServerTypes {-interactive}

Using Jython string:

AdminTask.listServerTypes ('[-interactive]')

Using Jython list:

AdminTask.listServerTypes (['-interactive'])

setJVMDebugMode

Use the setJVMDebugMode command to set the JVM debug mode for the application server.

Target object None

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)

Examples

Interactive mode example usage:

Using Jacl:

$AdminTask setJVMDebugMode {-interactive}

Using Jython string:

AdminTask.setJVMDebugMode ('[-interactive]')

Using Jython list:

AdminTask.setJVMDebugMode (['-interactive'])

setGenericJVMArguments

Use the setGenericJVMArguments command passes command line arguments to the JVM code that starts the application server process.

Target object None

Required parameters

-serverName: Specifies 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: Specifies the 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)

Examples

Batch mode example usage:

Using Jacl:

$AdminTask setGenericJVMArguments {-serverName server1 -nodeName node1}

Using Jython string:

AdminTask.setGenericJVMArguments('[-serverName server1 -nodeName node1]')

Using Jython list:

AdminTask.setGenericJVMArguments(['-serverName', 'server1', 
'-nodeName', 'node1'])

Interactive mode example usage:

Using Jacl:

$AdminTask setGenericJVMArguments {-interactive}

Using Jython string:

AdminTask.setGenericJVMArguments ('[-interactive]')

Using Jython list:

AdminTask.setGenericJVMArguments (['-interactive'])

setJVMInitialHeapSize

Use the setJVMInitialHeapSize command to set the Java Virtual Machine (JVM) initial heap size for the application server.

Target object

None

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

Interactive mode example usage:

Using Jacl:

$AdminTask setJVMInitialHeapSize {-interactive}

Using Jython string:

AdminTask.setJVMInitialHeapSize ('[-interactive]')

Using Jython list:

AdminTask.setJVMInitialHeapSize (['-interactive'])

setJVMMaxHeapSize

Use the setJVMMaxHeapSize command to set the JVM maximum heap size for the application server.

Target object

None

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

Batch mode example usage:

Using Jacl:

$AdminTask setJVMMaxHeapSize {-serverName server1 -nodeName node1 -maximumHeapSize 10}

Using Jython string:

AdminTask.setJVMMaxHeapSize('[-serverName server1 -nodeName node1 -maximumHeapSize 10]')

Using Jython list:

AdminTask.setJVMMaxHeapSize(['-serverName', 'server1', '-nodeName', 'node1', '-maximumHeapSize', '10'])

Interactive mode example usage:

Using Jacl:

$AdminTask setJVMMaxHeapSize {-interactive}

Using Jython string:

AdminTask.setJVMMaxHeapSize ('[-interactive]')

Using Jython list:

AdminTask.setJVMMaxHeapSize (['-interactive'])

setJVMMode

Use the setJVMMode command to set the Java virtual machine mode. The mode can either be 64 bit or 31 bit. Local mode is allowed for disconnected modification of the server. If you use this command to set the mode to 31-bit mode and the server is currently at 64-bit mode with a heap size greater than 2 GB, the heap size will automatically be reduced to original 31 bit heap size value.

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

Batch mode example usage:

Using Jacl:

$AdminTask setJVMMode {-nodeName myNode -serverName myserver -mode 64bit}

Using Jython string:

AdminTask.setJVMMode ('[-nodeName myNode -serverName myserver -mode 64bit]')

Using Jython list:

AdminTask.setJVMMode (['-nodeName', 'myNode', '-serverName', 'myserver', '-mode', '64bit'])

Interactive mode example usage:

Using Jacl:
```
$AdminTask setJVMMode {-interactive}
```
Using Jython string:
```
AdminTask.setJVMMode ('[-interactive]')
```
Using Jython list:
```
AdminTask.setJVMMode (['-interactive'])
```

setJVMProperties

Use the setJVMProperties command to set the JVM configuration for the application server.

Target object None

Required parameters

-serverName: Specifies 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: Specifies 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

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

Batch mode example usage:

Using Jacl:

$AdminTask setJVMProperties {-serverName server1 -nodeName node1}

Using Jython string:

AdminTask.setJVMProperties('[-serverName server1 -nodeName node1]')

Using Jython list:

AdminTask.setJVMProperties(['-serverName', 'server1', '-nodeName', 'node1'])

Interactive mode example usage:

Using Jacl:

$AdminTask setJVMProperties {-interactive}

Using Jython string:

AdminTask.setJVMProperties ('[-interactive]')

Using Jython list:

AdminTask.setJVMProperties (['-interactive'])

setJVMSystemProperties

Use the setJVMSystemProperties command to set the JVM system property for the process of the application server.

Target object None

Required parameters

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

Examples

Batch mode example usage:

Using Jacl:

$AdminTask setJVMSystemProperties {-serverName server1 -nodeName node1 -propertyName 
test.property -propertyValue testValue}

Using Jython string:

AdminTask.setJVMSystemProperties('[-serverName server1 -nodeName node1 -propertyName 
test.property -propertyValue testValue]')

Using Jython list:

AdminTask.setJVMSystemProperties(['-serverName', 'server1', 
'-nodeName', 'node1', '-propertyName', 'test.property', 
'-propertyValue', 'testValue'])

Interactive mode example usage:

Using Jacl:

$AdminTask setJVMSystemProperties {-interactive}

Using Jython string:

AdminTask.setJVMSystemProperties ('[-interactive]')

Using Jython list:

AdminTask.setJVMSystemProperties (['-interactive'])

setProcessDefinition

Use the setProcessDefinition command to set the process definition of an application server.

Target object None

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: Specifies the executable name that is invoked to start the process. This parameter is only applicable to WebSphere Application Server version. (String, optional)
-executableArguments: Specifies 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: File system directory that the process uses for the current working directory. (String, optional)
-executableTargetKind: Timeype of the executable target. Valid values include JAVA_CLASS and EXECUTABLE JAR. (String, optional)
-executableTarget: Specifies 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

Batch mode example usage:

Using Jacl:

$AdminTask setProcessDefinition {-serverName server1 -nodeName node1}

Using Jython string:

AdminTask.setProcessDefinition('[-serverName server1 -nodeName node1]')

Using Jython list:

AdminTask.setProcessDefinition(['-serverName', 'server1', '-nodeName', 
'node1'])

Interactive mode example usage:

Using Jacl:

$AdminTask setProcessDefinition {-interactive}

Using Jython string:

AdminTask.setProcessDefinition ('[-interactive]')

Using Jython list:

AdminTask.setProcessDefinition (['-interactive'])

setTraceSpecification

Use the setTraceSpecification command to set the trace specification for the server. If the server is running new trace specification the change takes effect immediately. This command also saves the trace specification in configuration.

Target object None

Required parameters

-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: Specifies the node name where the server resides. If the server name is unique in the cell, this parameter is optional. (String, required)
-traceSpecification: Timerace specification. (String, required)

Examples

Batch mode example usage:

Using Jacl:

$AdminTask setTraceSpecification {-serverName server1 -nodeName node1 -traceSpecification 
com.ibm.*=all=enabled}

Using Jython string:

AdminTask.setTraceSpecification('[-serverName server1 -nodeName node1 -traceSpecification 
com.ibm.*=all=enabled]')

Using Jython list:

AdminTask.setTraceSpecification(['-serverName', 'server1', 
'-nodeName', 'node1', '-traceSpecification', 
'com.ibm.*=all=enabled'])

Interactive mode example usage:

Using Jacl:

$AdminTask setTraceSpecification {-interactive}

Using Jython string:

AdminTask.setTraceSpecification ('[-interactive]')

Using Jython list:

AdminTask.setTraceSpecification (['-interactive'])

showJVMProperties

Use the showJVMProperties command to list the JVM configuration for the server of the application process.

Target object None

Required parameters

-serverName: Specifies 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: Specifies 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, optional)

Optional parameters

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

Examples

Batch mode example usage:

Using Jacl:

$AdminTask showJVMProperties {-serverName server1 -nodeName node1 
-propertyName test.property}

Using Jython string:

AdminTask.showJVMProperties('[-serverName server1 -nodeName node1 
-propertyName test.property]')

Using Jython list:

AdminTask.showJVMProperties(['-serverName', 'server1', '-nodeName', 'node1', '-propertyName', 'test.property'])

Interactive mode example usage:

Using Jacl:

$AdminTask showJVMProperties {-interactive}

Using Jython string:

AdminTask.showJVMProperties ('[-interactive]')

Using Jython list:

AdminTask.showJVMProperties (['-interactive'])

showJVMSystemProperties

Use the showJVMSystemProperties command to show the Java virtual machine (JVM) system properties for the process of the application server.

Target object None

Required parameters

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

Batch mode example usage:

Using Jacl:

$AdminTask showJVMSystemProperties {-serverName server1 -nodeName node1 -propertyName test.property}

Using Jython string:

AdminTask.showJVMSystemProperties('[-serverName server1 -nodeName node1 -propertyName test.property]')

Using Jython list:

AdminTask.showJVMSystemProperties(['-serverName', 'server1', 
'-nodeName', 'node1', '-propertyName', 
'test.property'])

Interactive mode example usage:

Using Jacl:

$AdminTask showJVMSystemProperties {-interactive}

Using Jython string:

AdminTask.showJVMSystemProperties ('[-interactive]')

Using Jython list:

AdminTask.showJVMSystemProperties (['-interactive'])

showProcessDefinition

Use the showProcessDefinition command to show the process definition of the server.

Target object None

Required parameters

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

Batch mode example usage:

Using Jacl:

$AdminTask showProcessDefinition {-serverName server1 -nodeName node1 -propertyName test.property}

Using Jython string:

AdminTask.showProcessDefinition('[-serverName server1 -nodeName node1 -propertyName test.property]')

Using Jython list:

AdminTask.showProcessDefinition(['-serverName', 'server1', 
'-nodeName', 'node1', '-propertyName', 
'test.property'])

Interactive mode example usage:

Using Jacl:

$AdminTask showProcessDefinition {-interactive}

Using Jython string:

AdminTask.showProcessDefinition ('[-interactive]')

Using Jython list:

AdminTask.showProcessDefinition (['-interactive'])

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

Parameters: None
Returns: A list of metadata.

Examples

Batch mode example usage:

Using Jacl:

$AdminTask showServerInfo server1(cells/WAS00Network /nodes/ndnode1/servers/server1|server.xml)

Using Jython string:

AdminTask.showServerInfo('server1(cells/WAS00Network /nodes/ndnode1/servers/server1|server.xml)')

Using Jython list:

AdminTask.showServerInfo('server1(cells/WAS00Network /nodes/ndnode1/servers/server1|server.xml)')

Interactive mode example usage:

Using Jacl:

$AdminTask showServerInfo {-interactive}

Using Jython string:

AdminTask.showServerInfo ('[-interactive]')

Using Jython list:

AdminTask.showServerInfo (['-interactive'])

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

Examples

Batch mode example usage:

Using Jacl:

$AdminTask showServerTypeInfo APPLICATION_SERVER

Using Jython string:

AdminTask.showServerTypeInfo(APPLICATION_SERVER)

Using Jython list:

AdminTask.showServerTypeInfo(APPLICATION_SERVER)

Interactive mode example usage:

Using Jacl:

$AdminTask showServerTypeInfo {-interactive}

Using Jython string:

AdminTask.showServerTypeInfo ('[-interactive]')

Using Jython list:

AdminTask.showServerTypeInfo (['-interactive'])

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:

Using Jacl:

$AdminTask showTemplateInfo default(templates/servertypes/APPLICATION_SERVER/servers/default|server.xml) 
{isSystemTemplate true} {name default} {com.ibm.websphere.baseProductV6.0.0} {description {The WebSphere 
Default Server Template}} {com.ibm.websphere.baseProductMinorV0.0} {com.ibm.websphere.baseProductMajorV6} 
{com.ibm.websphere.nodeOperatingSystem {}} {isDefaultTemplate true}

Using Jython string:

AdminTask.showTemplateInfo(default(templates/serverTypes/APPLICATION_SERVER/servers/default|server.xml)) 
'[[isSystemTemplate true] [com.ibm.websphere.baseProductV6.0.0] [name default] 
[com.ibm.websphere.baseProductMinorV0.0] [description The WebSphere Default Server Template] 
[isDefaultTemplate true] [com.ibm.websphere.nodeOperatingSystem] [com.ibm.websphere.baseProductMajorV6]]'

Using Jython list:

AdminTask.showTemplateInfo(default(templates/serverTypes/APPLICATION_SERVER/servers/default|server.xml)) 
[['isSystemTemplate', 'true'], ['com.ibm.websphere.baseProductVersion', '6.0.0'], ['name', 'default'] 
['com.ibm.websphere.baseProductMinorVersion', '0.0'], ['description', 'The WebSphere Default Server Template'] 
['isDefaultTemplate', 'true'], ['com.ibm.websphere.nodeOperatingSystem'], ['com.ibm.websphere.baseProductMajorVersion', 
'6']]

Interactive mode example usage:

Using Jacl:

$AdminTask showTemplateInfo {-interactive}

Using Jython string:

AdminTask.showTemplateInfo ('[-interactive]')

Using Jython list:

AdminTask.showTemplateInfo (['-interactive'])

Related Reference

Commands for the AdminTask object