event_log list

Displays a list of events or types of events.

SYNOPSIS

event_log ‑list 
   [‑details]
   { ‑eventTypes
   | [‑severity severity‑value [, severity‑value ]... ]
     [‑before date‑time [‑startingIndex starting‑event‑index]]
     [‑after date‑time]
     [‑eventType event‑type]
     [‑category category‑value [, category‑value]... ]
     [‑eventCount number‑of‑events]
     [‑internal]
   }

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

DESCRIPTION

The event_log ‑list command returns a listing of Oracle FS System events.

You can list a block of events by specifying the index of the first log entry and the number of log entries following the first log entry that meet your selection criteria. Use -before with ‑startingIndex to specify the starting point to ensure that new events that are being generated do not effect the results. Then use ‑eventCount to specify the number of log entries. Combined, the values that you specify for the ‑startingIndex option and the ‑eventCount option determine the ending index.

To reduce the number of events that are displayed, run the event_log ‑list command with any combination of options. By choosing various option combinations, you can filter the output based on the following selection criteria:
  • Events by severity: informational, warning, or critical

  • Events that were logged after a start date

  • Events that were logged before an end date

  • Events of the specified type

  • Events by category: security, audit, or system

  • A limited number of events

  • Internal system events that are not generated by administrators

The event_log ‑list ‑eventType command lists all event types that can be generated on the system. To display only the events of a specific type, select an event_type from the list of possible event types, and pass it into the event_log ‑list ‑eventType event_type command. In addition to the name of the event, specifying the ‑details option returns the following additional information for each event type:
  • Category

  • Severity

  • Short Description

  • Long Description

Note: An Oracle Customer Support representative might request that you capture the output of the event_log ‑list ‑details command in a file. Do not filter or reduce the size of the output that you generate.
Note: Administrators with primary administrator, admin1, admin2, monitor, or support roles are authorized to run the event_log list command, except for the ‑internal option. Only administrators with support roles are authorized to use the ‑internal option.

OPTIONS

after
Requests events that were posted after the specified date and time. Use Coordinated Universal Time (UTC). Specify the before timestamp by using the YYYY-MM-DD[THH[:mm[:SS[.xxx]]]][+-HH:mm] format. The T character is a literal character that separates the date portion of the timestamp from the time portion. The SS characters indicate seconds and the xxx characters indicate milliseconds. The colon (:) and period (.) characters are required characters.
Important! The system interprets the request to be inclusive. For example, if you request events after 2015-03-18T10:10:10.000, the system returns any event that occurred exactly at that time or at any time afterward.
before
Requests events that were posted before the specified date and time. Use Coordinated Universal Time (UTC). Specify the before timestamp by using the YYYY-MM-DD[THH[:mm[:SS[.xxx]]]][+-HH:mm] format. The T character is a literal character that separates the date portion of the timestamp from the time portion. The SS characters indicate seconds and the xxx characters indicate milliseconds. The colon (:) and period (.) characters are required characters.
Important! The system interprets the request to be inclusive. For example, if you request events before 2015-03-18T10:10:10.000, the system returns any event that occurred exactly at that time or at any time beforehand.
category
Displays events that fall within one of the following categories:
  • Security

  • Audit

  • System

details

Displays the details of each event or event type.

eventCount

Limits the number of events returned to the value specified. The most recent events are returned first.

eventType

Displays the events in the event log that match the specified event type.

eventTypes

Displays a list of all known event types. If used with the ‑details option, the ‑eventTypes option also displays a description of each event.

internal

Displays internal system events.

Note: Only administrators with support roles are authorized to run the event_log ‑list ‑internal command.
severity
Displays events that have one of the following severity levels:
Critical

Requires prompt action to prevent system failures or offline conditions.

Informational

Requires no action for events that are information only.

Warning

Requires no immediate action for minor conditions that you can address at your convenience.

If not specified, displays events of all severities.
startingIndex

Defines a position within the event log from which to start listing events. Set the position by counting backwards in time. The most recent event has the starting index value of 1. You must use ‑startingIndex with the ‑before option to avoid dropping events from an event log request while new events are being generated.

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-useroracleFS 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
Save a log of the summarized events to a local file.
Note: For each event, the summarized output contains the following types of information:
  • The severity of the event.

  • The timestamp of the event in Universal Coordinated Time (UTC).

  • The name of the event.

  • A short description of the cause of the event.

Parameters
  • Local filename: Oracle_FS_events_2013.08.07

$ fscli event_log ‑list > Oracle_FS_events_2013.08.07