Commands for the AdminConfig object

Commands for the AdminConfig object

Use the AdminConfig object to invoke configuration commands and to create or change elements of the WebSphere Application Server configuration, for example, creating a data source.

We can start the scripting client without a running server, to use only local operations. To run in local mode, use the -conntype NONE option to start the scripting client. You receive a message that we are running in the local mode. If a server is running, do not run the AdminConfig tool in local mode. Configuration changes that are made in local mode are not reflected in the running server configuration. If we save a conflicting configuration, we might corrupt the configuration.

In a deployment manager environment, configuration updates are available only if a scripting client is connected to a deployment manager.

When connected to a node agent or a managed application server, we are not able to update the configuration because the configurations for these server processes are copies of the master configuration that resides in the deployment manager. The copies are created on a node machine when a configuration synchronization occurs between the deployment manager and the node agent. Make configuration changes to the server processes by connecting a scripting client to a deployment manager. For this reason, to change a configuration, do not run a scripting client in local mode on a node machine. It is not a supported configuration.

Use the Jython list or string syntax to pass parameters to a wsadmin command. If we have a parameter that includes a comma as a character, though, we need to use the Jython string syntax to pass the parameters.
To use the create command, for example, we might enter a command similar to:
params='[[name name1] [nameInNameSpace nameSpace_Name] [string_to_bind "value, withComma"]]'
AdminConfig.create(type, parent, params)

We can also use the modify command:
AdminConfig.modify(type, params)

attributes
checkin
convertToCluster
create
createClusterMember
createDocument
createUsingTemplate
defaults
deleteDocument
existsDocument
extract
getCrossDocumentValidationEnabled
getid
getObjectName
getObjectType
getSaveMode
getValidationLevel
getValidationSeverityResult
hasChanges
help
installResourceAdapter
list
listTemplates
modify
parents
queryChanges
remove
required
reset
resetAttributes
save
setCrossDocumentValidationEnabled
setSaveMode
setValidationLevel
show
showall
showAttribute
types
uninstallResourceAdapter
unsetAttributes
validate

attributes

Return a list of the top level attributes for a given type.

Target object: None.
Required parameters:

object type

Name of the object type based on the XML configuration files. The object type does not have to be the same name that the administrative console displays.

Optional parameters: None.
Sample output
"properties Property*" "serverSecurity ServerSecurity" 
"server Server@" "id Long" "stateManagement StateManageable" 
"name String" "moduleVisibility EEnumLiteral(MODULE, 
COMPATIBILITY, SERVER, APPLICATION)" "services Service*" 
"statisticsProvider StatisticsProvider" 
Examples
Use Jacl:
$AdminConfig attributes ApplicationServer
Use Jython:
print AdminConfig.attributes('ApplicationServer')
checkin

Check a file into the configuration repository that is described by the document Uniform Resource Identifier (URI). This method applies to deployment manager configurations only.

Target object: None.
Required parameters:

URI

The document URI is relative to the root of the configuration repository, for example:

app_server_root\config
(iSeries) /WebSphere/AppServer/config
\WebSphere\AppServer\config

file name

Name of the source file to check in.

opaque object

Specifies an object that the extract command of the AdminConfig object returns by a prior call.

Optional parameters: None.
Sample output
"properties Property*" "serverSecurity ServerSecurity" 
"server Server@" "id Long" "stateManagement StateManageable" 
"name String" "moduleVisibility EEnumLiteral(MODULE, 
COMPATIBILITY, SERVER, APPLICATION)" "services Service*" 
"statisticsProvider StatisticsProvider" 
Examples
Use Jacl:
(AIX) (HPUX) (iSeries) (Linux) (Solaris)
$AdminConfig checkin cells/MyCell/Node/MyNode/serverindex.xml /mydir/myfile $obj
(Windows)
$AdminConfig checkin cells/MyCell/Node/MyNode/serverindex.xml c:\\mydir\myfile $obj
(ZOS)
$AdminConfig checkin cells/MyCell/Node/MyNode/serverindex.xml \mydir\myfile $obj
Use Jython:
(AIX) (HPUX) (iSeries) (Linux) (Solaris)
print AdminConfig.checkin('cells/MyCell/Node/MyNode/serverindex.xml', '/mydir/myfile',  obj)
(Windows)
print AdminConfig.checkin('cells/MyCell/Node/MyNode/serverindex.xml', 'c:\mydir\myfile',  obj)
(ZOS)
print AdminConfig.checkin('cells/MyCell/Node/MyNode/serverindex.xml', '\mydir\myfile',  obj)
convertToCluster

Convert a server so that it is the first member of a new server cluster.

Target object: None.
Required parameters:

server ID

The configuration ID of the server of interest.

cluster name

Name of the cluster of interest.

