Table of Contents¶
nimbleclient.v1.api.master_key¶
MasterKey¶
class MasterKey(Resource)
Manage the master key. Data encryption keys for volumes are encrypted by using a master key that must be initialized before encrypted volumes can be created. The master key in turn is protected by a passphrase that is set when the master key is created. The passphrase may have to be entered to enable the master key when it is not available, for example, after an array reboot.
Parameters
- id : Identifier of the master key.
- name : Name of the master key. The only allowed value is "default".
- passphrase : Passphrase used to protect the master key, required during creation, enabling/disabling the key and change the passphrase to a new value.
- halfkey : When changing the passphrase, this authenticates the change operation, for support use only.
- new_passphrase : When changing the passphrase, this attribute specifies the new value of the passphrase.
- active : Whether the master key is active or not.
- purge_age : Default minimum age (in hours) of inactive encryption keys to be purged. '0' indicates to purge keys immediately.
purge_inactive¶
| purge_inactive(**kwargs)
Purges encryption keys that have been inactive for the age or longer. If you do not specify an age, the keys will be purged immediately.
Parameters
- id : Identifier for the master key.
- age : Minimum age (in hours) of inactive encryption keys to be purged. '0' indicates to purge the keys immediately.
MasterKeyList¶
class MasterKeyList(Collection)
purge_inactive¶
| purge_inactive(id, **kwargs)
Purges encryption keys that have been inactive for the age or longer. If you do not specify an age, the keys will be purged immediately.
Parameters
- id : Identifier for the master key.
- age : Minimum age (in hours) of inactive encryption keys to be purged. '0' indicates to purge the keys immediately.