ServerManagement command group for the AdminTask object

changeServerSpecificShortName

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

Target object

None

Required parameters

Optional parameters

-specificShortName

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

Examples

Batch mode example usage:

• Using Jacl:

  $AdminTask changeServerSpecificShortName {-serverName server1 -nodeName node1
       -specificShortName newshortname}

• Using Jython string:

  AdminTask.changeServerSpecificShortName('[-serverName myserver -nodeName myNode
   -specificShortName newshortname]')

• Using Jython list:

  AdminTask.changeServerSpecificShortName(['-serverName', 'myserver', '-nodeName', 'myNode',
      '-specificShortName', 'newshortname'])

Interactive mode example usage:

• Using Jacl:

  $AdminTask changeServerSpecificShortName {-interactive}

• Using Jython string:

  AdminTask.changeServerSpecificShortName ('[-interactive]')

• Using Jython list:

  AdminTask.changeServerSpecificShortName (['-interactive'])

createApplicationServer

Use the createApplicationServer command to create a new application server.

Target object

Specifies the name of the node (String, required)

Required parameters

Optional parameters

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:

  AdminTask.createApplicationServer ('-interactive')

createApplicationServerTemplate

The createApplicationServerTemplate command creates a new application server template.

Target object

Required parameters

Optional parameters

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

Required parameters

Optional parameters

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

createGenericServerTemplate for new server template

The createGenericServerTemplate command creates a new generic server template.

Target object

Required parameters

Optional parameters

Examples

Batch mode example usage:

• Using Jacl:

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

• Using Jython string:

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

• Using Jython list:

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

Interactive mode example usage:

• Using Jacl:

  $AdminTask createGenericServerTemplate {-interactive}

• Using Jython string:

  AdminTask.createGenericServerTemplate ('[-interactive]')

• Using Jython list:

  AdminTask.createGenericServerTemplate (['-interactive'])

createGenericServerTemplate based on existing template

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

Target object

Required parameters

-serverName

Specifies the name of the server of interest. (String, required)

-nodeName

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

-templateName

Specifies the name of the template to create. (String, required)

Optional parameters

-description

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

-templateLocation

Specifies a configuration Id that represents the location of the template. If this parameter is not specified, the system uses the default location. (String, optional)

The following example displays the format of the configuration Id, where the display name is optional:

Websphere:_Websphere_Config_Data_Display_Name=display_name,_Websphere_Config_Data_Id=
configuration_id

The configuration Id 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

Interactive mode example usage:

• Using Jacl:

  $AdminTask createGenericServerTemplate {-interactive}

• Using Jython:

  AdminTask.createGenericServerTemplate('-interactive')

createProxyServer

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

Target object

Required parameters

Optional parameters

Optional steps

Examples

Batch mode example usage:

• Using Jacl:

  $AdminTask createProxyServer myNode {-name myProxyServer -templateName myTemplate 
   -ConfigCoreGroup [-coregroupName [myCoreGroup]] -selectProtocols [-list [HTTP, SIP]]}

• Using Jython string:

  AdminTask.createProxyServer('myNode', '[-name myProxyServer -templateName myTemplate 
   -ConfigCoreGroup [-coregroupName [myCoreGroup]] -selectProtocols [-list [HTTP, SIP]]]')

• Using Jython list:

  AdminTask.createProxyServer(myNode, ['-name', 'myProxyServer', '-templateName', 'myTemplate', 
   '-ConfigCoreGroup', '[-coregroupName [myCoreGroup]]', '-selectProtocols', '[-list [HTTP, SIP]]'])

Interactive mode example usage:

• Using Jacl:

  $AdminTask createProxyServer {-interactive}

• Using Jython:

  AdminTask.createProxyServer('-interactive')

createProxyServerTemplate

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

Target object

Required parameters

Optional parameters

Examples

Batch mode example usage:

• Using Jacl:

  $AdminTask createProxyServerTemplate {-templateName proxyServerTemplate -serverName proxyServer1 
   -nodeName myNode}

• Using Jython string:

  AdminTask.createProxyServerTemplate('[-templateName proxyServerTemplate -serverName proxyServer1 
   -nodeName myNode]')

• Using Jython list:

  AdminTask.createProxyServerTemplate(['-templateName', 'proxyServerTemplate', '-serverName', 
   'proxyServer1', '-nodeName', 'myNode'])

Interactive mode example usage:

• Using Jacl:

  $AdminTask createProxyServerTemplate {-interactive}

• Using Jython:

  AdminTask.createProxyServerTemplate('[-interactive]')

createServerType

Use the createServerType command to define a server type.

Target object

Required parameters

-version

Specifies the product version. (String, required)

-serverType

Specifies the server type of interest. (String, required)

-createTemplateCommand

Specifies the command to use to create a server template. (String, required)

-createCommand

Specifies the command to use to create a server. (String, required)

-configValidator

Specifies the name of the configuration validator class. (String, required)

