Intelligent Management: middleware server management administrative tasks
We can use the Jython and Jacl scripting languages to manage middleware servers with wsadmin.sh. Use commands in the MiddlewareServerManagement group.
Use the following commands to work with middleware servers:
- getMiddlewareServerType
- listForeignServerTypes
- listMiddlewareServers
- listMiddlewareServerTypes
- listWASServerTypes
- modifyForeignServerProperty
- showMiddlewareServerInfo
- startMiddlewareServer
- stopMiddlewareServer
- executeMiddlewareServerOperation
getMiddlewareServerType
The getMiddlewareServerType command lists the middleware server types.
Target object: None.
Required parameters
- -serverName
- Name of the server for which to display the type. (String, required)
- -nodeName
- Node on which the server runs. (String, required)
Return value
The command returns a list of the middleware servers for the specified type.
Batch mode example
- Jacl:
$AdminTask getMiddlewareServerType {-serverName myserver -nodeName mynode}
- Jython string...
AdminTask.getMiddlewareServerType('[-serverName myserver -nodeName mynode]')
Interactive mode
- Jacl:
$AdminTask stopMiddlewareServer {-interactive}
- Jython string...
AdminTask.stopMiddlewareServer ('[-interactive]')
listForeignServerTypes
The listForeignServerTypes command lists all of the supported middleware server types, not including any middleware servers associated with Intelligent Management.
Target object
Return value
The command returns a list of middleware server types, for example:
PHP_SERVER WASCE_SERVER CUSTOMHTTP_SERVER APACHE_SERVER TOMCAT_SERVER LIBERTY_SERVER WEBLOGIC_SERVER JBOSS_SERVER WASAPP_SERVERBatch mode example
- Jacl:
$AdminTask listForeignServerTypes
- Jython string...
AdminTask.listForeignServerTypes()
listMiddlewareServers
The listMiddlewareServers command lists the middleware servers and the path to the configuration file for the servers. If we do not pass node or middleware server type parameters, then all of the servers are displayed.
Target object: None.
Optional parameters
- -middlewareServerType
- Type of middleware server to list. The middleware server types include: TOMCAT_SERVER, LIBERTY_SERVER, PHP_SERVER, WEBLOGIC_SERVER, JBOSS_SERVER, WASCE_SERVER, APACHE_SERVER, and CUSTOMHTTP_SERVER.(String, optional)
- -nodeName
- Node for which to list the servers. (String, optional)
Return value
The command returns the list of the middleware servers for the type that you indicated. For example, you might see the following output:
nodeagent(cells/xdblade02b07/nodes/xdblade01b08/servers/nodeagent|server.xml) WASCE_2.0.0.0_xdblade01b08_DS_2(cells/xdblade02b07/nodes/xdblade01b08/servers/WASCE_2.0.0.0_xdblade01b08_DS_2|server.xml) WASCE_2.0.0.0_xdblade01b08_DS_1(cells/xdblade02b07/nodes/xdblade01b08/servers/WASCE_2.0.0.0_xdblade01b08_DS_1|server.xml) WASCE_2.0.0.0_xdblade01b08_DS_4(cells/xdblade02b07/nodes/xdblade01b08/servers/WASCE_2.0.0.0_xdblade01b08_DS_4|server.xml) frucg(cells/xdblade02b07/nodes/xdblade01b08/servers/frucg|server.xml) WASCE_2.0.0.0_xdblade01b08_DD_1(cells/xdblade02b07/nodes/xdblade01b08/servers/WASCE_2.0.0.0_xdblade01b08_DD_1|server.xml) dmgr(cells/xdblade02b07/nodes/xdblade02b07/servers/dmgr|server.xml) middlewareagent(cells/xdblade02b07/nodes/thebe14/servers/middlewareagent|server.xml) tttomcat_server(cells/xdblade02b07/nodes/thebe14/servers/tttomcat_server|server.xml)Batch mode example
- Jacl:
$AdminTask listMiddlewareServers {-middlewareServerType TOMCAT_SERVER}
- Jython string...
AdminTask.listMiddlewareServers('[-middlewareServerType TOMCAT_SERVER]')
Interactive mode
- Jacl:
$AdminTask listMiddlewareServers
- Jython string...
AdminTask.listMiddlewareServers()
listMiddlewareServerTypes
The listMiddlewareServerTypes command lists all of the server types.
Target object
Return value
The command returns a list of all of the server types, for example:
APPLICATION_SERVER PHP_SERVER WASCE_SERVER CUSTOMHTTP_SERVER APACHE_SERVER TOMCAT_SERVER LIBERTY_SERVER WEBLOGIC_SERVER ONDEMAND_ROUTER PROXY_SERVER WEB_SERVER JBOSS_SERVER WASAPP_SERVER GENERIC_SERVERBatch mode example
- Jacl:
$AdminTask listMiddlewareServerTypes
- Jython string...
AdminTask.listMiddlewareServerTypes
Interactive mode
listWASServerTypes
The listWASServerTypes command lists only the server types associated with WebSphere Application Server.
Target object
Return value
The command returns a list of server types, for example:
APPLICATION_SERVER ONDEMAND_ROUTER PROXY_SERVER WEB_SERVER GENERIC_SERVER
Batch mode example
- Jacl:
$AdminTask listWASServerTypes
- Jython string...
AdminTask.listWASServerTypes()
modifyForeignServerProperty
The modifyForeignServerProperty command modifies a property on a middleware server.
Target object: None.
Required parameters
- -serverName
- Name of the server. (String, required)
- -nodeName
- Name of the node. (String, required)
- -propKey
- Property key that is associated with the server.xml file. (String, required)
- -propValue
- Property value to set in the server.xml file. (String, required)
Return value
The command returns
Batch mode example
- Jacl:
$AdminTask modifyForeignServerProperty {-serverName WASCE_2.0.0.0_xdblade01b08_DS_4 -nodeName xdblade01b08 -propKey port -propValue 9090 }
- Jython string...
AdminTask.modifyForeignServerProperty('[-serverName WASCE_2.0.0.0_xdblade01b08_DS_4 -nodeName xdblade01b08 -propKey port -propValue 9090]')
Interactive mode
- Jacl:
$AdminTask modifyForeignServerProperty {-interactive}
- Jython string...
AdminTask.modifyForeignServerProperty('[-interactive]')
showMiddlewareServerInfo
The showMiddlewareServerInfo command displays a list of properties for the middleware server.
Return value
The command returns
Required parameters
- server_name(path_to_configuration_file|configuration_file_name)
- This parameter determines the server for which to display the information. For example, you might use the following value for this parameter:
odr2(cells/SVT61/nodes/oberon04/servers/odr2|server.xml)
We can determine the value of the path_to_configuration_file variable and the configuration_file_name value by running the listMiddlewareServers command. We can use the output of that command as the parameter value.
Batch mode example
- Jacl:
$AdminTask showMiddlewareServerInfo odr2(cells/SVT61/nodes/oberon04/servers/odr2|server.xml)
- Jython string...
AdminTask.showMiddlewareServerInfo('odr2(cells/SVT61/nodes/oberon04/servers/odr2|server.xml)')
Interactive mode
- Jacl:
$AdminTask showMiddlewareServerInfo {-interactive}
- Jython string...
AdminTask.showMiddlewareServerInfo('[-interactive]')
Example output
{cell SVT61} {serverMiddlewareType ONDEMAND_ROUTER} {com.ibm.websphere.baseProductVersion 6.1.0.11} {node oberon04} {server odr2}
startMiddlewareServer
The startMiddlewareServer command starts a specified middleware server.
Target object: None.
Required parameters
- -serverName
- Name of the server to start. (String, required)
- -nodeName
- Node on which the server to start runs. (String, required)
Return value
The command returns
Batch mode example
- Jacl:
$AdminTask.startMiddlewareServer('[-serverName myserver -nodeName mynode]')
- Jython string...
AdminTask.startMiddlewareServer('[-serverName myserver -nodeName mynode]')
Interactive mode
- Jacl:
$AdminTask startMiddlewareServer{-interactive}
- Jython string...
AdminTask.startMiddlewareServer('[-interactive]')
stopMiddlewareServer
The stopMiddlewareServer command stops the specified middleware server.
Target object: None.
Required parameters
- -serverName
- Name of the middleware server to stop. (String, required)
- -nodeName
- Node on which the server to stop runs. (String, required)
Batch mode example
- Jacl:
$AdminTask.stopMiddlewareServer('[-serverName myserver -nodeName mynode]')
- Jython string...
AdminTask.stopMiddlewareServer('[-serverName myserver -nodeName mynode]')
Interactive mode
- Jacl:
$AdminTask stopMiddlewareServer {-interactive}
- Jython string...
AdminTask.stopMiddlewareServer ('[-interactive]')
executeMiddlewareServerOperation
The executeMiddlewareServerOperation command runs an existing server operation on a specified server.
Target object: None.
Required parameters
- -serverName
- Name of the server on which to run the server operation. (String, required)
- -nodeName
- Name of the node on which the specified server runs. (String, required)
- -operation
- Name of the server operation to run on the server. (String, required)
Return value
The command returns a status message for the server operation, for example:
CWMWS0420I: Start completed for middleware server "WASCE_2.0.0.0_xdblade01b08_DS_4" on node "xdblade01b08"
Batch mode example
- Jacl:
$AdminTask executeMiddlewareServerOperation {-serverName WASCE_2.0.0.0_xdblade01b08_DS_4 -nodeName xdblade01b08 -operation start }
- Jython string...
AdminTask.executeMiddlewareServerOperation('[-serverName WASCE_2.0.0.0_xdblade01b08_DS_4 -nodeName xdblade01b08 -operation start]')
Interactive mode
- Jacl:
$AdminTask executeMiddlewareServerOperation {-interactive}
- Jython string...
AdminTask.executeMiddlewareServerOperation('[-interactive]')
Reference topic