nopclearfail

nopclearfail -n|-c|-f|-S|-r|-M|-O|-I -w -a|-m MODULE

Clear an HSM, put an HSM into the error state, retry a failed HSM, or change the HSM mode.

For information about changing the nShield HSM mode, see

Network-attached HSMs: Checking and changing the mode on a network-attached HSM
nShield Solo and Solo XC: Checking and changing the mode on an nShield Solo module
nShield 5s: nShield 5s modes of operation
USB HSMs: Checking and changing the mode on an nShield Edge

Solo XC only: Reboot the Solo XC, for example after a firmware upgrade, without needing to reboot the host, see Upgrading firmware only.

Option Description

Option	Description
Action selection
`-c`, `--clear`	Can only be executed as privileged user (a user with a privileged connection to the HSM). Sends the `ClearUnit` command to the module.
`-f`, `--fail`	Sends the `Fail` command to the module.
`-I`, `--initialization`	Can only be executed as privileged user (a user with a privileged connection to the HSM). Puts the module into pre-initialization mode.
`-M`, `--maintenance`	Can only be executed as privileged user (a user with a privileged connection to the HSM). Puts the module into maintenance mode.
`-n`, `--no-op`	Sends the `NoOp` command to the module.
`-O`, `--operational`	Can only be executed as privileged user (a user with a privileged connection to the HSM). Puts the module into operational mode.
`-r`, `--retry`	Sends the `RetryFailedModule` command to restore a failed local or remote module and its remote slots, if possible.
`-S`, `--hot-reset`	Performs a hot reset. The module must be in Maintenance mode before you run `nopclearfail` with this option.
Miscellaneous
`-w`, `--wait`	Sends a `NoOp` to the affected modules and waits for a reply before exiting.
Options to address HSMs
`-a`, `--all`	Sends the command to all modules.
`-m`, `--module=MODULE`	Sends the command to module `MODULE`. If you only have one module, `MODULE` is `1`.
Help options
`-h`, `--help`	Displays help for `nopclearfail`.
`-u`, `--usage`	Displays a brief usage summary for `nopclearfail`.
`-v`, `--version`	Displays the version number of the Security World Software that deploys `nopclearfail`.

Action selection

-c, --clear

Can only be executed as privileged user (a user with a privileged connection to the HSM).
Sends the ClearUnit command to the module.

-f, --fail

Sends the Fail command to the module.

-I, --initialization

Can only be executed as privileged user (a user with a privileged connection to the HSM).
Puts the module into pre-initialization mode.

-M, --maintenance

Can only be executed as privileged user (a user with a privileged connection to the HSM).
Puts the module into maintenance mode.

-n, --no-op

Sends the NoOp command to the module.

-O, --operational

Can only be executed as privileged user (a user with a privileged connection to the HSM).
Puts the module into operational mode.

-r, --retry

Sends the RetryFailedModule command to restore a failed local or remote module and its remote slots, if possible.

-S, --hot-reset

Performs a hot reset. The module must be in Maintenance mode before you run nopclearfail with this option.

Miscellaneous

-w, --wait

Sends a NoOp to the affected modules and waits for a reply before exiting.

Options to address HSMs

-a, --all

Sends the command to all modules.

-m, --module=MODULE

Sends the command to module MODULE.
If you only have one module, MODULE is 1.

Help options

-h, --help

Displays help for nopclearfail.

-u, --usage

Displays a brief usage summary for nopclearfail.

-v, --version

Displays the version number of the Security World Software that deploys nopclearfail.