Specifying configuration objects using the wsadmin tool

 

+

Search Tips   |   Advanced Search

 

Specify configuration objects with scripting and the wsadmin tool.

Before starting this task, the wsadmin tool must be running.

 

Overview

To manage an existing configuration object, identify the configuration object and obtain a configuration ID of the object to use for subsequent manipulation.

 

Procedure

1. Obtain the configuration ID in one of the following ways:

   • Obtain the ID of the configuration object with the getid command, for example:

     Use Jacl:

     set var [$AdminConfig getid /type:name/]
     

     • Use Jython:

       var = AdminConfig.getid('/type:name/')
       

     where:

     set	Jacl command
     var	variable name
     $	Jacl operator for substituting a variable name with its value
     AdminConfig	object representing the WebSphere Application Server configuration
     getid	AdminConfig command
     /type:name/	hierarchical containment path of the configuration object
     type	object type. The name of the object type that you input here is the one that is based on the XML configuration files and does not have to be the same name that is displayed in the administrative console.
     name	optional name of the object

     You can specify multiple /type:name/ value pairs in the string, for example, /type:name/type:name/type:name/. If you specify the type in the containment path without the name, include the colon, for example, /type:/. The containment path must be a path that contains the correct hierarchical order. For example, if you specify /Server:server1/Node:node/ as the containment path, you do not receive a valid configuration ID because Node is a parent of Server and comes before Server in the hierarchy.

     This command returns all the configuration IDs that match the representation of the containment and assigns them to a variable.

     To look for all the server configuration IDs that reside in the mynode node, use the code in the following example:

     Use Jacl:

     set nodeServers [$AdminConfig getid /Node:mynode/Server:/]
     

     • Use Jython:

       nodeServers = AdminConfig.getid('/Node:mynode/Server:/')
       

     To look for the server1 configuration ID that resides in mynode, use the code in the following example:

     Use Jacl:

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

     • Use Jython:

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

     To look for all the server configuration IDs, use the code in the following example:

     Use Jacl:

     set servers [$AdminConfig getid /Server:/]
     

     • Use Jython:

       servers = AdminConfig.getid('/Server:/')
       

   • Obtain the ID of the configuration object with the list command, for example:

     Use Jacl:

     set var [$AdminConfig list type]
     

     or

     set var [$AdminConfig list type scopeId]
     

     • Use Jython:

       var = AdminConfig.list('type')
       

       or

       var = AdminConfig.list('type', 'scopeId')
       

     where:

     set	Jacl command
     var	variable name
     $	Jacl operator for substituting a variable name with its value
     AdminConfig	object that represents the WebSphere Application Server configuration
     list	AdminConfig command
     type	object type. The name of the object type that you input here is the one that is based on the XML configuration files and does not have to be the same name that is displayed in the administrative console.
     scopeId	configuration ID of a cell, a node, or a server object

     This command returns a list of configuration object IDs of a given type. If you specify the scopeId value, the list of objects is returned within the specified scope. The returned list is assigned to a variable.

     To look for all the server configuration IDs, use the following example:

     Use Jacl:

     set servers [$AdminConfig list Server]
     

     • Use Jython:

       servers = AdminConfig.list('Server')
       

     To look for all the server configuration IDs in the mynode node, use the code in the following example:

     Use Jacl:

     set scopeid [$AdminConfig getid /Node:mynode/] set nodeServers [$AdminConfig list Server $scopeid]
     

     • Use Jython:

       scopeid = AdminConfig.getid('/Node:mynode/') nodeServers = AdminConfig.list('Server', scopeid)
       

2. If more than one configuration ID is returned from the getid or the list command, the IDs are returned in a list syntax. One way to retrieve a single element from the list is to use the lindex command. The following example retrieves the first configuration ID from the server object list:

   Use Jacl:

   set allServers [$AdminConfig getid /Server:/] set aServer [lindex $allServers 0]
   

   • Use Jython:

     allServers = AdminConfig.getid('/Server:/')
     
       # get line separator 
       import  java
       lineSeparator = java.lang.System.getProperty('line.separator')
     
       arrayAllServers = allServers.split(lineSeparator)
       aServer = arrayAllServers[0]
     

   For other ways to manipulate the list and perform pattern matching to look for a specified configuration object, refer to the Jacl syntax.

 

Results

You can now use the configuration ID in any subsequent AdminConfig commands that require a configuration ID as a parameter.

---

Use the AdminConfig object for scripted administration

 

Related Reference

Commands for the AdminConfig object