AOEXEC ALERT
This command manages exception messages and message queues that can be displayed by any of the STATUS applications and ALERT Management Facility applications.
Command | Parameters |
|---|---|
AOEXEC ALERT | [KEY()] [TEXT('text string')] [ALARM(YES|NO)] [COLOR(RED|PINK|YELLOW|DKBLUE|LTBLUE|GREEN|WHITE)] [DISPOSE(KEEP|DELETE)] [ESCALATE(UP|DOWN)] [ESCCMD(type,PRI(NORMAL|HIGH| HOT| FIRST),DLY(0-99999):(command)] [ESCEXEC(PRI(NORMAL|HIGH| HOT|FIRST),DLY(0-99999):execname p1 p2 p3...pn] [EXEC(PRI(NORMAL|HIGH| HOT|FIRST),DLY(0-99999):execname p1 p2 p3...pn] [FUNCTION(ADD|COUNT|CREATEQ|DELETE|DELETEQ|LISTQ|READQ)] [HELP(panelname)] [INTERVAL(nnnn,nnnn,nnnn,nnnn,nnnn,nnnn)] [PCMD('cmd string')] [POSITION(position)] [PRI(CRITICAL|MAJOR|MINOR|WARNING|INFORMATIONAL|CLEARING)] [PUBLISH(REPLACE|ADD|NO] [QUEUE(MAIN|queue name)] [RETAIN(YES|NO)] SS | SSID(subsystem identifier) [AOOPTION | AOOPT(ANV, CAO, IAO, IIZ, MAO, QAO, or TSH)] [SYSTEM(YES|NO)] [TGTJNT()] [TGTSS(target subsystem identifier)] [ORIGIN(origin)] [UDATA('user data')] [USER(user name)] |
You can use the following keywords with AOEXEC ALERT keywords when you also have the BMC Impact Integration for z/OS product and have specified PRODUCT=IIZ in BBPARM member BBISSP00. | |
| ALIAS[alias_name] BIIZJRNL[(YES | NO)] CLASS[event_class-name] PUBLISH[(REPLACE|ADD|NO)] SLOTSTEM[stem_variable] TGTPUB |
The following table describes the parameters.
Parameter | Function | Notes |
|---|---|---|
KEY | Key used to uniquely identify an ALERT within a queue | Maximum length is 64 alphanumeric positions. Required for the keywords
Optional for
You must specify a unique key for every ALERT you create. If you create a second ALERT with the same key as an already existing ALERT in the queue, the second ALERT will overwrite the first ALERT. The key cannot contain blanks. Valid characters that you can use for the alert-key include the following; cent sign (¢), period(.), greater than and less than (<,>), plus sign (+), vertical bar (|), exclamation point (!), dollar sign ($), asterisk (*), not sign (¬), hyphen (-), slash (/), Euro symbol (€), percent sign (%), underscore(_), question mark (?), grave sign ( `), colon (:), pound sign (#), at sign (@), equal sign (=), alphabetic letters a through z, and numbers 0 through 9. |
TEXT | Text of the ALERT message | Maximum message length is 255 alphanumeric positions. Required for FUNCTION(ADD): If the contents of the text are null but specified (for example, zero length), the ALERT text is replaced by N/A. A specification of /N within the ALERT text forces a line break. You must include a blank space before and after using /N. This parameter applies also to the READQ and COUNT functions. Only ALERTs matching this text string are considered during these operations. |
ALARM | An audible alarm emitted from the terminal on the ALERT Detail application | Possible values are
NO is the default. |
COLOR|COL | The color in which the ALERT is displayed in the ALERT DETAIL and STATUS applications (overrides default color associated with ALERT priority) | This parameter does not have any impact upon the ALERT OVERVIEW application. When an ALERT’s priority is increased or decreased (with the ESCALATE parameter), the new ALERT priority’s color will always default to the following list of colors:
|
DISPOSE | Allows you to specify whether an ALERT is kept or deleted when it has reached its final escalation priority level | This keyword must be used with the INTERVAL keyword. Possible values are
KEEP is the default. The variable AMFEDISP returns the value of this keyword. |
ESCALATE | Allows you to create ALERTs that can change in priority over a specified interval of time | This keyword must be used with the INTERVAL keyword. Possible values are
UP is the default. The variable AMFEDIR returns the value of this keyword. |
ESCCMD | Allows you to specify a command that is issued when the ALERT escalation process has completed | This keyword must be used with the INTERVAL keyword. The ESCEXEC and ESCCMD keywords are cannot be used together. The format of the command keyword is ESCCMD(type,'command') You can enter blanks or commas between the commands but you must use single quotation marks. Valid values for the type keyword are as follows EXEC, BBI, CICS, IMS, IMP, MVS, MQ, NV, TOM Valid values for the command can be any command of the type specified by the type value; some examples follow: When using ESCCMD(type,’EXEC’), the PRI and DLY keywords can be used. For more information about the PRI and DLY keywords, refer to Examples-of-using-PRI-and-DLY-keywords. |
ESCEXEC | Enables you to specify an EXEC (with parameters) that is scheduled when the ALERT reaches its final priority level | This keyword must be used with the INTERVAL keyword. The variable AMFEEXEC returns the value of this keyword. For more information about the PRI and DLY keywords, refer to Examples-of-using-PRI-and-DLY-keywords. |
EXEC | The name of the ALERT-initiated follow-up EXEC and its parameters | Maximum length is 256 characters. See Rule-initiated-REXX-EXECs for more information about parameters passed to ALERT-initiated EXECs. For more information about the PRI and DLY keywords, refer to Examples-of-using-PRI-and-DLY-keywords. |
FUNCTION|FUN | The function to be performed | Use the FUNCTION keyword with
For more information about these functions and the return codes they generate, refer to FUNCTION names and return codes table. |
HELP | The name of an extended help pane | Maximum length is 8 characters. This help panel is displayed when you enter the EXPAND primary command in the ALERT DETAIL application while the cursor is positioned on the ALERT. The help panel is a text member without any formatting or control characters. The help text member must be included the BBPLIB concatenation for the terminal session. |
INTERVAL | Allows you to specify one to six intervals of time over which the priority of an ALERT will change An ALERT’s priority can either increase (become more critical) or decrease (become less critical) in priority over the specified time intervals. The interval can be specified from 0 to 9999 minutes. At least one interval must be specified for an ALERT when ESCALATE is specified. When the final interval expires, the action specified by the DISPOSE keyword occurs (either the ALERT is deleted or kept). When an EXEC is specified with the ESCEXEC keyword, the EXEC is scheduled | This keyword must be used with the ESCALATE keyword and you must specify at least one interval for an ALERT when ESCALATE is specified. The variables AMFEINT1 through AMFEINT6 return the values associated with this keyword. In addition, when you want to have an ALERT change in priority, you must always code one interval more than the number of changes. No priority changes occur in the last interval. For example, if you want an ALERT to change from MAJOR to CRITICAL, you must code two interval periods. |
ORIGIN | A new origin to assign to this ALERT | A 1- to 8-character user-defined origin that is assigned to the ALERT. The first character cannot be a numeric. This user-defined origin overrides the EXEC’s IMFSYSID (or the originating job name for the EXEC). |
PCMD | A command to be executed if the terminal operator uses the TRANSFER command on the ALERT DETAIL panel | Any command that is valid from the COMMAND line is a valid value for this parameter. Maximum length is 256 characters. PCMD is executed as if it were entered on the COMMAND line. You should use the SYSTEM parameter or include the BBI SYSTEM command for ALERTs that contain PCMD to ensure that the target field of the transferred-to application will be correct. If you use the SYSTEM parameter, the SYSTEM command is executed after all other commands specified with PCMD have executed. |
POSITION|POS | The order of the ALERT in the queue to read | Valid values are in the range from 1 to 32,767. This parameter is used only with the READQ function. |
PRIORITY | The priority of the ALERT | A valid value is one of the following options:
|
QUEUE|QUE | The name of the queue to access or into which to place the ALERT | Length can be one to eight characters; embedded blanks are valid. |
RETAIN | Allows you to specify that an ALERT will be retained across BBI-SS PAS restarts (both cold and warm restarts) and MVS IPLs | Possible values are
NO is the default. ALERTs that specify RETAIN(YES) cannot also specify the INTERVAL keyword. In other words, ALERTs that are to be retained across BBI-SS PAS restarts or MVS IPLs cannot change priority (either increase or decrease). |
SS | SSID | Specifies the subsystem identifier of a local subsystem If TGTSS() is not specified, this subsystem is where the requested function is executed. | This keyword is required. Generic wildcard characters are supported for this keyword. You can specify 1 to 4 asterisks (*) or plus signs (+).
Use the AOOPTION parameter to further filter on the wildcard value. By specifying a value with AOOPTION, you can route the EXEC to the BMC AMI OpsA BBI-SS PAS that is running a product option or group of product options. AOOPTION is mutually exclusive with TGTSS and TGTJNT, and it is ignored on a fully qualified SSID specified with SS or SSID parameter. |
AOOPTION | Specifies the product options that must be active in the BMC AMI OpsA PAS. The following values are valid: ANV, CAO, IAO, IIZ, MAO, QAO, or TSH. IIZ represents the BMC AMI OpsA BMC Impact Integration for z/OS product. The stand-alone BMC Impact Integration for z/OS product does not support AOAnywhere. | The specified product option must be active in the BMC AMI OpsA PAS. The value specified with the AOOPTION parameter is valid only when the SSID parameter specifies a wildcard value. AOOPTION cannot be specified if TGTSS or TGTJNT are also specified. |
SYSTEM | Determines whether the ALERT DETAIL processor switches the current target to the origin of the ALERT when processing a TRANSFER (PCMD) | The default is YES, switch the current target to the origin of the ALERT when processing a TRANSFER (PCMD). NO specifies do not switch current target to the origin of the ALERT when processing a TRANSFER (PCMD). The target is changed to reflect what was coded in the ORIGIN parameter or the BMC AMI OpsA SSID. |
TGTJNT() | Optional | A JNT entry that identifies the SSID which processes this request Use this parameter to specify a different target from the target system where the EXEC is invoked. The specified TGTJNT() should match a TARGET=(tgtname) parameter that is entered in BBPARM member BBIJNT00. The EXEC is scheduled on the subsystem that corresponds to the subsystem that is specified by the SS | SSID parameter of the JNT entry. The specified TGTJNT() may also be an SSID with which the original subsystem communicates. This keyword is mutually exclusive with the TGTSS() keyword. |
TGTSS | If the TGTSS() keyword is specified, the subsystem that is specified by the SS | SSID() keyword is considered a router and the actual function is executed on the subsystem specified by TGTSS(). If TGTSS() is not specified, the requested function is executed on the subsystem that is specified by the SS | SSID keyword. | This keyword is optional. It must be in the same sysplex as the BBI-SS that is specified with the SSID() keyword, and both systems must have the same XCFGROUP specified in the BBPARM BBISSPxx. BMC recommends that you do not use the XCFGROUP parameter in BBISSPxx. When the AOEXEC command originates, in a NetView EXEC, the router and local BMC AMI OpsA PAS must have an active, valid BMC AMI Ops Automation Access NV key. |
UDATA | Any desired user data string | Maximum length is 256 bytes. The contents of the UDATA field can be retrieved by using the READQ function. |
USER | The name of the user ID to which the ALERT is addressed | A one- to eight-character valid BBI-TS user ID. Contents of the user field can be used to tailor ALERT DETAIL displays using the ALERT DETAIL PROFILE panel. Refer to the ALERT-Management-Facility section in Using-BMC-AMI-Ops-Automation-basic-applications for more information. |
You can use the following keywords with AOEXEC ALERT keywords when you also have the BMC Impact Integration for z/OS product and have specified PRODUCT=IIZ in BBPARM member BBISSP00. | ||
ALIAS | Specifies that when an event is sent to Service Impact Manager (SIM), the Component Alias value is used to match against a specific object in the Service Impact Model | This keyword is the equivalent of specifying the mc_smc_alias slot, or the Component Alias field on the Rule Processor Alert Action(s) III - BiiZ/SIEM panel; it is the Component Alias name. |
BIIZJRNL | Specifies that BMC AMI OpsA writes informational messages to the BBI Journal that describe this ALERT | This keyword is equivalent to the Journal Detail field on the Rule Processor Alert Action(s) III - BiiZ/SIEM panel. You can set a default valueof YES or NO in BBPARM member BBISSP00. When BIIZJRNL=Y is specified in BBISSP00 and the BMC AMI OpsA ALERT is being PUBLISHED to a cell, the messages will be written. You can specify IMFEXEC ALERT BIIZJRNL=N to override the default setting for this ALERT. |
CLASS | Specifies a BMC Impact Manager (BMC IM) event subclass of the default class | This keyword is the same as the Event Class field on the Rule Processor Alert Action(s) III - BiiZ/SIEM panel, and is the name of the variable that contains the event class. The default class is MV_ALERT. The class must be defined to the BMC IM cell and BMC recommends that it be defined as a subclass of the default class. |
PUBLISH | Specifies whether an ALERT is published and how it is published to connected BMC IM cell targets that have subscribed to receive ALERTs through the General Message Exchange (GME) | Possible values are as follows: REPLACE: An ALERT that replaces the ALERT’s QUEUE and KEY name is sent to all BIM cell targets that have subscribed to receive ALERTs from this BMC AMI OpsA BBI-SS PAS. For PATROL EM workstations, if there is already an ALERT with that QUEUE and KEY name specified on a PATROL EM workstation, the original ALERT is deleted before publishing the new ALERT. ADD: An ALERT add is sent to all workstations that have subscribed to receive ALERTs from this BMC AMI OpsA BBI-SS PAS. For PATROL EM workstations, if there is already an ALERT with that QUEUE and KEY name on a PATROL EM workstation, it is not deleted before publishing the new ALERT. ADD is the default. NO: The ALERT is not written to the connected BIM cell workstations even if they have subscribed to receive ALERTs. BMC recommends that ALERTs that specify the same QUEUE name and KEY values are always be published with the same value specified for the PUBLISH parameter. For example, if an ALERT is published with PUBLISH(ADD), it should always be published with PUBLISH(ADD). |
SLOTSTEM | Specifies the BMC IM cell slot names and slot values in REXX stem variables. | This keyword is the name of the stem variables that contain the slot values. Specify a stem root name for the REXX stem variable. Two REXX stem variables are used:
For example, if SLOTSTEM(MYSTEM) is specified, the variable names will resolve to MYSTEM.SLOTNAME. and MYSTEM.SLOTDATA. In addition, these rules apply:
|
TGTPUB | Specifies which BMC IM cell targets to publish a BMC AMI OpsA ALERT to | Use the TGTPUB keyword to enter the TGTNAME that you have specified on the TGTNAME parameter in BBPARM member AAOGMExx. Do not use a BMC IM cell name. The TGTPUB keyword is not required if you want to specify that the ALERT will be published to all connected BIM cells. The TGTPUB keyword is not valid for PATROL EM workstations. In addition, consider the following information:
BMC recommends that ALERTs that specify the same QUEUE name and KEY values are always be published to the same BIM cell targets. |
This section contains the following topics:
Related topic