Module netapp_ontap.models.consistency_group_namespace

Copyright © 2022 NetApp Inc. All rights reserved.


class ConsistencyGroupNamespaceSchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)

The fields of the ConsistencyGroupNamespace object


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

Class variables

auto_delete GET POST PATCH

This property marks the NVMe namespace for auto deletion when the volume containing the namespace runs out of space. This is most commonly set on namespace clones.
When set to true, the NVMe namespace becomes eligible for automatic deletion when the volume runs out of space. Auto deletion only occurs when the volume containing the namespace is also configured for auto deletion and free space in the volume decreases below a particular threshold.
This property is optional in POST and PATCH. The default value for a new NVMe namespace is false.
There is an added cost to retrieving this property's value. It is not populated for either a collection GET or an instance GET unless it is explicitly requested using the fields query parameter. See Requesting specific fields to learn more.


A configurable comment available for use by the administrator. Valid in POST and PATCH.

create_time GET

The time the NVMe namespace was created.

Example: 2018-06-04T19:00:00.000+0000

enabled GET

The enabled state of the NVMe namespace. Certain error conditions cause the namespace to become disabled. If the namespace is disabled, you can check the state property to determine what error disabled the namespace. An NVMe namespace is enabled automatically when it is created.


The fully qualified path name of the NVMe namespace composed of a "/vol" prefix, the volume name, the (optional) qtree name and base name of the namespace. Valid in POST.
NVMe namespaces do not support rename, or movement between volumes.

Example: /vol/volume1/qtree1/namespace1

os_type GET POST

The operating system type of the NVMe namespace.
Required in POST when creating an NVMe namespace that is not a clone of another. Disallowed in POST when creating a namespace clone.

Valid choices:

  • aix
  • linux
  • vmware
  • windows
provisioning_options GET POST PATCH

The provisioning_options field of the consistency_group_namespace.

subsystem_map GET POST PATCH

The NVMe subsystem with which the NVMe namespace is associated. A namespace can be mapped to zero (0) or one (1) subsystems.
There is an added cost to retrieving property values for subsystem_map. They are not populated for either a collection GET or an instance GET unless explicitly requested using the fields query parameter.

uuid GET

The unique identifier of the NVMe namespace.

Example: 1cd8a442-86d1-11e0-ae1c-123478563412