volume_group add

Creates a new volume group and adds it to the Oracle FS System.

SYNOPSIS

volume_group ‑add 
   ‑name name
   [‑in parent‑id‑or‑fqn]

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

DESCRIPTION

Use the volume_group ‑add command to create a volume group. Volume groups allow you to organize logical volumes into organizational units. You can create volume groups in the root volume group of the Oracle FS System to create a broad, shallow grouping of volume groups. Alternatively, you can create one or more volume groups within an existing volume group to create a nested hierarchy of volume groups.

Note: Only administrators with primary administrator or admin1 roles are authorized to run the volume_group -add command.

OPTIONS

in

Specifies the ID or fully qualified name (FQN) of the parent volume group for the new volume group. If omitted, this command creates a volume group by default at the root level, which is designated by the forward slash (/) character. If you do not set a volume group, any LUN or file system would be created in this default volume group.

name
Specifies the name of the volume group that you are defining on the Oracle FS System. The name that you provide must be between from 1 through 40 characters. The name that you provide is used to create the fully qualified name (FQN) after the Oracle FS System creates the volume group. Use double quotation marks around names containing one or more spaces or dashes to ensure that the Pilot software handles the spaces or dashes correctly. The following characters are invalid in a volume group name:
  • Non-printable characters, including ASCII 0 through 31, decimal

  • / (slash) and \ (backslash)

  • . (dot) and .. (dot-dot)

  • Embedded tabs

Note: The volume_group ‑add command fails:
  • If the Oracle FS System already contains a volume group with the specified name

  • If you specify a parent that does not exist 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-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

Create a volume group in a parent volume group on the Oracle FS System.

Parameters
  • The name of the volume group: user1_vg

  • The name of the parent volume group: /⁠all_users

$ fscli volume_group -add -name user1_vg ‑in /⁠all_users