system ‑list

Displays system information.

SYNOPSIS

system ‑list 
   [‑details]
   [‑storage]
   [‑productDetails ]
   [‑ssh]
   [‑status]

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

DESCRIPTION

Running the system ‑list command with no options displays the following information:

The operating status and software build number of the Oracle FS System
The operating status and software build number of each component in the Oracle FS System
The available and used storage capacity of the Oracle FS System
The system properties that are set by the system ‑modify command and the system ‑network command.

Running the system ‑list command with options displays the following types of information:

Storage information
Product details
Secure shell status
Network availability status
Password settings

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

OPTIONS

‑details

Returns detailed configuration and state information for the specified Oracle FS System components.

‑productDetails

Displays the following Oracle FS System product information:

Software build number
Pilot operating system version
Model number

‑ssh

Displays the SSH status of true if SSH is enabled, and false if SSH is disabled. Additionally displays the following SSH status information if SSH is enabled and the ‑details option is also specified:

start time: Timestamp of when SSH began normal operations.
duration: Amount of time that SSH had been running without disruption.
enabled: Indicates whether SSH is enabled.

‑status

Displays the name and status of the Oracle FS System. When the Oracle FS System is starting up, this option displays the software component that is currently being initialized in the STATUS field. If a non-zero code is returned when you issue a system ‑list ‑status command, it indicates that the Oracle FS System is offline and data services are unavailable.

‑storage

Displays a summary of used, available, and reclaimed storage on the Oracle FS System.

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

Display the operating status of the Oracle FS System, display system information, and display network information.

Parameters

None

$ fscli system -list