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 appservers and server 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 appserver.

Target object Node name (optional)

Parameters and return values

-name

The name of the server 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:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask createApplicationServer {-interactive}
  

• Use Jython string:

  AdminTask.createApplicationServer ('[-interactive]')
  

• Use Jython list:

  AdminTask.createApplicationServer (['-interactive'])
  

 

createApplicationServerTemplate

The createApplicationServerTemplate command creates a new appserver template.

Target object None

Parameters and return values

-templateName

The name of the appserver template 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:

• Use Jacl:

  $AdminTask createApplicationServerTemplate {-templateName newTemplate -serverName server1 -nodeName ndnode1 -description "This is my new template"}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask createApplicationServerTemplate {-interactive}
  

• Use Jython string:

  AdminTask.createApplicationServerTemplate ('[-interactive]')
  

• Use 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 WAS 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 to create.

-templateName

Picks up a server template. This step provides a list of appserver 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:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask createGenericServer {-interactive}
  

• Use Jython string:

  AdminTask.createGenericServer ('[-interactive]')
  

• Use Jython list:

  AdminTask.createGenericServer (['-interactive'])
  

 

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 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 to use. Templates include... IHS, iPlanet, IIS, DOMINO, APACHE. The default template is IHS. (String, required)

genUniquePorts

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

