system ‑modify

Changes various system properties, including those that provide password recovery capability.

SYNOPSIS

system ‑modify 
   [‑name system‑name]
   [‑description oracle‑fs‑system‑description]
   [‑location system‑location]
   [‑contactName contact‑name]
   [‑contactPhone contact‑phone]
   [‑assetNumber asset‑number]
   [‑sessionTimeout timeout‑in‑minutes]
   [‑maximumFailedLogins maximum‑failed‑login‑attempts]
   [‑messageOfTheDay message‑of‑the‑day]
   [{‑enableEmail | ‑disableEmail}]
   [‑smtpServerIp smtp‑server‑ip_or_dns]
   [‑smtpServerPort smtp‑server‑port‑number]
   [‑emailDomain email‑domain]
   [‑emailFloodInterval flood‑prevention‑interval‑seconds]
   [{‑enableSsh enable‑duration‑in‑minutes] | ‑disableSsh}]
   [{‑conservativeMode | ‑performanceMode}]
   [‑storageClassCost {capDisk | perfDisk | perfSsd | capSsd}
        [‑perIop cost‑per‑iop]
        [‑perGigabyte cost‑per‑gigabyte]
        [‑relativeLatency relative‑latency]
   ]
   [{‑enableReloadModePages | ‑disableReloadModePages }]

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

DESCRIPTION

The Oracle FS System is pre-configured with default property values. To customize the Oracle FS System to accommodate the needs of your data center, run the system ‑modify command to provide meaningful values for the following categories of system properties:

Identifying information associated with the Oracle FS System such as asset number, system name, system owner, and similar details.
Properties that manage administrator accounts and manage administrator sessions
Simple Mail Transfer Protocol (SMTP) settings
Flag to enable secure shell (SSH) access to the Pilot
Performance optimization settings

To define the configuration of your network, run the system ‑network command. To display the values for the system parameters that are set by running the system ‑modify command or by running the system ‑network command, run the system ‑list command.

Note: To specify how the SMTP server sends emails to the event service subscribers, use the system ‑modify command. To define the behavior of the event service and to manage its subscribers, use the event_notification ‑add command and the event_notification ‑modify command.

Note: Only administrators with primary administrator or admin1 roles are authorized to run the system -modify command. To run the following options of the system -modify command, additional privileges are required:

Only administrators with support roles are authorized to run the enableReloadModePages and disableReloadModePages options.
Only administrators with primary administrator or admin1 roles are authorized to run the enableSsh and disableSsh options.
Only administrators with primary administrator, admin1, admin 2, or support roles are authorized to run the conservativeMode and performanceMode options.

OPTIONS

‑assetNumber: Specifies a asset number that is relevant in your inventory system. If not specified, the default is Unknown.
‑conservativeMode: Disables all caching and flushes existing cached data to physical storage. The system continues to serve data, but performance is diminished.
‑contactName: Specifies the primary contact who is responsible for the system. This name is not necessarily associated with any user accounts. If a contact name contains spaces, enclose the entire name in quotation marks. If not provided, the default is Unknown.
‑contactPhone: Specifies the phone number of the system owner. The string is not validated as a true phone number. If not provided, the default is Unknown.
‑description: Specifies a string of up to 256 characters as the description of the Oracle FS System. Enclose the system descriptions that contain more than one word in quotation marks. The default description is Unknown.
‑disableEmail: Disables the Oracle FS System from sending event notification emails.
‑disableReloadModePages: Specifies that the drive mode pages should not be reloaded during the next system restart operation. If not specified, reloading drive mode pages is disabled by default.
Note: A drive mode page contains changeable values that are stored on a drive as part of the drive firmware. Do not reload or reset drive mode pages unless you are instructed to do so by Oracle Customer Support. Reloading or resetting drive mode pages increases the time that is needed to restart or to shut down the system.

