NAME | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
create-management-rule [--terse={true|false}][ --echo={true|false} ] [ --interactive={true|false} ] [ --host host] [--port port] [--secure| -s ] [ --user admin_user] [--passwordfile filename] [--help] [ --ruleenabled =true|false] [--ruledescription description] [--action action-mbean-name] --eventtype event-type [--eventloglevel log-level [--recordevent=true|false] [ --eventdescription description] [--eventproperties (property=value[:property=value]*)] [--target target] rule-name
The create-management-rule creates a new management rule to intelligently self-manage the application server installation and deployed applications.
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.
The machine name where the domain administration server is running. The default value is localhost.
The HTTP/S port for administration. This is the port to which you should point your browser in order to manage the domain. For example, http://localhost:4848.
The default port number is 4848.
If set to true, uses SSL/TLS to communicate with the domain administration server.
The authorized domain administration server administrative username.
If you have authenticated to a domain using the asadmin login command, then you need not specify the --user option on subsequent operations to this particular domain.
The --passwordfile option specifies the name, including the full path, of a file containing the password entries in a specific format. The entry for the password must have the AS_ADMIN_ prefix followed by the password name in uppercase 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, and AS_ADMIN_ALIASPASSWORD.
All remote commands must specify the admin password to authenticate to the domain administration server, either through --passwordfile or asadmin login, or interactively on the command prompt. The asadmin login command can be used only to specify the admin password. For other passwords, that must be specified for remote commands, use the --passwordfile or enter them at the command prompt.
If you have authenticated to a domain using the asadmin login command, then you need not specify the admin password through the --passwordfile option on subsequent operations to this particular domain. However, this is applicable only to AS_ADMIN_PASSWORD option. You will still need to provide the other passwords, for example, AS_ADMIN_USERPASSWORD, as and when required by individual commands, such as update-file-user.
For security reasons, passwords specified as an environment variable will not be read by asadmin.
The default value for AS_ADMIN_MASTERPASSWORD is changeit.
Displays the help text for the command.
Determines whether the rule is enabled or not. Default value is true.
Provides the description of the rule.
The action MBean associated with the event.
Identifies the configured event as one of the predefined event types.
Valid values are:
cluster
lifecycle
log
monitor
notification
timer
trace
Specifies at what level to record the event occurance in server log file. Default value is INFO.
Valid values are:
FINEST
FINER
FINE
CONFIG
INFO
WARNING
SEVERE
OFF
Specifies whether the occurrence of the event is to be logged or not. Default value is true. If no action is specified, the event is logged.
A description of the event.
The properties defined for the event. Different events have different properties. If you do not specify a value for some properties, defaults are used. The following properties and their values are identified for each event type:
Notifies when the GMS starts, stops, or reports failure of a server instance.
Values: start, stop, fail
Event type: cluster
Specifies the server instances about which notifications are given.
Values: A comma-separated list of server instance names, or * for all server instances.
Event type: cluster
Specifies a server life cycle event.
Values: ready, shutdown, termination.
Event type: lifecycle
(optional) Notifies when the specified loggers write messages to the server log.
Values: A comma-separated list of logger names, or * for all loggers, which is the default.
Event type: log
(optional) Notifies when messages of the specified level are written to the server log.
Values: A comma-separated list of log levels.
Event type: log
Specifies the name of the monitored MBean. Either this property or observedObject must be specified.
Values: A name attribute of a user-defined MBean, or a JMX ObjectName for a system MBean.
Event type: monitor
Specifies the name of the monitored MBean. Either this property or observedMbean must be specified.
Values: An object-name attribute of a user-defined MBean, or a JMX ObjectName for a system MBean.
Event type: monitor
Specifies the monitored attribute of the monitored MBean.
Values: An MBean Attribute name.
Event type: monitor
The type of monitoring of the attribute.
Values: CounterMonitor, GaugeMonitor, StringMonitor
Event type: monitor
(optional) Specifies the granularity at which the monitoring data should be collected, in seconds.
Values: any numerical value representing the number of seconds of data monitoring.
Event type: monitor
Specifies that the attribute value must match the stringToCompare value. Either this property or notifyDiffer is required if the monitor type is StringMonitor.
Values: true or false
Event type: monitor
Specifies that the attribute value must not match the stringToCompare value. Either this property or notifyMatch is required if the monitor type is StringMonitor.
Values: true or false
Event type: monitor
Specifies the value to which the attribute value is compared. Required if the monitor type is StringMonitor.
Event type: monitor
Specifies the type of the numeric value being monitored. Required if the monitor is of type CounterMonitor or GaugeMonitor.
Values: byte, double, float, int, long, short
Event type: monitor
Specifies the difference mode flag value common to all observed MBeans. Required if the monitor is of type CounterMonitor or GaugeMonitor.
Values: true or false
Event type: monitor
Specifies a value above which notification occurs. Required if the monitor is of type CounterMonitor.
Event type: monitor
(optional) Specifies that the event should be re-triggered when the initThreshold value plus this offset value is reached. Applicable if the monitor is of type CounterMonitor.
Event type: monitor
(optional) Specifies the modulus value common to all observed MBeans. Applicable if the monitor is of type CounterMonitor.
Event type: monitor
Specifies the upper limit of the range within which notification occurs. Required if the monitor is of type GaugeMonitor.
Event type: monitor
Specifies the lower limit of the range within which notification occurs. Required if the monitor is of type GaugeMonitor.
Event type: monitor
Specifies a custom MBean that implements the JMX NotificationEmitter interface. Either this property or sourceObjectName must be specified.
Values: name of an Mbean
Event type: notification
Specifies a custom MBean that implements the JMX NotificationEmitter interface. Either this property or sourceMBean must be specified.
Values: object-name of Mbean
Event type: notification
(optional) Specifies the notification type. If this property is specified, the action of the parent management rule is performed only if the notification type emitted is same as this property's value.
Event type: notification
Begins notification at the specified date and time.
Values: Input format determined by the pattern property
Event type: timer
(optional) Specifies the date and time input format. The default is mm/dd/yyyy hh:mm:ss.
Event type: timer
(optional) Notification repeats at the specified time interval in miliseconds.
Event type: timer
(optional) Specifies the number of times notification occurs.
Event type: timer
(optional) Specifies a message that is delivered as part of timer notification.
Event type: timer
Notifies at the specified trace point.
Values: web_component_method_entry, web_component_method_exit, ejb_component_method_entry, ejb_component_method_exit, request_start, request_end
Event type: trace
Specifies the IP address for which trace notifications are sent.
Values: An IP address
Event type: trace
Specifies the caller principal for which trace notifications are sent.
Event type: trace
Specifies the component name for which trace notifications are sent.
Event type: trace
This operand specifies the target on which you are creating a management rule. Valid values are:
server, which creates the management rule for the default server instance server and is the default value
configuration_name, which creates the management rule for the named configuration
cluster_name, which creates the management rule for every server instance in the cluster
instance_name, which creates the management rule for a particular server instance
asadmin> create-management-rule --user admin --passwordfile adminpassword.txt --host localhost --port 4848 --eventtype monitor --eventloglevel FINE --eventdescription "monitoring eventproperties" myRule1 Command create-management-rule executed successfully |
NAME | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also