Using the wsadmin scripting AdminConfig object for scripted administration

Use the AdminConfig object to manage the configuration information that is stored in the repository.

Before you begin

This object communicates with the WebSphere® Application Server configuration service component to make configuration inquires and changes. You can use it to query existing configuration objects, create configuration objects, modify existing objects, remove configuration objects, and obtain help.

Updates to the configuration through a scripting client are kept in a private temporary area called a workspace and are not copied to the master configuration repository until you run a save command. The workspace is a temporary repository of configuration information that administrative clients including the administrative console use. The workspace is kept in the wstemp subdirectory of your WebSphere Application Server installation. The use of the workspace allows multiple clients to access the master configuration. If the same update is made by more than one client, it is possible that updates made by a scripting client will not save because there is a conflict. If this occurs, the updates will not be saved in the configuration unless you change the default save policy with the setSaveMode command.

About this task

The AdminConfig commands are available in both connected and local modes. If a server is currently running, it is not recommended that you run the scripting client in local mode because the configuration changes made in the local mode is not reflected in the running server configuration and vice versa. In connected mode, the availability of the AdminConfig commands depend on the type of server to which a scripting client is connected in a WebSphere Application Server Network Deployment installation.

The AdminConfig commands are available only if a scripting client is connected to a deployment manager. When connected to a node agent or an application server, the AdminConfig commands will not be available because the configuration for these server processes are copies of the master configuration that resides in the deployment manager. The copies are created in a node machine when configuration synchronization occurs between the deployment manager and the node agent. You should 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.

Procedure

  • Query and update a configuration object.
    1. Identify the configuration type and the corresponding attributes.
    2. Query an existing configuration object to obtain a configuration ID to use.
    3. Modify the existing configuration object or create a one.
    4. Save the configuration.
  • See the Commands for the AdminConfig object topic. You can also use the help command, for example:
    Using Jacl:
    $AdminConfig help
    Using Jython:
    print AdminConfig.help()