Commands for the AdminControl object using wsadmin scripting

Use the AdminControl object to invoke operational commands that manage objects for the 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.

Avoid trouble Avoid trouble: When using the commands available in the AdminControl object in large topologies, query and search with process=dmgr and type=Cluster. This method of searching is more efficient, less time consuming, and avoids searching all nodes.gotcha
The following commands are available for the AdminControl object:

completeObjectName

Use the completeObjectName command to create 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 the system finds several MBeans that match the fragment, the command returns the first one.

Target object

None.

Required parameters

object name
Specifies the name of the object to complete. (ObjectName)
template
Specifies the name of the template to use. For example, the template might be type=Server,*. (java.lang.String)

Optional parameters

None.

Sample output

The command does not return output.

Examples

getAttribute

Use the getAttribute command to return the value of the attribute for the name that you provide.

If you use the getAttribute command to determine the state of an application, one of the following values is returned:
  • 0 - which indicates that the application is starting
  • 1 - which indicates that the application has started
  • 2 - which indicates that the application is stopping
  • 3 - which indicates that the application has stopped
  • 4 - which indicates that the application failed to start

Target object

None.

Required parameters

object name
Specifies the object name of the MBean of interest. (ObjectName)
attribute
Specifies the name of the attribute to query. (java.lang.String)

Optional parameters

None.

Sample output

The command returns a string that contains the value of the attribute that you query, as the following example displays:
'DeploymentManager'

Examples

getAttribute_jmx

Use the getAttribute_jmx command to return the value of the attribute for the name that you provide.

Target object

None.

Required parameters

object name
Specifies the object name of the MBean of interest. (ObjectName)
attribute
Specifies the name of the attribute to query. (java.lang.String)

Optional parameters

None.

Sample output

The command returns a string that contains the value of the attribute that you query, as the following example displays:
'DeploymentManager'

Examples

getAttributes

Use the getAttributes command to return the attribute values for the names that you provide.

Target object

None.

Required parameters

object name
Specifies the object name of the MBean of interest. (ObjectName)
attribute
Specifies the names of the attributes to query. (java.lang.String[] or java.lang.Object[])

Optional parameters

None.

Sample output

The command returns a string that contains the value of the attribute that you query, as the following example displays:
'[ [cellName myCell01] [nodeName myCellManager01] ]'

Examples

getAttributes_jmx

Use the getAttributes_jmx command to return the attribute values for the names that you provide.

Target object

None.

Required parameters

object name
Specifies the object name of the MBean of interest. (ObjectName)
attribute
Specifies the names of the attributes to query. (java.lang.String[] or java.lang.Object[])

Optional parameters

None.

Sample output

The command returns an attribute list.

Examples

getCell

Use the getCell command to return the name of the connected cell.

Target object

None.

Required parameters

None.

Optional parameters

None.

Sample output

The command returns the cell name that you query, as the following example displays:
Mycell

Examples

getConfigId

Use the getConfigId command to create a configuration ID from an ObjectName or an ObjectName fragment. Each MBean does not have corresponding configuration objects. If several MBeans correspond to an ObjectName fragment, a warning is created and a configuration ID builds for the first MBean that the system finds.

Target object

None.

Required parameters

object name
Specifies the name of the object of interest. The object name string can be a wildcard, specified with an asterisk character (*).

Optional parameters

None.

Sample output

The command returns a string that contains the configuration ID of interest.

Examples

getDefaultDomain

Use the getDefaultDomain command to return the default domain name from the server.

Target object

None.

Required parameters

None.

Optional parameters

None.

Sample output

The command returns a string that contains the default domain name of interest, as the following example displays:
WebSphere

Examples

getDomainName

Use the getDomainName command to return the domain name from the server.

Target object

None.

Required parameters

None.

Optional parameters

None.

Sample output

The command returns a string that contains the domain name of interest, as the following example displays:
WebSphere

Examples

getHost

Use the getHost command to return the name of your host.

Target object

None.

Required parameters

None.

Optional parameters

None.

Sample output

The command returns a string that contains the name of the host of interest, as the following example displays:
myHost

Examples

getMBeanCount

Use the getMBeanCount command to return the number of MBeans that are registered in the server.

Target object

None.

Required parameters

None.

Optional parameters

None.

Sample output

The command returns an integer value that contains the number of MBeans that are registered in the server, as the following example displays:
151

Examples

getMBeanInfo_jmx

Use the getMBeanInfo_jmx command to return 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_jmx command.

Target object

None.

Required parameters

object name
Specifies the object name of the MBean of interest. (ObjectName)

Optional parameters

None.

Sample output

The command returns a javax.management.MBeanInfo object, as the following example displays:
javax.management.modelmbean.ModelMBeanInfoSupport@10dd5f35

Examples

getNode

Use the getNode command to return the name of the connected node.

Target object

None.

Required parameters

