WebSphere Application Server - Express, Version 6.0.x     Operating Systems: AIX, HP-UX, Linux, Solaris, Windows

Commands for the AdminControl object

Use the AdminControl object to invoke operational commands that deal with running objects in the WebSphere Application Server. Many of the AdminControl commands have multiple signatures so that they can either invoke in a raw mode using parameters that are specified by Java Management Extensions (JMX), or by using strings for parameters. In addition to operational commands, the AdminControl object supports some utility commands for tracing, reconnecting with a server, and converting data types.

The following commands are available for the AdminControl object:

Command name: Description: Parameters and return values: Examples:
complete ObjectName Creates a string representation of a complete ObjectName value that is based on a fragment. This command does not communicate with the server to find a matching ObjectName value. If it finds several MBeans that match the fragment, the command returns the first one.
  • Parameters: name-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
set serverON [$AdminControl 
completeObjectName node=
mynode,type=Server,*] 
Using Jython:
serverON = AdminControl.
completeObjectName('node=
mynode,type=Server,*')
getAttribute Returns the value of the attribute for the name that you provide.
  • Parameters: name-java.lang.String; attribute-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
set objNameString 
[$AdminControl complete
ObjectName WebSphere:
type=Server,*] 
$AdminControl getAttribute 
$objNameString processType 
Using Jython:
objNameString = Admin
Control.completeObject
Name('WebSphere:type=
Server,*') 
AdminControl.getAttribute
(objNameString, 
'processType')
getAttribute _jmx Returns the value of the attribute for the name that you provide.
  • Parameters: name-ObjectName; attribute-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
set objNameString 
[$AdminControl complete
ObjectName WebSphere:
type=Server,*] 
set objName [java::new 
javax.management.Object
Name $objNameString]
$AdminControl 
getAttribute_jmx 
$objName processType
Using Jython:
objNameString = 
AdminControl.complete
ObjectName('WebSphere:
type=Server,*') 
import  javax.
management  as  mgmt 
objName =  mgmt.Object
Name(objNameString) 
AdminControl.getAttribute
_jmx(objName, 
'processType')
getAttributes Returns the attribute values for the names that you provide.
  • Parameters using Jacl: name-String; attributes-java.lang.String
  • Parameters using Jython: name-String; attributes-java.lang.String or name-String; attributes-java.lang.Object[]
  • Returns: java.lang.String

Example usage:

Using Jacl:
set objNameString 
[$AdminControl complete
ObjectName WebSphere:
type=Server,*] 
$AdminControl 
getAttributes $objName
String "cellName nodeName"
Using Jython with string attributes:
objNameString = Admin
Control.completeObject
name('WebSphere:type
=Server,*)
AdminControl.getAttributes
(objNameString, 
'[cellName nodeName]')
Using Jython with object attributes:
objNameString = Admin
Control.completeObject
name('WebSphere:type
=Server,*)
AdminControl.get
Attributes(objNameString, 
['cellName', 'nodeName'])
getAttributes _jmx Returns the attribute values for the names that you provide.
  • Parameters: name-ObjectName; attributes-java.lang.String[]
  • Returns: javax.management. AttributeList

Example usage:

Using Jacl:
set objectNameString 
[$AdminControl complete
ObjectName WebSphere:
type=Server,*]
set objName [$AdminControl 
makeObjectName 
$objectNameString]
set attrs [java::new 
{String[]} 2 {cellName 
nodeName}] 
$AdminControl getAttributes
_jmx $objName $attrs
Using Jython:
objectNameString = 
AdminControl.complete
ObjectName('type=Server,*')
objName = AdminControl.
makeObjectName
(objectNameString)
attrs = ['cellName', 
'nodeName']
AdminControl.getAttributes
_jmx(objName, attrs)
getCell Returns the name of the connected cell.
  • Parameters: None
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl getCell
Using Jython:
AdminControl.getCell()
Example output:
Mycell
getConfigId Creates a configuration ID from an ObjectName or an ObjectName fragment. Use this ID with the $AdminConfig command. Not all MBeans that run have configuration objects that correspond. If several MBeans correspond to an ObjectName fragment, a warning is created and a configuration ID builds for the first MBean it finds.
  • Parameters: name-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
set threadpoolCID [$AdminControl 
getConfigId node=mynode,
type=ThreadPool,*]  
Using Jython:
threadpoolCID = AdminControl.
getConfigId('node=mynode,
type=ThreadPool,*')
getDefault Domain Returns the default domain name from the server.
  • Parameters: None
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl getDefaultDomain 
Using Jython:
AdminControl.getDefaultDomain()
Example output:
WebSphere
getDomain Name Returns the domain name from the server.
  • Parameters: None
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl getDomainName
Using Jython:
AdminControl.getDomainName()
Example output:
WebSphere
getHost Returns the name of your host.
  • Parameters: None
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl getHost
Using Jython:
AdminControl.getHost()
Example output:
myhost
getMBean Count Returns the number of MBeans that are registered in the server.
  • Parameters: None
  • Returns: java.lang.Integer

Example usage:

Using Jacl:
$AdminControl getMBeanCount 
Using Jython:
AdminControl.getMBeanCount()
Example output:
114
getMBeanInfo _jmx Returns the Java Management Extension MBeanInfo structure that corresponds to an ObjectName value. No string signature exists for this command, because the Help object displays most of the information available from the getMBeanInfo command.
  • Parameters: name-ObjectName
  • Returns: javax.management. MBeanInfo

Example usage:

Using Jacl:
set objectNameString 
[$AdminControl complete
ObjectName type=Server,*] 
set objName [$AdminControl 
makeObjectName 
$objectNameString]
$AdminControl getMBeanInfo
_jmx $objName 
Using Jython:
objectNameString = 
AdminControl.complete
ObjectName('type=Server,*') 
objName = AdminControl.
makeObjectName
(objectNameString)
AdminControl.getMBeanInfo
_jmx(objName)
Example output:
javax.management.modelmbean.
ModelMBeanInfoSupport@
10dd5f35
getNode Returns the name of the connected node.
  • Parameters: None
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl getNode
Using Jython:
AdminControl.getNode()
Example output:
Myhost
getPort Returns the name of your port.
  • Parameters: None
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl getPort
Using Jython:
AdminControl.getPort()
Example output:
8877
getProperties ForData Source Deprecated, no replacement.

This command incorrectly assumes the availability of a configuration service when running in connected mode.

  • Parameters: configId-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
set ds [lindex 
[$AdminConfig list 
DataSource] 0] 
$AdminControl getProper
tiesForDataSource $ds
Using Jython:
ds = AdminConfig.list
('DataSource')

# get line separator 
import  java.lang.
System  as  sys
lineSeparator = sys.
getProperty('line.
separator')

dsArray = ds.split
(lineSeparator)
AdminControl.getProper
tiesForDataSource
(dsArray[0])
Example output:
WASX7389E: Operation 
not supported - get
PropertiesForDataSource 
command is not supported.
getType Returns the connection type.
  • Parameters: None
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl getType
Using Jython:
AdminControl.getType()
Example output:
SOAP
help Returns general help text for the AdminControl object.
  • Parameters: None
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl help 
Using Jython:
AdminControl.help()
Example output:
WASX7027I: The AdminControl 
object enables the 
manipulation of MBeans that 
run in a WebSphere 
Application Server process.
The number and type of MBeans 
that are available to the 
scripting client depend 
on the server to
which the client is connected.  
If the client is 
connected to a
deployment manager, then 
all the MBeans running 
in the Deployment
Manager are visible, as 
are all the MBeans running 
in the node agents
that are connected to this 
deployment manager, and 
all the MBeans that run in 
the application servers 
on those nodes.

The following commands are 
supported by the 
AdminControl object; 
more detailed information 
about each of these 
commands is available by 
using the "help" command 
of the AdminControl object 
and supplying the name 
of the command as an 
argument.

Many of these commands 
support two different 
sets of signatures: one 
that accepts and returns 
strings, and one low-level
set that works with JMX 
objects like ObjectName 
and AttributeList.
In most situations, the 
string signatures are 
likely to be more useful,
but JMX-object signature 
versions are supplied 
as well.  Each of these
JMX-object signature 
commands has "_jmx" 
appended to the command 
name, so an "invoke" 
command, as well as a 
"invoke_jmx" command 
are supported.
     
completeObjectName
Return a String version 
of an object name given a
template name
getAttribute_jmx
Given ObjectName and 
name of attribute, 
returns value of
attribute
getAttribute    
Given String version 
of ObjectName and 
name of attribute,
returns value of 
attribute
getAttributes_jmx
Given ObjectName and 
array of attribute 
names, returns AttributeList
getAttributes   
Given String version 
of ObjectName and 
attribute names,
returns String of 
name value pairs

getCell         
returns the cell name 
of the connected server
getConfigId     
Given String version of 
ObjectName, return a 
config id for the 
corresponding configuration 
object, if any.
getDefaultDomain
returns "WebSphere"
getDomainName   
returns "WebSphere"

getHost         
returns String 
representation of 
connected host
getMBeanCount   
returns number of 
registered beans
getMBeanInfo_jmx
Given ObjectName, 
returns MBeanInfo 
structure for MBean

getNode         
returns the node name 
of the connected server
getPort         
returns String 
representation of 
port in use
getType         
returns String 
representation of 
connection type in use
help            
     
Show help information
invoke_jmx      
Given ObjectName, name 
of command, array of 
parameters and
signature, invoke 
command on MBean 
specified
invoke          
Invoke a command on 
the specified MBean
isRegistered_jmx
true if supplied 
ObjectName is registered
isRegistered    
true if supplied String 
version of ObjectName 
is registered
makeObjectName  
Return an ObjectName 
built with the given string
queryNames_jmx  
Given ObjectName and 
QueryExp, retrieves 
set of ObjectNames
that match.
queryNames      
Given String version of 
ObjectName, retrieves 
String of ObjectNames 
that match.
reconnect       
reconnects with server
setAttribute_jmx 
Given ObjectName and 
Attribute object, set 
attribute for MBean
specified
setAttribute    
Given String version 
of ObjectName, 
attribute name and
attribute value, set 
attribute for MBean 
specified
setAttributes_jmx
Given ObjectName and 
AttributeList object, 
set attributes for
the MBean specified
startServer     
Given the name of a 
server, start that server.
stopServer      
Given the name of a 
server, stop that server.
testConnection  
Test the connection 
to a DataSource object
trace           
Set the wsadmin trace 
specification
help Returns help text for the specific command of the AdminControl object. The command name is not case sensitive.
  • Parameters: command-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl help getAttribute 
Using Jython:
AdminControl.help('getAttribute')
Example output:
WASX7043I: command: getAttribute
Arguments: object name, attribute
Description: Returns value of 
"attribute" for the MBean 
described by "object name."
invoke Invokes the object operation without any parameter. Returns the result of the invocation.
  • Parameters: name- java.lang.String; operationName- java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
set objNameString [$AdminControl 
completeObjectName WebSphere:
type=Server,*] 
$AdminControl invoke 
$objNameString stop
Using Jython:
objNameString = AdminControl.
completeObjectName('WebSphere:
type=Server,*') 
AdminControl.invoke(objNameString, 
'stop')
invoke Invokes the object operation using the parameter list that you supply. The signature generates automatically. The types of parameters are supplied by examining the MBeanInfo that the MBean supplies. Returns the string result of the invocation. The string that is returned is controlled by the Mbean method that you invoked. If the Mbean method is synchronous, then control is returned back to the wsadmin tool only when the operation is complete. If the Mbean method is asynchronous, control is returned back to the wsadmin tool immediately even though the invoked task might not be complete.
  • Parameters: name-java.lang.String; operationName-java.lang.String; params-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
set objNameString [$AdminControl 
completeObjectName WebSphere:
type=Server,*] 
$AdminControl invoke 
$objNameString appendTraceString 
com.ibm.*=all=enabled 
Using Jython:
objNameString = AdminControl.
completeObjectName('WebSphere:
type=Server,*') 
AdminControl.invoke(objName
String, 'appendTraceString', 
'com.ibm.*=all=enabled')
invoke Invokes the object operation by conforming the parameter list to the signature. Returns the result of the invocation.
  • Parameters: name-java.lang.String; operationName-java.lang.String; params-java.lang.String; sigs-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
set objNameString [$AdminControl 
completeObjectName WebSphere:
type=Server,*] 
$AdminControl invoke 
$objNameString appendTraceString 
com.ibm.*=all=enabled 
java.lang.String
Using Jython:
objNameString = AdminControl.
completeObjectName('WebSphere:
type=Server,*') 
AdminControl.invoke
(objNameString, 'appendTrace
String', 'com.ibm.*=all=enabled',  
'java.lang.String')
invoke_jmx Invokes the object operation by conforming the parameter list to the signature. Returns the result of the invocation.
  • Parameters: name-ObjectName; operationName-java.lang.String; params- java.lang.Object[]; signature-java.lang.String[]
  • Returns: java.lang.Object
Example usage:
set objNameString [$AdminControl 
completeObjectName WebSphere:
type=TraceService,*] 
set objName [java::new javax.
management.ObjectName 
$objNameString] 
set parms [java::new {java.
lang.Object[]} 1 com.ibm.ejs.
sm.*=all=disabled] 
set signature [java::new 
{java.lang.String[]} 1 
java.lang.String] 
$AdminControl invoke_jmx 
$objName appendTraceString 
$parms $signature
Using Jython:
objNameString = AdminControl.
completeObjectName('WebSphere:
type=TraceService,*') 
import  javax.management  
as  mgmt 
objName =  mgmt.ObjectName
(objNameString) 
parms = ['com.ibm.ejs.sm.*=
all=disabled'] 
signature = ['java.lang.
String'] 
AdminControl.invoke_jmx
(objName, 'appendTraceString', 
parms, signature)
isRegistered If the ObjectName value is registered in the server, then the value is true.
  • Parameters: name-java.lang.String
  • Returns: Boolean

Example usage:

Using Jacl:
set objNameString [$AdminControl 
completeObjectName WebSphere:
type=Server,*] 
$AdminControl isRegistered 
$objNameString 
Using Jython:
objNameString = AdminControl.
completeObjectName('WebSphere:
type=Server,*') 
AdminControl.isRegistered
(objNameString)
isRegistered _jmx If the ObjectName value is registered in the server, then the value is true.
  • Parameters: name-ObjectName
  • Returns: Boolean

Example usage:

Using Jacl:
set objectNameString [$AdminControl 
completeObjectName type=Server,*]
set objName [$AdminControl 
makeObjectName $objNameString]
$AdminControl isRegistered_jmx 
$objName 
Using Jython:
objectNameString = AdminControl.
completeObjectName('type=Server,*')
objName = AdminControl.
makeObjectName(objectNameString)
AdminControl.isRegistered_jmx
(objName)
makeObject Name A convenience command that creates an ObjectName value that is based on the strings input. This command does not communicate with the server, so the ObjectName value that results might not exist. If the string you supply contains an extra set of double quotes, they are removed. If the string does not begin with a Java Management Extensions (JMX) domain, or a string followed by a colon, then the WebSphere Application Server string appends to the name.
  • Parameters: name-java.lang.String
  • Returns: javax.management. ObjectName

Example usage:

Using Jacl:
set objectNameString 
[$AdminControl complete
ObjectName type=Server,
node=mynode,*]
set objName [$AdminControl 
makeObjectName $objNameString]
Using Jython:
objectNameString = 
AdminControl.completeObjec
tName('type=Server,
node=mynode,*')
objName = AdminControl.
makeObjectName
(objectNameString)
queryNames Returns a string that lists all the ObjectName objects based on the name template.
  • Parameters: name-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl queryNames 
WebSphere:type=Server,* 
Using Jython:
AdminControl.queryNames
('WebSphere:type=Server,*')
Example output:
WebSphere:cell=Base
ApplicationServerCell,
name=server1,mbeanIdentifier=
server1,type=Server,node=
mynode,process=server1 
queryNames _jmx Returns a set of ObjectName objects that are based on the ObjectName object and the QueryExp query that you provide.
  • Parameters: name-javax.management. ObjectName;query-javax .management.QueryExp
  • Returns: java.util.Set

Example usage:

Using Jacl:
set objectNameString 
[$AdminControl complete
ObjectName type=Server,*]
set objName [$AdminControl 
makeObjectName $objNameString]
set null [java::null]
$AdminControl queryNames
_jmx $objName $null
Using Jython:
objectNameString = 
AdminControl.completeObject
Name('type=Server,*')
objName = AdminControl.make
ObjectName(objectNameString)
AdminControl.queryNames_
jmx(objName, None)
Example output:
[WebSphere:cell=Base
ApplicationServerCell,
name=server1,mbeanIdentifier=
server1,type=Server,node=
mynode,process=server1] 
reconnect Reconnects to the server, and clears information out of the local cache.
  • Parameters: None
  • Returns: None

Example usage:

Using Jacl:
$AdminControl reconnect 
Using Jython:
AdminControl.reconnect()
Example output:
WASX7074I: Reconnect of 
SOAP connector to host 
myhost completed.
setAttribute Sets the attribute value for the name that you provide.
  • Parameters: name-java.lang.String; attributeName-java.lang.String; attributeValue-java.lang.String
  • Returns: None

Example usage:

Using Jacl:
set objNameString [$AdminControl 
completeObjectName WebSphere:
type=TraceService,*] 
$AdminControl setAttribute 
$objNameString traceSpecification 
com.ibm.*=all=disabled 
Using Jython:
objNameString = AdminControl.
completeObjectName('WebSphere:
type=TraceService,*') 
AdminControl.setAttribute
(objNameString, 'trace
Specification',  'com.ibm.
*=all=disabled')
setAttribute _jmx Sets the attribute value for the name that you provide.
  • Parameters: name-ObjectName; attribute-javax. management. Attribute
  • Returns: None

Example usage:

Using Jacl:
set objectNameString 
[$AdminControl complete
ObjectName WebSphere:
type=TraceService,*] 
set objName [$AdminControl 
makeObjectName 
$objectNameString]
set attr [java::new javax.
management.Attribute 
traceSpecification com.ibm.
*=all=disabled] 
$AdminControl setAttribute_
jmx $objName $attr 
Using Jython:
objectNameString = AdminControl.
completeObjectName('WebSphere:
type=TraceService,*')
import  javax.management  
as  mgmt
objName = AdminControl.
makeObjectName(objectNameString)
attr = mgmt.Attribute
('traceSpecification', 
'com.ibm.*=all=disabled')
AdminControl.setAttribute_
jmx(objName, attr)
setAttributes Sets the attribute values for the names that you provide and returns a list of successfully set names.
  • Parameters using Jacl: name-String; attributes-java.lang.String
  • Parameters using Jython: name-String; attributes-java.lang.String or name-String; attributes-java.lang.Object[]
  • Returns: java.lang.String

Example usage:

Using Jacl:
set objNameString [$AdminControl 
completeObjectName WebSphere:
type=TracesService,*] 
$AdminControl setAttributes 
$objNameString {{trace
Specification com.ibm.ws.
*=all=enabled}} 
Using Jython with string attributes:
objNameString = AdminControl.
completeObjectName('WebSphere:
type=TracesService,*') 
AdminControl.setAttributes
(objNameString, '[[trace
Specification "com.ibm.ws.
*=all=enabled"]]')
Using Jython with object attributes:
objNameString = AdminControl.
completeObjectName('WebSphere:
type=TracesService,*') 
473 AdminControl.setAttributes
(objNameString, [['trace
Specification', 'com.ibm.ws.
*=all=enabled']])
setAttributes _jmx Sets the attribute values for the names that you provide and returns a list of successfully set names.
  • Parameters: name-ObjectName; attributes-javax.management. AttributeList
  • Returns: javax.management. AttributeList

Example usage:

Using Jacl:
set objectNameString 
[$AdminControl completeObject
Name WebSphere:type=
TraceService,*] 
set objName [$AdminControl 
makeObjectName 
$objectNameString] 
set attr [java::new javax.
management.Attribute 
traceSpecification com.
ibm.ws.*=all=enabled] 
set alist [java::new javax.
management.AttributeList] 
$alist add $attr 
$AdminControl setAttributes
_jmx $objName $alist
Using Jython:
objectNameString = 
AdminControl.completeObject
Name('WebSphere:type=
TraceService,*')
import  javax.management  
as  mgmt 
objName = AdminControl.
makeObjectName(object
NameString) 
attr = mgmt.Attribute
('traceSpecification', 
'com.ibm.ws.*=all=enabled') 
alist = mgmt.AttributeList() 
alist.add(attr)
AdminControl.setAttributes_
jmx(objName, alist)
startServer Starts the specified application server by locating it in the configuration. This command uses the default wait time. You can only use this command if the scripting client is connected to a node agent. This command returns a message to indicate if the server starts successfully.
  • Parameters: server name-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl startServer server1
Using Jython:
AdminControl.startServer
('server1')
startServer Starts the specified application server by locating it in the configuration. The start process waits the number of seconds specified by the wait time for the server to start. You can only use this command if the scripting client is connected to a node agent. This command returns a message to indicate if the server starts successfully.
  • Parameters: server name-java.lang.String, wait time-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl startServer 
server1 100
Using Jython:
AdminControl.startServer
('server1', 100)
startServer Starts the specified application server by locating it in the configuration. This command uses the default wait time. You can use this command when the scripting client is either connected to a node agent or to a deployment manager process. It returns a message to indicate if the server starts successfully.
  • Parameters: server name-java.lang.String, node name-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl startServer 
server1 myNode
Using Jython:
AdminControl.startServer
('server1', 'myNode')
startServer Starts the specified application server by locating it in the configuration. The start process waits the number of seconds specified by the wait time for the server to start. You can use this command when the scripting client is either connected to a node agent or to a deployment manager process. This command returns a message to indicate if the server starts successfully.
  • Parameters: server name-java.lang.String, node name-java.lang.String, wait time-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl startServer 
server1 myNode 100
Using Jython:
AdminControl.startServer
('server1', 'myNode', 100)
stopServer Stops the specified application server. The command returns a message to indicate if the server stops successfully.
  • Parameters: server name-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl stopServer 
server1
Using Jython:
AdminControl.stopServer
('server1')
stopServer Stops the specified application server. If you set the flag to immediate, the server stops immediately. Otherwise, a normal stop occurs. This command returns a message to indicate if the server stops successfully.
  • Parameters: server name-java.lang.String, immediate flag-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl stopServer 
server1 immediate
Using Jython:
AdminControl.stopServer
('server1', 'immediate')
stopServer Stops the specified application server. This command returns a message to indicate if the server stops successfully.
  • Parameters: server name-java.lang.String, node name-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl stopServer 
server1 myNode
Using Jython:
AdminControl.stopServer
('server1', 'my Node')
stopServer Stops the specified application server. If you set the flag to immediate, the server stops immediately. Otherwise, a normal stop occurs. This command returns a message to indicate if the server stops successfully.
  • Parameters: server name-java.lang.String, node name-java.lang.String, immediate flag-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
$AdminControl stopServer 
server1 myNode immediate
Using Jython:
AdminControl.stopServer
('server1', 'my Node', 
'immediate')
test Connection A convenience command communicates with the DataSource CfgHelper MBean to test a DataSource connection. This command works with the DataSource that resides in the configuration repository. If the DataSource to be tested is in the temporary workspace that holds the update to the repository, you have to save the update to the configuration repository before running this command. Use this command with the configuration ID that corresponds to the DataSource and the WAS40DataSource object types.
  • Parameters: configId-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
set ds [lindex [$AdminConfig list 
DataSource] 0] 
$AdminControl testConnection $ds
Using Jython:
# get line separator 
import java.lang.System as sys
lineSeparator = sys.getProperty
('line.separator')
ds = AdminConfig.list
('DataSource').split
(lineSeparator)[0]
AdminControl.testConnection(ds)
Example output:
WASX7217I: Connection to 
provided datasource was 
successful.
  The return value is a message that contains the message indicating a successful connection or a connection with warning. If the connection fails, an exception is created from the server indicating the error.    
test Connection Deprecated.

This command can give false results and does not work when connected to a node agent. As of V5.0.2, the preferred way to test a data source connection is with the test Connection command that passes in the DataSource configId parameter as the only parameter.

  • Parameters: configId-java.lang.String; props-java.lang.String
  • Returns: java.lang.String

Example usage:

Using Jacl:
set ds [lindex [$AdminConfig list 
DataSource] 0] 
$AdminControl testConnection $ds 
{{prop1 val1}}
Using Jython:
# get line separator 
import java.lang.System as sys
lineSeparator = sys.getProperty
('line.separator')
ds = AdminConfig.list
('DataSource').split
(lineSeparator)[0]
AdminControl.testConnection(ds, 
'[[prop1 val1]]')
Example output:
WASX7390E: Operation not 
supported - testConnection 
command with config id
and properties arguments is 
not supported. Use 
testConnection command with
config id argument only.
trace Sets the trace specification for the scripting process to the value that you specify.
  • Parameters: traceSpec-java.lang.String
  • Returns: None

Example usage:

Using Jacl:
$AdminControl trace com.
ibm.ws.scripting.
*=all=enabled
Using Jython:
AdminControl.trace('com.
ibm.ws.scripting.
*=all=enabled')



Related reference
AdminControl object for scripted administration

Reference topic    

Terms of Use | Feedback

Last updated: Jun 8, 2005 12:45:23 PM EDT
http://publib.boulder.ibm.com/infocenter/wasinfo/v6r0/index.jsp?topic=/com.ibm.websphere.express.doc/info/exp/ae/rxml_admincontrol.html

© Copyright IBM Corporation 2004, 2005. All Rights Reserved.
This information center is powered by Eclipse technology. (http://www.eclipse.org)