WAS v8.5 > Reference > Commands (wsadmin scripting)

ServerManagement command group for AdminTask

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

The ServerManagement command group for AdminTask includes the following commands:

• createApplicationServer
• createApplicationServerTemplate
• createGenericServer
• createGenericServerTemplate
• createGenericServerTemplate
• createProxyServer
• createProxyServerTemplate
• createServerType (Deprecated)
• createWebServer
• createWebServerTemplate
• deleteServer
• deleteServerTemplate
• getJavaHome
• getServerType
• listServers
• listServerTemplates
• listServerTypes
• setJVMDebugMode
• setGenericJVMArguments
• setJVMInitialHeapSize
• setJVMMaxHeapSize
• setJVMProperties
• setJVMSystemProperties
• setProcessDefinition
• setTraceSpecification
• showJVMProperties
• showJVMSystemProperties
• showProcessDefinition
• showServerInfo
• showServerTypeInfo
• showTemplateInfo

createApplicationServer

Use the createApplicationServer command to create a new application server.

Target object

Name of the node (String, required)

Required parameters

-name

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

Optional parameters

-templateName

The name of the template from which to base the server. (String, optional)

-genUniquePorts

Whether the system generates unique HTTP ports for the server. Default is true. Specify false if we do not want to generate unique HTTP ports for the server. (Boolean)

-templateLocation

-templateLocation (ConfigID, optional)

The configuration Id that represents the location of a template. To list all of the available templates, we can use the following command:

print AdminTask.listServerTemplates('-serverType WEB_SERVER')

Example usage:

-templateLocation 
IHS(templates/servertypes/WEB_SERVER/servers/IHS|server.xml)

Examples

Batch mode example usage:

• Jacl:
  $AdminTask createApplicationServer ndnode1 {-name test1 -templateName default}
• Jython string:

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask createApplicationServer {-interactive}
• Using Jython:
  AdminTask.createApplicationServer ('-interactive')

createApplicationServerTemplate

The createApplicationServerTemplate command creates a new application server template.

Target object None

Required parameters

-templateName

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

-serverName

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

-nodeName

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

Optional parameters

-description

Description of the template. (String)

-templateLocation

Configuration Id that represents the location to place the template. (String)

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

Websphere:_Websphere_Config_Data_Display_Name=display_name,_Websphere_Config_Data_Id=
configuration_id

The configuration Id value is the application server template, which is templates\servertypes\APPLICATION_SERVER|servertype-metadata.xml

Examples

Batch mode example usage:

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

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask createApplicationServerTemplate {-interactive}
• Jython string:
  AdminTask.createApplicationServerTemplate ('[-interactive]')
• 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 the WebSphere Application Server manages, but did not supply. The createGenericServer command provides an additional step, ConfigProcDef, used to configure the parameters that are specific to generic servers.

Target object Specifies the name of the node (String, required)

Required parameters

-name

The name of the server to create.

Optional parameters

-templateName

Picks up a server template. This step provides a list of application server templates for the node and server type. The default value is the default templates for the server type. (String, optional)

-genUniquePorts

Whether the system generates unique HTTP ports for the server. Default is true. Specify false if we do not want to generate unique HTTP ports for the server. (Boolean)

-templateLocation

The configuration Id that represents the location of a template. Specify the _Websphere_Config_Data_Id=templates/servertypes/GENERIC_SERVER|servertype-metadata.xml configuration Id to create a generic server. (ObjectName)

-startCommand

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

Whether a Java class name (use JAVA_CLASS) or the name of an executable JAR file (use EXECUTABLE_JAR) will be used as the executable target for this process. This field should be left blank for binary executables. This parameter is only applicable for Java processes. (String optional)

-executableTarget

Name of the executable target (a Java class containing a main() method or the name of an executable JAR), depending on the executable target type. This field should be left blank for binary executables. This parameter is only applicable for Java processes. (String, optional)

