appliance-cli

Enables certain appliance administration or status commands. All operations require a privileged client (by default, that means an elevated command-prompt on Windows or membership of the nfast group on Linux). Operations run against a remote module additionally require that the module has been enrolled as privileged in the local hardserver.

appiance-cli supports remote administration of nShield Connect and nShield 5c devices, in addition to enabling certain administration or status commands to be made available to privileged clients running in guest VMs that have access to nShield SoloXC or nShield 5s local HSMs running on the host machine over nCipher Secure Transport/Impath.

Appliance command Action

expirehsmlog

Expire signed nShield 5 HSM syslogs

exporthsmlog

Get signed nShield 5 HSM syslogs

gethsmlog

Get nShield 5 HSM syslogs

gethsmlogkey

Get nShield 5 HSM syslog signing key

getservcfg

Get server config file

getservlog

Get server logs

Module selection

-m, --module=MODULE

Specifies the number ID to use.
If you only have one module, MODULE is 1.
If you do not specify a module ID, appliance-cli uses all modules by default.

Help options

-h, --help

Displays help for appliance-cli.

-u, --usage

Displays a brief usage summary for appliance-cli.

-v, --version

Displays the version number of the Security World Software that deploys appliance-cli.