event_notification ‑add

Adds an event notification entry to the Oracle FS System event notification service.

SYNOPSIS

event_notification ‑add 
   ‑name notification‑name
   [‑description descriptive‑string]
   ‑recipients email‑address [, email‑address ]...
   [‑severity severity:category [, severity:category ]... ]
   [‑eventType type [, type ]... ]
   [{‑enable | ‑disable}]

   [{‑sessionKey | ‑u admin‑user ‑oracleFS oracle‑fs‑system}]
   [{‑outputformat | ‑o} { text | xml }]
   [{‑timeout timeout‑in‑seconds | ‑verify | ‑usage | ‑example | ‑help}]

DESCRIPTION

The subscribers of the Oracle FS System event notification service receive event notifications when a predefined system event occurs. The severity threshold of an event is determined by specifying the event severity and category.

The events that are classified as critical or warning can occur for the following reasons:

The Oracle FS System encounters a predefined error condition.
The Oracle FS System has encountered an environmental problem.
The storage management thresholds have been reached.

Informational events include all normal system and administrator activities on the Oracle FS System that do not cause the system to be in a warning or critical condition.

Note: Providing a severity level is optional. The default is informational. Specify the least critical event severity that you are interested in. For example, setting the severity level to informational indicates that the subscribers will also receive notifications of warning and critical conditions. However, the subscribers will also receive almost every event generated by the system.

To define the type of events to send to specified subscribers, run the event_notification ‑add command. At a minimum, provide the following information:

The name of the event notification
A list of subscriber email addresses

To obtain a list of events that can be generated by the Oracle FS System, run the event_log ‑eventTypes command.

Note: Only administrators with primary administrator or admin1 roles are authorized to run the event_notification ‑add command.

OPTIONS

‑description

Specifies a string of up to 256 characters as the description of the event notification. Enclose the descriptions that contain more than one word in quotation marks. The default description is the name of the event notification.

‑disable

Disables the event notification service from sending the event notification to the registered subscribers.

‑enable

Enables the event notification service to send the event notification to the registered subscribers.

‑eventType

Specifies one or more event types in a comma separated list.

‑name

Specifies the name of the event notification that you are setting up on the Oracle FS System. The name that you provide is used to create the fully qualified name (FQN) after the Oracle FS System creates the new event notification. Use double quotation marks around names containing dashes or spaces.

‑recipients

Specifies the email addresses of one to four subscribers or externally defined mailing lists to which the Oracle FS System sends the event notification. Provide the email addresses in a comma separated list.

‑severity

Specifies a combination of event severity and category. Any combination is allowed. Multiple combinations are specified in a comma separated list. Specifes the severity and category in the format of severity:category.

Severity levels

Critical: Requires prompt action to prevent system failures or offline conditions.
Warning: Requires no immediate action for minor conditions that you can address at your convenience.
Informational: Requires no action for events that are information only.

Categories

Security: Events to notify of a security problem, such as an unauthorized request.
Audit: Events that keep track of what administrators are doing, such as the operations that they performed.
System: Events to notify of system problems, such as a missing Drive Enclosure or Controller.

For each severity level, specify one of the following event categories:

If you do not define a severity:category pair, notifications of all events are sent to the specified recipients.

GLOBAL OPTIONS FOR SUBCOMMANDS

The following global options can be used for fscli command-subcommand pairs that do not include other command-line options:

‑help: Returns the context-sensitive help for the specified subcommand.
‑usage: Returns the subcommand syntax for the given command, including all of the options that are available for the command-subcommand pair.

GLOBAL OPTIONS FOR COMMANDS

The following global options can be used for fully formed fscli commands:

‑example

Returns sample output from the specified command.

Note: To see the output in XML format, include the ‑o xml option.

‑timeout timeout-in-seconds