-workingDirectory

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:

• Jacl:

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

• Jython string:

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask createGenericServer {-interactive}
• Jython string:
  AdminTask.createGenericServer ('[-interactive]')
• Jython list:
  AdminTask.createGenericServer (['-interactive'])

createGenericServerTemplate

The createGenericServerTemplate command creates a new generic server template.

Target object None

Required parameters

-templateName

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

-serverName

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

-nodeName

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

Optional parameters

-description

Description of the template. (String)

-templateLocation

Configuration Id that represents the location to place the template. (String)

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

Websphere:_Websphere_Config_Data_Display_Name=display_name,_Websphere_Config_Data_Id=
configuration_id

The configuration Id value is the generic server template, which is templates\servertypes\GENERIC_SERVER|servertype-metadata.xml

Examples

Batch mode example usage:

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

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask createGenericServerTemplate {-interactive}
• Jython string:
  AdminTask.createGenericServerTemplate ('[-interactive]')
• Jython list:
  AdminTask.createGenericServerTemplate (['-interactive'])

createGenericServerTemplate

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

Target object None.

Required parameters

-serverName

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

-nodeName

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

-templateName

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

Optional parameters

-description

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

-templateLocation

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

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

Websphere:_Websphere_Config_Data_Display_Name=display_name,_Websphere_Config_Data_Id=
configuration_id

The configuration Id can be one of the following values:

• To create a web server template:

  templates\servertypes\WEB_SERVER|servertype-metadata.xml

• To create an 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:

• 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 Specifies the name of the node (String, required)

Required parameters

-name

The name of the server to create. (String)

Optional parameters

-templateName

Picks up a server template. This step provides a list of application server templates for the node and server type. The default value is the default templates for the server type. (String)

-genUniquePorts

Whether the system generates unique HTTP ports for the server. Default is true. Specify false if we do not want to generate unique HTTP ports for the server. (Boolean)

-templateLocation

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

-clusterName

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

Optional steps

-ConfigCoreGroup

coregroupName

Name of the core group to configure. (String)

-selectProtocols

list

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

Examples

Batch mode example usage:

• Jacl:

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

• Jython string:

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

• Jython list:

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

Interactive mode example usage:

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

Required parameters

-templateName

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

-serverName

Name of the proxy server of interest. (String)

-nodeName

Name of the node of interest. (String)

Optional parameters

-description

Description for the new server template. (String)

-templateLocation

Configuration Id that represents the location to place the template. Use the system defined location if you are unsure of the location. (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 value is the proxy server template, which is templates\servertypes\PROXY_SERVER|servertype-metadata.xml

Examples

Batch mode example usage:

• Jacl:

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

• Jython string:

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask createProxyServerTemplate {-interactive}
• Using Jython:
  AdminTask.createProxyServerTemplate('[-interactive]')

createServerType

Deprecated feature: The createServerType command is deprecated. No alternative command is provided for this deprecation.

Use the createServerType command to define a server type.

Target object None.

Required parameters

-version

Product version. (String, required)

-serverType

Server type of interest. (String, required)

-createTemplateCommand

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

-createCommand

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

-configValidator

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

Optional parameters

-defaultTemplateName

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

Sample output The command returns the object name of the server type that was created.

Examples

Batch mode example usage:

• Jacl:

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

• Jython string:

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

• Jython list:

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

Interactive mode example usage:

• 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, we can use web server definitions to administer and configure IBM HTTP Server web servers with the dmgr console. These functions include: Start, Stop, View logs, View and Edit configuration files.

Target object Name of the node (String, required).

Required parameters

-name

Name of the server. (String, required)

-serverConfig

Specifies the web server definition properties. Use this parameter and associated options to specify configuration properties for the IBM HTTP Server. Specify the following values in order in a list with the -serverConfig parameter:

webPort

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

webInstallRoot

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

pluginInstallRoot

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

configurationFile

File path for the IBM HTTP Server. 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. 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 values in order in a list with 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)

