Saves the topology configuration information and related logs to the designated location.
SYNOPSIS
topology ‑download
‑topoMap topomap‑file‑name
[{‑sessionKey | ‑u admin‑user ‑oracleFS oracle‑fs‑system}]
[{‑outputformat | ‑o} { text | xml }]
[{‑timeout timeout‑in‑seconds | ‑verify | ‑usage | ‑example | ‑help}]
DESCRIPTION
The topology configuration is stored in an internal database, along with other related log files. The database, which is located on the master Controller, stores the current topology and up to three previous topology states. Use the topology ‑download command to download and to save the information to a file and a location of your choice. The file format is human-readable ASCII text. The output can be specified by full path and file name or just file name. If only a file name is specified, the file is saved to the FSCLI directory.
If problems occur during the file creation, the system creates a second file that lists the errors that are associated with the download. The file name will be the same as the db-logs-file-name value with Errors- prepended to that name. If a path is specified for the db-logs-file-name, the errors file is placed in that path. If a path is not specified, the errors file is placed in the FSCLI directory with the db-logs-file-name.
Note: Only administrators with primary administrator, admin1, admin2, or support roles are authorized to run this command.
OPTIONS
- ‑topoMap
Returns the topology configuration information that is stored in an internal database. The database, which is located on the master
Controller, stores the current topology and up to three previous topology states. The database also stores all of the issues that are related to the hardware components (including the cabling) and all of the automated actions that were taken to resolve those issues.
Note: In cases where a topology change is at a very low level , the configuration information that is returned for one topology state can appear to be identical to another topology state.
The system empties and re-initializes the internal topology database when the master Controller is restarted or when a new master Controller is selected.
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 }
Has no effect on the output format. The ‑outputformat option is included for consistency across all subcommands.
For the topology ‑download ‑topoMap command, the output format is always simple text.
- ‑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
To assist with a topology evaluation, Oracle Customer Support instructs you to download health and status information for the components that comprise the Backend SAS Interconnect.
- Parameters
-
$ fscli topology ‑download ‑topoMap topology0905.txt