system shutdown

Stops the data paths, writes the data from the Controller memory to permanent storage, and then places the Oracle FS System in shutdown status. The system should always be placed in shutdown state before the system is powered down. The Oracle FS System continues to monitor system status, and issues alerts and call homes if needed. The system does not permit data access until it is restarted.

SYNOPSIS

system ‑shutdown 
   { [‑overridePinnedData]
     [‑overrideDisabledControllers]
     [‑overrideOperationPoolDraining]
     [‑overrideStateCheck]
     [‑serviceType {san}]
     [‑resetModePages]
   |
     [‑ip ip‑address]
     [‑netmask netmask]
     [‑gateway gateway]
     [‑nameServer dns‑ip1 [, dns‑ip2]... ]
     [{‑enableDhcp | ‑disableDhcp}]
     [‑duplex {auto | 100f | 1000f | 10fGig}]
     [‑pilot1Ip pilot1‑ip‑address]
     [‑pilot2Ip pilot2‑ip‑address]
   }

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

DESCRIPTION

During a system shutdown, the Oracle FS System writes to the storage arrays any data that is stored in cache. After this operation completes, the data is said to be flushed. Any data that was not written to the storage arrays is said to be pinned. The default behavior is for the Oracle FS System to cancel the system ‑shutdown command with an error when the Oracle FS System discovers any pinned data.

You can identify the reason why data was not written to disk:
  • In a SAN environment, inspect the output of the lun ‑list ‑details ‑bs ‑volumeGroup volume group id command.

After addressing the cause of any detected pinned data, run the system ‑shutdown command. To restart without attempting to write any remaining pinned data to disk, run the system ‑shutdown ‑overridePinnedData command.

Note: Only administrators with primary administrator or support roles are authorized to run the system ‑shutdown command. Only administrators with support roles are authorized to use the following options of the system ‑shutdown command:
  • ip

  • netmask

  • gateway

  • nameServer

  • enableDhcp

  • duplex

  • pilot1Ip

  • pilot2Ip

OPTIONS

disableDhcp

Disables the Dynamic Host Configuration Protocol (DHCP).

duplex
Sets the speed requirements and the duplex requirements for the Oracle FS System. The default value is auto.
Important! Do not change the default value unless you are connecting to a switch that is known to have problems with auto-negotiation. Manually setting the duplex to an incompatible speed can cause the Oracle FS System to become unreachable on your network.
Valid options:
  • auto – Determined by the Oracle FS System.
  • 100f – Full 100 Mbps
  • 1000f – Full 1000 Mbps
  • 10fGig– Full 10 Gbps
enableDhcp

Specifies whether the Dynamic Host Configuration Protocol (DHCP) is enabled. The DHCP protocol can be enabled for the public management interface only.

gateway

Assigns the IP address of the gateway network node in the subnetwork of which the Oracle FS System (the Pilot) is a member.

ip

Identifies the public or the shared IP address that is assigned to the Pilot. This IP address is what the administrator uses to access the Oracle FS System over the management interface.

nameServer

Identifies the IP addresses of the Domain Name Servers (DNS) that are used by the Pilot to resolve the IP addresses in an ordered comma separated list, starting with the primary server.

netmask

Specifies the subnetwork mask for the static IP address that is permanently assigned to the Oracle FS System.

overrideDisabledControllers

If there is a disabled Controller the system does not perform a normal shutdown. This option allows the system to be restarted. The status of the disabled Controller may or may not change on the resulting restart.

overrideOperationPoolDraining

Restarts the Oracle FS System without completing any pending management operations.

overridePinnedData
If there is pinned data, it does not stop the process of restarting the system. The pinned data that cannot be written to physical storage is discarded.
Important! Contact Oracle Customer Support to resolve any issues with the Backend SAS Interconnect, a storage condition, or both, which might be causing the pinned data. Clearing pinned data guarantees that host data is deleted permanently.
overrideStateCheck

Ignore the state of the system and continue with the shutdown operation.

pilot1Ip

Specifies the static IP address that is assigned to Pilot 1.

pilot2Ip

Specifies the static IP address that is assigned to Pilot 2.

resetModePages
Requests that the mode pages be reloaded on all of the drives. If an administrator has disabled the reload mode pages flag, the system ignores the resetModePages option.
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.
serviceType

Specifies the type of protocol that the Oracle FS System supports: san. The correct service type for your system is specified on the Sales Order and the System Customer Information Documents and should not be changed. If the installed hardware in the Controllers does not allow the changed service type, the system will not boot. Modify the service type only as instructed by Oracle Customer Support.

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

Shut down the Oracle FS System.

Parameters
  • None

$ fscli system -shutdown