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.

You can start the scripting client without a running server, if you only want to use local operations. To run in local mode, use the -conntype NONE option to start the scripting client. You receive a message that you are running in the local mode. If a server is currently running, running the AdminConfig tool in local mode is not recommended. This is because any configuration changes made in local mode will not be reflected in the running server configuration and vice versa. If you save a conflicting configuration, you could 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, you will not be able to update the configuration because the configuration for these server processes are copies of the master configuration which 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. The following commands are available for the AdminConfig object:

• attributes

• checkin

• convertToCluster

• create

• createClusterMember

• createDocument

• createUsingTemplate

• defaults

• deleteDocument

• existsDocument

• extract

• getCrossDocumentValidationEnabled

• getid

• getObjectName

• getSaveMode

• getValidationLevel

• getValidationSeverityResult

• hasChanges

• help

• installResourceAdapter

• list

• listTemplates

• modify

• parents

• queryChanges

• remove

• required

• reset

• save

• setCrossDocumentValidationEnabled

• setSaveMode

• setValidationLevel

• show

• showall

• showAttribute

• types

• uninstallResourceAdapter

• validate

attributes

Use the attributes command to return a list of the top level attributes for a given type.

Target object None.

Required parameters

object type

Specifies the name of the object type that is 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

• Using Jacl:

  $AdminConfig attributes ApplicationServer

• Using Jython:

  print AdminConfig.attributes('ApplicationServer')

checkin

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

Target object None.

Required parameters

URI

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

.

file name

Specifies the 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

• Using Jacl:

• Using Jython:

convertToCluster

Use the convertToCluster command to 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

Specifies the name of the cluster of interest.

Optional parameters None.

Sample output