• Use Jacl:

  $AdminTask createWebServer {-name web1 -serverConfig {{webPort WebserverInstallRoot PluginInstallRoot Configuration_file_name Windows_Server_Name errorLogPath accessLogPath WebProtocol}} -remoteServerConfig {{AdminPort UserID Password AdminProtocol}}
  

• Use Jython list:

  AdminTask.createWebServer(['-name', 'web1', '-serverConfig', [['webPort', 'WebserverInstallRoot', 'PluginInstallRoot', 'Configuration_file_name', 'Windows_Server_Name', 'errorLogPath', 'accessLogPath', 'WebProtocol']], '-remoteServerConfig', [['AdminPort', 'UserID', 'Password', 'AdminProtocol']]]) 
  

• Use Jython string:

  AdminTask.createWebServer('[-name web1 -serverConfig [[webPort WebserverInstallRoot PluginInstallRoot Configuration_file_name Windows_Server_Name errorLogPath accessLogPath WebProtocol]] -remoteServerConfig [[AdminPort UserID Password AdminProtocol]]]') 
  

  where -serverConfig is second step of the command.

  • WebPort - is the port for the Webserver (required for all webservers)

  • WebserverInstallRoot - is the install path (directory) for webserver. necessary for IBM HTTP Server Admin Function.

  • Plugin Install Root - is install root where the plugin for the webserver is installed. Necessary for all webservers.

  • Configuration file name - is the file path for the IBM HTTP Server. This is necessary for View and edit of the IBM HTTP Server Configuration file only.

  • Windows Service Name - The windows service name on which IBM HTTP Server is to be started. This is necessary for Start and stop of the IBM HTTP Server Web server only.

  • ErrorLogPath - This is the path for the IBM HTTP Server error log (error.log)

• AccessLogPath - This is the path for the IBM HTTP Server access log (access.log)

• WebServerProtocol - HTTP or HTTPS

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:

• Use Jacl:

  $AdminTask createWebServer -interactive
  

• Use Jython string:

  AdminTask.createWebServer ('[-interactive]')
  

• Use Jython list:

  AdminTask.createWebServer (['-interactive'])
  

 

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 to delete. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteServer {-serverName server -nodeName node}
  

• Use Jython string:

  AdminTask.deleteServer('[-serverName server -nodeName node]')
  

• Use Jython list:

  AdminTask.deleteServer(['-serverName', 'server', '-nodeName', 'node'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteServer {-interactive}
  

• Use Jython string:

  AdminTask.deleteServer ('[-interactive]')
  

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

Parameters and return values

• Parameters:

• Returns: None

Examples

Batch mode example usage:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteServerTemplate {-interactive}
  

• Use Jython string:

  AdminTask.deleteServerTemplate ('[-interactive]')
  

• Use Jython list:

  AdminTask.deleteServerTemplate (['-interactive'])
  

 

getJavaHome

Use the getJavaHome command to get the Java home value.

Target object

None

Parameters and return values

-serverName

The name of the server. (String, required)

-nodeName

The name of the node. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getJavaHome {-nodeName mynode -serverName myserver}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask getJavaHome {-interactive}
  

• Use Jython string:

  AdminTask.getJavaHome ('[-interactive]')
  

• Use Jython list:

  AdminTask.getJavaHome (['-interactive'])
  

 

getJVMMode

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

Target object

None

Parameters and return values

-serverName

The name of the server. (String, required)

-nodeName

The name of the node. (String, required)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getJVMMode {-nodeName mynode -serverName myserver}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask getJVMMode {-interactive}
  

• Use Jython string:

  AdminTask.getJVMMode ('[-interactive]')
  

• Use Jython list:

  AdminTask.getJVMMode (['-interactive'])
  

 

getServerType

The getServerType command returns the type of the server specified.

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:

• Use Jacl:

  $AdminTask getServerType {-serverName test2 -nodeName ndnode1}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask getServerType {-interactive}
  

• Use Jython string:

  AdminTask.getServerType ('[-interactive]')
  

• Use Jython list:

  AdminTask.getServerType (['-interactive'])
  

 

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:

• Use Jacl:

  $AdminTask listServers {-serverType APPLICATION_SERVER -nodeName ndnode1}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask listServers {-interactive}
  

• Use Jython string:

  AdminTask.listServers ('[-interactive]')
  

• Use Jython list:

  AdminTask.listServers (['-interactive'])
  

 

listServerTemplates

Use the listServerTemplates command to list server templates.

Target object None

Parameters and return values

-version

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

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listServerTemplates {-version 6.0.0.0 -serverType APPLICATION_SERVER}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask listServerTemplates {-interactive}
  

• Use Jython string:

  AdminTask.listServerTemplates ('[-interactive]')
  

• Use 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:

• Use Jacl:

  $AdminTask listServerTypes ndnode1
  

• Use Jython string:

  AdminTask.listServerTypes(ndnode1)
  

• Use Jython list:

  AdminTask.listServerTypes(ndnode1)
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask listServerTypes {-interactive}
  

• Use Jython string:

  AdminTask.listServerTypes ('[-interactive]')
  

• Use Jython list:

  AdminTask.listServerTypes (['-interactive'])
  

 

setJVMDebugMode

Use the setJVMDebugMode command to set the JVM debug mode for the appserver.

Target object

None

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask setJVMDebugMode {-interactive}
  

• Use Jython string:

  AdminTask.setJVMDebugMode ('[-interactive]')
  

• Use Jython list:

  AdminTask.setJVMDebugMode (['-interactive'])
  

 

setGenericJVMArguments

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

Target object

None

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 appserver process. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask setGenericJVMArguments {-serverName server1 -nodeName node1}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask setGenericJVMArguments {-interactive}
  

• Use Jython string:

  AdminTask.setGenericJVMArguments ('[-interactive]')
  

• Use Jython list:

  AdminTask.setGenericJVMArguments (['-interactive'])
  

 

setJVMInitialHeapSize

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

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:

• Use Jacl:

  $AdminTask setJVMInitialHeapSize {-interactive}
  

• Use Jython string:

  AdminTask.setJVMInitialHeapSize ('[-interactive]')
  

• Use Jython list:

  AdminTask.setJVMInitialHeapSize (['-interactive'])
  

 

setJVMMaxHeapSize

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

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:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask setJVMMaxHeapSize {-interactive}
  

• Use Jython string:

  AdminTask.setJVMMaxHeapSize ('[-interactive]')
  

• Use 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:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask setJVMMode {-interactive}
  

• Use Jython string:

  AdminTask.setJVMMode ('[-interactive]')
  

• Use Jython list:

  AdminTask.setJVMMode (['-interactive'])
  

 

setJVMProperties

Use the setJVMProperties command to set the JVM configuration for the appserver.

Target object

None

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

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:

• Use Jacl:

  $AdminTask setJVMProperties {-serverName server1 -nodeName node1}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask setJVMProperties {-interactive}
  

• Use Jython string:

  AdminTask.setJVMProperties ('[-interactive]')
  

• Use Jython list:

  AdminTask.setJVMProperties (['-interactive'])
  

 

setJVMSystemProperties

Use the setJVMSystemProperties command to set the Java virtual machine (JVM) system property for the process of the appserver.

Target object

None

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

Batch mode example usage:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask setJVMSystemProperties {-interactive}
  

• Use Jython string:

  AdminTask.setJVMSystemProperties ('[-interactive]')
  

• Use Jython list:

  AdminTask.setJVMSystemProperties (['-interactive'])
  

 

setProcessDefinition

Use the setProcessDefinition command to set the process definition of an appserver.

Target object

None

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 WAS version. (String, optional)

-executableArguments

The arguments that are passed to the process when it is started. This parameter is only applicable to WAS 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

Batch mode example usage:

• Use Jacl:

  $AdminTask setProcessDefinition {-serverName server1 -nodeName node1}
  

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask setProcessDefinition {-interactive}
  

• Use Jython string:

  AdminTask.setProcessDefinition ('[-interactive]')
  

• Use 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

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

Batch mode example usage:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask setTraceSpecification {-interactive}
  

• Use Jython string:

  AdminTask.setTraceSpecification ('[-interactive]')
  

• Use 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

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

Batch mode example usage:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask showJVMProperties {-interactive}
  

• Use Jython string:

  AdminTask.showJVMProperties ('[-interactive]')
  

• Use Jython list:

  AdminTask.showJVMProperties (['-interactive'])
  

 

showJVMSystemProperties

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

Target object

None

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

Batch mode example usage:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask showJVMSystemProperties {-interactive}
  

• Use Jython string:

  AdminTask.showJVMSystemProperties ('[-interactive]')
  

• Use Jython list:

  AdminTask.showJVMSystemProperties (['-interactive'])
  

 

showProcessDefinition

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

Target object

None

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 specified is returned. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask showProcessDefinition {-interactive}
  

• Use Jython string:

  AdminTask.showProcessDefinition ('[-interactive]')
  

• Use Jython list:

  AdminTask.showProcessDefinition (['-interactive'])
  

 

showServerInfo

The showServerInfo command returns the information for a server specified.

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:

• Use Jacl:

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

• Use Jython string:

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

• Use Jython list:

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

Interactive mode example usage:

• Use Jacl:

  $AdminTask showServerInfo {-interactive}
  

• Use Jython string:

  AdminTask.showServerInfo ('[-interactive]')
  

• Use Jython list:

  AdminTask.showServerInfo (['-interactive'])
  

 

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

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask showServerTypeInfo APPLICATION_SERVER
  

• Use Jython string:

  AdminTask.showServerTypeInfo(APPLICATION_SERVER)
  

• Use Jython list:

  AdminTask.showServerTypeInfo(APPLICATION_SERVER)
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask showServerTypeInfo {-interactive}
  

• Use Jython string:

  AdminTask.showServerTypeInfo ('[-interactive]')
  

• Use Jython list:

  AdminTask.showServerTypeInfo (['-interactive'])
  

 

showTemplateInfo

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

Target object

The server type... APPLICATION_SERVER (String, required)

Parameters and return values

• Parameters: None

• Returns: The metadata information regarding a specific template.

Examples

Batch mode example usage:

• Use 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}
  

• Use 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]]'
  

• Use 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:

• Use Jacl:

  $AdminTask showTemplateInfo {-interactive}
  

• Use Jython string:

  AdminTask.showTemplateInfo ('[-interactive]')
  

• Use Jython list:

  AdminTask.showTemplateInfo (['-interactive'])
  

---

 

Related tasks

Use the AdminTask object for scripted administration

 

Related Reference

Commands for the AdminTask object

 

Reference topic