Displays the Call‑Home settings.
SYNOPSIS
call_home ‑list
[‑details]
[‑settings]
[‑matrix]
[{‑sessionKey | ‑u admin‑user ‑oracleFS oracle‑fs‑system}]
[{‑outputformat | ‑o} { text | xml }]
[{‑timeout timeout‑in‑seconds | ‑verify | ‑usage | ‑example | ‑help}]
DESCRIPTION
When the
call_home ‑list command is used without additional options, the
Oracle FS System displays all of the information about the
Call‑Home settings and the
Call‑Home matrix. The information includes the following items:
Event and periodic trigger options
Periodic schedules
Number of events to include in each Call‑Home bundle
Call‑Home destination server name
Call‑Home matrix version and format
Proxy configuration, if enabled
Use the ‑settings option to display only Call‑Home settings. Use the ‑matrix option to display only Call‑Home matrix details.
Note: Administrators with primary administrator, admin1, admin2, monitor, or support roles are authorized to run the call_home ‑list command.
OPTIONS
- ‑details
-
Provides no additional information. This option is included for consistency across all subcommands.
- ‑matrix
Displays the version and the format of the Call‑Home matrix.
If the ‑matrix option and the ‑settings option are both omitted, the information for both options is displayed.
- ‑settings
Displays all of the Call‑Home settings except for the password that is associated with the user account on the local destination server.
If the ‑matrix option and the ‑settings option are both omitted, the information for both options is displayed.
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:
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 a list of all the Call‑Home settings and Matrix information that exists on the Oracle FS System.
- Parameters
-
$ fscli call_home ‑list