The nzstate command
Use the nzstate command to display the current system state or to wait for a particular system state to occur.
Syntax
The nzstate command
uses the following syntax:
nzstate [-h|-rev|-hc] subcmd [subcmd options]]
Inputs
The nzstate command
takes the following inputs:
| Input | Description |
|---|---|
| nzstate listStates | Displays the system states and a description. |
| nzstate show options | Displays the current state. This is the default if you type the command without any arguments. |
| nzstate waitFor options | Waits for the system to reach the specified state. You cannot wait for a state that ends in -ing. |
Options
The nzstate command
takes the following options:
| Command | Option | Description |
|---|---|---|
| nzstate listStates | Takes no options. | |
| nzstate show | -u user | Specifies the database user name [NZ_USER]. |
| -pw password | Specifies the user password [NZ_PASSWORD]. | |
| -host name | Specifies host name or IP address [NZ_HOST]. | |
| -timeout secs | Specifies the number of seconds to wait for the command to complete before it exits with a timeout error. The default is 300. | |
| -terse | Prints only the current state symbol. | |
| -verbose | Prints the expected state if it is different from the current state. | |
| -reason | Displays more information about why the system is in the Down state. | |
| nzstate waitFor | -type state_type | Waits for the specified state to occur. Use the listStates subcommand to display the state types. |
| -u user | Specifies the database user name [NZ_USER]. | |
| -pw password | Specifies the user password [NZ_PASSWORD]. | |
| -host name | Specifies host name or IP address [NZ_HOST]. | |
| -timeout secs | Specifies the number of seconds to wait for the command to complete before it exits with a timeout error. The default is 300. |
Description
The nzstate command
does the following:
- Privileges required
- You do not need special privileges to run the nzstate listStates command. You must specify a database user account to show or wait for states.
- Common tasks
- Use the nzstate command to display the current state.
Usage
The following provides
sample usage
- To list the states, enter:
nzstate listStates State Symbol Description ------------ ------------------------------------------------------------ initialized used by a system component when first starting paused already running queries will complete but new ones are queued pausedNow like paused, except running queries are aborted offline no queries are queued, only maintenance is allowed offlineNow like offline, except user jobs are stopped immediately online system is running normally stopped system software is not running down system was not able to initialize successfully - To show the current state, enter:
nzstate show -u user -pw password -host nzhost -verbose - To wait for the offline state until the state change occurs or
the command timer expires, enter:
nzstate waitFor -u user -pw password -host nzhost -type offline - To display more information about a system that is in the down
state, enter:
nzstate -reason The system is DOWN because failing over SPUs results in invalid topology