event_notification ‑modify

Changes the event selection criteria for an event notification and changes the list of subscribers subscribed to the event notification.

SYNOPSIS

event_notification ‑modify 
   ‑eventNotification event‑notification‑id‑or‑fqn
   [‑description descriptive‑string]
   [‑recipients email‑address [, email‑address ]... ]
   [‑severity severity:category [, severity:category ]... ]
   [‑name notification‑name]
   [{‑enable | ‑disable}]
   [‑eventType type [, type ]... ]

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

DESCRIPTION

The event_notification ‑modify command requires that you provide the unique ID or fully qualified name (FQN) of the notification to modify. To provide a fully qualified name, specify the name preceded by a forward slash ( / ) character. Run the event_notification ‑list command to obtain a list of the event notifications that are currently defined on the Oracle FS System.

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 ‑modify 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.

‑eventNotification

Specifies the fully qualified name (FQN) of the event notification. The name must be preceded by a forward slash (/). You can also specify the unique ID for the event notification.

‑eventType

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

‑name

Specifies the new name of the event notification. The name that you provide is used to create the fully qualified name (FQN) and replaces the FQN for the event notification that you defined previously. Use double quotation marks around names containing spaces or dashes.

‑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 any combination of severity and category as the threshold for sending event notifications to subscribers. Specify multiple combinations in a comma separated list. Define the combination of 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.

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

Change the list of email subscribers to the facilities manager and the primary Oracle FS System administrator when the temperature in the data center reaches an unacceptable level.

Note: Before running this example, obtain the list of event notifications by running the event_notification ‑list ‑details command. For each event notification, the output returns the email addresses of the subscribers. Using the email address that you are interested in, locate the name of the event notification to which it is associated.

Parameters

The name of the event notification preceded by a forward slash (/⁠) character: /⁠lost-AC
List of subscribers: facilities-IT@mydatacenter.com, OracleFS-admin-IT@mydatacenter.com

$ fscli event_notification -modify ‑eventNotification /lost-AC ‑recipients facilities-IT@mydatacenter.com, OracleFS-admin-IT@mydatacenter.com