adminProtocol

Administrative protocol title. Options include HTTP or HTTPS.

The default is HTTP. (String, required)

adminUserID

User ID, if authentication is activated on the Administration server in the admin configuration file (admin.conf). This value should match the authentication in the admin.conf file. (String, optional)

adminPasswd

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

Optional parameters

-templateName

Name of the template to use. Templates include the following: IHS, iPlanet, IIS, DOMINO, APACHE.

The default template is IHS. (String, required)

-genUniquePorts

Whether the system generates unique HTTP ports for the server. Default is true. Specify false if we do not want to generate unique HTTP ports for the server. (Boolean)

-templateLocation

The configuration Id that represents the location of a template. Specify the _Websphere_Config_Data_Id=templates/servertypes/WEB_SERVER|servertype-metadata.xml configuration Id to create a generic server. (ObjectName)

Examples

Batch mode example usage:

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

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

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

• Jacl:
  $AdminTask createWebServer -interactive
• Jython string:
  AdminTask.createWebServer ('[-interactive]')
• Jython list:
  AdminTask.createWebServer (['-interactive'])

createWebServerTemplate

The createWebServerTemplate command creates a new web server template.

Target object None

Required parameters

-templateName

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

-serverName

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

-nodeName

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

Optional parameters

-description

Description of the template. (String)

-templateLocation

Configuration Id that represents the location to place the template. (String)

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

Websphere:_Websphere_Config_Data_Display_Name=display_name,_Websphere_Config_Data_Id=configuration_id

The configuration Id value is the Webserver template, which is templates\servertypes\WEB_SERVER|servertype-metadata.xml

Examples

Batch mode example usage:

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

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask createWebServerTemplate {-interactive}
• Jython string:
  AdminTask.createWebServerTemplate ('[-interactive]')
