Module netapp_ontap.models.volume_encryption

Copyright © 2021 NetApp Inc. All rights reserved.


class VolumeEncryptionSchema (*, only: typing.Union = None, exclude: typing.Union = (), many: bool = False, context: typing.Dict = None, load_only: typing.Union = (), dump_only: typing.Union = (), partial: typing.Union = False, unknown: str = None)

The fields of the VolumeEncryption object


  • netapp_ontap.resource.ResourceSchema
  • marshmallow.schema.Schema
  • marshmallow.base.SchemaABC

Class variables


Creates an encrypted or an unencrypted volume. For POST, when set to 'true', a new key is generated and used to encrypt the given volume. In that case, the underlying SVM must be configured with the key manager. When set to 'false', the volume created will be unencrypted. For PATCH, when set to 'true', it encrypts an unencrypted volume. Specifying the parameter as 'false' in a PATCH operation for an encrypted volume is only supported when moving the volume to another aggregate.

key_id GET

The key ID used for creating encrypted volume. A new key-id is generated for creating an encrypted volume. This key-id is associated with the generated key.

key_manager_attribute POST

Specifies an additional key manager attribute that is an identifier-value pair, separated by '='. For example, CRN=unique-value. This parameter is required when using the POST method and an IBM Key Lore key manager is configured on the SVM.

Example: CRN=v1:bluemix:public:containers-kubernetes:us-south:a/asdfghjkl1234:asdfghjkl1234:worker:kubernetes-asdfghjkl-worker1


If set to 'true', re-encrypts the volume with a new key. Valid in PATCH.

state GET

Volume encryption state.
encrypted ‐ The volume is completely encrypted.
encrypting ‐ Encryption operation is in progress.
partial ‐ Some constituents are encrypted and some are not. Applicable only for FlexGroup volume.
rekeying. Encryption of volume with a new key is in progress.
unencrypted ‐ The volume is a plain-text one.

Valid choices:

  • encrypted
  • encrypting
  • partial
  • rekeying
  • unencrypted

The status field of the volume_encryption.

type GET

Volume encryption type.
none ‐ The volume is a plain-text one.
volume ‐ The volume is encrypted with NVE (NetApp Volume Encryption).
aggregate ‐ The volume is encrypted with NAE (NetApp Aggregate Encryption).

Valid choices:

  • none
  • volume
  • aggregate