drive_group list

Returns information about the drive groups, and, optionally, returns the health and status of each of the drives in the drive groups.

SYNOPSIS

drive_group ‑list 
   [‑details]
   {[‑misplacedDriveGroups]
   |
    [‑driveGroup drive‑group‑id‑or‑fqn [,drive‑group‑id‑or‑fqn]...]
    [{ ‑unassigned
     | ‑persistenceDriveGroup
     | ‑offlineVolumes drive‑group‑id
     }]
    [‑dataConsistency]
   }

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

DESCRIPTION

Run the drive_group ‑list command to list all of the drive groups in the Oracle FS System. The output of the drive_group ‑list ‑details command reports the following information:
  • The Drive Enclosure that is associated with each drive group.

  • The total capacity of each drive group.

  • The status of each drive in the drive group.

Administrators with primary administrator, admin1, admin2, monitor, or support roles are authorized to run this command.

OPTIONS

dataConsistency

Displays data consistency information of the specified drive group.

details

Returns detailed configuration and state information for the specified drive groups.

driveGroup

Specifies the fully qualified name (FQN) or the unique identifier (ID) of the drive group. When a Drive Enclosure is added to the Oracle FS System, the system automatically allocates the storage by generating one or more drive groups. The drive_group ‑list command displays the names of all drive groups that are defined on the Oracle FS System. The FQN consists of the name that the system generates preceded by a forward slash (/) character.

misplacedDriveGroups
Returns a list of drive groups that are misplaced. A misplaced drive group results when all of the following conditions occur:
  • Data exists in flash-backed memory that belongs to the drive group.

  • The system is not cleanly shut down.

  • The Drive Enclosure in which the drive group is configured is moved to a different Drive Enclosure string or the drives in the drive group are moved to another Drive Enclosure that is on a different Drive Enclosure string.

  • The Oracle FS System restarts, but the system cannot locate the drive group on the original string.

offlineVolumes

Displays a list of any offline SAN LUNs that reside on compromised drive groups.

persistenceDriveGroup

Displays the drive group that is holding Persistence data.

unassigned

Displays any drive groups that are not assigned to a storage domain. If all of the drive groups are assigned, the command returns without displaying any output.

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

Display a list of drive groups with details about the drives that are in the drive group.

Parameters
  • None

$ fscli drive_group ‑list ‑details