Module netapp_ontap.models.nvme_namespace_provisioning_options

Copyright © 2024 NetApp Inc. All rights reserved.

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

Classes

class NvmeNamespaceProvisioningOptionsSchema (*, 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 NvmeNamespaceProvisioningOptions object

Ancestors

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

Class variables

auto: bool POST

If the volume specified in the request does not exist, automatically provision one of appropriate size. If the volume does exist, resize it to accommodate the new namespace.
This property is only supported on Unified ONTAP.
The following behavior is different from a traditional POST request:

  • The operation is asynchronous.
  • The qos_policy property is supported and is applied to the provisioned volume. A default QoS policy is applied to the volume if one is not provided.
  • The provisioning_options.count property is supported, provisioning count namespaces on the volume using the specified properties.
  • The subsystem_map property is supported. If the specified subsystem does not exist, it is created. The namespace is mapped to this subsystem. If a subsystem is provisioned in this way, it is deleted after it is no longer mapped to any namespaces.
  • The clone and convert properties are not supported.
  • When performing records based operations, specifying this property in the query applies to the entire operation. Specifying it for an individual record within the request applies to only that record.
  • Many other provisioning_options properties are supported to control the placement of the namespace and the properties of the volume containing the namespace.
count: Size POST

The number of namespaces to provision with these properties. Only POST requests based on space.size are supported. When provided, the name is considered a prefix, and a suffix of the form __<N>_ is generated where N is the next available numeric index, starting with 1.

qos_policy: ConsistencyGroupQosPolicy POST

When "min_throughput_iops", "min_throughput_mbps", "max_throughput_iops" or "max_throughput_mbps" attributes are specified, the storage object is assigned to an auto-generated QoS policy group. If the attributes are later modified, the auto-generated QoS policy-group attributes are modified. Attributes can be removed by specifying "0" and policy group by specifying "none". Upon deletion of the storage object or if the attributes are removed, then the QoS policy-group is also removed.

snapshot_policy: SnapshotPolicy GET POST PATCH

The snapshot policy for the volume provisioned to host the namespace. This property is only supported when the request provisions a new volume.

storage_service: NvmeNamespaceProvisioningOptionsStorageService POST

Determines the placement of the volume provisioned to host the namespace.

tiering: ConsistencyGroupTiering POST

The tiering field of the nvme_namespace_provisioning_options.

use_mirrored_aggregates: bool POST

Specifies whether mirrored aggregates are selected when provisioning the volume to host the namespace. Only mirrored aggregates are used if this parameter is set to true and only unmirrored aggregates are used if this parameter is set to false. The default value is true for a MetroCluster configuration and is false for a non-MetroCluster configuration.