NAME | SYNOPSIS | DESCRIPTION | OPTIONS | OPERANDS | EXAMPLES | EXIT STATUS | SEE ALSO
Gets the names and values of attributes. If the --monitor option is set to true, the monitorable attributes are returned. If the --monitor option is set to false, the configurable attribute values are returned. On UNIX platforms, if the shell treats the wildcard (*) as a special character, enclose the dotted name in a double quotes (“dotted_name”).
The asadmin get, set and list commands work in tandem to provide a navigation mechanism for the Application Server's abstract hierarchy. There are two hierarchies: configuration and monitoring and these commands operate on both. The list command provides the fully qualified dotted names of the management components that have read-only or modifiable attributes. The configuration hierarchy provides attributes that are modifiable; whereas the attributes of management components from monitoring hierarchy are purely read-only. The configuration hierarchy is loosely based on the domain's schema document; whereas the monitoring hierarchy is a little different. Use the list command to reach a particular management component in the desired hierarchy. Then, invoke the get and set commands to get the names and values or set the values of the attributes of the management component at hand. Use the wildcard (*) option to fetch all matches in a given fully qualified dotted name. See the examples for further clarification of the possible navigation of the hierarchies and management components.
An application server dotted name uses the “.” (period) as a delimiter to separate the parts of a complete name. This is similar to how the “/” character is used to delimit the levels in the absolute path name of a file in the UNIX file system. The following rules apply while forming the dotted names accepted by the get, set and list commands. Note that a specific command has some additional semantics applied.
A . (period) always separates two sequential parts of the name.
A part of the name usually identifies an application server subsystem and/or its specific instance. For example: web-container, log-service, thread-pool-1 etc.
If any part of the name itself contains a . (period), then it must be escaped with a leading \ (backslash) so that the “.” does not act like a delimiter.
An * (asterisk) can be used anywhere in the dotted name and it acts like the wildcard character in regular expressions. Additionally, an * can collapse all the parts of the dotted name. Long dotted name like "this.is.really.long.hierarchy" can be abbreviated to "th*.hierarchy". But note that the . always delimits the parts of the name.
The top level switch for any dotted name is -–monitor or –m that is separately specified on a given command line. The presence or lack of this switch implies the selection of one of the two hierarchies for appserver management: monitoring and configuration.
If you happen to know the exact complete dotted name without any wildcard character, then list and get/set have a little difference in their semantics:
The list command treats this complete dotted name as the complete name of a parent node in the abstract hierarchy. Upon providing this name to list command, it simply returns the names of the immediate children at that level. For example, list server.applications.web-module will list all the web modules deployed to the domain or the default server.
The get and set commands treat this complete dotted name as the fully qualified name of the attribute of a node (whose dotted name itself is the name that you get when you remove the last part of this dotted name) and it gets/sets the value of that attribute. This is true if such an attribute exists. You will never start with this case because in order to find out the names of attributes of a particular node in the hierarchy, you must use the wildcard character *. For example, server.applications.web-module.JSPWiki.context-root will return the context-root of the web-application deployed to the domain or default server.
If you are using the Enterprise Edition of the Application Server, then "server" (usually the first part of the complete dotted name) can be replaced with the name of a particular server instance of interest (e.g., server1) and you'll get the information of that server instance, remaining part of the dotted name remaining the same. Note that the dotted names that are available in such other server instances are those from the monitoring hierarchy because these server instances don't have a way to expose the configuration hierarchy.
The list command is the progenitor of navigational capabilities of these three commands. If you want to set or get attributes of a particular application server subsystem, you must know its dotted name. The list command is the one which can guide you to find the dotted name of that subsystem. For example, to find out the modified date (attribute) of a particular file in a large file system that starts with /. First you must find out the location of that file in the file system, and then look at its attributes. Therefor, two of the first commands to understand the hierarchies in appserver are: * list "*" and * list * -–monitor. The sorted output of these commands is typically of the following form:
Command |
Output |
---|---|
list * |
|
list -–monitor * |
|
Consequently, the list command is the entry point into the navigation of the application server's s management hierarchies. Take note of the output of the list command:
The output lists one element per line.
Every element on a line is a complete-dotted-name of a management component that is capable of having attributes. Note that none of these lines show any kind of attributes at all.
The output of thelist command is a list of dotted names representing individual application server components and subsystems. Every component or subsystem is capable of having zero or more attributes that can be read and modified.
With thelist command you can drill down through the hierarchy in a particular branch of interest. For example, if you want to find the configuration of the http-listener of the domain (the default server, whose ID is "server"). Here is how you could proceed on a UNIX terminal:
ID |
Command |
Output/Comment |
---|---|---|
1 |
list "*" | grep http | grep listener |
|
2 |
To find the listener that corresponds to the default http-listener where the web applications in the domain/server are deployed:
|
server.http-service.http-listener.http-listener-1.acceptor-threads = 1server.http-service.http-listener.http-listener-1.address = 0.0.0.0server.http-service.http-listener.http-listener-1.blocking-enabled = falseserver.http-service.http-listener.http-listener-1.default-virtual-server = serverserver.http-service.http-listener.http-listener-1.enabled = trueserver.http-service.http-listener.http-listener-1.external-port =server.http-service.http-listener.http-listener-1.family = inetserver.http-service.http-listener.http-listener-1.id = http-listener-1server.http-service.http-listener.http-listener-1.port = 8080server.http-service.http-listener.http-listener-1.redirect-port =server.http-service.http-listener.http-listener-1.security-enabled = falseserver.http-service.http-listener.http-listener-1.server-name =server.http-service.http-listener.http-listener-1.xpowered-by = true |
Making use of both list and get commands, it is straightforward to reach a particular component of interest.
To get the monitoring information of a particular subsystem you must:
Use the set command to set an appropriate monitoring level for the component of interest.
Obtain the various information about the JVM that the application server domain is running.
ID |
Command |
Output/Comment |
---|---|---|
1 |
list server* | grep monitoring |
server-config.monitoring-serviceserver-config.monitoring-service.module-monitoring-levelsserver.monitoring-serviceserver.monitoring-service.module-monitoring-levels Note that this is the list command. It only shows the hierarchy, nothing else. Using the '|' and "grep" narrows down the search effectively. Now, you can choose server.monitoring-service to set the attributes of various attributes that can be monitored. This is the configuration data because this setting will be persisted to the server's configuration store. |
2 |
get server.monitoring-service.* |
You can try the number of attributes that are presently available with monitoring service. Here is the output: No matches resulted from the wildcard expression. This is because this fully dotted name does not have any attributes at all. Logically, you try the next one and that is: server.monitoring-service.module-monitoring-levels. Again, use the wildcard character to get ALL the attributes of a particular component. |
3 |
get server.monitoring-service.module-monitoring-levels.* |
server.monitoring-service.module-monitoring-levels.connector-connection-pool = OFF server.monitoring-service.module-monitoring-levels.connector-service = OFF server.monitoring-service.module-monitoring-levels.ejb-container = OFF server.monitoring-service.module-monitoring-levels.http-service = OFF server.monitoring-service.module-monitoring-levels.jdbc-connection-pool = OFF server.monitoring-service.module-monitoring-levels.jms-service = OFF server.monitoring-service.module-monitoring-levels.jvm = OFF server.monitoring-service.module-monitoring-levels.orb = OFF server.monitoring-service.module-monitoring-levels.thread-pool = OFF server.monitoring-service.module-monitoring-levels.transaction-service = OFF server.monitoring-service.module-monitoring-levels.web-container = OFF The JVM monitoring is at a level OFF. It must be changed in order to make the JVM monitoring information available. The other valid values for all the monitoring level are: LOW and HIGH. use the set command to set the value appropriately. |
4 |
set server.monitoring-service.module-monitoring-levels.jvm=HIGH There is no space before or after the = sign. |
server.monitoring-service.module-monitoring-levels.jvm = HIGH Now, the JVM information can be obtained using the get command and monitoring switch. But remember , when you switch to the monitoring hierarchy, start with the list command again. |
5 |
list --monitor * | grep jvm |
server.jvm server.jvm.class-loading-system server.jvm.compilation-system server.jvm.garbage-collectors server.jvm.garbage-collectors.Copy server.jvm.garbage-collectors.MarkSweepCompact server.jvm.memory server.jvm.operating-system server.jvm.runtime server.jvm.thread-system server.jvm.thread-system.thread-1 . . . server.jvm.thread-system.thread-793823 server.jvm.thread-system.thread-793824 server.jvm.thread-system.thread-793825 server.jvm.thread-system.thread-793826 server.jvm.thread-system.thread-793827 server.jvm.thread-system.thread-9 The JRE 1.5.0 monitorable components are exposed in an elegant manner. This is what you see when connected by the JConsole. Now, to know more about the class-loading system in the JVM, this is how you'll proceed. Note that now you are interested in the attributes of a particular leaf node. Thus the command is get not list. |
6 |
get -–monitor server.jvm.class-loading-system.* |
server.jvm.class-loading-system.dotted-name = server.jvm.class-loading-system server.jvm.class-loading-system.loadedclasscount-count = 7328 server.jvm.class-loading-system.loadedclasscount-description = No Description was available server.jvm.class-loading-system.loadedclasscount-lastsampletime = 1133819508973 server.jvm.class-loading-system.loadedclasscount-name = LoadedClassCount? server.jvm.class-loading-system.loadedclasscount-starttime = 1133819131268 server.jvm.class-loading-system.loadedclasscount-unit = count server.jvm.class-loading-system.totalloadedclasscount-count = 10285 server.jvm.class-loading-system.totalloadedclasscount-description = No Description was available server.jvm.class-loading-system.totalloadedclasscount-lastsampletime = 1133819508972 server.jvm.class-loading-system.totalloadedclasscount-name = TotalLoadedClassCount? server.jvm.class-loading-system.totalloadedclasscount-starttime = 1133819131268 server.jvm.class-loading-system.totalloadedclasscount-unit = count server.jvm.class-loading-system.unloadedclasscount-count = 2957 server.jvm.class-loading-system.unloadedclasscount-description = No Description was available server.jvm.class-loading-system.unloadedclasscount-lastsampletime = 1133819508973 server.jvm.class-loading-system.unloadedclasscount-name = UnloadedClassCount? server.jvm.class-loading-system.unloadedclasscount-starttime = 1133819131268 server.jvm.class-loading-system.unloadedclasscount-unit = count You cansee that 10285 is the total number of classes loaded by the Virtual Machine. Whereas, 2957 is number of classes unloaded, since it was started. ,Similarly, you can explore attributes of the other subsystems as well. |
The authorized domain administration server administrative username.
The ––password option is deprecated. Use ––passwordfile instead.
This option replaces the –– password option. Using the ––password option on the command line or through the environment is deprecated. The ––passwordfile option specifies the name of a file containing the password entries in a specified format. The entry for the password must have the AS_ADMIN_ prefix followed by the password name in capital letters. For example, to specify the domain administration server password, use an entry with the following format: AS_ADMIN_PASSWORD=password, where password is the actual administrator password. Other passwords that can be specified include AS_ADMIN_MAPPEDPASSWORD, AS_ADMIN_USERPASSWORD, AS_ADMIN_MQPASSWORD, AS_ADMIN_ALIASPASSWORD, and so on.
The machine name where the domain administration server is running. The default value is localhost.
The port number of the domain administration server listening for administration requests. The default port number for Enterprise Edition is 4849.
If set to true, uses SSL/TLS to communicate with the domain administration server.
Indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false.
Setting to true will echo the command line statement on the standard output. Default is false.
If set to true (default), only the required password options are prompted.
Displays the help text for the command.
defaults to false; if set to false, the configurable attribute values are returned. If set to true, the monitorable attribute values are returned.
Identifies the attribute name in the dotted notation. At least one dotted name attribute is required. The dotted notation is the syntax used to access attributes of configurable entities. The following format is used for the notation:
Configuration: <config name>.<config element name>.<primary key>.<attribute name> | <instance name>.<config element name>.<primary key>.<attribute name>
Resource: <instancename>.<resource name>.<primary key>.<attribute name> | domain.resources.<resource name>.<primary key>.<attribute name>
Command |
Operation |
---|---|
get * |
get all values on all dotted name prefixes |
get *.* |
same as get *. |
get domain.* |
gets all values on the dotted name “domain.” Note that this is quite different from “domain*”. |
get domain* |
gets all values on the dotted nams that begin with “domain”. Equivalent to get domain*.*. |
get *config*.*.* |
gets all values on the dotted names which match “*config*.*” |
get domain.j2ee-applications.*.ejb-module.*.* |
gets all values on all ejb-modules of all applications. |
get *web-modules.*.* |
get all values on all web modules whether in an application or standalone. |
get *.*.*.* |
get all values on all dotted names which have three parts. |
To get the monitoring data from the domain administration server, the appropriate monitoring level must be set on the appropriate subsystem. Use the set command to set the monitoring data level. For example, to set the monitoring level on Web Container on Domain Administration Server (DAS) to HIGH so that the Web Container returns many monitorable attributes and their values: server.monitoring-service.module-monitoring-levels.web-container=HIGH. See the set command for further details on setting the monitoring level.
Command |
Dotted Name |
Output |
---|---|---|
Top Level |
||
get -m |
server.* |
No output, but message saying there are no attributes at this node. |
Applications Level |
||
get -m |
server.applications.*or*applications.* |
No output, but message saying there are no attributes at this node. |
Applications — Enterprise Applications and Standalone Modules |
||
get -m |
server.applications.app1.*or*app1.* |
No output, but message saying there are no attributes at this node. |
get -m |
server.applications.app1.ejb-module1_jar.* or *ejb-module1_jar.* or server.applications.ejb-module1_jar.* |
No output, but message saying there are no attributes at this node. |
get -m |
server.applications.app1.ejb-module1_jar.bean1.* Note : where it is a standalone module, the node app1 will not appear. |
Attribute CreateCount_Count, Value = xxxx Attribute CreateCount_Description, Value = xxxx Attribute CreateCount_LastSampleTime, Value = xxxx Attribute CreateCount_Name, Value = xxxx Attribute CreateCount_StartTime, Value = xxxx Attribute CreateCount_Unit, Value = xxxx Attribute MethodReadyCount_Current, Value = xxxx Attribute MethodReadyCount_Description, Value = xxxx Attribute MethodReadyCount_HighWaterMark, Value = xxxx Attribute MethodReadyCount_LastSampleTime, Value = xxxx Attribute MethodReadyCount_LowWaterMark, Value = xxxx Attribute MethodReadyCount_Name, Value = xxxx MethodReadyCount_StartTime, Value = xxxx MethodReadyCount_Unit, Value = xxxx Attribute RemoveCount_Count, Value = xxxx Attribute RemoveCount_Description, Value = xxxx Attribute RemoveCount_LastSampleTime, Value = xxxx Attribute RemoveCount_Name, Value = xxxx Attribute RemoveCount_StartTime, Value = xxxx Attribute RemoveCount_Unit, Value = xxxx |
get -m |
server.applications.app1.ejb-module1_jar.bean1.bean-pool Note: Where it is a standalone module, the node app1 will not appear. |
List of Attributes and Values corresponding to attributes as defined under EJBPoolStats Statistics. |
get -m |
server.applications.app1.ejb-module1_jar.bean1.bean-cache.* Note: Where it is a standalone module, the node app1 will not appear. |
List of Attributes and Values corresponding to attributes as defined under EJBCacheStats Statistics. |
get -m |
server.applications.app1.ejb-module1_jar.bean1.bean-cachemethod.method1.* Note: Where it is a standalone module, the node app1 will not appear. |
List of Attributes and Values corresponding to attributes as defined under EJBMethodStats Statistics. |
get -m |
server.applications.app1.web-module1_war.* |
No output, but message saying there are no attributes at this node. |
get -m |
server.applications.app1.web-module1_war.virtual_server1.* |
No output, but message saying there are no attributes at this node. |
get -m |
server.applications.app1.web-module1_war.virtual_server1.servlet1.* |
List of Attributes and Values corresponding to ServletStats statistics. |
Http-Service Level |
||
get -m |
server.http-service.* |
No output, but message saying there are no attributes at this node. |
get -m |
server.http-service.virtual-server1 |
No output, but message saying there are no attributes at this node. |
get -m |
server.http-service.virtual-server1.http-listener1.* |
Attributes and Values corresponding to HttpListerneStats Statistics. |
Thread-Pools Level |
||
get -m |
server.thread-pools.* |
No output, but message saying there are no attributes at this node. |
get -m |
server.thread-pools.thread-pool1.* |
List of Attributes and Values corresponding to ThreadPoolStats Statistics. |
Resources Level |
||
get -m |
server.resources.* |
No output, but message saying there are no attributes at this node. |
get -m |
server.resources.connection-pool1.* |
List of Attributes and Values corresponding to JDBCConnectionPool Stats or ConnectorConnectionPoolStats Statistics as the case may be. |
Transaction-Service Level |
||
get -m |
server.transaction-service.* |
List of Attributes and Values corresponding to JTAStats Statistics. |
ORB Level |
||
get -m |
server.orb.* |
No output, but message saying there are no attributes at this node. |
get -m |
server.orb.connection-managers.* |
No output, but message saying there are no attributes at this node. |
get -m |
server.orb.connection-managers.orbconnmgr1.* |
Attributes and values corresponding to OrbConnectionManagerStats Statistics. |
JVM Level |
||
get -m |
server.jvm.* |
Attributes and Values corresponding to JVMStats Statistics. For example:server.jvm.HeapSize_Current = 45490176server.jvm.HeapSize_Description = Describes JvmHeapSizeserver.jvm.HeapSize_HighWaterMark = 45490176server.jvm.HeapSize_LastSampleTime = 1063217002433server.jvm.HeapSize_LowWaterMark = 0server.jvm.HeapSize_LowerBound = 0server.jvm.HeapSize_Name = JvmHeapSizeserver.jvm.HeapSize_StartTime = 1063238840055server.jvm.HeapSize_Unit = bytesserver.jvm.HeapSize_UpperBound = 531628032server.jvm.UpTime_Count = 1063238840100server.jvm.UpTime_Description = Describes JvmUpTimeserver.jvm.UpTime_LastSampleTime = 1-63238840070server.jvm.UpTime_Name = JvmUpTimeserver.jvm.UpTime_StartTime = 1063217002430server.jvm.UpTime_Unit = milliseconds |
NAME | SYNOPSIS | DESCRIPTION | OPTIONS | OPERANDS | EXAMPLES | EXIT STATUS | SEE ALSO