Optional parameters: None.
Sample output
myCluster(cells/mycell/clusters/myCluster|cluster.xml#ClusterMember_2)
Examples
Use Jacl:
set serverid [$AdminConfig getid /Server:myServer/]
$AdminConfig convertToCluster $serverid myCluster
Use Jython:
serverid = AdminConfig.getid('/Server:myServer/')
print AdminConfig.convertToCluster(serverid, 'myCluster')
create

Create configuration objects.

Target object: None.
Required parameters:

type

Name of the object type based on the XML configuration files. This parameter value does not have to be the same name that the administrative console displays.

parent ID

Configuration ID of the parent object.

attributes

Specifies any attributes to add to the configuration ID.

Optional parameters: None.
Sample output

This command returns a string of the configuration object name, as this sample output shows:
ds1(cells/mycell/nodes/DefaultNode/servers/server1|resources.xml#DataSource_6)
Examples

Use Jacl:
set jdbc1 [$AdminConfig getid /JDBCProvider:jdbc1/] $AdminConfig create DataSource $jdbc1 {{name ds1}}

Use Jython string attributes:
jdbc1 = AdminConfig.getid('/JDBCProvider:jdbc1/') print AdminConfig.create('DataSource', jdbc1, '[[name ds1]]')

Use Jython with object attributes:
jdbc1 = AdminConfig.getid('/JDBCProvider:jdbc1/') print AdminConfig.create('DataSource', jdbc1, [['name', 'ds1']])

Create a port:

serverName = 'server1'
node = AdminConfig.getid('/Node:smtitan24Node03')
serverEntries = AdminConfig.list('ServerEntry', node).split(java.lang.System.getProperty('line.separator'))

for serverEntry in serverEntries:
sName = AdminConfig.showAttribute(serverEntry, "serverName")

if sName == serverName:

id = AdminConfig.create('NamedEndPoint', serverEntry, '[[endPointName "OVERLAY_TEST"]]')
start = id.find('#')
end = id.find(')',start)
str = id[start:end]
server = id[0:start]

AdminConfig.create('EndPoint', server+str+')', '[[port "8888"] [host "*"]]')
AdminConfig.save()
#AdminConfig.reset()

createClusterMember

Create a new server object on the node that the node id parameter specifies. This server is created as a new member of the existing cluster specified by the cluster id parameter, and contains attributes specified in the member attributes parameter. The server is created using the server template specified by the template id attribute, and containing the name specified by the memberName attribute. The memberName attribute is required. The template options are available only for the first cluster member that we create. All cluster members that we create after the first member are identical.

Target object: None.
Required parameters:

cluster ID

Configuration ID of the cluster of interest.

node ID

Configuration ID of the node of interest.

template ID

Template ID to use to create the server.

member attributes

Specifies any attributes to add to the cluster member. The memberName attribute is required, and defines the name of the cluster member to create.

Optional parameters: None.
Sample output

This command returns the configuration ID of the newly created cluster member:
myCluster(cells/mycell/clusters/myCluster|cluster.xml#ClusterMember_2)
Examples
Use Jacl:
set clid [$AdminConfig getid /ServerCluster:myCluster/]
set nodeid [$AdminConfig getid /Node:mynode/]
$AdminConfig createClusterMember $clid $nodeid {{memberName newMem1} {weight 5}}
Use Jython string attributes:
clid = AdminConfig.getid('/ServerCluster:myCluster/') 
nodeid = AdminConfig.getid('/Node:mynode/')
print AdminConfig.createClusterMember(clid, nodeid, '[[memberName newMem1] [weight 5]]')
Use Jython with object attributes:
clid = AdminConfig.getid('/ServerCluster:myCluster/') 
nodeid = AdminConfig.getid('/Node:mynode/') 
print AdminConfig.createClusterMember(clid, nodeid, [['memberName', 'newMem1'], ['weight', 5]])
createDocument

Create a new document in the configuration repository.

Target object: None.
Required parameters:

document URI

Name of the document to create in the repository.

file name

Specifies a valid local file name of the document to create.

Optional parameters: None.
Examples
Use Jacl:
(AIX) (HPUX) (iSeries) (Linux) (Solaris)
$AdminConfig createDocument cells/mycell/myfile.xml /mydir/myfile
(Windows)
$AdminConfig createDocument cells/mycell/myfile.xml c:/mydir/myfile
(ZOS)
$AdminConfig createDocument cells/mycell/myfile.xml /mydir/myfile
Use Jython with string attributes:
(Dist)
AdminConfig.createDocument('cells/mycell/myfile.xml', 'c:/mydir/myfile')
(iSeries)
AdminConfig.createDocument('cells/mycell/myfile.xml', '/mydir/myfile')
(ZOS)
AdminConfig.createDocument('cells/mycell/myfile.xml', '/mydir/myfile')
createUsingTemplate

Create a type of object with the given parent, using a template. Use this command only for creation of a server with APPLICATION_SERVER type. To create a server with a type other than APPLICATION_SERVER, use the createGenericServer or the createWebServer command.

Target object: None.
Required parameters:

type

Type of object to create.

parent

Configuration ID of the parent.

template

Configuration ID of an existing object. This object can be a template object returned using the listTemplates command, or any other existing object of the correct type.

Optional parameters:

attributes

Specifies attribute values for the object. The attributes specified using this parameter override the settings in the template.

Sample output

The command returns the configuration ID of the new object:
myCluster(cells/mycell/clusters/myCluster|cluster.xml#ClusterMember_2)
Examples
Use Jacl:
set node [$AdminConfig getid /Node:mynode/]
set templ [$AdminConfig listTemplates JDBCProvider "DB2 JDBC Provider (XA)"]
$AdminConfig createUsingTemplate JDBCProvider $node {{name newdriver}} $templ 
Use Jython with string attributes:
node = AdminConfig.getid('/Node:mynode/')
templ = AdminConfig.listTemplates('JDBCProvider', "DB2 JDBC Provider (XA)")
print AdminConfig.createUsingTemplate('JDBCProvider', node, '[[name newdriver]]', templ)
Use Jython with object attributes:
node = AdminConfig.getid('/Node:mynode/')
templ = AdminConfig.listTemplates('JDBCProvider', "DB2 JDBC Provider (XA)")
print AdminConfig.createUsingTemplate('JDBCProvider', node, [['name', 'newdriver']], templ)
defaults

Display the default values for attributes of a given type. This method displays all of the possible attributes contained by an object of a specific type. If the attribute has a default value, this method also displays the type and default value for each attribute.

Target object: None.
Required parameters:

type

Type of object to return. The name of the object type specified is based on the XML configuration files. This name does not have to be the same name that the administrative console displays.

Optional parameters: None.
Sample output

The command returns string containing a list of attributes with its type and value:
Attribute               Type        Default

usingMultiRowSchema     Boolean  false
maxInMemorySessionCount Integer  1000
allowOverflow           Boolean  true scheduleInvalidation    Boolean  false
writeFrequency          ENUM
writeInterval           Integer  120
writeContents           ENUM
invalidationTimeout     Integer  30
invalidationSchedule    InvalidationSchedule
Examples
Use Jacl:
$AdminConfig defaults TuningParams
Use Jython:
print AdminConfig.defaults('TuningParams')
deleteDocument

Delete a document from the configuration repository.

Target object: None.
Required parameters:

documentURI

Document to delete from the repository.

Optional parameters: None.
Examples
Use Jacl:
$AdminConfig deleteDocument cells/mycell/myfile.xml
Use Jython:
AdminConfig.deleteDocument('cells/mycell/myfile.xml')
existsDocument

Test for the existence of a document in the configuration repository.

Target object: None.
Required parameters:

documentURI

Document to test for in the repository.

Optional parameters: None.
Sample output

The command returns a true value if the document exists:
1
Examples
Use Jacl:
$AdminConfig existsDocument cells/mycell/myfile.xml
Use Jython:
print AdminConfig.existsDocument('cells/mycell/myfile.xml')
extract

Extract a configuration repository file that is described by the document URI and places it in the file named by filename. This method applies to deployment manager configurations only.

Target object: None.
Required parameters:

documentURI

Document to extract from the configuration repository. The document URI must exist in the repository. The document URI is relative to the root of the configuration repository, for example:

(AIX) (HPUX) (iSeries) (Linux) (Solaris) (ZOS) /WebSphere/AppServer/config
(Windows) app_server_root\config

filename

Filename to extract the document to. The filename must be a valid local filename where the contents of the document are written. If the file specified by the filename parameter exists, the extracted file replaces it.

Optional parameters: None.
Sample output

The command returns an opaque "digest" object that should be used to check the file back in using the checkin command.

Examples
Use Jacl:
(AIX) (HPUX) (iSeries) (Linux) (Solaris)
set obj [$AdminConfig extract cells/MyCell/nodes/MyNode/serverindex.xml /mydir/myfile] 
(Windows)
set obj [$AdminConfig extract cells/MyCell/nodes/MyNode/serverindex.xml c:\\mydir\myfile] 
(ZOS)
set obj [$AdminConfig extract cells/MyCell/nodes/MyNode/serverindex.xml \mydir\myfile] 
Use Jython:
(AIX) (HPUX) (iSeries) (Linux) (Solaris)
obj = AdminConfig.extract('cells/MyCell/nodes/MyNode/serverindex.xml','/mydir/myfile')
(Windows)
obj = AdminConfig.extract('cells/MyCell/nodes/MyNode/serverindex.xml','c:\mydir\myfile')
(ZOS)
obj = AdminConfig.extract('cells/MyCell/nodes/MyNode/serverindex.xml','\mydir\myfile')
getCrossDocumentValidationEnabled

Return a message with the current cross-document enablement setting. This method returns true if cross-document validation is enabled.

Target object: None.
Required parameters: None.

Optional parameters: None.

Sample output

The command returns string containing the message with the cross-document validation setting, as the following example displays:
WASX7188I: Cross-document validation enablement set to true 
Examples
Use Jacl:
$AdminConfig getCrossDocumentValidationEnabled
Use Jython:
print AdminConfig.getCrossDocumentValidationEnabled()
getid

Return the configuration ID of an object.

Target object: None.
Required parameters:

containment path

Containment path of interest.

Optional parameters: None.

Sample output

The command returns configuration ID for an object that is described by the containment path:
Db2JdbcDriver(cells/testcell/nodes/testnode|resources.xml#JDBCProvider_1)
Examples
Use Jacl:
$AdminConfig getid /Cell:testcell/Node:testNode/JDBCProvider:Db2JdbcDriver/
Use Jython:
print AdminConfig.getid('/Cell:testcell/Node:testNode/JDBCProvider:Db2JdbcDriver/')
getObjectName

Return a string version of the object name for the corresponding running MBean. This method returns an empty string if no corresponding running MBean exists.

Target object: None.
Required parameters:

configuration ID

Configuration ID of the object name to return.

Optional parameters: None.

Sample output

The command returns a string containing the object name:
WebSphere:cell=mycell,name=server1,mbeanIdentifier=cells/mycell/nodes/mynode/servers/server1/
server.xml#Server_1,type=Server,node=mynode,process=server1,processType=UnManagedProcess
Examples
Use Jacl:
set server [$AdminConfig getid /Node:mynode/Server:server1/]
$AdminConfig getObjectName $server
Use Jython:
server = AdminConfig.getid('/Node:mynode/Server:server1/')
print AdminConfig.getObjectName(server)
getObjectType

Display the object type for the object configuration ID of interest.

Target object: None.
Required parameters:

configuration ID

Configuration ID of the object name to return.

Optional parameters: None.

Examples
Use Jacl:
set server [$AdminConfig getid /Node:mynode/Server:server1/]
$AdminConfig getObjectType $server
Use Jython:
server = AdminConfig.getid('/Node:mynode/Server:server1/')
print AdminConfig.getObjectType(server)
getSaveMode

Return the mode used when you invoke a save command. The command returns one of the following possible values:

overwriteOnConflict - Saves changes even if they conflict with other configuration changes
rollbackOnConflict - Fails a save operation if changes conflict with other configuration changes. This value is the default.

Target object: None.
Required parameters: None.

Optional parameters: None.

Sample output

The command returns a string containing the current save mode setting:
rollbackOnConflict
Examples
Use Jacl:
$AdminConfig getSaveMode
Use Jython:
print AdminConfig.getSaveMode()
getValidationLevel

Return the validation used when files are extracted from the repository.

Target object: None.
Required parameters: None.

Optional parameters: None.

Sample output

The command returns a string containing the validation level:
WASX7189I: Validation level set to HIGH
Examples
Use Jacl:
$AdminConfig getValidationLevel
Use Jython:
print AdminConfig.getValidationLevel()
getValidationSeverityResult

Return the number of validation messages with the given severity from the most recent validation.
Target object: None.
Required parameters:

severity

Specifies which severity level for which to return the number of validation messages. Specify an integer value 0 - 9.

Optional parameters: None.

Sample output

The command returns a string that indicates the number of validation messages of the given severity:
16
Examples
Use Jacl:
$AdminConfig getValidationSeverityResult 1
Use Jython:
print AdminConfig.getValidationSeverityResult(1)
hasChanges

Determine whether unsaved configuration changes exist.

Target object: None.
Required parameters: None.

Optional parameters: None.

Sample output

The command returns 1 if unsaved configuration changes exist or 0 if unsaved configuration changes do not exist, as the following example displays:
1
Examples
Use Jacl:
$AdminConfig hasChanges
Use Jython:
print AdminConfig.hasChanges()
help

Display static help information for the AdminConfig object.

Target object: None.
Required parameters: None.

Optional parameters: None.

Sample output

The command returns a list of options for the help command:
WASX7053I: The AdminConfig object communicates with the configuration service in a product to manipulate 
configuration data for an Application Server installation.  The AdminConfig object has commands to list, 
create, remove, display, and modify configuration data, as well as commands to display information about 
configuration data types.

ost of the commands supported by the AdminConfig object operate in two modes: the default mode is one in which 
the AdminConfig object communicates with the Application Server to accomplish its tasks. A local mode is also 
possible, in which no server communication takes place.  The local mode of operation is invoked by bringing up 
the scripting client without a server connected using the command line "-conntype NONE" option or setting the 
"com.ibm.ws.scripting.connectionType=NONE" property in the wsadmin.properties file.

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

attributes                                        Shows the attributes for a given type
checkin                                           Checks a file into the configuration repository.
convertToCluster                                  Converts a server to be the first member of a new server cluster
create                                            Creates a configuration object, given a type, a parent, and a list of attributes, and 
                                                  optionally an attribute name for the new object createClusterMember                             
                                                  Creates a new server that is a member of an existing cluster.
createDocument                                    Creates a new document in the configuration repository.
installResourceAdapter                            Installs a J2C resource adapter with the given RAR file name and an option string in the node.
createUsingTemplate                               Creates an object using a particular template type.
defaults                                          Display the default values for the attributes of a given type.
deleteDocument                                    Deletes a document from the configuration repository.
existsDocument                                    Tests for the existence of a document in the configuration repository.
extract                                           Extracts a file from the configuration repository.
getCrossDocumentValidationEnabled                 Returns true if cross-document validation is enabled.
getid                                             Show the configuration ID of an object, given a string version of its containment
getObjectName                                     Given a configuration ID, returns a string version of the ObjectName 
                                                  for the corresponding running MBean, if any.
getSaveMode                                       Return the mode used when "save" is invoked
getValidationLevel                                Return the validation used when files are extracted from the repository.
getValidationSeverityResult                       Return the number of messages of a given severity from the most recent validation.
hasChanges                                        Returns true if unsaved configuration changes exist
help                                              Shows help information
list                                              Lists all the configuration objects of a given type
listTemplates                                     Lists all the available configuration templates of a given type.
modify                                            Changes the specified attributes of a given configuration object parents
                                                  Shows the objects which contain a given type
queryChanges                                      Returns a list of unsaved files
remove                                            Removes the specified configuration object required                                            
                                                  Display the required attributes of a given type.
reset                                            Discards the unsaved configuration changes
save                                             Commits the unsaved changes to the configuration repository
setCrossDocumentValidationEnabled                Sets the cross-document validation enabled mode.
setSaveMode                                      Changes the mode used when "save" is invoked
setValidationLevel                               Sets the validation used when files are extracted from the repository.
show                                             Shows the attributes of a given configuration object showall 
                                                 Recursively shows the attributes of a given configuration                                                     
                                                 object, and all the objects contained within each attribute.
showAttribute                                    Displays only the value for the single attribute specified.
types                                            Shows the possible types for configuration validate Invokes validation
Examples
Use Jacl:
$AdminConfig help
Use Jython:
print AdminConfig.help()
installResourceAdapter

Install a Java 2 Connector (J2C) resource adapter with the given Resource Adapter Archive (RAR) file name and an option string in the node. When we edit the installed application with the embedded RAR, existing J2C connection factory, J2C activation specs, and J2C administrative objects only are edited. No new J2C objects are created.

Target object: None.
Required parameters:

node

Node of interest.

RAR file name

Fully qualified file name of the RAR file that resides in the node specified.

Optional parameters:
options
Specifies more options for installing a resource adapter. The valid options include the following options:

rar.name
rar.desc
rar.archivePath
rar.classpath
rar.nativePath
rar.threadPoolAlias
rar.propertiesSet
The rar.name option is the name for the J2C resource adapter. If we do not specify this option, the display name in the RAR deployment descriptor is used. If that name is not specified, the RAR file name is used. The rar.desc option is a description of the J2CResourceAdapter.
The rar.archivePath is the name of the path where you extract the file. If we do not specify this option, the archive is extracted to the $\{CONNECTOR_INSTALL_ROOT\} directory. The rar.classpath option is the additional class path.

rar.propertiesSet is constructed with the following:
name String
value String
type String
*desc String
*required true/false 
* means the item is optional 
Each attribute of the property are specified in a set of {}. A property is specified in a set of {}. We can specify multiple properties in {}.
Sample output

The command returns the configuration ID of the new J2CResourceAdapter object:
myResourceAdapter(cells/mycell/nodes/mynode|resources.xml#J2CResourceAdapter_1)
Examples
Use Jacl:
(AIX) (HPUX) (iSeries) (Linux) (Solaris) (ZOS)
$AdminConfig installResourceAdapter /rar/mine.rar mynode{-rar.name myResourceAdapter 
-rar.desc "My rar file"} 
(Windows)
$AdminConfig installResourceAdapter c:/rar/mine.rar mynode {-rar.name myResourceAdapter 
-rar.desc "My rar file"}
Use Jython:
(AIX) (HPUX) (iSeries) (Linux) (Solaris) (ZOS)
print AdminConfig.installResourceAdapter('/rar/mine.rar', 'mynode', '[-rar.name myResourceAdapter 
-rar.desc "My rar file"]')
(Windows)
print AdminConfig.installResourceAdapter('c:/rar/mine.rar', 'mynode', '[-rar.name myResourceAdapter 
-rar.desc "My rar file"]') 
To add a String
resourceProperties (name=myName,value=myVal)
into the resource adapter configuration,s:
pSet = [['propertySet',[['resourceProperties',[[['name','myName'], ['type', 'String'], 
['value','myVal']]]]]]]
(AIX) (HPUX) (iSeries) (Linux) (Solaris) (ZOS)
myRA =AdminConfig.installResourceAdapter('/query.rar','mynodeCellManager05',
['-rar.desc','mydesc'])
(Windows)
myRA =AdminConfig.installResourceAdapter('c:\query.rar','mynodeCellManager05',
['-rar.desc','mydesc'])
AdminConfig.modify(myRA,pSet)
list

Return a list of objects of a given type, or narrow down the search query by giving a type and a scoped parent, or giving a type and a wildcard character (*) or Java regular expression (.*) pattern in the command syntax to customize the search query.

Target object: None.
Required parameters:

object type

Name of the object type. The name of the object type is based on the XML configuration files and does not have to be the same name that the administrative console displays.

Optional parameters:

scope

Specifies additional search query information using a scoped parent.

pattern

Specifies additional search query information using wildcard character (*) or Java regular expressions pattern (.*).

Sample output

The command returns a list of objects:
Db2JdbcDriver(cells/mycell/nodes/DefaultNode|resources.xml#JDBCProvider_1) 
Db2JdbcDriver(cells/mycell/nodes/DefaultNode/servers/deploymentmgr|resources.xml#JDBCProvider_1) 
Db2JdbcDriver(cells/mycell/nodes/DefaultNode/servers/nodeAgent|resources.xml#JDBCProvider_1) 
Examples

The following examples list each JDBC provider configuration object:
Use Jacl:
$AdminConfig list JDBCProvider
Use Jython:
print AdminConfig.list('JDBCProvider')
Use single or double quotes.
The following examples list each JDBC provider configuration object by giving an object type and a wildcard pattern that begin with the derby string:
Use Jacl:
$AdminConfig list JDBCProvider derby*
Use Jython:
print AdminConfig.list('JDBCProvider', 'derby*')
Use regular Java expression patterns and wildcard patterns to specify command name for $AdminConfig list, types, and listTemplates functions.

The following examples list the server configuration objects by giving an object type and a Java expression pattern that begin with the server1 string::
Use Jacl:
$AdminConfig list Server server1.*
Use Jython:
print AdminConfig.list("Server", "server1.*")
The following examples list the server configuration objects by giving an object type and a parent scope configuration id:
Use Jacl:
$AdminConfig list Server myNode(cells/myCell/nodes/myNode|node.xml#Node_1)
Use Jython:
print AdminConfig.list("Server", "myNode(cells/myCell/nodes/myNode|node.xml#Node_1)")
The following examples list each find configuration object of that starts with SSLConfig:
Use Jacl and regular Java expression patterns:
$AdminConfig types SSLConfig.*
Use Jacl and wildcard patterns:
$AdminConfig types SSLConfig*
Use Jython and regular Java expression patterns:
print AdminConfig.types("SSLConfig.*")
Use Jython and wildcard patterns:
print AdminConfig.types("SSLConfig*")
listTemplates

Display a list of template object IDs. Use wildcard characters (*) or Java regular expressions (.*) in the command syntax to customize the search query.

Target object: None.
Required parameters:

object type

Name of the object type. The name of the object type is based on the XML configuration files and does not have to be the same name that the administrative console displays.

pattern

Specifies more search query information using wildcard characters or Java regular expressions.

Optional parameters: None.
Sample output

The example displays a list of all the JDBCProvider templates available on the system:
"Derby JDBC Provider (XA)(templates/servertypes/APPLICATION_SERVER/servers/DeveloperServer|resources.xml#builtin_jdbcprovider)"
"Derby JDBC Provider (XA)(templates/servertypes/APPLICATION_SERVER/servers/defaultZOS|resources.xml#builtin_jdbcprovider)"
"Derby JDBC Provider (XA)(templates/servertypes/APPLICATION_SERVER/servers/default|resources.xml#builtin_jdbcprovider)"
"Derby JDBC Provider (XA)(templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)"
"Derby JDBC Provider 40 (XA)(templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_2)"
"Derby JDBC Provider 40 Only (XA)(templates/system|jdbc-resource-provider-only-templates.xml#JDBCProvider_derby_2)"
"Derby JDBC Provider 40 Only(templates/system|jdbc-resource-provider-only-templates.xml#JDBCProvider_derby_1)"
"Derby JDBC Provider 40(templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_1)"
"Derby JDBC Provider Only (XA)(templates/system|jdbc-resource-provider-only-templates.xml#JDBCProvider_derby_4)"
"Derby JDBC Provider Only(templates/system|jdbc-resource-provider-only-templates.xml#JDBCProvider_derby_3)"
"Derby JDBC Provider(templates/servertypes/APPLICATION_SERVER/servers/DeveloperServer|resources.xml#JDBCProvider_1124467079638)"
"Derby JDBC Provider(templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_derby_3)" 
Examples

The following examples return each JDBC provider template:
Use Jacl:
$AdminConfig listTemplates JDBCProvider
Use Jython:
print AdminConfig.listTemplates('JDBCProvider')
The following examples return each JDBC provider template that begins with the sybase string:
Use Jacl:
$AdminConfig listTemplates JDBCProvider sybase*
Use Jython:
print AdminConfig.listTemplates('JDBCProvider', 'sybase*')
modify

Support the modification of object attributes.

Target object: None.
Required parameters:

configuration ID

Configuration ID of the object to modify.

attributes

Attributes to modify for the configuration ID of interest.

Optional parameters: None.
Examples
Use Jacl:
$AdminConfig modify ConnFactory1(cells/mycell/nodes/DefaultNode/servers/deploymentmgr|resources.xml#
GenericJMSConnectionFactory_1) {{userID newID} {password newPW}}
Use Jython with string attributes:
AdminConfig.modify('ConnFactory1(cells/mycell/nodes/DefaultNode/servers/deploymentmgr|resources.xml#
GenericJMSConnectionFactory_1)', '[[userID newID] [password newPW]]')
Use Jython with object attributes:
AdminConfig.modify('ConnFactory1(cells/mycell/nodes/DefaultNode/servers/deploymentmgr|resources.xml#
GenericJMSConnectionFactory_1)', [['userID', 'newID'], ['password', 'newPW']])
parents

Obtain information about object types.
Target object: None.
Required parameters:

object type

Object type of interest. The name of the object type is based on the XML configuration files and does not have to be the same name that the administrative console displays.

Optional parameters: None.
Sample output

The example displays a list of object types:
Cell
Node
Server 
Examples
Use Jacl:
$AdminConfig parents JDBCProvider
Use Jython:
print AdminConfig.parents('JDBCProvider')
queryChanges

Return a list of unsaved configuration files.

Target object: None.
Required parameters: None.
Optional parameters: None.
Sample output

The example displays a string containing a list of files with unsaved changes:
WASX7146I: The following configuration files contain unsaved changes:
cells/mycell/nodes/mynode/servers/server1|resources.xml
Examples
Use Jacl:
$AdminConfig queryChanges
Use Jython:
print AdminConfig.queryChanges()
remove

Remove a configuration object.
Target object: None.
Required parameters:

configuration ID

Configuration object of interest.

Optional parameters: None.
Examples
Use Jacl:
set ds [$AdminConfig list DataSource "Default Datasource*"]
$AdminConfig remove $ds
Use Jython:
ds = AdminConfig.list('DataSource', 'Default Datasource*')
AdminConfig.remove(ds)
required

Display the required attributes contained by an object of a certain type.

Target object: None.
Required parameters:

type

Object type for which to display the required attributes. The name of the object type is based on the XML configuration files. It does not have to be the same name that the administrative console displays.

Optional parameters: None.
Sample output

The example displays a string containing a list of the required attributes with its type:
Attribute                       Type
streamHandlerClassName          String
protocol                        String
Examples
Use Jacl:
$AdminConfig required URLProvider
Use Jython:
print AdminConfig.required('URLProvider')
reset

Reset the temporary workspace that holds updates to the configuration.

Target object: None.
Required parameters: None.
Optional parameters: None.
Examples
Use Jacl:
$AdminConfig reset
Use Jython:
AdminConfig.reset()
resetAttributes

Reset specific attributes for the configuration object of interest.

Target object: None.
Required parameters:

configuration ID

Configuration ID of the configuration object of interest.

attributes

Attribute to reset and the value to which the attribute is reset.

Optional parameters: None.
Examples
Use Jacl:
set ds [$AdminConfig list DataSource "Default Datasource*"]
$AdminConfig resetAttributes $ds {{"description" "A new description for the data source"}}
Use Jython:
ds = AdminConfig.list('DataSource', 'Default Datasource*')
AdminConfig.resetAttributes(ds, [["description", "A new description for the data source"]])
save

Save changes to the configuration repository.

Target object: None.
Required parameters: None.
Optional parameters: None.
Sample output

The save command does not return output.

Examples
Use Jacl:
$AdminConfig save
Use Jython:
AdminConfig.save()
setCrossDocumentValidationEnabled

Set the cross-document validation enabled mode. Values include true or false.

Target object: None.
Required parameters:

flag

Specifies whether cross-document validation is enabled or disabled. Specify true to enable or false to disable cross-document validation.

Optional parameters: None.
Sample output

The command returns a status statement for cross-document validation:
WASX7188I: Cross-document validation enablement set to true 
Examples
Use Jacl:
$AdminConfig setCrossDocumentValidationEnabled true 
Use Jython:
print AdminConfig.setCrossDocumentValidationEnabled('true')
setSaveMode

Modify the behavior of the save command.

Target object: None.
Required parameters:

save mode

Save mode to use. The default is rollbackOnConflict. When the system discovers a conflict while saving, the unsaved changes are not committed. The alternative value is overwriteOnConflict, which saves the changes to the configuration repository even if conflicts exist. To use overwriteOnConflict as the value of this command, the deployment manager must be enabled for configuration overwrite.

Optional parameters: None.
Sample output

The setSaveMode command does not return output.

Examples
Use Jacl:
$AdminConfig setSaveMode overwriteOnConflict
Use Jython:
AdminConfig.setSaveMode('overwriteOnConflict')
setValidationLevel

Set the validation used when files are extracted from the repository.

Target object: None.
Required parameters:

level

Validation to use. Five validation levels are available: none, low, medium, high, or highest.

Optional parameters: None.
Sample output

The command returns a string containing the validation level setting:
WASX7189I: Validation level set to HIGH
Examples
Use Jacl:
$AdminConfig setValidationLevel high
Use Jython:
print AdminConfig.setValidationLevel('high')
show

Return the top-level attributes of the given object.

Target object: None.
Required parameters:

configuration ID

Configuration ID of the object of interest.

Optional parameters: None.
Sample output

The command returns a string containing the attribute value:
[name "Sample Datasource"] [description "Data source for the Sample entity beans"]
Examples
Use Jacl:
$AdminConfig show Db2JdbcDriver(cells/mycell/nodes/DefaultNode|resources.xmlJDBCProvider_1)
Use Jython:
print AdminConfig.show('Db2JdbcDriver(cells/mycell/nodes/DefaultNode|resources.xmlJDBCProvider_1)')
showall

Recursively show the attributes of a given configuration object.

Target object: None.
Required parameters:

configuration ID

Configuration ID of the object of interest.

Optional parameters: None.
Sample output

The command returns a string containing the attribute value, as the following examples show:

Use Jacl:
tcpNoDelay: null
SoTimeout: 0
bytesRead: 6669
{authMechanismPreference BASIC_PASSWORD}
{connectionPool {{agedTimeout 0}
{connectionTimeout 180}
{freePoolDistributionTableSize 0}
{maxConnections 10}
{minConnections 1}
{numberOfFreePoolPartitions 0}
{numberOfSharedPoolPartitions 0}
{numberOfUnsharedPoolPartitions 0}
{properties {}}
{purgePolicy EntirePool}
{reapTime 180}
{stuckThreshold 0}
{stuckTime 0}
{stuckTimerTime 0}
{surgeCreationInterval 0}
{surgeThreshold -1}
{testConnection false}
{testConnectionInterval 0}
{unusedTimeout 1800}}}
{datasourceHelperClassname com.ibm.websphere.rsadapter.DerbyDataStoreHelper}
{description "Datasource for the WebSphere Default Application"}
{diagnoseConnectionUsage false}
{jndiName DefaultDatasource}
{logMissingTransactionContext true}
{manageCachedHandles false}
{name "Default Datasource"}
{properties {}}
{propertySet {{resourceProperties {{{name databaseName}
{required false}
{type java.lang.String}
{value ${APP_INSTALL_ROOT}/${CELL}/DefaultApplication.ear/DefaultDB}} {{name shu
tdownDatabase}
{required false}
{type java.lang.String}
{value {}}} {{name dataSourceName}
{required false}
{type java.lang.String}
{value {}}} {{name description}
{required false}
{type java.lang.String}
{value {}}} {{name connectionAttributes}
{required false}
{type java.lang.String}
{value upgrade=true}} {{name createDatabase}
{required false}
{type java.lang.String}
{value {}}}}}}}
{provider "Derby JDBC Provider(cells/isthmusCell04/nodes/isthmusNode14/servers/s
erver1|resources.xml#JDBCProvider_1183122153343)"}
{providerType "Derby JDBC Provider"}
{relationalResourceAdapter "WebSphere Relational Resource Adapter(cells/isthmusC
ell04/nodes/isthmusNode14/servers/server1|resources.xml#builtin_rra)"}
{statementCacheSize 10}
Use Jython:
[datasourceHelperClassname com.ibm.websphere.rsadapter.DerbyDataStoreHelper]
[description "Datasource for the WebSphere Default Application"]
[jndiName DefaultDatasource]
[name "Default Datasource"]
[propertySet [[resourceProperties [[[description "Location of Apache Derby default database."]
[name databaseName]
[type string]
[value ${WAS_INSTALL_ROOT}/bin/DefaultDB]] [[name remoteDataSourceProtocol]
[type string]
[value []]] [[name shutdownDatabase]
[type string]
[value []]] [[name dataSourceName]
[type string]
[value []]] [[name description]
[type string]
[value []]] [[name connectionAttributes]
[type string]
[value []]] [[name createDatabase]
[type string]
[value []]]]]]]
[provider "Apache Derby JDBC Driver(cells/pongo/nodes/pongo/servers/server1|resources.xml#JDBCProvider_1)"]
[relationalResourceAdapter "WebSphere Relational Resource Adapter(cells/pongo/nodes/pongo/servers/server1|
resources.xml#builtin_rra)"]
[statementCacheSize 0]
We might have to convert the Jython output from a string to a list for further processing.
Examples
Use Jacl:
$AdminConfig showall "Default Datasource(cells/mycell/nodes/DefaultNode/servers/server1:resources.xml#DataSource_1)"
Use Jython:
print AdminConfig.showall
  ("Default Datasource(cells/mycell/nodes/DefaultNode/servers/server1:resources.xml#DataSource_1)")
showAttribute

Display only the value for the single attribute specified.

Target object: None.
Required parameters:

configuration ID

Configuration ID of the object of interest.

attribute

Attribute to query.

Optional parameters: None.
Sample output

The output of this command is different from the output of the show command when a single attribute is specified. The showAttribute command does not display a list containing the attribute name and value. It displays only the attribute value, as the following example displays:
mynode
Examples
Use Jacl:
set ns [$AdminConfig getid /Node:mynode/]
$AdminConfig showAttribute $ns hostName
Use Jython:
ns = AdminConfig.getid('/Node:mynode/')
print AdminConfig.showAttribute(ns, 'hostName')
Before v7.0.0.5, the Jython scripting language does not recognize special characters. In addition, when the comma and single space characters occur between attribute parameters, these characters are treated as eliminators and ignored when the attribute value is saved. For example, we might have the following set of Jython commands:
value='{"param1","param2"}'
serverId=AdminConfig.getid('/Cell:cell/Node:node/Server:server')
nameSpace=AdminConfig.create('StringNameSpaceBinding',serverId,[['name','TestName'],
['nameInSpace','TestNameSpace'],['stringToBind',value] ])
To print the value:
print AdminConfig.showAttribute(nameSpace, 'stringToBind')
that results in the following output:
{"param1" "param2"}
In Version 7.0.0.5 and later, the Jython scripting language recognizes the comma if you precede it with a backslash character (\). For example, in the original example set of Jython commands, change the first line to the following command:
value='{"param1"\,"param2"}'
When we print the value, the following output returns:
{"param1","param2"}
types

Return a list of the configuration object types that we can manipulate or customize the search query by giving an additional wildcard characters (*) or Java regular expressions (.*) pattern in the command syntax.

Target object: None.
Required parameters: None.
Optional parameters:

pattern

Specifies additional search query information using wildcard character (*) or Java regular expressions pattern (.*).

Sample output

The command returns a list of object types, as the following example displays:
AdminService
Agent
ApplicationConfig
ApplicationDeployment
ApplicationServer
AuthMechanism
AuthenticationTarget
AuthorizationConfig
AuthorizationProvider
AuthorizationTableImpl
BackupCluster
CMPConnectionFactory
CORBAObjectNameSpaceBinding
Cell
CellManager
Classloader
ClusterMember
ClusteredTarget
CommonSecureInteropComponent
Examples

The following examples return each object type in the configuration:
Use Jacl:
$AdminConfig types
Use Jython:
print AdminConfig.types()
The following examples return each object type in the configuration containing an additional security string pattern:
Use Jacl:
$AdminConfig types *security*
Use Jython:
print AdminConfig.types('*security*')
uninstallResourceAdapter

Uninstall a Java 2 Connector (J2C) resource adapter with the given J2C resource adapter configuration ID and an option list. When we remove a J2CResourceAdapter object from the configuration repository, the installed directory is removed at the time of synchronization. A stop request is sent to the J2CResourceAdapter MBean that was removed.

Target object: None.
Required parameters:

configuration ID

Configuration ID of the resource adapter to remove.

Optional parameters:

options list

Uninstall options for command. The valid option is force. This option forces the uninstallation of the resource adapter without checking whether the resource adapter is being used by an application. The application that is using it is not uninstalled. If we do not specify the force option and the specified resource adapter is still in use, the resource adapter is not uninstalled.

Sample output

The command returns the configuration ID of the J2C resource adapter that is removed:
WASX7397I: The following J2CResourceAdapter objects are removed: 
yJ2CRA(cells/juniarti/nodes/juniarti|resources.xml#J2CResourceAdapter_1069433028609)
Examples
Use Jacl:
set j2cra [$AdminConfig getid /J2CResourceAdapter:MyJ2CRA/]
$AdminConfig uninstallResourceAdapter $j2cra {-force}
Use Jython:
j2cra = AdminConfig.getid('/J2CResourceAdapter:MyJ2CRA/')
print AdminConfig.uninstallResourceAdapter(j2cra, '[-force]')
unsetAttributes

Reset specific attributes for a configuration object to the default values.

Target object: None.
Required parameters:

configuration ID

Configuration ID of the configuration object of interest.

attributes

Attributes to reset to the default values.

Optional parameters: None.
Examples
Use Jacl:
set cluster [$AdminConfig getid /ServerCluster:myCluster]
$AdminConfig unsetAttributes $cluster {"enableHA", "preferLocal"}
Use Jython:
cluster = AdminConfig.getid("/ServerCluster:myCluster")
AdminConfig.unsetAttributes(cluster, ["enableHA", "preferLocal"])
validate

Request the configuration validation results based on the files in your workspace, the value of the cross-document validation enabled flag, and the validation level setting. Optionally, we can specify a configuration ID to set the scope. If we specify a configuration ID, the scope of this request is the object named by the configuration ID parameter.

Target object: None.
Required parameters: None.
Optional parameters:

configuration ID

Configuration ID of the object of interest.

Sample output

The command returns a string containing the results of the validation, as the following example displays:
WASX7193I: Validation results are logged in c:\WebSphere5\AppServer\logs\wsadmin.valout: Total number of messages: 16
WASX7194I: Number of messages of severity 1: 16
Examples
Use Jacl:
$AdminConfig validate
Use Jython:
print AdminConfig.validate()
wsadmin AdminConfig