None.

Optional parameters

None.

Sample output

The command returns a string containing the name of the node, as the following example displays:
myNode01

Examples

getObjectInstance

Use the getObjectInstance command to return the object instance that matches the input object name.

Target object

None.

Required parameters

object name
Specifies the name of the object of interest. (ObjectName)

Optional parameters

None.

Sample output

The command returns the object instance that matches the input object name, as the following example displays:
javax.management.modelmbean.RequiredModelMBean

Examples

getPort

Use the getPort command to return the name of the port used for the scripting connection.

Target object

None.

Required parameters

None.

Optional parameters

None.

Sample output

The command returns the port number of the port that the system uses to establish the scripting connection, as the following example displays:
8877

Examples

getPropertiesForDataSource (Deprecated)

The getPropertiesForDataSource command is deprecated, and no replacement exists. This command incorrectly assumes the availability of a configuration service when running in connected mode.

Target object

None.

Required parameters

None.

Optional parameters

None.

Sample output

The command returns the following message:
WASX7389E: Operation not supported - getPropertiesForDataSource command is not supported.

Examples

getType

Use the getType command to return the connection type used for the scripting connection.

Target object

None.

Required parameters

None.

Optional parameters

None.

Sample output

The command returns a string that contains the connection type for the scripting connection, as the following example displays:
SOAP

Examples

help

Use the help command to return general help text for the AdminControl object.

Target object

None.

Required parameters

None.

Optional parameters

command
Specifies the command for which to return help information. The command name is not case-sensitive.

Sample output

The command returns a string that details specific options for the help command, as the following example displays:
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 atemplate name
getAttribute_jmx			Given ObjectName and name of attribute, returns value ofattribute
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  help									Show help information
invoke_jmx      			Given ObjectName, name of command, array of parameters andsignature, 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 serversetAttribute_jmx Given ObjectName and Attribute object, set attribute for 
										MBean specified
setAttribute    			Given String version of ObjectName, attribute name andattribute 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
If you specify a specific command with the help command, the wsadmin tool returns detailed help about the command, as the following example displays:
WASX7043I: command: getAttribute
Arguments: object name, attribute
Description: Returns value of "attribute" for the MBean described by "object name."

Examples

invoke

Use the invoke command to invoke a specific MBean operation based on the number of parameters that operation requires. If this constraint is not sufficient to select a unique operation, use invoke_jmx. The supplied parameters are converted to the object types required by the selected operation's signature before the operation is invoked. Any returned value is converted to its string representation.

Target object

None.

Required parameters

object name
Specifies the object name of the MBean of interest.
operation
Specifies the operation to invoke.

Optional parameters

arguments
Specifies the arguments required for the operation. If no arguments are required for the operation of interest, you can omit the arguments parameter.

The arguments parameter is a single string. Each individual argument in the string can contain spaces.

Sample output

The command returns a string that shows the result of the invocation.

Examples

invoke_jmx

Use the invoke_jmx command to invoke the object operation by conforming the parameter list to the signature. The command returns the result of the invocation.

Target object

None.

Required parameters

object name
Specifies the object name of the MBean of interest. (ObjectName)
operation
Specifies the operation to invoke. (java.lang.String)

Optional parameters

arguments
Specifies the arguments required for the operation. If no arguments are required for the operation of interest, you can omit the arguments parameter. (java.lang.String[] or java.lang.Object[])

Sample output

The command returns a string that shows the result of the invocation.

Examples

isRegistered

Use the isRegistered command to determine if a specific object name is registered.

Target object

None.

Required parameters

object name
Specifies the object name of interest. (java.lang.String)

Optional parameters

None.

Sample output

The command returns a boolean value for the object of interest. If the ObjectName value is registered in the server, then the value is 1, as the following example displays:
wsadmin>s = AdminControl.queryNames( 'type=Server,*' ).splitlines()[ 0 ]
wsadmin>AdminControl.isRegistered( s )
1
wsadmin>

If the ObjectName value is not registered in the server, then the value is 0.

Examples

isRegistered_jmx

Use the isRegistered_jmx command to determine if a specific object name is registered.

Target object

None.

Required parameters

object name
Specifies the object name of interest. (java.lang.String)

Optional parameters

None.

Sample output

The command returns a boolean value for the object of interest. If the ObjectName value is registered in the server, then the value is true, as the following example displays:
true

Examples

makeObjectName

Use the makeObjectName command to create 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.

Target object

None.

Required parameters

object name
Specifies the object name of interest. (java.lang.String)

Optional parameters

None.

Sample output

The command returns an Objectname object constructed from the object name string.

Examples

queryMBeans

Use the queryMBeans command to query for a list of object instances that match the object name that you provide.

Target object

None.

Required parameters

object name
Specifies the object name of interest. (ObjectName)

Optional parameters

query
Specifies the query expression. (QueryExp)

