Getting to know the tools

This document relies on csadm Help=<command> throughout, as the syntax or capability of a given tool or command may change based on which version of the SecurityServer you are using. For brevity, this is generally shown as csadm <command>`, the Help= is assumed.


csadm Help
csadm Help=BackupDatabase


Keep in mind that the database commands for backup and restore require system-, and/or user-admin-level authorization, and which auth level depends on both the tool used and the database that you are trying to back up.

For example, the user.db requires a "user admin" authorization (csadm), CXIKEY.db can be backed up as a single file with "system admin" authorization (csadm), or a specific user can backup their own keys using "cryptographic user" level authorization (cxitool).


See the SecurityServer documentation for how the authorization mechanism works. The CryptoServer Manual for System Administrators, section 2.14 'Users, User Groups and Authentication', is a good place to start. [V4.2x]


:warning:

The csadm BackupDatabase and RestoreDatabase commands are not permitted when the HSM is running "FIPS" or "CC" firmware. In this case, backup and restore must use one of the API tool commands, cxitool BackupKey for example.