myCluster(cells/mycell/clusters/myCluster|cluster.xml#ClusterMember_2)

Examples

• Using Jacl:

  set serverid [$AdminConfig getid /Server:myServer/]
  $AdminConfig convertToCluster $serverid myCluster

• Using Jython:

  serverid = AdminConfig.getid('/Server:myServer/')
  print AdminConfig.convertToCluster(serverid, 'myCluster')

create

Use the create command to create configuration objects.

Target object None.

Required parameters

type

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

parent ID

Specifies the 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 displays:

ds1(cells/mycell/nodes/DefaultNode/servers/server1|resources.xml#DataSource_6)

Examples

• Using Jacl:

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

• Using Jython string attributes:

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

• Using Jython with object attributes:

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

createClusterMember

Use the createClusterMember command to 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 that is specified by the cluster id parameter, and contains attributes that are specified in the member attributes parameter. The server is created using the server template that is specified by the template id attribute, and that contains the name specified by the memberName attribute. The memberName attribute is required. The template options are available only for the first cluster member that you create. All cluster members that you create after the first member will be identical.

Target object None.

Required parameters

cluster ID

Specifies the configuration ID of the cluster of interest.

node ID

Specifies the configuration ID of the node of interest.

template ID

Timeemplate 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, as the following example displays:

myCluster(cells/mycell/clusters/myCluster|cluster.xml#ClusterMember_2)

Examples

• Using Jacl:

  set clid [$AdminConfig getid /ServerCluster:myCluster/]
  set nodeid [$AdminConfig getid /Node:mynode/]
  $AdminConfig createClusterMember $clid $nodeid {{memberName newMem1} {weight 5}}

• Using Jython string attributes:

  clid = AdminConfig.getid('/ServerCluster:myCluster/') 
  nodeid = AdminConfig.getid('/Node:mynode/')
  print AdminConfig.createClusterMember(clid, nodeid, '[[memberName newMem1] [weight 5]]')

• Using Jython with object attributes:

  clid = AdminConfig.getid('/ServerCluster:myCluster/') 
  nodeid = AdminConfig.getid('/Node:mynode/') 
  print AdminConfig.createClusterMember(clid, nodeid, [['memberName', 'newMem1'], ['weight', 5]])

createDocument

Use the createDocument command to create a new document in the configuration repository.

Target object None.

Required parameters

file name

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

document URI

Specifies the name of the document to create in the repository.

Optional parameters None.

Examples

• Using Jacl:

• Using Jython with string attributes:

createUsingTemplate

Use the createUsingTemplate command to create a type of object with the given parent, using a template. You can only use this command for creation of a server with APPLICATION_SERVER type. If you want to create a server with a type other than APPLICATION_SERVER, use the createGenericServer or the createWebServer command.

Target object None.

Required parameters

type

Timeype of object to create.

parent

Specifies the configuration ID of the parent.

template

Specifies a configuration ID of an existing object. This object can be a template object returned by 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, as the following example displays:

myCluster(cells/mycell/clusters/myCluster|cluster.xml#ClusterMember_2)

Examples

• Using Jacl:

  set node [$AdminConfig getid /Node:mynode/]
  set templ [$AdminConfig listTemplates JDBCProvider "DB2 JDBC Provider (XA)"]
  $AdminConfig createUsingTemplate JDBCProvider $node {{name newdriver}} $templ 
  

• Using 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)

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

Use the defaults command to 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

Timeype of object to return. The name of the object type that you specify 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 that contains a list of attributes with its type and value, as the following example displays:

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

• Using Jacl:

  $AdminConfig defaults TuningParams

• Using Jython:

  print AdminConfig.defaults('TuningParams')

deleteDocument

Use the deleteDocument command to delete a document from the configuration repository.

Target object None.

Required parameters

documentURI

Specifies the document to delete from the repository.

Optional parameters None.

Examples

• Using Jacl:

  $AdminConfig deleteDocument cells/mycell/myfile.xml

• Using Jython:

  AdminConfig.deleteDocument('cells/mycell/myfile.xml')

existsDocument

Use the existsDocument command to test for the existence of a document in the configuration repository.

Target object None.

Required parameters

documentURI

Specifies the document to test for in the repository.

Optional parameters None.

Sample output The command returns a true value if the document exists, as the following example displays:

1

Examples

• Using Jacl:

  $AdminConfig existsDocument cells/mycell/myfile.xml

• Using Jython:

  print AdminConfig.existsDocument('cells/mycell/myfile.xml')

extract

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

Target object None.

Required parameters

documentURI

Specifies the 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...

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 that is specified by the filename parameter exists, the extracted file replaces it.

Optional parameters None.

Sample output

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

Examples

• Using Jacl:

• Using Jython:

getCrossDocumentValidationEnabled

Use the getCrossDocumentValidationEnabled command to 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 that contains the message with the cross-document validation setting, as the following example displays:

WASX7188I: Cross-document validation enablement set to true

Examples

• Using Jacl:

  $AdminConfig getCrossDocumentValidationEnabled

• Using Jython:

  print AdminConfig.getCrossDocumentValidationEnabled()

getid

Use the getid command to return the configuration ID of an object.

Target object None.

Required parameters

containment path

Specifies the containment path of interest.

Optional parameters

None.

Sample output The command returns configuration ID for an object that is described by the containment path, as the following example displays:

Db2JdbcDriver(cells/testcell/nodes/testnode|resources.xml#JDBCProvider_1)

Examples

• Using Jacl:

  $AdminConfig getid /Cell:testcell/Node:testNode/JDBCProvider:Db2JdbcDriver/

• Using Jython:

  print AdminConfig.getid('/Cell:testcell/Node:testNode/JDBCProvider:Db2JdbcDriver/')

getObjectName

Use the getObjectName command to 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

Specifies the configuration ID of the object name to return.

Optional parameters

None.

Sample output The command returns a string that contains the object name, as the following example displays:

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

• Using Jacl:

  set server [$AdminConfig getid /Node:mynode/Server:server1/]
  $AdminConfig getObjectName $server

• Using Jython:

  server = AdminConfig.getid('/Node:mynode/Server:server1/')
  print AdminConfig.getObjectName(server)

getSaveMode

• 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 that contains the current save mode setting, as the following example displays:

rollbackOnConflict

Examples

• Using Jacl:

  $AdminConfig getSaveMode

• Using Jython:

  print AdminConfig.getSaveMode()

getValidationLevel

Use the getValidationLevel command to 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 that contains the validation level, as the following example displays:

WASX7189I: Validation level set to HIGH

Examples

• Using Jacl:

  $AdminConfig getValidationLevel

• Using Jython:

  print AdminConfig.getValidationLevel()

getValidationSeverityResult

Use the getValidationSeverityResult command to 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 between 0 and 9.

Optional parameters

None.

Sample output The command returns a string that indicates the number of validation messages of the given severity, as the following example displays:

16

Examples

• Using Jacl:

  $AdminConfig getValidationSeverityResult 1

• Using Jython:

  print AdminConfig.getValidationSeverityResult(1)

hasChanges

Use the hasChanges command to determine if 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

• Using Jacl:

  $AdminConfig hasChanges

• Using Jython:

  print AdminConfig.hasChanges()

help

Use the help command to 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, as the following example displays:

WASX7053I: The AdminConfig object communicates with the configuration service in a WebSphere Application Server 
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.

Most 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 by 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                 Displays 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              Returns the mode used when "save" is invoked
getValidationLevel        Returns the validation that is used when files are extracted from the repository.
getValidationSeverityResult    Returns 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                 Displays 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 that are contained within each attribute.
showAttribute            Displays only the value for the single attribute that is specified.
types                    Shows the possible types for configuration
validate                 Invokes validation

Examples

• Using Jacl:

  $AdminConfig help

• Using Jython:

  print AdminConfig.help()

installResourceAdapter

Use the installResourceAdapter command to 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 you edit the installed application with the embedded RAR, only existing J2C connection factory, J2C activation specs, and J2C administrative objects will be edited. No new J2C objects will be created.

Target object None.

Required parameters

node

Specifies the node of interest.

RAR file name

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

Optional parameters

options

Specifies additional 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 you 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 you 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 {}. You 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

• Using Jacl:

• Using Jython:

list

Use the list command to return a list of objects of a given type, possibly scoped by a parent.

Target object None.

Required parameters

object type

Specifies the 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

None.

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

• Using Jacl:

  $AdminConfig list JDBCProvider

• Using Jython:

  print AdminConfig.list('JDBCProvider')

listTemplates

Use the listTemplates command to display a list of template object IDs.

Target object None.

Required parameters

object type

Specifies the 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 None.

Sample output The example displays a list of all the JDBCProvider templates that are available on the system:

"Cloudscape JDBC Provider (XA)(templates/servertypes/APPLICATION_SERVER/servers/
defaultZOS_60X|resources.xml#builtin_jdbcprovider)"
"Cloudscape JDBC Provider (XA)(templates/servertypes/APPLICATION_SERVER/servers/
default_60X|resources.xml#builtin_jdbcprovider)"
"Cloudscape JDBC Provider (XA)(templates/servertypes/PROXY_SERVER/servers/proxy_
server_60X|resources.xml#builtin_jdbcprovider)"
"Cloudscape JDBC Provider (XA)(templates/servertypes/PROXY_SERVER/servers/proxy_
server_zos_60X|resources.xml#builtin_jdbcprovider)"
"Cloudscape JDBC Provider (XA)(templates/system|jdbc-resource-provider-templates
.xml#JDBCProvider_db2j_4)"
"Cloudscape JDBC Provider Only (XA)(templates/system|jdbc-resource-provider-only
-templates.xml#JDBCProvider_db2j_4)"
"Cloudscape JDBC Provider Only(templates/system|jdbc-resource-provider-only-temp
lates.xml#JDBCProvider_db2j_3)"
"Cloudscape JDBC Provider(templates/servertypes/APPLICATION_SERVER/servers/defau
ltZOS_5X|resources.xml#JDBCProvider_1)"
"Cloudscape JDBC Provider(templates/servertypes/APPLICATION_SERVER/servers/defau
lt_5X|resources.xml#JDBCProvider_1)"
"Cloudscape JDBC Provider(templates/system|jdbc-resource-provider-templates.xml#J
DBCProvider_db2j_3)"
"Cloudscape Network Server Using Universal JDBC Driver Provider Only(templates/s
ystem|jdbc-resource-provider-only-templates.xml#JDBCProvider_db2jN_1)"
"Cloudscape Network Server Using Universal JDBC Driver(templates/system|jdbc-res
ource-provider-templates.xml#JDBCProvider_db2jN_1)"
"DB2 Legacy CLI-based Type 2 JDBC Driver (XA)(templates/system|jdbc-resource-pro
vider-templates.xml#JDBCProvider_4)"

Examples

• Using Jacl:

  $AdminConfig listTemplates JDBCProvider

• Using Jython:

  print AdminConfig.listTemplates('JDBCProvider')

modify

Use the modify command to support the modification of object attributes.

Target object None.

Required parameters

configuration ID

Specifies the configuration ID of the object to modify.

attributes

Specifies the attributes to modify for the configuration ID of interest.

Optional parameters None.

Examples

• Using Jacl:

  $AdminConfig modify ConnFactory1(cells/mycell/nodes/DefaultNode/servers/deploymentmgr|resources.xml#
  GenericJMSConnectionFactory_1) {{userID newID} {password newPW}}

• Using Jython with string attributes:

  AdminConfig.modify('ConnFactory1(cells/mycell/nodes/DefaultNode/servers/deploymentmgr|resources.xml#
  GenericJMSConnectionFactory_1)', '[[userID newID] [password newPW]]')
  

• Using Jython with object attributes:

  AdminConfig.modify('ConnFactory1(cells/mycell/nodes/DefaultNode/servers/deploymentmgr|resources.xml#
  GenericJMSConnectionFactory_1)', [['userID', 'newID'], ['password', 'newPW']])

parents

Use the parents command to obtain information about object types.

Target object None.

Required parameters

object type

Specifies the 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

• Using Jacl:

  $AdminConfig parents JDBCProvider

• Using Jython:

  print AdminConfig.parents('JDBCProvider')

queryChanges

Use the queryChanges command to return a list of unsaved configuration files.

Target object None.

Required parameters None.

Optional parameters None.

Sample output The example displays a string that contains a list of files with unsaved changes:

WASX7146I: The following configuration files contain unsaved changes:
cells/mycell/nodes/mynode/servers/server1|resources.xml

Examples

• Using Jacl:

  $AdminConfig queryChanges

• Using Jython:

  print AdminConfig.queryChanges()

remove

Use the remove command to remove a configuration object.

Target object None.

Required parameters

configuration ID

Specifies the configuration object of interest.

Optional parameters None.

Examples

• Using Jacl:

  $AdminConfig remove ds1(cells/mycell/nodes/DefaultNode/servers/server1:resources.xml#DataSource_6)

• Using Jython:

  AdminConfig.remove('ds1(cells/mycell/nodes/DefaultNode/servers/server1:resources.xml#DataSource_6)')

required

Use the required command to display the required attributes that are contained by an object of a certain type.

Target object None.

Required parameters

type

Specifies the 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 that contains a list of the required attributes with its type:

Attribute                       Type
streamHandlerClassName          String
protocol                        String

Examples

• Using Jacl:

  $AdminConfig required URLProvider

• Using Jython:

  print AdminConfig.required('URLProvider')

reset

Use the reset command to reset the temporary workspace that holds updates to the configuration.

Target object None.

Required parameters None.

Optional parameters None.

Examples

• Using Jacl:

  $AdminConfig reset

• Using Jython:

  AdminConfig.reset()

save

Use the save command to 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

• Using Jacl:

  $AdminConfig save

• Using Jython:

  AdminConfig.save()

setCrossDocumentValidationEnabled

Use the setCrossDocumentValidationEnabled command to 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, as the following example displays:

WASX7188I: Cross-document validation enablement set to true

Examples

• Using Jacl:

  $AdminConfig setCrossDocumentValidationEnabled true

• Using Jython:

  print AdminConfig.setCrossDocumentValidationEnabled('true')

setSaveMode

Use the setSaveMode command to modify the behavior of the save command.

Target object None.

Required parameters

save mode

Save mode to use. The default value 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

• Using Jacl:

  $AdminConfig setSaveMode overwriteOnConflict

• Using Jython:

  AdminConfig.setSaveMode('overwriteOnConflict')

setValidationLevel

Use the setValidationLevel command to set the validation that is used when files are extracted from the repository.

Target object None.

Required parameters

level

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

Optional parameters None.

Sample output The command returns a string that contains the validation level setting, as the following example displays:

WASX7189I: Validation level set to HIGH

Examples

• Using Jacl:

  $AdminConfig setValidationLevel high

• Using Jython:

  print AdminConfig.setValidationLevel('high')

show

Use the show command to return the top-level attributes of the given object.

Target object None.

Required parameters

configuration ID

Specifies the configuration ID of the object of interest.

Optional parameters None.

Sample output The command returns a string that contains the attribute value, as the following example displays:

[name "Sample Datasource"] [description "Data source for the Sample entity beans"]

Examples

• Using Jacl:

  $AdminConfig show Db2JdbcDriver(cells/mycell/nodes/DefaultNode|resources.xmlJDBCProvider_1)

• Using Jython:

  print AdminConfig.show('Db2JdbcDriver(cells/mycell/nodes/DefaultNode|resources.xmlJDBCProvider_1)')

showall

Use the showall command to recursively show the attributes of a given configuration object.

Target object None.

Required parameters

configuration ID

Specifies the configuration ID of the object of interest.

Optional parameters None.

Sample output The command returns a string that contains the attribute value, as the following example displays:

[datasourceHelperClassname com.ibm.websphere.rsadapter.CloudscapeDataStoreHelper]
[description "Datasource for the WebSphere Default Application"]
[jndiName DefaultDatasource]
[name "Default Datasource"]
[propertySet [[resourceProperties [[[description "Location of Cloudscape 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 "Cloudscape 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]

Examples

• Using Jacl:

  $AdminConfig showall "Default Datasource(cells/mycell/nodes/DefaultNode/servers/server1:resources.xml#DataSource_1)

• Using Jython:

  print AdminConfig.showall("Default Datasource(cells/mycell/nodes/DefaultNode/servers/server1:resources.xml#DataSource_1)")

showAttribute

Use the showAttribute command to display only the value for the single attribute that you specify.

Target object None.

Required parameters

configuration ID

Specifies the configuration ID of the object of interest.

attribute

Specifies the 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 that contains the attribute name and value. It only displays the attribute value, as the following example displays:

mynode

Examples

• Using Jacl:

  set ns [$AdminConfig getid /Node:mynode/]
  $AdminConfig showAttribute $ns hostName

• Using Jython:

  ns = AdminConfig.getid('/Node:mynode/')
  print AdminConfig.showAttribute(ns, 'hostName')

types

Use the types command to return a list of the configuration object types that you can manipulate.

Target object None.

Required parameters None.

Optional parameters None.

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

• Using Jacl:

  $AdminConfig types

• Using Jython:

  print AdminConfig.types()

uninstallResourceAdapter

Use the uninstallResourceAdapter command to uninstall a Java 2 Connector (J2C) resource adapter with the given J2C resource adapter configuration ID and an option list. When you remove a J2CResourceAdapter object from the configuration repository, the installed directory will be removed at the time of synchronization. A stop request will be sent to the J2CResourceAdapter MBean that was removed. Uninstalls

Target object None.

Required parameters

configuration ID

Specifies the 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 will not be uninstalled. If you 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, as the following example displays:

WASX7397I: The following J2CResourceAdapter objects are removed: 
MyJ2CRA(cells/juniarti/nodes/juniarti|resources.xml#J2CResourceAdapter_1069433028609)

Examples

• Using Jacl:

  set j2cra [$AdminConfig getid /J2CResourceAdapter:MyJ2CRA/]
  $AdminConfig uninstallResourceAdapter $j2cra {-force}
  $AdminConfig save
  

• Using Jython:

  j2cra = AdminConfig.getid('/J2CResourceAdapter:MyJ2CRA/')
  print AdminConfig.uninstallResourceAdapter(j2cra, '[-force]')
  AdminConfig.save()

validate

Use the validate command to 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, you can specify a configuration ID to set the scope. If you 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

Specifies the configuration ID of the object of interest.

Sample output The command returns a string that contains 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

• Using Jacl:

  $AdminConfig validate

• Using Jython:

  print AdminConfig.validate()

Related tasks

Reference topic