Sample output

The command returns a list of object instances for the object name specified, as the following example displays:
WebSphere:name=PlantsByWebSphere,process=server1,platform=dynamicproxy,node=Goodog,
J2EEName=PlantsByWebSphere,Server=server1,version=6.1.0.0,type=Application,
mbeanIdentifier=cells/GooddogNode02Cell/applications/PlantsByWebSphere.ear/
deployments/PlantsByWebSphere/deployment.xml#ApplicationDeployment_1126623343902,
cell=GooddogNode02Cell

Examples

queryNames

Use the queryNames command to query for a list of each of the ObjectName objects based on the name template.

Target object

None.

Required parameters

object name
Specifies the object name of interest. You can specify a wildcard for the object name parameter with the asterisk character (*). (java.lang.String)

Optional parameters

None.

Sample output

The command returns a string that contains the ObjectNames that match the input object name, as the following example displays:
WebSphere:cell=BaseApplicationServerCell,
name=server1,mbeanIdentifier=server1,
type=Server,node=mynode,process=server1 

Examples

queryNames_jmx

Use the queryNames_jmx command to query for a list of each of the ObjectName objects based on the name template and the query conditions that you specify.

Target object

None.

Required parameters

object name
Specifies the object name of interest. You can specify a wildcard for the object name parameter with the asterisk character (*). (ObjectName)
query
Specifies the query expression to use. (javax.management.QueryExp)

Optional parameters

None.

Sample output

The command returns a string that contains the ObjectNames that match the input object name, as the following example displays:
[WebSphere:cell=BaseApplicationServerCell,name=server1,mbeanIdentifier=
server1,type=Server,node=mynode,process=server1] 

Examples

reconnect

Use the reconnect command to reconnect to the server, and to clear information out of the local cache.

Target object

None.

Required parameters

None.

Optional parameters

None.

Sample output

The command returns a message that displays the status of the operation, as the following example displays:
WASX7074I: Reconnect of SOAP connector to host myhost completed.

Examples

setAttribute

Use the setAttribute command to set the attribute value for the name that you provide.

Target object

None.

Required parameters

object name
Specifies the object name of the MBean of interest. (java.lang.String)
attribute name
Specifies the name of the attribute to set. (java.lang.String)
attribute value
Specifies the value of the attribute of interest. (java.lang.String)

Optional parameters

None.

Sample output

The command returns does not return output.

Examples

setAttribute_jmx

Use the setAttribute_jmx command to set the attribute value for the name that you provide.

Target object

None.

Required parameters

object name
Specifies the object name of the MBean of interest. (ObjectName)
attribute
Specifies the name of the attribute to set. (Attribute)

Optional parameters

None.

Sample output

The command returns does not return output.

Examples

setAttributes

Use the setAttributes command to set the attribute values for the object names that you provide.

Target object

None.

Required parameters

object name
Specifies the object name of the MBean of interest. (String)
attributes
Specifies the names of the attributes to set. (java.lang.String[] or java.lang.Object[])

Optional parameters

None.

Sample output

The command returns a list of object names that are successfully set by the command invocation, as the following example displays:
'[traceSpecification com.ibm.ws.*=all=enabled]'

Examples

setAttributes_jmx

Use the setAttributes_jmx command to set the attribute values for the object names that you provide.

Target object

None.

Required parameters

object name
Specifies the object name of the MBean of interest. (String)
attributes
Specifies the names of the attributes to set. (javax.management.AttributeList)

Optional parameters

None.

Sample output

The command returns an attribute list of object names that are successfully set by the command invocation, as the following example displays:
'[traceSpecification com.ibm.ws.*=all=enabled]'

Examples

testConnection

Use the testConnection command to test a data source connection. This command works with the data source that resides in the configuration repository. If the data source to be tested is in the temporary workspace that holds the update to the repository, you must save the update to the configuration repository before running this command. Use this command with the configuration ID that corresponds to the data source and the WAS40DataSource object types.

Target object

None.

Required parameters

configuration ID
Specifies the configuration ID of the data source object of interest. (java.lang.String)

Optional parameters

None.

Sample output

The command returns a message that indicates a successful connection or a connection with a warning. If the connection fails, an exception is created from the server indicating the error. For example:
WASX7217I: Connection to provided datasource was successful.

Examples

  • 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]
    print AdminControl.testConnection(ds)

trace

Use the trace command to set the trace specification for the scripting process to the value that you specify.

Target object

None.

Required parameters

trace specification
Specifies the trace to enable for the scripting process. (java.lang.String)

Optional parameters

None.

Sample output

The command does not return output.

Examples

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

Terms and conditions for information centers | Feedback

Last updatedLast updated: Jan 16, 2013 3:37:33 AM CST
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=v700osgijpa&product=was-nd-mp&topic=rxml_admincontrol
File name: rxml_admincontrol.html