system_log ‑collect

Collects system logs and stores them in a log bundle on the Oracle FS System.

SYNOPSIS

system_log ‑collect 
      { ‑all
       |[‑eventLog]
        [‑statistics]
        [‑systemConfig]
        [‑pilot]
        [‑sanhostLogs]
        [‑controllerBackup]
        [‑controllerInMemory]
        [‑controllerLogs]
        [‑replicationAppliance]
        [‑client]      
        [-enclosureLogs]
    }
      [‑controller controller‑id‑or‑fqn [, controller‑id‑or‑fqn ]... ]
      [-enclosure enclosure-id-or-fqn [, enclosure-id-or-fqn]… ]
      [‑sanhost sanhost‑id‑or‑fqn [, sanhost‑id‑or‑fqn]... ]
      [‑sendToCallHome
            [{ ‑logBundle log‑bundle‑id‑or‑fqn [,log‑bundle‑id‑or‑fqn]...
            | ‑previousBundles time‑frame {minutes | hours | days}
            }]
      ]
      [‑withinLastHours number‑of‑hours ]
      [‑collectionReason reason‑description ]
      [‑uploadClientLogsFirst]

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

DESCRIPTION

Your Oracle Customer Support representative might ask you to collect logs and either send them to the Oracle Server or transfer them using My Oracle Support. If your Oracle Customer Support representative does not specify which logs to collect, assume that all are collected. Run the system_log ‑collect ‑all command when instructed to do so.

Note: The private interconnect management (topology) logs are not collected with system logs. The topology logs cannot be collected with any other logs.

Note: Administrators with primary administrator, admin1, admin2, monitor, or support roles are authorized to run the system_log ‑collect command.

OPTIONS

‑all

Collects the following information and creates a log bundle:

Event log
System statistics
System configuration database (Persistence)
Pilot logs
Controller backup data
Controller logs that are stored in memory
Controller logs
Replication appliance logs
Client logs for GUI clients that are currently logged in.

‑client

Specifies that any Oracle FS System Manager (GUI) logs and Oracle FS CLI client logs that have already been uploaded to the Pilot to be included in the log bundle.

‑collectionReason

Specifies a string to describe the reason for collecting the logs. If the string contains spaces, you do not need to enclose the string in double quotes.

Important! If you are collecting logs and transferring them to the Call‑Home server, ensure that there is an existing My Oracle Support (MOS) service request (SR) and enter the number of the SR in this field. This field is required and must contain an SR number when sending logs to the Oracle Call‑Home server so that those logs are properly attached to the MOS SR. Also, ensure that you have enabled Oracle Auto Service Request (ASR).

‑controller

Specifies the fully qualified name (FQN) or the unique identifier (ID) of one or more Controllers for the Oracle FS System.

‑controllerBackup

Collects data from the Controller backup logs.

‑controllerInMemory

Collects the current Controller logs that are stored in memory.

‑controllerLogs

Collects the Controller logs that are backed up and stored in memory.

‑enclosure

Specifies the fully qualified name (FQN) or unique identifier (ID) of the Drive Enclosure from which to collect the logs.

‑enclosureLogs

Collects the logs related to the Drive Enclosure.

‑eventLog

Collects the log of all events that are generated and stored on the Pilot.

‑logBundle

Specifies the fully qualified names or unique IDs of one or more log bundles that were previously collected. Multiple log bundles are specified by using a comma separated list of log bundles.

‑pilot

Collects all logs that are maintained for the software components on the Pilot.

‑previousBundles

Transfers all previously existing log bundles within the specified the -timeframe option. The previous bundles are transferred individually, but their sequence numbers are modified to indicate that they are part of a larger set of log transfers. To specify the time frame, provide a value followed by one of the following labels:

minutes
hours
days

‑replicationAppliance

Collects information from all of the replication appliances that are configured to work with and are currently logged into the Oracle FS System.

‑sanhost

Specifies the IDs or the fully qualified names (FQNs) of one to 10 SAN hosts. Used with the ‑sanhostLogs option.

‑sanhostLogs

Collects logs from up to 10 SAN hosts that are running the Oracle FS Path Manager and are currently logged in to the Oracle FS System.

‑sendToCallHome

Sends the log bundle to the Call‑Home server immediately after collecting the logs.

‑statistics

Requests that the log of system statistics be included in the log bundle.

‑systemConfig

Collects the System Configuration Database and Storage Configuration (Persistence and COD) information.

‑uploadClientLogsFirst

Specifies that FSCLI log files on the client’s computer be first collected and sent to the Oracle FS System for inclusion in the specified set of collected logs using the ‑client option.

‑withinLastHours

Restricts the log information to collect from the logs to the specified number of hours before the present time.

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

Oracle Customer Support has instructed you to collect all of the system logs that the Oracle FS System captured within the last two hours.

Parameters

Number of hours: 2

$ fscli system_log -collect ‑withinLastHours 2