The AdminConfig object communicates with the Config Service in a WebSphere server to manipulate configuration data for a WebSphere installation. AdminConfig 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 AdminConfig operate in two modes: the default mode is one in which AdminConfig communicates with the WebSphere 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 with no server connected using the command line "-conntype NONE" option or setting the "com.ibm.ws.scripting.connectionType=NONE" property in the wsadmin.properties.
Use the AdminConfig object to manage the configuration information that is stored in the repository.
AdminConfig 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.
To see a list of all available commands for the AdminApp object:
Print AdminConfig.help()
Methods in AdminConfig
Name | Description |
attributes | Show the attributes for a given type |
checkin | Check a file into the the configuration repository. |
convertToCluster | converts a server to be the first member of a new ServerCluster |
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. |
createUsingTemplate | Creates an object using a particular template type. |
defaults | Displays the default values for 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 | Extract 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, return a string version of the ObjectName for the corresponding running MBean, if any. |
getObjectType | Given a configuration ID, return a string version of the object type. |
getSaveMode | Returns the mode used when "save" is invoked |
getValidationLevel | Returns the validation 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 | Show help information |
installResourceAdapter | Installs a J2C resource adapter with the given rar file name and an option string in the node. |
list | Lists all configuration objects of a given type |
listTemplates | Lists all available configuration templates of a given type. |
modify | Change specified attributes of a given configuration object |
parents | Show the objects which contain a given type |
queryChanges | Returns a list of unsaved files |
remove | Removes the specified configuration object |
reset | Discard unsaved configuration changes |
resetAttributes | Reset value of the specified attributes. |
save | Commit 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 | Show the attributes of a given configuration object |
showall | Recursively show 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 | Show the possible types for configuration |
uninstallResourceAdapter | Uninstalls a J2C resource adapter with the given resource adapter configuration ID. |
unsetAttributes | Unset value of the specified attributes. |
validate | Invokes validation |
No comments:
Post a Comment