account ‑add

Creates an account.

SYNOPSIS

account ‑add 
   ‑name account‑name
   ‑role {admin1 | admin2 | monitor | support}
   [‑email email‑address]
   [‑phone phone‑number]
   [{‑enable | ‑disable}]
   [‑fullName full‑name]
   [‑passwordDuration duration‑in‑days]

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

DESCRIPTION

The account ‑add command creates additional accounts. To base a new account on an existing account, run the account ‑list ‑account account-id-or-fqn ‑details command to obtain information about the roles and other settings that are currently defined for the account that you want to replicate.

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

OPTIONS

‑disable

Specifies that the new account is disabled when it is created. If not specified, the account is enabled by default.

‑email

Specifies the email address of the account owner. The Oracle FS System does not verify the validity of the email address.

Important! An email address is required to allow accounts to recover their passwords.

‑enable

Specifies that the new account is enabled when the system creates the account. If not specified, the account is enabled by default.

‑fullName

Specifies the name of the account owner. If the full name contains spaces, enclose the entire name inside double quotation marks. For example: “Tyler Leslie Mendoza”.

‑name

Specifies the name of the account. Use double quotation marks around names containing dashes or spaces.

The following characters are invalid in an account name:

Non-printable characters, including ASCII 0 through 31
/ (slash) and \ (backslash)
. (dot) and .. (dot-dot)
Tabs or spaces

The Oracle FS System removes leading spaces and trailing spaces. Names are case sensitive.

‑passwordDuration

Specifies the number of days that the password that the administrator provides is valid. When the password expires, the Oracle FS System prompts the account user to provide a new password.

‑phone

Specifies the phone number of the account owner. The Oracle FS System does not verify the validity of the phone number.

‑role

Specifies the permissions that are granted to users of the account. To specify permissions, assign one of the following roles:

admin1

Authorizes the administrator to perform the following types of tasks:

Administration
Configuration
Recovery

admin2

Authorizes the administrator to perform all administrative tasks that an admin1 role can perform except for the following tasks:

Create, modify, or delete administrator accounts
Modify Call‑Home settings.
Create, modify, or delete LUNs, File Servers, and filesystems.
Modify system-wide settings.
Modify software configurations
Modify hardware configurations.
Shut down the Oracle FS System.

monitor

Authorizes the administrator to perform read-only tasks and to modify the attributes of their account.

support

Authorizes the administrator to perform support operations as instructed by Oracle Customer Support. This role does not authorize the administrator to modify or delete data resources, system alerts, or administrator accounts.

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

Create a new administrator account.

Parameters

Name of the account: flash_store_admin
Role: admin1
Password duration in days: 180

$ fscli account ‑add ‑name flash_store_admin ‑role admin1 ‑passwordDuration 180