Module netapp_ontap.models.software_data_encryption

Copyright © 2024 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

Classes

class SoftwareDataEncryptionSchema (*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool | None = None, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)

The fields of the SoftwareDataEncryption object

Ancestors

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

Class variables

conversion_enabled: bool GET PATCH

Indicates whether or not software encryption conversion is enabled on the cluster. A PATCH request initiates the conversion of all non-encrypted metadata volumes in the cluster to encrypted metadata volumes and all non-NAE aggregates to NAE aggregates. For the PATCH request to start, the cluster must have either an Onboard or an external key manager set up and the aggregates should either be empty or have only metadata volumes. No data volumes should be present in any of the aggregates in the cluster. For MetroCluster configurations, a PATCH request enables conversion on all the aggregates and metadata volumes of both local and remote clusters and is not allowed when the MetroCluster is in switchover state.

disabled_by_default: bool GET PATCH

Indicates whether or not default software data at rest encryption is disabled on the cluster.

encryption_state: str GET

Software data encryption state.
encrypted ‐ All the volumes are encrypted.
encrypting ‐ Encryption conversion operation is in progress.
partial ‐ Some volumes are encrypted, and others remains in plain text.
rekeying ‐ All volumes are currently being encrypted with a new key.
unencrypted ‐ None of the volumes are encrypted.
conversion_paused ‐ Encryption conversion operation is paused on one or more volumes.
rekey_paused ‐ Encryption rekey operation is paused on one or more volumes.

Valid choices:

  • encrypted
  • encrypting
  • partial
  • rekeying
  • unencrypted
  • conversion_paused
  • rekey_paused
rekey: bool PATCH

The rekey field of the software_data_encryption.