Services
The CipherTrust Manager contains operations for the management of CipherTrust Manager services. It supports operations such as a reset of the service (erases all data) and restart of a service (without erasing all data).
Note
The following operations can have a major impact on the availability of CipherTrust Manager and the data inside of it. We recommend taking a backup of your devices and information before using these operations.
The following are typical operations initiated using the ksctl. If you are using the API, see the "API playground".
Services Reset
This operation can be used to return a CipherTrust Manager to its initial state. The Reset operation will wipe all data from the CipherTrust Manager. This includes keys, users, and audit logs.
Warning
This is a destructive operation and will wipe all data in the CipherTrust Manager.
This operation requires authentication and an optional parameter called --delay int that defines the delay, in seconds, before the CipherTrust Manager initiates the operation.
To initiate a services reset
ksctl services reset
This returns the following response:
Please note that this operation could take some time.
WARNING - Reset is a destructive operation and will wipe all data in the CipherTrust Manager!
Are you really sure you want to continue? [y/N] y
Resetting CipherTrust Manager services...
Services Restart
This operation restarts the CipherTrust Manager without causing a hard reboot of the appliance. It requires authentication and an optional parameter called 'delay' that defines the delay, in seconds, before the CipherTrust Manager initiates the operation.
This operation can be used in the following scenarios:
Configuration changes
General troubleshooting
To initiate a services restart
ksctl services restart
This returns the following response:
Please note that this operation could take some time and temporarily disrupt the service.
Are you really sure you want to continue? [y/N] y
Restarting CipherTrust Manager services...
To initiate a services restart by service-name
ksctl services restart --service-names <List-of-service-names>
Example (restarting nae-kmip service)
ksctl services restart --service-names nae-kmip
Example (restarting web service)
ksctl services restart --service-names web
Services Status
This operation reports the status of a CipherTrust Manager services.
To check on the status of each service
ksctl services status
This returns the following response:
{
"status": "started",
"services": [
{
"name": "nae-kmip",
"status": "started"
},
{
"name": "web",
"status": "started"
}
]
}
To check on the overall status of the services:
ksctl services status -o
This returns the following response:
"started"