• Jython list:
  AdminTask.createWebServerTemplate (['-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 to delete. (String, required)

Optional parameters

Examples

:

• Jacl:
  $AdminTask deleteServer {-serverName server_name -nodeName node_name}
• Jython string:
  AdminTask.deleteServer('[-serverName server_name -nodeName node_name]')
• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask deleteServer {-interactive}
• Jython string:
  AdminTask.deleteServer ('[-interactive]')
• Jython list:
  AdminTask.deleteServer (['-interactive'])

deleteServerTemplate

Use the deleteServerTemplate command to delete a server template. We cannot delete templates that are defined by the system. We can only delete server templates 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

:

• Jacl:

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

• Jython string:

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask deleteServerTemplate {-interactive}
• Jython string:
  AdminTask.deleteServerTemplate ('[-interactive]')
• Jython list:
  AdminTask.deleteServerTemplate (['-interactive'])

getJavaHome

Use the getJavaHome command to get the Java home value.

Target object None.

Required parameters

-serverName

Name of the server. (String, required)

-nodeName

Name of the node. (String, required)

Examples

Batch mode example usage:

• Jacl:

  $AdminTask getJavaHome {-nodeName mynode -serverName myserver}

• Jython string:

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask getJavaHome {-interactive}
• Jython string:
  AdminTask.getJavaHome ('[-interactive]')
• Jython list:
  AdminTask.getJavaHome (['-interactive'])

getServerType

The getServerType command returns the type of the server specified.

Target object None

Optional parameters

-serverName

The name of the server. (String)

-nodeName

The name of the node. (String)

Examples

Batch mode example usage:

• Jacl:
  $AdminTask getServerType {-serverName test2 -nodeName ndnode1}
• Jython string:
  AdminTask.getServerType('[-serverName test2 -nodeName ndnode1]')
• Jython list:
  AdminTask.getServerType(['-serverName', 'test2', '-nodeName', 'ndnode1'])

Interactive mode example usage:

• Jacl:
  $AdminTask getServerType {-interactive}
• Jython string:
  AdminTask.getServerType ('[-interactive]')
• Jython list:
  AdminTask.getServerType (['-interactive'])

listServers

The listServers command returns a list of servers.

Target object None

Optional parameters

serverType

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

nodeName

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

Examples

Batch mode example usage:

• Jacl:
  $AdminTask listServers {-serverType APPLICATION_SERVER -nodeName ndnode1}
• Jython string:
  AdminTask.listServers('[-serverType APPLICATION_SERVER -nodeName ndnode1]')
• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask listServers {-interactive}
• Jython string:
  AdminTask.listServers ('[-interactive]')
• 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 to list. (String, optional)

-serverType

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

-name

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

-queryExp

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

Examples

Batch mode example usage:

• Jacl:

  $AdminTask listServerTemplates {-version 6.0.0.0 -serverType 
   APPLICATION_SERVER}

• Jython string:

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask listServerTemplates {-interactive}
• Jython string:
  AdminTask.listServerTemplates ('[-interactive]')
• 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 we can define on a node. If we do not specify the target object, this command returns all of the server types defined in the entire cell.

Examples

Batch mode example usage:

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

Interactive mode example usage:

• Jacl:
  $AdminTask listServerTypes {-interactive}
• Jython string:
  AdminTask.listServerTypes ('[-interactive]')
• 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

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

Examples

Interactive mode example usage:

• Jacl:
  $AdminTask setJVMDebugMode {-interactive}
• Jython string:
  AdminTask.setJVMDebugMode ('[-interactive]')
• 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 None

Required parameters

-serverName

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

-nodeName

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

Optional parameters

-genericJvmArguments

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

Examples

Batch mode example usage:

• Jacl:
  $AdminTask setGenericJVMArguments {-serverName server1 -nodeName node1}
• Jython string:
  AdminTask.setGenericJVMArguments('[-serverName server1 -nodeName node1]')
• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask setGenericJVMArguments {-interactive}
• Jython string:
  AdminTask.setGenericJVMArguments ('[-interactive]')
• 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

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

Examples

Interactive mode example usage:

• Jacl:
  $AdminTask setJVMInitialHeapSize {-interactive}
• Jython string:
  AdminTask.setJVMInitialHeapSize ('[-interactive]')
• 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

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

Examples

Batch mode example usage:

• 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, we can set the JVM maximum heap size using the command commands:

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

• Jython string:

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

• Jython list:

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

Interactive mode example usage:

• Jacl:

  $AdminTask setJVMMaxHeapSize {-interactive}

• Jython string:

  AdminTask.setJVMMaxHeapSize ('[-interactive]')

• Jython list:

  AdminTask.setJVMMaxHeapSize (['-interactive'])

setJVMProperties

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

Target object None

Required parameters

-serverName

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

-nodeName

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

Optional parameters

-classpath

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

-bootClasspath

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

-verboseModeClass

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

-verboseModeGarbageCollection

Whether to use verbose debug output for garbage page .

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

-verboseModeJNI

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

-initialHeapSize

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

-maximumHeapSize

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

-runHProf

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

-hprofArguments

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

-debugMode

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

-debugArgs

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

-genericJvmArguments

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

-executableJarFileName

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

-disableJIT

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:

• Jacl:
  $AdminTask setJVMProperties {-serverName server1 -nodeName node1}
• Jython string:
  AdminTask.setJVMProperties('[-serverName server1 -nodeName node1]')
• Jython list:
  AdminTask.setJVMProperties(['-serverName', 'server1', '-nodeName', 'node1'])

Interactive mode example usage:

• Jacl:
  $AdminTask setJVMProperties {-interactive}
• Jython string:
  AdminTask.setJVMProperties ('[-interactive]')
• 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

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

-nodeName

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

-propertyName

Property name. (String, required)

-propertyValue

Property value. (String, required)

Examples

Batch mode example usage:

• Jacl:

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

• Jython string:

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask setJVMSystemProperties {-interactive}
• Jython string:
  AdminTask.setJVMSystemProperties ('[-interactive]')
• 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 to modify the process definition. If there is only one server in the entire configuration, this parameter is optional. (String, required)

-nodeName

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

Optional parameters

-executableName

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

-executableArguments

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

-workingDirectory

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

-executableTargetKind

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

-executableTarget

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

Examples

Batch mode example usage:

• Jacl:
  $AdminTask setProcessDefinition {-serverName server1 -nodeName node1}
• Jython string:
  AdminTask.setProcessDefinition('[-serverName server1 -nodeName node1]')
• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask setProcessDefinition {-interactive}
• Jython string:
  AdminTask.setProcessDefinition ('[-interactive]')
• 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

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

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

-traceSpecification

Trace specification. (String, required)

Examples

Batch mode example usage:

• Jacl:

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

• Jython string:

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask setTraceSpecification {-interactive}
• Jython string:
  AdminTask.setTraceSpecification ('[-interactive]')
• 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

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

-nodeName

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

-propertyName

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

Optional parameters

-propertyName

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

Examples

Batch mode example usage:

• Jacl:

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

• Jython string:

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask showJVMProperties {-interactive}
• Jython string:
  AdminTask.showJVMProperties ('[-interactive]')
• 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

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

-nodeName

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

Optional parameters

-propertyName

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

Examples

Batch mode example usage:

• Jacl:

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

• Jython string:

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask showJVMSystemProperties {-interactive}
• Jython string:
  AdminTask.showJVMSystemProperties ('[-interactive]')
• Jython list:
  AdminTask.showJVMSystemProperties (['-interactive'])

showProcessDefinition

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

Target object None

Required parameters

-serverName

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

-nodeName

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

Optional parameters

-propertyName

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

Examples

Batch mode example usage:

• Jacl:

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

• Jython string:

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask showProcessDefinition {-interactive}
• Jython string:
  AdminTask.showProcessDefinition ('[-interactive]')
• 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:

• Jacl:

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

• Jython string:

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

• Jython list:

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

Interactive mode example usage:

• Jacl:
  $AdminTask showServerInfo {-interactive}
• Jython string:
  AdminTask.showServerInfo ('[-interactive]')
• 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

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

-serverType

Specifies to list templates for a specific server type. (String, optional)

-name

Whether to look for a specific template. (String, optional)

-queryExp

Specifies a key and value pair used to find templates by properties. For example, com.ibm.websphere.nodeOperatingSystem=os390. (String[], optional)

Examples

Batch mode example usage:

• Jacl:
  $AdminTask showServerTypeInfo APPLICATION_SERVER
• Jython string:
  AdminTask.showServerTypeInfo(APPLICATION_SERVER)
• Jython list:
  AdminTask.showServerTypeInfo(APPLICATION_SERVER)

Interactive mode example usage:

• Jacl:
  $AdminTask showServerTypeInfo {-interactive}
• Jython string:
  AdminTask.showServerTypeInfo ('[-interactive]')
• 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:

• 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.baseProductMinorVersion 0.0} {com.ibm.websphere.baseProductMajorv6} 
   {com.ibm.websphere.nodeOperatingSystem {}}{isDefaultTemplate true}

• 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.baseProductMinorVersion 0.0] [description  The WebSphere Default Server Template] 
    [isDefaultTemplate true] [com.ibm.websphere.nodeOperatingSystem] [com.ibm.websphere.baseProductMajorv6]]'

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

• Jacl:
  $AdminTask showTemplateInfo {-interactive}
• Jython string:
  AdminTask.showTemplateInfo ('[-interactive]')
• Jython list:
  AdminTask.showTemplateInfo (['-interactive'])

Related

Use the wsadmin scripting AdminTask object for scripted administration

Reference:

Commands for AdminTask using wsadmin.sh

+

Search Tips   |   Advanced Search