Optional parameters

-defaultTemplateName

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

-defaultzOSTemplateName

Specifies the name of the default template. The default value is default_zOS. (String, optional)

Sample output

Examples

Batch mode example usage:

• Using Jacl:

  $AdminTask createServerType {-version version -serverType serverType  
   -createTemplateCommand name -createCommand name}

• Using Jython string:

  AdminTask.createServerType('[-version version -serverType serverType  
   -createTemplateCommand name -createCommand name]')

• Using Jython list:

  AdminTask.createServerType(['-version', 'version', '-serverType', 'serverType',
   '-createTemplateCommand', 'name', '-createCommand', 'name'])

Interactive mode example usage:

• Using Jacl:

  $AdminTask createServerType {-interactive}

• Using Jython:

  AdminTask.createServerType('-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 web server definitions to administer and configure IBM HTTP Server web servers with the administrative console. These functions include: Start, Stop, View logs, View and Edit configuration files.

Target object

Required parameters

Optional parameters

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

createWebServerTemplate

The createWebServerTemplate command creates a new web server template.

Target object

Required parameters

Optional parameters

Examples

Batch mode example usage:

• Using Jacl:

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

• Using Jython string:

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

• Using Jython list:

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

Interactive mode example usage:

• Using Jacl:

  $AdminTask createWebServerTemplate {-interactive}

• Using Jython string:

  AdminTask.createWebServerTemplate ('[-interactive]')

• Using Jython list:

  AdminTask.createWebServerTemplate (['-interactive'])

deleteServer

Use the deleteServer command to delete a server.

Target object

Required parameters

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

Required parameters

Optional parameters

-mode

Specifies either 64bit or 31bit mode. (String, optional)

Deprecated feature: You should eventually convert all of your servers to run in 64-bit mode because support for servers in 31-bit mode is deprecated.

Examples

Batch mode example usage:

• Using Jacl:

  $AdminTask getJavaHome {-nodeName mynode -serverName myserver}

  

   $AdminTask getJavaHome {-nodeName mynode -serverName myserver -mode 64bit}

• Using Jython string:

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

  

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

• Using Jython list:

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

  

  AdminTask.getJavaHome (['-nodeName', 'mynode', '-serverName', 'myserver', '-mode', '64bit'])

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

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

Target object

Optional parameters

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

Target object

Optional parameters

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

Optional parameters

-version

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

-serverType

Specify this option if you want to list templates for a specific server type. (String, optional)

-name

Specify this option to look for a specific template. (String, optional)

-queryExp

A key and value pair that you can use to find templates by properties. For example, com.ibm.websphere.nodeOperatingSystem=os390 (String[], optional).

Examples

Batch mode example usage:

• 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 Java virtual machine (JVM) debug mode for the application server.

Target object

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 Java virtual machine (JVM) code that starts the application server process.

Target object

Required parameters

Optional parameters

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 Java virtual machine (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}

  Configuration note: With the Jacl scripting language, the subst command enables you to substitute a previously set value for a variable in the command. For example, you can set the JVM maximum heap size using the command commands:

  set nodeparm node1
  $AdminTask setJVMMaxHeapSize [subst {-serverName server1 -nodeName $nodeparm 
  -maximumHeapSize 100}]

• 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 be either 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, the heap size is automatically set to use a maximum heap size of 512 MB and an initial heap size of 256 MB.

Target object

Parameters and return values

-serverName

The name of the server. (String, required)

-nodeName

The name of the node. (String, required)

Optional parameters

-mode

Specifies either 64bit or 31bit mode. (String, required)

Note: You should eventually convert all of your servers to run in 64-bit mode because support for servers in 31-bit mode is deprecated.

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 Java virtual machine (JVM) configuration for the application server.

Target object

Required parameters

Optional parameters

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 Java virtual machine (JVM) system property for the process of the application server.

Target object

Required parameters

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

Required parameters

Optional parameters

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

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

Specifies the trace specification. (String, required)

Optional parameters

-persist

Specifies how long the trace specification is to last. The default is -persist false and is only applied at JVM runtime. If the JVM is restarted the trace specification is automatically removed. If you want the trace specification to continue even when the JVM is restarted, then you specify -persist true. (String, optional)

Examples

Batch mode example usage:

• Using Jacl:

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

• Using Jacl with -persist:

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

• Using Jython string:

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

• Using Jython string with -persist :

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

• Using Jython list with -persist:

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

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 Java virtual machine (JVM) configuration for the server of the application process.

Target object

Required parameters

Optional parameters

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

Required parameters

Optional parameters

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

Required parameters

Optional parameters

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

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

Optional parameters

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.baseProductVersion 6.0.0} 
  {description {The WebSphere  Default Server Template}} 
   {com.ibm.websphere.baseProductMinorVersion 0.0} {com.ibm.websphere.baseProductMajorVersion 6} 
   {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.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]]'

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