Note: Only administrators with support roles are authorized to run the ‑disableReloadModePages option of the system -modify command.
‑disableSsh: Disables secure shell (SSH) access to the Oracle FS System.
‑emailDomain: Specifies the domain name for the email that is automatically generated by the Oracle FS System for email alert notifications. The default value is oraclefsalerts.
‑emailFloodInterval: Specifies the interval, in seconds, that the Oracle FS System waits before sending event notification emails to the administrator for the same event.
‑enableEmail: Enables the Oracle FS System to send emails to one or more subscribers of the event notification service.
‑enableReloadModePages: Requests that the drive mode pages be reloaded during the next system restart operation.
Note: A drive mode page contains changeable values that are stored on a drive as part of the drive firmware. Do not reload or reset drive mode pages unless you are instructed to do so by Oracle Customer Support. Reloading or resetting drive mode pages increases the time that is needed to restart or to shut down the system.

Note: Only administrators with support roles are authorized to run the ‑enableReloadModePages, option of the system -modify command.
‑enableSsh: Enables SSH access to the Oracle FS System for the specified amount of time in minutes.
‑location: Specifies the location of the Oracle FS System. Enclose location descriptions that contain spaces in quotation marks. If not provided, the default is Unknown.
‑maximumFailedLogins: Specifies the number of failed login attempts allowed before the account is disabled. The default value is five login attempts.
‑messageOfTheDay: Specifies up to 256 characters that are displayed as the message of the day before the administrator logs into the Oracle FS System GUI or CLI. Enclose the message in quotation marks.
‑name: Sets the name of the Oracle FS System. Enclose the system names that contain spaces in quotation marks. Example: “Flash_Store 01”. If not set, the default name is Default Name.
‑performanceMode: Removes the conservative mode and returns the Oracle FS System to normal caching.
‑perGigabyte: Specifies the cost per gigabyte for the Storage Class that is identified by the ‑storageClassCost option. This cost is reflected as USD (US $) in the auto‑tiering effectiveness reports that are generated by Oracle FS System Manager (GUI).
‑perIop: Specifies the cost per I/⁠O for the Storage Class that is identified by the ‑storageClassCost option. For example, if a drive costs 100 USD (US $) and the rating for the drive is 100,000 I/⁠O operations per second, you can enter 0.001 for ‑perIop.
Note: This cost is reflected as USD (US $) in the auto‑tiering effectiveness reports that are generated by Oracle FS System Manager (GUI).
‑relativeLatency: Specifies a relative latency value for the Storage Class that is identified by the ‑storageClassCost option. Typically, you first assign a value of 1 to a selected Storage Class that can act as a reference point for all other Storage Classes. Then, you can assign a specific latency value to each of the other Storage Classes, which allows you to compare the latency of any given Storage class to the latency of any other Storage Class.
‑sessionTimeout: Specifies that amount of time a session can be idle before the session is automatically logged off by the Oracle FS System. The default value is 20 minutes.
Note: The sessionTimeout option sets the time out value for all sessions, including the Oracle FS System Manager GUI sessions.
‑smtpServerIp: Specifies the IP address or DNS name of the Simple Mail Transfer Protocol (SMTP) relay host for the Oracle FS System to use for sending out password recovery tokens and event notification emails to subscribers.
‑smtpServerPort: Identifies the port number of the SMTP relay host used to send emails to registered users of the event notification service.
‑storageClassCost: Specifies the type of physical media (the Storage Class) with which the cost information is to be associated. The cost information is used when creating the auto‑tiering effectiveness reports that are generated by Oracle FS System Manager (GUI).

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

Enable the Oracle FS System to send event notifications by email to the subscribers of the event notification service.

Parameters

IP address: 192.23.110.2
SMTP server port number: 25
Domain name server:flash_system_events
Flood interval: 10 seconds

$ fscli system -modify ‑enablemail ‑smtpServerIp 192.23.110.2 ‑smtpServerPort 25 ‑emailDomain flash_system_events ‑emailFloodInterval 10