Exporting event journal records and handling console alerts with the CLI
The alerttool is available for use under direction of BMC Support to gather information to help troubleshoot event or console alert issues. The following sections describe the functions that you can perform with this CLI command and the options that you can specify:
Output current console alerts
alerttool --output-alerts user
Sample JSON format for commands outputing alerts ...
{
"count" : 1,
"alerts" : [
{
"ackState" : false,
"audible" : false,
"audited" : false,
"dateTime" : "01/01/2017 18:00:00 UTC",
"messaage" : "alert message",
"ruleName" : "rule name",
"uuid" : "uuid",
"instPath" : "AHost",
"typePath" : "ComMQSoftwareNetworkHost"
}
]
}
Write current console alerts to a JSON file
alerttool --write-alerts Filename user
Output console alert history
alerttool --output-alerts --start "yyyy-MM-dd HH:mm:ss" --end "yyyy-MM-dd
HH:mm:ss" user
Sample JSON format for commands outputing alert history ...
{
"count" : 1,
"alertHistory" : [
{
"beginTime" : "2017-01-01 18:00:00",
"endTime" : "2017-01-01 18:00:00",
"messaage" : "alert message",
"instPath" : "AHost",
"typePath" : "ComMQSoftwareNetworkHost"
}
]
}
Write console alert history to a JSON file
alerttool --write-alerts Filename --start "yyyy-MM-dd HH:mm:ss" --end
"yyyy-MM-dd HH:mm:ss" user
Output journal records using object identifier (oid)
alerttool --output-journal --start "yyyy-MM-dd HH:mm:ss" --end "yyyy-MM-dd
HH:mm:ss" --object hi_lo_typeid user
Sample JSON format for commands outputting journal entries ...
{
"count" : 1,
"entries" : [
{
"instanceID" : 0,
"beginTime" : "2017-01-01 18:00:00",
"endTime" : "2017-01-01 18:00:00",
"rule" : "rule name",
"pipeline" : "pipe line name",
"action" : "action name",
"suppressed" : "true",
"success" : "false",
"resultCode" : "-1",
"cause" : "0",
"topicInputs" : {
"topicCount" : 1,
"topics" : [
{
"instanceID" : "0",
"physicalTypePath" : "ComMQSoftwareNetworkHost",
"physicalInstPath" : "sample",
"oldValue" : "0",
"newValue" : "1"
}
]
},
"nodeFlow" : {
"NodeCount" : 1,
"nodes" : [
{
"instanceID" : 0,
"sequenceID" : 0,
"nodeID" ": node id",
"nodeDescription" : "node desc",
"beginTime" : "2017-01-01 18:00:00",
"endTime" : "2017-01-01 18:00:00",
"resultValue" : 0
}
]
}
}
]
}
Output journal records using object topic
alerttool --output-journal --start "yyyy-MM-dd HH:mm:ss" --end "yyyy-MM-dd
HH:mm:ss" --object-type-path type_path --object-inst-path inst_path
user
Write journal records to a JSON file using object identifier (oid).
alerttool --write-journal Filename --start "yyyy-MM-dd HH:mm:ss" --end
"yyyy-MM-dd HH:mm:ss" --object hi_lo_typeid user
Write journal records to a JSON file using object topic
alerttool --write-journal Filename --start "yyyy-MM-dd HH:mm:ss" --end
"yyyy-MM-dd HH:mm:ss" --object-type-path type_path --object-inst-path
inst_path user
Force all clients to clear and re-load console alerts from the AS
alerttool --reset-clients user
Force the Application Service to disconnect from the Event Service and reconnect to clear and re-load console alerts from the Event Service
alerttool --force-reconnect user
Alerttool options
| Option | Description |
|---|---|
--as-host host_name | Application Service host |
--as-port port_number | Application Service port |
--end "yyyy-MM-dd HH:mm:ss" | Gets the records before the specified time |
--force-reconnect | Force reconnect to Event Service clearing and resending alerts to all clients |
--object hi_lo_typeid | Specifies an object using its object identifier. This option requires an oid; follow it with the format: |
--object-inst-path inst_path | Specifies an object using a topic path. Used with |
--object-type-path type_path | Specifies an object using a topic path. Used with This option requires that an exclamation mark (!) delimited type path follow it. |
| Writes JSON-formatted journal records to System.out |
--reset-clients | Clears and resends alerts to all clients |
| --start "yyyy-MM-dd HH:mm:ss" | Gets the records after the specified time |
--write-alerts Filename | Writes JSON-formatted alerts to named file |
| --write-journal Filename | Writes JSON-formatted journal records to named file |
-h|-? | Gives this help summary |
-p password | Password |
Comments