Specifies the length of time (timeout-in-seconds) that the command line interface waits before another command is allowed to run. If the command takes longer to run than the specified time limit, the system continues processing the command, but the command prompt is made available so that you can issue another command. If the -timeout option is omitted, the command line interface blocks until the one of the following conditions is met:

The command completes successfully.
The command returns with an error.
The session times out.

Note: Be sure to check the state of the system after initiating a long running command with the ‑timeout option. Many fscli commands run a series of underlying commands in sequence. When the timeout value is reached before all of the underlying commands have completed, the fscli command does not complete with the outstanding tasks reporting a failure status.

‑outputformat | ‑o { text | xml }: Controls the type of the output the system returns from a command. If the ‑outputformat option is not included, the format of the output defaults to simple text. If xml is provided, the output is a collection of XML elements.
Note: For XML output, if internal errors occur during command execution, each error is included in a separate <ErrorList> tag.

‑verify: Inspects the validity of the command syntax, not the semantics. Used to test the structure of a command without running the command. Does not determine whether errors would be produced if you issue a structurally correct command with the input provided.
‑sessionkey: Directs the CLI to prompt you to supply a session key when you issue the command. The CLI displays Sessionkey: as the prompt. To obtain a session key, log in with the ‑returnKey option specified. After the session is established, the session key is displayed in STDOUT. If you request a session key, the ‑sessionkey option is required syntax for all commands that are issued in a given session. In environments with more than one Oracle FS System, the session key is used to determine to which Oracle FS System to direct the command for validation. Session keys are also used to establish two or more CLI sessions when using a shared administrator account.
‑u admin-user ‑oracleFS oracle‑fs-system: Routes the command to a particular Oracle FS System for execution. This option passes the name of the administrator account to use when opening the session on the specified system. Identify a specific Oracle FS System by its IP address or by the name that is recorded in the domain name system (DNS). When logging in to the Oracle FS System using the ‑u option and the ‑oracleFS option, the fscli application prompts you for a password on the command line interface for access. The Oracle FS System and the account login information are used to authenticate the current session. Establishing a login session by specifying an Oracle FS System and an account does not change the credentials that are associated with the active sessions that are running on other clients.
Caution
Oracle recommends that you not use the Cygwin command line interface to run the fscli application on Windows platforms. If you are running the Cygwin interface and include the ‑u option as a part of the ‑list subcommand, the password for the specified account is included in the results. Exposing the password can cause a breach in security.

EXAMPLE

Task

Configure the system to send an email to the facilities manager if the internal temperature of the Oracle FS System rises to an unacceptable level.

Note: Run the event_log ‑list ‑eventTypes command to list the types of events that Oracle FS System generates. Inspect the list of event types to determine which ones report problematic environmental conditions.

Note: For the facilities manager to receive the event notification, the SMTP server must be running. Configure the environment so that the SMTP server and the network switches or routers are protected by an uninterruptable power supply (UPS) and are in a different physical location than the Oracle FS System.

Note: To define the behavior of the SMTP server that the event notification service uses to send event notifications to subscribers, run the system -modify command. Specify the following information:

The IP address of the SMTP server.
The port number that the SMTP server uses to receive event notifications from the Oracle FS System.
The email domain name.
The email flood interval.

Parameters

The name of the event notification: lost-AC
A description: The air conditioning system is not working properly. Facilities alerted.
The email address of the facilities manager: facilities-IT@mydatacenter.com
A list of event types:
- PSG_DMS_EVENT_THERM_WARN
- PSG_DMS_EVENT_THERM_WARN_LONG
- PSG_DMS_EVENT_THERM_CRIT

$ fscli event_notification -add ‑name lost-AC ‑description "The air conditioning system is not working properly. Facilities alerted." ‑recipients facilities-IT@mydatacenter.com ‑eventType PSG_DMS_EVENT_THERM_WARN, PSG_DMS_EVENT_THERM_WARN_LONG, PSG_DMS_EVENT_THERM_CRIT