Module netapp_ontap.models.consistency_group_namespaces
Copyright © 2024 NetApp Inc. All rights reserved.
This file has been automatically generated based on the ONTAP REST API documentation.
Classes
class ConsistencyGroupNamespacesSchema (*, 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 ConsistencyGroupNamespaces object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.base.SchemaABC
- abc.ABC
Class variables
-
auto_delete: bool GET POST PATCH
-
-
Unified ONTAP: 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 computational 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 thefields
query parameter. SeeRequesting specific fields
to learn more. -
ASA r2: This property is not supported. It cannot be set in POST or PATCH and will not be returned by GET.
-
-
comment: str GET POST PATCH
-
A configurable comment available for use by the administrator. Valid in POST and PATCH.
-
create_time: ImpreciseDateTime GET
-
The time the NVMe namespace was created.
Example: 2018-06-04T19:00:00.000+0000
-
enabled: bool GET
-
The enabled state of the NVMe namespace. Certain error conditions cause the namespace to become disabled. If the namespace is disabled, check the
status.state
property to determine what error disabled the namespace. An NVMe namespace is enabled automatically when it is created. -
name: str GET POST PATCH
-
The name of the NVMe namespace.
Platform Specifics
-
Unified ONTAP: An NVMe namespace is located within a volume. Optionally, it can be located within a qtree in a volume.
NVMe namespace names are paths of the form "/vol/\[/\ ]/\ " where the qtree name is optional.
Renaming an NVMe namespace is not supported. Valid in POST. -
ASA r2: NVMe namespace names are simple names that share a namespace with LUNs within the same SVM. The name must begin with a letter or "_" and contain only "_" and alphanumeric characters. In specific cases, an optional snapshot-name can be used of the form "\
[@\ ]". The snapshot name must not begin or end with whitespace.
Renaming an NVMe namespace is supported. Valid in POST and PATCH.
Example: /vol/volume1/qtree1/namespace1
-
-
os_type: str 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: ConsistencyGroupVdiskProvisioningOptions POST PATCH
-
Options that are applied to the operation.
-
space: ConsistencyGroupNamespaceSpace GET POST PATCH
-
The storage space related properties of the NVMe namespace.
-
status: ConsistencyGroupNamespaceStatus GET
-
Status information about the NVMe namespace.
-
subsystem_map: ConsistencyGroupNamespaceSubsystemMap 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 computational cost to retrieving property values forsubsystem_map
. They are not populated for either a collection GET or an instance GET unless explicitly requested using thefields
query parameter. -
uuid: str GET
-
The unique identifier of the NVMe namespace.
Example: 1cd8a442-86d1-11e0-ae1c-123478563412