config.save

Create a tar file of security-sensitive information. These options select which information is included in the tar file:

secretseed bool: When true, include password secret seed. pool_keys bool: IGNORED and DEPRECATED as it does not apply on SCALE systems. root_authorized_keys bool: When true, include “/root/.ssh/authorized_keys” file for the root user.

If none of these options are set, the tar file is not generated and the database file is returned.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: options

options

Type: object
Default:
{ "secretseed": false, "pool_keys": false, "root_authorized_keys": false }

Options controlling what data to include in the configuration backup.

 No Additional Properties

Secretseed

Type: boolean Default: false

Whether to include the secret seed in the configuration backup.

Pool Keys

Type: boolean Default: false

Whether to include encryption keys for storage pools in the backup.

Root Authorized Keys

Type: boolean Default: false

Whether to include root user's SSH authorized keys in the backup.

Result

Type: null

Returns null when the configuration backup is successfully created.


Required roles: FULL_ADMIN