Update a consistency group

09/08/2025

PATCH /application/consistency-groups/{uuid}

Introduced In: 9.10

Updates a consistency group.

that this operation will never delete storage elements. You can specify only elements that should be added to the consistency group regardless of existing storage objects. Mapping or unmapping a consistency group from igroups or subsystems is not supported.

vserver consistency-group modify

Parameters

Name	Type	In	Required	Description
uuid	string	path	True	The unique identifier of the consistency group to modify.
return_timeout	integer	query	False	The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202. Default value: 1 Max value: 120 Min value: 0

Name

Type

Required

Description

uuid

string

path

True

The unique identifier of the consistency group to modify.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

Default value: 1
Max value: 120
Min value: 0

Request Body

Name	Type	Description
_tags	array[string]	Tags are an optional way to track the uses of a resource. Tag values must be formatted as key:value strings.
application	application
clone	clone	Creates a clone of an existing consistency group from the current contents or an existing snapshot.
consistency_groups	array[consistency_groups]	A consistency group is a mutually exclusive aggregation of volumes or other consistency groups. A consistency group can only be associated with one direct parent consistency group.
luns	array[luns]	The LUNs array can be used to create or modify LUNs in a consistency group on a new or existing volume that is a member of the consistency group. LUNs are considered members of a consistency group if they are located on a volume that is a member of the consistency group. The maximum number of items for this array is 16.
namespaces	array[namespaces]	An NVMe namespace is a collection of addressable logical blocks presented to hosts connected to the SVM using the NVMe over Fabrics protocol. In ONTAP, an NVMe namespace is located within a volume. Optionally, it can be located within a qtree in a volume. An NVMe namespace is created to a specified size using thin or thick provisioning as determined by the volume on which it is created. NVMe namespaces support being cloned. An NVMe namespace cannot be renamed, resized, or moved to a different volume. NVMe namespaces do not support the assignment of a QoS policy for performance management, but a QoS policy can be assigned to the volume containing the namespace. See the NVMe namespace object model to learn more about each of the properties supported by the NVMe namespace REST API. An NVMe namespace must be mapped to an NVMe subsystem to grant access to the subsystem's hosts. Hosts can then access the NVMe namespace and perform I/O using the NVMe over Fabrics protocol. The maximum number of items for this array is 16. minItems: 0 uniqueItems: 1 Introduced in: 9.10
parent_consistency_group	parent_consistency_group	The parent consistency group.
provisioning_options	provisioning_options	Options that are applied to the operation.
qos	qos
replicated	boolean	Indicates whether or not replication has been enabled on this consistency group.
replication_relationships	array[replication_relationships]	Indicates the SnapMirror relationship of this consistency group.
replication_source	boolean	Since support for this field is to be removed in the next release, use replication_relationships.is_source instead.
restore_to	restore_to	Use to restore a consistency group to a previous snapshot
snapshot_policy	snapshot_policy_reference	This is a reference to the snapshot policy.
uuid	string	The unique identifier of the consistency group. The UUID is generated by ONTAP when the consistency group is created. example: 1cd8a442-86d1-11e0-ae1c-123478563412 readOnly: 1 Introduced in: 9.10 x-nullable: true
vdisk_type	string	Type of objects in the consistency group.
volumes	array[volumes]	A consistency group is a mutually exclusive aggregation of volumes or other consistency groups. A volume can only be associated with one direct parent consistency group. The volumes array can be used to create new volumes in the consistency group, add existing volumes to the consistency group, or modify existing volumes that are already members of the consistency group. The total number of volumes across all child consistency groups contained in a consistency group is constrained by the same limit.

Name

Type

Description

_tags

array[string]

Tags are an optional way to track the uses of a resource. Tag values must be formatted as key:value strings.

application

clone

Creates a clone of an existing consistency group from the current contents or an existing snapshot.

consistency_groups

array[consistency_groups]

A consistency group is a mutually exclusive aggregation of volumes or other consistency groups. A consistency group can only be associated with one direct parent consistency group.

luns

array[luns]

The LUNs array can be used to create or modify LUNs in a consistency group on a new or existing volume that is a member of the consistency group. LUNs are considered members of a consistency group if they are located on a volume that is a member of the consistency group. The maximum number of items for this array is 16.

namespaces

array[namespaces]

An NVMe namespace is a collection of addressable logical blocks presented to hosts connected to the SVM using the NVMe over Fabrics protocol. In ONTAP, an NVMe namespace is located within a volume. Optionally, it can be located within a qtree in a volume.

An NVMe namespace is created to a specified size using thin or thick provisioning as determined by the volume on which it is created. NVMe namespaces support being cloned. An NVMe namespace cannot be renamed, resized, or moved to a different volume. NVMe namespaces do not support the assignment of a QoS policy for performance management, but a QoS policy can be assigned to the volume containing the namespace. See the NVMe namespace object model to learn more about each of the properties supported by the NVMe namespace REST API.

An NVMe namespace must be mapped to an NVMe subsystem to grant access to the subsystem's hosts. Hosts can then access the NVMe namespace and perform I/O using the NVMe over Fabrics protocol. The maximum number of items for this array is 16.

minItems: 0
uniqueItems: 1
Introduced in: 9.10

parent_consistency_group

The parent consistency group.

provisioning_options

Options that are applied to the operation.

qos

replicated

boolean

Indicates whether or not replication has been enabled on this consistency group.

replication_relationships

array[replication_relationships]

Indicates the SnapMirror relationship of this consistency group.

replication_source

boolean

Since support for this field is to be removed in the next release, use replication_relationships.is_source instead.

restore_to

Use to restore a consistency group to a previous snapshot

snapshot_policy

snapshot_policy_reference

This is a reference to the snapshot policy.

uuid

string

The unique identifier of the consistency group. The UUID is generated by ONTAP when the consistency group is created.

example: 1cd8a442-86d1-11e0-ae1c-123478563412
readOnly: 1
Introduced in: 9.10
x-nullable: true

vdisk_type

string

Type of objects in the consistency group.

volumes

array[volumes]

A consistency group is a mutually exclusive aggregation of volumes or other consistency groups. A volume can only be associated with one direct parent consistency group.

The volumes array can be used to create new volumes in the consistency group, add existing volumes to the consistency group, or modify existing volumes that are already members of the consistency group.

The total number of volumes across all child consistency groups contained in a consistency group is constrained by the same limit.

Example request

{
  "_tags": [
    "team:csi",
    "environment:test"
  ],
  "application": {
    "component_type": "string",
    "type": "string"
  },
  "clone": {
    "parent_svm": {
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    },
    "split_complete_percent": 0,
    "split_estimate": 0
  },
  "consistency_groups": [
    {
      "_tags": [
        "team:csi",
        "environment:test"
      ],
      "application": {
        "component_type": "string",
        "type": "string"
      },
      "luns": [
        {
          "clone": {
            "source": {
              "name": "/vol/volume1/lun1",
              "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
            }
          },
          "comment": "string",
          "create_time": "2018-06-04 15:00:00 -0400",
          "lun_maps": [
            {
              "igroup": {
                "comment": "string",
                "igroups": [
                  {
                    "name": "igroup1",
                    "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
                  }
                ],
                "initiators": [
                  {
                    "comment": "my comment",
                    "name": "iqn.1998-01.com.corp.iscsi:name1"
                  }
                ],
                "name": "igroup1",
                "os_type": "string",
                "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
              }
            }
          ],
          "provisioning_options": {
            "action": "string"
          },
          "qos": {
            "policy": {
              "max_throughput_iops": 10000,
              "max_throughput_mbps": 500,
              "min_throughput_iops": 2000,
              "min_throughput_mbps": 500,
              "name": "performance",
              "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
            }
          },
          "serial_number": "string",
          "space": {
            "size": 1073741824,
            "used": 0
          },
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      ],
      "namespaces": [
        {
          "comment": "string",
          "create_time": "2018-06-04 15:00:00 -0400",
          "name": "/vol/volume1/qtree1/namespace1",
          "provisioning_options": {
            "action": "string"
          },
          "space": {
            "size": 1073741824,
            "used": 0
          },
          "subsystem_map": {
            "anagrpid": "00103050h",
            "nsid": "00000001h",
            "subsystem": {
              "comment": "string",
              "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
            }
          },
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      ],
      "parent_consistency_group": {
        "name": "my_consistency_group",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "provisioning_options": {
        "action": "string",
        "name": "string",
        "storage_service": {
          "name": "string"
        }
      },
      "qos": {
        "policy": {
          "name": "performance",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      },
      "restore_to": {
        "snapshot": {
          "name": "string",
          "uuid": "string"
        }
      },
      "snapshot_policy": {
        "name": "default",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
      "volumes": [
        {
          "comment": "string",
          "name": "vol_cs_dept",
          "nas": {
            "cifs": {
              "shares": [
                {
                  "comment": "HR Department Share",
                  "dir_umask": 18,
                  "file_umask": 18,
                  "home_directory": true,
                  "offline_files": "string",
                  "unix_symlink": "string",
                  "vscan_profile": "string"
                }
              ]
            },
            "export_policy": {
              "id": 0,
              "name": "string",
              "rules": [
                {
                  "anonymous_user": "string",
                  "chown_mode": "string",
                  "clients": [
                    {
                      "match": "0.0.0.0/0"
                    }
                  ],
                  "ntfs_unix_security": "string",
                  "protocols": [
                    "string"
                  ],
                  "ro_rule": [
                    "string"
                  ],
                  "rw_rule": [
                    "string"
                  ],
                  "superuser": [
                    "string"
                  ]
                }
              ]
            }
          },
          "provisioning_options": {
            "action": "string",
            "storage_service": {
              "name": "string"
            }
          },
          "qos": {
            "policy": {
              "name": "performance",
              "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
            }
          },
          "snapshot_policy": {
            "name": "default",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          },
          "space": {
            "available": 0,
            "used": 0
          },
          "tiering": {
            "control": "string",
            "object_stores": [
              {
                "name": "string"
              }
            ]
          },
          "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
        }
      ]
    }
  ],
  "luns": [
    {
      "clone": {
        "source": {
          "name": "/vol/volume1/lun1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      },
      "comment": "string",
      "create_time": "2018-06-04 15:00:00 -0400",
      "lun_maps": [
        {
          "igroup": {
            "comment": "string",
            "igroups": [
              {
                "name": "igroup1",
                "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
              }
            ],
            "initiators": [
              {
                "comment": "my comment",
                "name": "iqn.1998-01.com.corp.iscsi:name1"
              }
            ],
            "name": "igroup1",
            "os_type": "string",
            "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
          }
        }
      ],
      "provisioning_options": {
        "action": "string"
      },
      "qos": {
        "policy": {
          "max_throughput_iops": 10000,
          "max_throughput_mbps": 500,
          "min_throughput_iops": 2000,
          "min_throughput_mbps": 500,
          "name": "performance",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      },
      "serial_number": "string",
      "space": {
        "size": 1073741824,
        "used": 0
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "namespaces": [
    {
      "comment": "string",
      "create_time": "2018-06-04 15:00:00 -0400",
      "name": "/vol/volume1/qtree1/namespace1",
      "provisioning_options": {
        "action": "string"
      },
      "space": {
        "size": 1073741824,
        "used": 0
      },
      "subsystem_map": {
        "anagrpid": "00103050h",
        "nsid": "00000001h",
        "subsystem": {
          "comment": "string",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "parent_consistency_group": {
    "name": "my_consistency_group",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "provisioning_options": {
    "action": "string",
    "name": "string",
    "storage_service": {
      "name": "string"
    }
  },
  "qos": {
    "policy": {
      "name": "performance",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  },
  "replication_relationships": [
    {
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    }
  ],
  "restore_to": {
    "snapshot": {
      "name": "string",
      "uuid": "string"
    }
  },
  "snapshot_policy": {
    "name": "default",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
  "vdisk_type": "luns",
  "volumes": [
    {
      "comment": "string",
      "name": "vol_cs_dept",
      "nas": {
        "cifs": {
          "shares": [
            {
              "comment": "HR Department Share",
              "dir_umask": 18,
              "file_umask": 18,
              "home_directory": true,
              "offline_files": "string",
              "unix_symlink": "string",
              "vscan_profile": "string"
            }
          ]
        },
        "export_policy": {
          "id": 0,
          "name": "string",
          "rules": [
            {
              "anonymous_user": "string",
              "chown_mode": "string",
              "clients": [
                {
                  "match": "0.0.0.0/0"
                }
              ],
              "ntfs_unix_security": "string",
              "protocols": [
                "string"
              ],
              "ro_rule": [
                "string"
              ],
              "rw_rule": [
                "string"
              ],
              "superuser": [
                "string"
              ]
            }
          ]
        }
      },
      "provisioning_options": {
        "action": "string",
        "storage_service": {
          "name": "string"
        }
      },
      "qos": {
        "policy": {
          "name": "performance",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      },
      "snapshot_policy": {
        "name": "default",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "space": {
        "available": 0,
        "used": 0
      },
      "tiering": {
        "control": "string",
        "object_stores": [
          {
            "name": "string"
          }
        ]
      },
      "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
    }
  ]
}

Response

Status: 200, Ok

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code	Description
262285	Consistency group does not support removing elements using a PATCH request.
2621761	Consistency groups with DP volumes are not supported on storage-limit enabled SVM.
53411842	Consistency group does not exist.
53411843	A consistency group with specified UUID was not found.
53411844	Specified consistency group was not found in the specified SVM.
53411845	The specified UUID and name refer to different consistency groups.
53411846	Either name or UUID must be provided.
53411852	A consistency group with the same identifier in the same scope exists.
53411853	Fields provided in the request conflict with each other.
53411856	Field provided is only supported when provisioning new objects.
53411857	LUNs that are not members of the application are not supported by this API. LUNs can be added to an application by adding the volume containing the LUNs to the application.
53411860	An object with the same identifier in the same scope exists.
53411861	The specified volume does not exist in provided volume array.
53411862	Modifying existing igroups is not supported using this API.
53411864	Request content insufficient to add an existing volume to an application.
53411865	Volumes contained in one consistency group cannot be added to a different consistency group.
53411866	LUNs are not supported on FlexGroup volumes.
53411867	LUN name is too long after appending a unique suffix.
53411869	Volume name is too long after appending a unique suffix.
53411870	When using the "round_robin" layout, the volume count must not be greater than the LUN count.
53411942	The application or component type of a consistency group that has an associated SnapMirror relationship cannot be changed.
53411959	Volumes with snapshot locking enabled cannot be added to a consistency group.
53412027	Failed to update the snapshot policy because the snapshot policies are not supported on the destination consistency group of SnapMirror active sync relationships.
53412056	The consistency group is not a FlexClone.
53412057	Consistency group split operation failed.
53412058	Failed to map or unmap because the consistency group consists of both 'luns' and 'namespaces'.

Also see the table of common errors in the Response body overview section of this documentation.

Definitions

See Definitions

href

Name	Type	Description
href	string

Name

Type

Description

href

string

self_link

application

Name	Type	Description
component_type	string	Nested consistency group tag.
type	string	Top level consistency group tag.

Name

Type

Description

component_type

string

Nested consistency group tag.

type

string

Top level consistency group tag.

guarantee

Name	Type	Description
type	string	The type of space guarantee of this volume in the aggregate.

Name

Type

Description

type

string

The type of space guarantee of this volume in the aggregate.

parent_consistency_group

Consistency group that is to be cloned.

_links

parent_snapshot

Consistency group that is to be cloned.

Name	Type	Description
name	string
uuid	string

Name

Type

Description

name

string

uuid

string

parent_svm

SVM, applies only to SVM-scoped objects.

Name	Type	Description
name	string	The name of the SVM. This field cannot be specified in a PATCH method.
uuid	string	The unique identifier of the SVM. This field cannot be specified in a PATCH method.

Name

Type

Description

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

volume

Volume name suffix/prefix for the cloned volumes.

Name	Type	Description
prefix	string	Volume name prefix for cloned volumes.
suffix	string	Volume name suffix for cloned volumes.

Name

Type

Description

prefix

string

Volume name prefix for cloned volumes.

suffix

string

Volume name suffix for cloned volumes.

clone

Creates a clone of an existing consistency group from the current contents or an existing snapshot.

Name	Type	Description
is_flexclone	boolean	Specifies if this consistency group is a FlexClone of a consistency group.
parent_svm	parent_svm	SVM, applies only to SVM-scoped objects.
split_complete_percent	integer	Percentage of FlexClone blocks split from its parent consistency group.
split_estimate	integer	Space required to split the FlexClone consistency group.
split_initiated	boolean	Splits volumes after cloning. Defaults to false during POST. Only accepts true during a PATCH.

Name

Type

Description

is_flexclone

boolean

Specifies if this consistency group is a FlexClone of a consistency group.

parent_svm

SVM, applies only to SVM-scoped objects.

split_complete_percent

integer

Percentage of FlexClone blocks split from its parent consistency group.

split_estimate

integer

Space required to split the FlexClone consistency group.

split_initiated

boolean

Splits volumes after cloning. Defaults to false during POST. Only accepts true during a PATCH.

source

The source LUN for a LUN clone operation. This can be specified using property clone.source.uuid or clone.source.name. If both properties are supplied, they must refer to the same LUN.

Valid in POST to create a new LUN as a clone of the source.

Valid in PATCH to overwrite an existing LUN's data as a clone of another.

Name	Type	Description
name	string	The name of the clone source LUN. A LUN is located within a volume. Optionally, it can be located within a qtree in a volume. LUN names are paths of the form "/vol/<volume>[/<qtree>]/<namespace>" where the qtree name is optional. Valid in POST and PATCH.
uuid	string	The unique identifier of the clone source LUN. Valid in POST and PATCH.

Name

Type

Description

name

string

The name of the clone source LUN. A LUN is located within a volume. Optionally, it can be located within a qtree in a volume.

LUN names are paths of the form "/vol/<volume>[/<qtree>]/<namespace>" where the qtree name is optional.

Valid in POST and PATCH.

uuid

string

The unique identifier of the clone source LUN. Valid in POST and PATCH.

clone

This sub-object is used in POST to create a new LUN as a clone of an existing LUN, or PATCH to overwrite an existing LUN as a clone of another. Setting a property in this sub-object indicates that a LUN clone is desired. Consider the following other properties when cloning a LUN: auto_delete, qos_policy, space.guarantee.requested and space.scsi_thin_provisioning_support_enabled.

When used in a PATCH, the patched LUN's data is over-written as a clone of the source and the following properties are preserved from the patched LUN unless otherwise specified as part of the PATCH: class, auto_delete, lun_maps, serial_number, status.state, and uuid.

Persistent reservations for the patched LUN are also preserved.

Name Type Description

Name	Type	Description
source	source	The source LUN for a LUN clone operation. This can be specified using property `clone.source.uuid` or `clone.source.name`. If both properties are supplied, they must refer to the same LUN. Valid in POST to create a new LUN as a clone of the source. Valid in PATCH to overwrite an existing LUN's data as a clone of another.

source

The source LUN for a LUN clone operation. This can be specified using property clone.source.uuid or clone.source.name. If both properties are supplied, they must refer to the same LUN.

Valid in POST to create a new LUN as a clone of the source.

Valid in PATCH to overwrite an existing LUN's data as a clone of another.

igroups

Name	Type	Description
name	string	The name of the initiator group.
uuid	string	The unique identifier of the initiator group.

Name

Type

Description

name

string

The name of the initiator group.

uuid

string

The unique identifier of the initiator group.

initiators

The initiators that are members of the initiator group.

Name	Type	Description
comment	string	A comment available for use by the administrator.
name	string	Name of initiator that is a member of the initiator group.

Name

Type

Description

comment

string

A comment available for use by the administrator.

name

string

Name of initiator that is a member of the initiator group.

igroup

The initiator group that directly owns the initiator, which is where modification of the initiator is supported. This property will only be populated when the initiator is a member of a nested initiator group.

Name Type Description

Name	Type	Description
comment	string	A comment available for use by the administrator. Valid in POST and PATCH.
igroups	array[igroups]	The existing initiator groups that are members of the group. Optional in POST. This property is mutually exclusive with the initiators property during POST. This array contains only the direct children of the initiator group. If the member initiator groups have further nested initiator groups, those are reported in the `igroups` property of the child initiator group. Zero or more nested initiator groups can be supplied when the initiator group is created. The initiator group will act as if it contains the aggregation of all initiators in any nested initiator groups. After creation, nested initiator groups can be added or removed from the initiator group using the `/protocols/san/igroups/{igroup.uuid}/igroups` endpoint. See link:post-protocols-san-igroups-igroups(#-san-igroup-nested-create)anddelete-protocols-san-igroups-igroups-.htmlPOST /protocols/san/igroups/{igroup.uuid}/igroups and [DELETE /protocols/san/igroups/{igroup.uuid}/igroups/{uuid}] for more details.
initiators	array[initiators]	The initiators that are members of the group.
name	string	The name of the initiator group. Required in POST; optional in PATCH.
os_type	string	The host operating system of the initiator group. All initiators in the group should be hosts of the same operating system. Required in POST; optional in PATCH.
uuid	string	The unique identifier of the initiator group.

comment

string

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

igroups

array[igroups]

The existing initiator groups that are members of the group. Optional in POST.

This property is mutually exclusive with the initiators property during POST.

This array contains only the direct children of the initiator group. If the member initiator groups have further nested initiator groups, those are reported in the igroups property of the child initiator group.

Zero or more nested initiator groups can be supplied when the initiator group is created. The initiator group will act as if it contains the aggregation of all initiators in any nested initiator groups.

After creation, nested initiator groups can be added or removed from the initiator group using the /protocols/san/igroups/{igroup.uuid}/igroups endpoint. See link:post-protocols-san-igroups-igroups(#-san-igroup-nested-create)anddelete-protocols-san-igroups-igroups-.htmlPOST /protocols/san/igroups/{igroup.uuid}/igroups and [DELETE /protocols/san/igroups/{igroup.uuid}/igroups/{uuid}] for more details.

initiators

array[initiators]

The initiators that are members of the group.

name

string

The name of the initiator group. Required in POST; optional in PATCH.

os_type

string

The host operating system of the initiator group. All initiators in the group should be hosts of the same operating system. Required in POST; optional in PATCH.

uuid

string

The unique identifier of the initiator group.

lun_maps

A LUN map is an association between a LUN and an initiator group.

When a LUN is mapped to an initiator group, the initiator group's initiators are granted access to the LUN. The relationship between a LUN and an initiator group is many LUNs to many initiator groups.

Name	Type	Description
igroup	igroup	The initiator group that directly owns the initiator, which is where modification of the initiator is supported. This property will only be populated when the initiator is a member of a nested initiator group.

Name

Type

Description

igroup

provisioning_options

Options that are applied to the operation.

Name	Type	Description
action	string	Operation to perform
count	integer	Number of elements to perform the operation on.

Name

Type

Description

action

string

Operation to perform

count

integer

Number of elements to perform the operation on.

policy

The QoS policy

Name	Type	Description
max_throughput_iops	integer	Specifies the maximum throughput in IOPS, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH. This cannot be set when max_throughput is set during POST or PATCH.
max_throughput_mbps	integer	Specifies the maximum throughput in Megabytes per sec, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH. This cannot be set when max_throughput is set during POST or PATCH.
min_throughput_iops	integer	Specifies the minimum throughput in IOPS, 0 means none. Setting "min_throughput" is supported on AFF platforms only, unless FabricPool tiering policies are set. This is mutually exclusive with name and UUID during POST and PATCH. This cannot be set when min_throughput is set during POST or PATCH.
min_throughput_mbps	integer	Specifies the minimum throughput in Megabytes per sec, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH.This cannot be set when min_throughput is set during POST or PATCH.
name	string	The QoS policy group name. This is mutually exclusive with UUID and other QoS attributes during POST and PATCH.
uuid	string	The QoS policy group UUID. This is mutually exclusive with name and other QoS attributes during POST and PATCH.

Name

Type

Description

max_throughput_iops

integer

Specifies the maximum throughput in IOPS, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH. This cannot be set when max_throughput is set during POST or PATCH.

max_throughput_mbps

integer

Specifies the maximum throughput in Megabytes per sec, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH. This cannot be set when max_throughput is set during POST or PATCH.

min_throughput_iops

integer

Specifies the minimum throughput in IOPS, 0 means none. Setting "min_throughput" is supported on AFF platforms only, unless FabricPool tiering policies are set. This is mutually exclusive with name and UUID during POST and PATCH. This cannot be set when min_throughput is set during POST or PATCH.

min_throughput_mbps

integer

Specifies the minimum throughput in Megabytes per sec, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH.This cannot be set when min_throughput is set during POST or PATCH.

name

string

The QoS policy group name. This is mutually exclusive with UUID and other QoS attributes during POST and PATCH.

uuid

string

The QoS policy group UUID. This is mutually exclusive with name and other QoS attributes during POST and PATCH.

qos

Name	Type	Description
policy	policy	The QoS policy

Name

Type

Description

policy

The QoS policy

guarantee

Properties that request and report the space guarantee for the LUN.

Name	Type	Description
requested	boolean	The requested space reservation policy for the LUN. If true, a space reservation is requested for the LUN; if false, the LUN is thin provisioned. Guaranteeing a space reservation request for a LUN requires that the volume in which the LUN resides is also space reserved and that the fractional reserve for the volume is 100%. Valid in POST and PATCH.
reserved	boolean	Reports if the LUN is space guaranteed. If true, a space guarantee is requested and the containing volume and aggregate support the request. If false, a space guarantee is not requested or a space guarantee is requested and either the containing volume or aggregate do not support the request.

Name

Type

Description

requested

boolean

The requested space reservation policy for the LUN. If true, a space reservation is requested for the LUN; if false, the LUN is thin provisioned. Guaranteeing a space reservation request for a LUN requires that the volume in which the LUN resides is also space reserved and that the fractional reserve for the volume is 100%. Valid in POST and PATCH.

reserved

boolean

Reports if the LUN is space guaranteed.

If true, a space guarantee is requested and the containing volume and aggregate support the request. If false, a space guarantee is not requested or a space guarantee is requested and either the containing volume or aggregate do not support the request.

space

The storage space related properties of the LUN.

Name	Type	Description
guarantee	guarantee	Properties that request and report the space guarantee for the LUN.
size	integer	The total provisioned size of the LUN. The LUN size can be increased but not reduced using the REST interface. The maximum and minimum sizes listed here are the absolute maximum and absolute minimum sizes, in bytes. The actual minimum and maximum sizes vary depending on the ONTAP version, ONTAP platform, and the available space in the containing volume and aggregate. For more information, see Size properties in the docs section of the ONTAP REST API documentation. example: 1073741824 format: int64 Max value: 140737488355328 Min value: 4096 Introduced in: 9.6 x-nullable: true
used	integer	The amount of space consumed by the main data stream of the LUN. This value is the total space consumed in the volume by the LUN, including filesystem overhead, but excluding prefix and suffix streams. Due to internal filesystem overhead and the many ways SAN filesystems and applications utilize blocks within a LUN, this value does not necessarily reflect actual consumption/availability from the perspective of the filesystem or application. Without specific knowledge of how the LUN blocks are utilized outside of ONTAP, this property should not be used as an indicator for an out-of-space condition. For more information, see Size properties in the docs section of the ONTAP REST API documentation. format: int64 readOnly: 1 Introduced in: 9.6 x-nullable: true

Name

Type

Description

guarantee

Properties that request and report the space guarantee for the LUN.

size

integer

The total provisioned size of the LUN. The LUN size can be increased but not reduced using the REST interface. The maximum and minimum sizes listed here are the absolute maximum and absolute minimum sizes, in bytes. The actual minimum and maximum sizes vary depending on the ONTAP version, ONTAP platform, and the available space in the containing volume and aggregate. For more information, see Size properties in the docs section of the ONTAP REST API documentation.

example: 1073741824
format: int64
Max value: 140737488355328
Min value: 4096
Introduced in: 9.6
x-nullable: true

used

integer

The amount of space consumed by the main data stream of the LUN.

This value is the total space consumed in the volume by the LUN, including filesystem overhead, but excluding prefix and suffix streams. Due to internal filesystem overhead and the many ways SAN filesystems and applications utilize blocks within a LUN, this value does not necessarily reflect actual consumption/availability from the perspective of the filesystem or application. Without specific knowledge of how the LUN blocks are utilized outside of ONTAP, this property should not be used as an indicator for an out-of-space condition.

For more information, see Size properties in the docs section of the ONTAP REST API documentation.

format: int64
readOnly: 1
Introduced in: 9.6
x-nullable: true

luns

A LUN is the logical representation of storage in a storage area network (SAN).

A LUN must be mapped to an initiator group to grant access to the initiator group's initiators (client hosts). Initiators can then access the LUN and perform I/O over a Fibre Channel (FC) fabric using the FC Protocol or a TCP/IP network using iSCSI.

See the LUN object model to learn more about each of the properties supported by the LUN REST API.

A LUN is located within a volume. Optionally, it can be located within a qtree in a volume.

LUN names are paths of the form "/vol/<volume>[/<qtree>]/<lun>" where the qtree name is optional.

A LUN can be created to a specified size using thin or thick provisioning. A LUN can then be renamed, resized, cloned, moved to a different volume and copied. LUNs support the assignment of a QoS policy for performance management or a QoS policy can be assigned to a volume containing one or more LUNs.

</lun></qtree></volume>

Name Type Description

Name	Type	Description
clone	clone	This sub-object is used in POST to create a new LUN as a clone of an existing LUN, or PATCH to overwrite an existing LUN as a clone of another. Setting a property in this sub-object indicates that a LUN clone is desired. Consider the following other properties when cloning a LUN: `auto_delete`, `qos_policy`, `space.guarantee.requested` and `space.scsi_thin_provisioning_support_enabled`. When used in a PATCH, the patched LUN's data is over-written as a clone of the source and the following properties are preserved from the patched LUN unless otherwise specified as part of the PATCH: `class`, `auto_delete`, `lun_maps`, `serial_number`, `status.state`, and `uuid`. Persistent reservations for the patched LUN are also preserved.
comment	string	A configurable comment available for use by the administrator. Valid in POST and PATCH.
create_time	string	The time the LUN was created.
enabled	boolean	The enabled state of the LUN. LUNs can be disabled to prevent access to the LUN. Certain error conditions also cause the LUN to become disabled. If the LUN is disabled, you can consult the `state` property to determine if the LUN is administratively disabled (offline) or has become disabled as a result of an error. A LUN in an error condition can be brought online by setting the `enabled` property to true or brought administratively offline by setting the `enabled` property to false. Upon creation, a LUN is enabled by default. Valid in PATCH.
lun_maps	array[lun_maps]	An array of LUN maps. A LUN map is an association between a LUN and an initiator group. When a LUN is mapped to an initiator group, the initiator group's initiators are granted access to the LUN. The relationship between a LUN and an initiator group is many LUNs to many initiator groups.
provisioning_options	provisioning_options	Options that are applied to the operation.
qos	qos
serial_number	string	The LUN serial number. The serial number is generated by ONTAP when the LUN is created. maxLength: 12 minLength: 12 readOnly: 1 Introduced in: 9.10 x-nullable: true
space	space	The storage space related properties of the LUN.
uuid	string	The unique identifier of the LUN. The UUID is generated by ONTAP when the LUN is created. example: 1cd8a442-86d1-11e0-ae1c-123478563412 readOnly: 1 Introduced in: 9.10 x-nullable: true

clone

Persistent reservations for the patched LUN are also preserved.

comment

string

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

create_time

string

The time the LUN was created.

enabled

boolean

The enabled state of the LUN. LUNs can be disabled to prevent access to the LUN. Certain error conditions also cause the LUN to become disabled. If the LUN is disabled, you can consult the state property to determine if the LUN is administratively disabled (offline) or has become disabled as a result of an error. A LUN in an error condition can be brought online by setting the enabled property to true or brought administratively offline by setting the enabled property to false. Upon creation, a LUN is enabled by default. Valid in PATCH.

lun_maps

array[lun_maps]

An array of LUN maps.

A LUN map is an association between a LUN and an initiator group. When a LUN is mapped to an initiator group, the initiator group's initiators are granted access to the LUN. The relationship between a LUN and an initiator group is many LUNs to many initiator groups.

provisioning_options

Options that are applied to the operation.

qos

serial_number

string

The LUN serial number. The serial number is generated by ONTAP when the LUN is created.

maxLength: 12
minLength: 12
readOnly: 1
Introduced in: 9.10
x-nullable: true

space

The storage space related properties of the LUN.

uuid

string

The unique identifier of the LUN. The UUID is generated by ONTAP when the LUN is created.

example: 1cd8a442-86d1-11e0-ae1c-123478563412
readOnly: 1
Introduced in: 9.10
x-nullable: true

guarantee

Properties that request and report the space guarantee for the NVMe namespace.

Name	Type	Description
requested	boolean	The requested space reservation policy for the NVMe namespace. If true, a space reservation is requested for the namespace; if false, the namespace is thin provisioned. Guaranteeing a space reservation request for a namespace requires that the volume in which the namespace resides also be space reserved and that the fractional reserve for the volume be 100%. The space reservation policy for an NVMe namespace is determined by ONTAP. Introduced in: 9.6 x-nullable: true
reserved	boolean	Reports if the NVMe namespace is space guaranteed. This property is true if a space guarantee is requested and the containing volume and aggregate support the request. This property is false if a space guarantee is not requested or if a space guarantee is requested and either the containing volume and aggregate do not support the request.

Name

Type

Description

requested

boolean

The requested space reservation policy for the NVMe namespace. If true, a space reservation is requested for the namespace; if false, the namespace is thin provisioned. Guaranteeing a space reservation request for a namespace requires that the volume in which the namespace resides also be space reserved and that the fractional reserve for the volume be 100%.

The space reservation policy for an NVMe namespace is determined by ONTAP.

Introduced in: 9.6
x-nullable: true

reserved

boolean

Reports if the NVMe namespace is space guaranteed.

This property is true if a space guarantee is requested and the containing volume and aggregate support the request. This property is false if a space guarantee is not requested or if a space guarantee is requested and either the containing volume and aggregate do not support the request.

space

The storage space related properties of the NVMe namespace.

Name	Type	Description
guarantee	guarantee	Properties that request and report the space guarantee for the NVMe namespace.
size	integer	The total provisioned size of the NVMe namespace. Valid in POST and PATCH. The NVMe namespace size can be increased but not reduced using the REST interface. The maximum and minimum sizes listed here are the absolute maximum and absolute minimum sizes, in bytes. The maximum size is variable with respect to large NVMe namespace support in ONTAP. If large namespaces are supported, the maximum size is 128 TB (140737488355328 bytes) and if not supported, the maximum size is just under 16 TB (17557557870592 bytes). The minimum size supported is always 4096 bytes. For more information, see Size properties in the docs section of the ONTAP REST API documentation. example: 1073741824 format: int64 Max value: 140737488355328 Min value: 4096 Introduced in: 9.6 x-nullable: true
used	integer	The amount of space consumed by the main data stream of the NVMe namespace. This value is the total space consumed in the volume by the NVMe namespace, including filesystem overhead, but excluding prefix and suffix streams. Due to internal filesystem overhead and the many ways NVMe filesystems and applications utilize blocks within a namespace, this value does not necessarily reflect actual consumption/availability from the perspective of the filesystem or application. Without specific knowledge of how the namespace blocks are utilized outside of ONTAP, this property should not be used as an indicator for an out-of-space condition. For more information, see Size properties in the docs section of the ONTAP REST API documentation. format: int64 readOnly: 1 Introduced in: 9.6 x-nullable: true

Name

Type

Description

guarantee

Properties that request and report the space guarantee for the NVMe namespace.

size

integer

The total provisioned size of the NVMe namespace. Valid in POST and PATCH. The NVMe namespace size can be increased but not reduced using the REST interface.

The maximum and minimum sizes listed here are the absolute maximum and absolute minimum sizes, in bytes. The maximum size is variable with respect to large NVMe namespace support in ONTAP. If large namespaces are supported, the maximum size is 128 TB (140737488355328 bytes) and if not supported, the maximum size is just under 16 TB (17557557870592 bytes). The minimum size supported is always 4096 bytes.

For more information, see Size properties in the docs section of the ONTAP REST API documentation.

example: 1073741824
format: int64
Max value: 140737488355328
Min value: 4096
Introduced in: 9.6
x-nullable: true

used

integer

The amount of space consumed by the main data stream of the NVMe namespace.

This value is the total space consumed in the volume by the NVMe namespace, including filesystem overhead, but excluding prefix and suffix streams. Due to internal filesystem overhead and the many ways NVMe filesystems and applications utilize blocks within a namespace, this value does not necessarily reflect actual consumption/availability from the perspective of the filesystem or application. Without specific knowledge of how the namespace blocks are utilized outside of ONTAP, this property should not be used as an indicator for an out-of-space condition.

For more information, see Size properties in the docs section of the ONTAP REST API documentation.

format: int64
readOnly: 1
Introduced in: 9.6
x-nullable: true

status

Status information about the NVMe namespace.

Name Type Description

Name	Type	Description
container_state	string	The state of the volume and aggregate that contain the NVMe namespace. Namespaces are only available when their containers are available.
mapped	boolean	Reports if the NVMe namespace is mapped to an NVMe subsystem. 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 the `fields` query parameter. See Requesting specific fields to learn more.
read_only	boolean	Reports if the NVMe namespace allows only read access.
state	string	The state of the NVMe namespace. Normal states for a namespace are online and offline. Other states indicate errors.

container_state

string

The state of the volume and aggregate that contain the NVMe namespace. Namespaces are only available when their containers are available.

mapped

boolean

Reports if the NVMe namespace is mapped to an NVMe subsystem.

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 the fields query parameter. See Requesting specific fields to learn more.

read_only

boolean

Reports if the NVMe namespace allows only read access.

state

string

The state of the NVMe namespace. Normal states for a namespace are online and offline. Other states indicate errors.

consistency_group_nvme_host_dh_hmac_chap

A container for the configuration of NVMe in-band authentication using the DH-HMAC-CHAP protocol for a host.

Name	Type	Description
mode	string	The expected NVMe in-band authentication mode for the host. This property is an indication of which secrets are configured for the host. When set to: none: The host has neither the host nor controller secret configured, and no authentication is performed. unidirectional: The host has a host secret configured. The controller will authenticate the host. bidirectional: The host has both a host and controller secret configured. The controller will authenticate the host and the host will authenticate the controller.

Name

Type

Description

mode

string

The expected NVMe in-band authentication mode for the host. This property is an indication of which secrets are configured for the host. When set to:

none: The host has neither the host nor controller secret configured, and no authentication is performed.
unidirectional: The host has a host secret configured. The controller will authenticate the host.
bidirectional: The host has both a host and controller secret configured. The controller will authenticate the host and the host will authenticate the controller.

peer_svms

A reference to an SVM peer relationship.

Name	Type	Description
name	string	The local name of the peer SVM. This name is unique among all local and peer SVMs.
uuid	string	The unique identifier of the SVM peer relationship. This is the UUID of the relationship, not the UUID of the peer SVM itself.

Name

Type

Description

name

string

The local name of the peer SVM. This name is unique among all local and peer SVMs.

uuid

string

The unique identifier of the SVM peer relationship. This is the UUID of the relationship, not the UUID of the peer SVM itself.

proximity

Properties that define the SVMs to which the host is proximal. This information is used to properly report active optimized and active non-optimized network paths using an NVMe controller. If no configuration has been specified for the host, the sub-object is not present in GET requests.

These properties apply to all instances of the host in the NVMe subsystem in the SVM and its peers.

Name	Type	Description
local_svm	boolean	A boolean that indicates if the host is proximal to the SVM for which it is configured.
peer_svms	array[peer_svms]	An array of remote peer SVMs to which the host is proximal.

Name

Type

Description

local_svm

boolean

A boolean that indicates if the host is proximal to the SVM for which it is configured.

peer_svms

array[peer_svms]

An array of remote peer SVMs to which the host is proximal.

tls

A container for the configuration for NVMe/TCP-TLS transport session for the host.

consistency_group_nvme_host

The NVMe host provisioned to access NVMe namespaces mapped to a subsystem.

Name	Type	Description
proximity	proximity	Properties that define the SVMs to which the host is proximal. This information is used to properly report active optimized and active non-optimized network paths using an NVMe controller. If no configuration has been specified for the host, the sub-object is not present in GET requests. These properties apply to all instances of the host in the NVMe subsystem in the SVM and its peers.

Name

Type

Description

proximity

These properties apply to all instances of the host in the NVMe subsystem in the SVM and its peers.

consistency_group_nvme_subsystem

An NVMe subsystem maintains configuration state and namespace access control for a set of NVMe-connected hosts.

Name	Type	Description
comment	string	A configurable comment for the NVMe subsystem. Optional in POST and PATCH.
uuid	string	The unique identifier of the NVMe subsystem.

Name

Type

Description

comment

string

A configurable comment for the NVMe subsystem. Optional in POST and PATCH.

uuid

string

The unique identifier of the NVMe subsystem.

subsystem_map

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 for subsystem_map. They are not populated for either a collection GET or an instance GET unless explicitly requested using the fields query parameter.

Name Type Description

Name	Type	Description
anagrpid	string	The Asymmetric Namespace Access Group ID (ANAGRPID) of the NVMe namespace. The format for an ANAGRPID is 8 hexadecimal digits (zero-filled) followed by a lower case "h". There is an added computational cost to retrieving this property's value. It is not populated for a GET request unless it is explicitly requested using the `fields` query parameter. See Requesting specific fields to learn more.
nsid	string	The NVMe namespace identifier. This is an identifier used by an NVMe controller to provide access to the NVMe namespace. The format for an NVMe namespace identifier is 8 hexadecimal digits (zero-filled) followed by a lower case "h".
subsystem	consistency_group_nvme_subsystem	An NVMe subsystem maintains configuration state and namespace access control for a set of NVMe-connected hosts.

anagrpid

string

The Asymmetric Namespace Access Group ID (ANAGRPID) of the NVMe namespace.

The format for an ANAGRPID is 8 hexadecimal digits (zero-filled) followed by a lower case "h".

There is an added computational cost to retrieving this property's value. It is not populated for a GET request unless it is explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

nsid

string

The NVMe namespace identifier. This is an identifier used by an NVMe controller to provide access to the NVMe namespace.

The format for an NVMe namespace identifier is 8 hexadecimal digits (zero-filled) followed by a lower case "h".

subsystem

consistency_group_nvme_subsystem

An NVMe subsystem maintains configuration state and namespace access control for a set of NVMe-connected hosts.

namespaces

An NVMe namespace is a collection of addressable logical blocks presented to hosts connected to the storage virtual machine using the NVMe over Fabrics protocol.

An NVMe namespace must be mapped to an NVMe subsystem to grant access to the subsystem's hosts. Hosts can then access the NVMe namespace and perform I/O using the NVMe over Fabrics protocol.

See the NVMe namespace object model to learn more about each of the properties supported by the NVMe namespace REST API.

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/<volume>[/<qtree>]/<namespace>" where the qtree name is optional.

An NVMe namespace is created to a specified size using thin or thick provisioning as determined by the volume on which it is created. An NVMe namespace can then be resized or cloned. An NVMe namespace cannot be renamed, or moved to a different volume. NVMe namespaces do not support the assignment of a QoS policy for performance management, but a QoS policy can be assigned to the volume containing the namespace.

</namespace></qtree></volume>

Name Type Description

Name	Type	Description
auto_delete	boolean	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 a GET request unless it is explicitly requested using the `fields` query parameter. See Requesting specific fields to learn more.
comment	string	A configurable comment available for use by the administrator. Valid in POST and PATCH.
create_time	string	The time the NVMe namespace was created.
enabled	boolean	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	string	The name of the NVMe namespace. 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/<volume>[/<qtree>]/<namespace>" where the qtree name is optional. Renaming an NVMe namespace is not supported. Valid in POST.
provisioning_options	provisioning_options	Options that are applied to the operation.
space	space	The storage space related properties of the NVMe namespace.
subsystem_map	subsystem_map	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 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	string	The unique identifier of the NVMe namespace.

auto_delete

boolean

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.

comment

string

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

create_time

string

The time the NVMe namespace was created.

enabled

boolean

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

string

The name of the NVMe namespace. 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/<volume>[/<qtree>]/<namespace>" where the qtree name is optional.

Renaming an NVMe namespace is not supported. Valid in POST.

provisioning_options

Options that are applied to the operation.

space

The storage space related properties of the NVMe namespace.

subsystem_map

The NVMe subsystem with which the NVMe namespace is associated. A namespace can be mapped to zero (0) or one (1) subsystems.

uuid

string

The unique identifier of the NVMe namespace.

parent_consistency_group

The parent consistency group.

Name	Type	Description
name	string	The name of the consistency group.
uuid	string	The unique identifier of the consistency group.

Name

Type

Description

name

string

The name of the consistency group.

uuid

string

The unique identifier of the consistency group.

storage_service

Determines the placement of any storage object created during this operation.

Name	Type	Description
name	string	Storage service name. If not specified, the default value is the most performant for the platform.

Name

Type

Description

name

string

Storage service name. If not specified, the default value is the most performant for the platform.

provisioning_options

Options that are applied to the operation.

Name	Type	Description
action	string	Operation to perform
name	string	New name for consistency group. Required to resolve naming collisions.
storage_service	storage_service	Determines the placement of any storage object created during this operation.

Name

Type

Description

action

string

Operation to perform

name

string

New name for consistency group. Required to resolve naming collisions.

storage_service

Determines the placement of any storage object created during this operation.

policy

The QoS policy

Name	Type	Description
name	string	The QoS policy group name. This is mutually exclusive with UUID and other QoS attributes during POST and PATCH.
uuid	string	The QoS policy group UUID. This is mutually exclusive with name and other QoS attributes during POST and PATCH.

Name

Type

Description

name

string

The QoS policy group name. This is mutually exclusive with UUID and other QoS attributes during POST and PATCH.

uuid

string

The QoS policy group UUID. This is mutually exclusive with name and other QoS attributes during POST and PATCH.

snapshot

A consistency group's snapshot

Name	Type	Description
name	string	The name of the consistency group's snapshot to restore to.
uuid	string	The UUID of the consistency group's snapshot to restore to.

Name

Type

Description

name

string

The name of the consistency group's snapshot to restore to.

uuid

string

The UUID of the consistency group's snapshot to restore to.

restore_to

Use to restore a consistency group to a previous snapshot

Name	Type	Description
snapshot	snapshot	A consistency group's snapshot

Name

Type

Description

snapshot

A consistency group's snapshot

snapshot_policy_reference

This is a reference to the snapshot policy.

Name	Type	Description
name	string
uuid	string

Name

Type

Description

name

string

uuid

string

space

Space information for the consistency group.

Name	Type	Description
available	integer	The amount of space available in the consistency group, in bytes.
size	integer	The total provisioned size of the consistency group, in bytes.
used	integer	The amount of space consumed in the consistency group, in bytes.

Name

Type

Description

available

integer

The amount of space available in the consistency group, in bytes.

size

integer

The total provisioned size of the consistency group, in bytes.

used

integer

The amount of space consumed in the consistency group, in bytes.

svm

The Storage Virtual Machine (SVM) in which the consistency group is located.

Name	Type	Description
name	string	The name of the SVM. This field cannot be specified in a PATCH method.
uuid	string	The unique identifier of the SVM. This field cannot be specified in a PATCH method.

Name

Type

Description

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

object_stores

Name	Type	Description
name	string	The name of the object store to use. Used for placement.

Name

Type

Description

name

string

The name of the object store to use. Used for placement.

tiering

The tiering placement and policy definitions for volumes in this consistency group.

Name	Type	Description
control	string	Storage tiering placement rules for the object.
object_stores	array[object_stores]	Object stores to use. Used for placement.

Name

Type

Description

control

string

Storage tiering placement rules for the object.

object_stores

array[object_stores]

Object stores to use. Used for placement.

acls

The permissions that users and groups have on a CIFS share.

Name	Type	Description
permission	string	Specifies the access rights that a user or group has on the defined CIFS Share. The following values are allowed: no_access - User does not have CIFS share access read - User has only read access change - User has change access full_control - User has full_control access

Name

Type

Description

permission

string

Specifies the access rights that a user or group has on the defined CIFS Share. The following values are allowed:

no_access - User does not have CIFS share access
read - User has only read access
change - User has change access
full_control - User has full_control access

consistency_group_cifs_share

CIFS share is a named access point in a volume. Before users and applications can access data on the CIFS server over SMB, a CIFS share must be created with sufficient share permission. CIFS shares are tied to the CIFS server on the SVM. When a CIFS share is created, ONTAP creates a default ACL for the share with Full Control permissions for Everyone.

Name	Type	Description
access_based_enumeration	boolean	Specifies whether all folders inside this share are visible to a user based on that individual user's access right; prevents the display of folders or other shared resources that the user does not have access to.
allow_unencrypted_access	boolean	Specifies whether or not the SMB2 clients are allowed to access the encrypted share.
change_notify	boolean	Specifies whether CIFS clients can request for change notifications for directories on this share.
comment	string	Specify the CIFS share descriptions.
continuously_available	boolean	Specifies whether or not the clients connecting to this share can open files in a persistent manner. Files opened in this way are protected from disruptive events, such as, failover and giveback. If the Vscan ONTAP feature is used, it is not supported in continuous availability (CA) shares. Default value: 1 Introduced in: 9.12 x-nullable: true
dir_umask	integer	Directory mode creation mask to be viewed as an octal number.
encryption	boolean	Specifies whether SMB encryption must be used when accessing this share. Clients that do not support encryption are not able to access this share.
file_umask	integer	File mode creation mask to be viewed as an octal number.
namespace_caching	boolean	Specifies whether or not the SMB clients connecting to this share can cache the directory enumeration results returned by the CIFS servers.
no_strict_security	boolean	Specifies whether or not CIFS clients can follow Unix symlinks outside the share boundaries.
offline_files	string	Offline Files The supported values are: none - Clients are not permitted to cache files for offline access. manual - Clients may cache files that are explicitly selected by the user for offline access. documents - Clients may automatically cache files that are used by the user for offline access. programs - Clients may automatically cache files that are used by the user for offline access and may use those files in an offline mode even if the share is available.
oplocks	boolean	Specifies whether opportunistic locks are enabled on this share. "Oplocks" allow clients to lock files and cache content locally, which can increase performance for file operations.
show_snapshot	boolean	Specifies whether or not the snapshots can be viewed and traversed by clients.
unix_symlink	string	Controls the access of UNIX symbolic links to CIFS clients. The supported values are: local - Enables only local symbolic links which is within the same CIFS share. widelink - Enables both local symlinks and widelinks. disable - Disables local symlinks and widelinks.
vscan_profile	string	Vscan File-Operations Profile The supported values are: no_scan - Virus scans are never triggered for accesses to this share. standard - Virus scans can be triggered by open, close, and rename operations. strict - Virus scans can be triggered by open, read, close, and rename operations. writes_only - Virus scans can be triggered only when a file that has been modified is closed.

Name

Type

Description

access_based_enumeration

boolean

Specifies whether all folders inside this share are visible to a user based on that individual user's access right; prevents the display of folders or other shared resources that the user does not have access to.

allow_unencrypted_access

boolean

Specifies whether or not the SMB2 clients are allowed to access the encrypted share.

change_notify

boolean

Specifies whether CIFS clients can request for change notifications for directories on this share.

comment

string

Specify the CIFS share descriptions.

continuously_available

boolean

Specifies whether or not the clients connecting to this share can open files in a persistent manner. Files opened in this way are protected from disruptive events, such as, failover and giveback. If the Vscan ONTAP feature is used, it is not supported in continuous availability (CA) shares.

Default value: 1
Introduced in: 9.12
x-nullable: true

dir_umask

integer

Directory mode creation mask to be viewed as an octal number.

encryption

boolean

Specifies whether SMB encryption must be used when accessing this share. Clients that do not support encryption are not able to access this share.

file_umask

integer

File mode creation mask to be viewed as an octal number.

namespace_caching

boolean

Specifies whether or not the SMB clients connecting to this share can cache the directory enumeration results returned by the CIFS servers.

no_strict_security

boolean

Specifies whether or not CIFS clients can follow Unix symlinks outside the share boundaries.

offline_files

string

Offline Files The supported values are:

none - Clients are not permitted to cache files for offline access.
manual - Clients may cache files that are explicitly selected by the user for offline access.
documents - Clients may automatically cache files that are used by the user for offline access.
programs - Clients may automatically cache files that are used by the user for offline access and may use those files in an offline mode even if the share is available.

oplocks

boolean

Specifies whether opportunistic locks are enabled on this share. "Oplocks" allow clients to lock files and cache content locally, which can increase performance for file operations.

show_snapshot

boolean

Specifies whether or not the snapshots can be viewed and traversed by clients.

unix_symlink

string

Controls the access of UNIX symbolic links to CIFS clients. The supported values are:

local - Enables only local symbolic links which is within the same CIFS share.
widelink - Enables both local symlinks and widelinks.
disable - Disables local symlinks and widelinks.

vscan_profile

string

Vscan File-Operations Profile The supported values are:

no_scan - Virus scans are never triggered for accesses to this share.
standard - Virus scans can be triggered by open, close, and rename operations.
strict - Virus scans can be triggered by open, read, close, and rename operations.
writes_only - Virus scans can be triggered only when a file that has been modified is closed.

cifs

Name	Type	Description
shares	array[consistency_group_cifs_share]

Name

Type

Description

array[consistency_group_cifs_share]

export_clients

Name	Type	Description
match	string	Client Match Hostname, IP Address, Netgroup, or Domain. You can specify the match as a string value in any of the following formats: As a hostname; for instance, host1 As an IPv4 address; for instance, 10.1.12.24 As an IPv6 address; for instance, fd20:8b1e:b255:4071::100:1 As an IPv4 address with a subnet mask expressed as a number of bits; for instance, 10.1.12.0/24 As an IPv6 address with a subnet mask expressed as a number of bits; for instance, fd20:8b1e:b255:4071::/64 As an IPv4 address with a network mask; for instance, 10.1.16.0/255.255.255.0 As a netgroup, with the netgroup name preceded by the @ character; for instance, @eng As a domain name preceded by the . character; for instance, .example.com

Name

Type

Description

match

string

Client Match Hostname, IP Address, Netgroup, or Domain. You can specify the match as a string value in any of the following formats:

As a hostname; for instance, host1
As an IPv4 address; for instance, 10.1.12.24
As an IPv6 address; for instance, fd20:8b1e:b255:4071::100:1
As an IPv4 address with a subnet mask expressed as a number of bits; for instance, 10.1.12.0/24
As an IPv6 address with a subnet mask expressed as a number of bits; for instance, fd20:8b1e:b255:4071::/64
As an IPv4 address with a network mask; for instance, 10.1.16.0/255.255.255.0
As a netgroup, with the netgroup name preceded by the @ character; for instance, @eng
As a domain name preceded by the . character; for instance, .example.com

export_rules

Name	Type	Description
allow_device_creation	boolean	Specifies whether or not device creation is allowed.
allow_suid	boolean	Specifies whether or not SetUID bits in SETATTR Op is to be honored.
anonymous_user	string	User ID To Which Anonymous Users Are Mapped.
chown_mode	string	Specifies who is authorized to change the ownership mode of a file.
clients	array[export_clients]	Array of client matches
index	integer	Index of the rule within the export policy.
ntfs_unix_security	string	NTFS export UNIX security options.
protocols	array[string]
ro_rule	array[string]	Authentication flavors that the read-only access rule governs
rw_rule	array[string]	Authentication flavors that the read/write access rule governs
superuser	array[string]	Authentication flavors that the superuser security type governs

Name

Type

Description

allow_device_creation

boolean

Specifies whether or not device creation is allowed.

allow_suid

boolean

Specifies whether or not SetUID bits in SETATTR Op is to be honored.

anonymous_user

string

User ID To Which Anonymous Users Are Mapped.

chown_mode

string

Specifies who is authorized to change the ownership mode of a file.

clients

array[export_clients]

Array of client matches

index

integer

Index of the rule within the export policy.

ntfs_unix_security

string

NTFS export UNIX security options.

protocols

array[string]

ro_rule

array[string]

Authentication flavors that the read-only access rule governs

rw_rule

array[string]

Authentication flavors that the read/write access rule governs

superuser

array[string]

Authentication flavors that the superuser security type governs

export_policy

The policy associated with volumes to export them for protocol access.

Name	Type	Description
id	integer	Identifier for the export policy.
name	string	Name of the export policy.
rules	array[export_rules]	The set of rules that govern the export policy.

Name

Type

Description

integer

Identifier for the export policy.

name

string

Name of the export policy.

rules

array[export_rules]

The set of rules that govern the export policy.

junction_parent

Name

Type

Description

name

string

The name of the parent volume that contains the junction inode of this volume. The junction parent volume must belong to the same SVM that owns this volume.

uuid

string

Unique identifier for the parent volume.

nas

The CIFS share policy and/or export policies for this volume.

Name

Type

Description

cifs

export_policy

The policy associated with volumes to export them for protocol access.

provisioning_options

Options that are applied to the operation.

Name

Type

Description

action

string

Operation to perform

count

integer

Number of elements to perform the operation on.

storage_service

Determines the placement of any storage object created during this operation.

qos

The QoS policy for this volume.

Name

Type

Description

policy

The QoS policy

space

Name

Type

Description

available

integer

The available space, in bytes.

size

integer

Total provisioned size, in bytes.

used

integer

The virtual space used (includes volume reserves) before storage efficiency, in bytes.

tiering

The tiering placement and policy definitions for this volume.

Name

Type

Description

control

string

Storage tiering placement rules for the object.

object_stores

array[object_stores]

Object stores to use. Used for placement.

volumes

Name

Type

Description

comment

string

A comment for the volume. Valid in POST or PATCH.

name

string

Volume name. The name of volume must start with an alphabetic character (a to z or A to Z) or an underscore (_). The name must be 197 or fewer characters in length for FlexGroup volumes, and 203 or fewer characters in length for all other types of volumes. Volume names must be unique within an SVM. Required on POST.

nas

The CIFS share policy and/or export policies for this volume.

provisioning_options

Options that are applied to the operation.

qos

The QoS policy for this volume.

snapshot_policy

snapshot_policy_reference

This is a reference to the snapshot policy.

space

tiering

The tiering placement and policy definitions for this volume.

uuid

string

Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

example: 028baa66-41bd-11e9-81d5-00a0986138f7
readOnly: 1
Introduced in: 9.8
x-nullable: true

consistency_groups

Name

Type

Description

_tags

array[string]

Tags are an optional way to track the uses of a resource. Tag values must be formatted as key:value strings.

application

luns

array[luns]

namespaces

array[namespaces]

minItems: 0
uniqueItems: 1
Introduced in: 9.10

parent_consistency_group

The parent consistency group.

provisioning_options

Options that are applied to the operation.

qos

restore_to

Use to restore a consistency group to a previous snapshot

snapshot_policy

snapshot_policy_reference

This is a reference to the snapshot policy.

uuid

string

The unique identifier of the consistency group. The UUID is generated by ONTAP when the consistency group is created.

example: 1cd8a442-86d1-11e0-ae1c-123478563412
readOnly: 1
Introduced in: 9.10
x-nullable: true

volumes

array[volumes]

A consistency group is a mutually exclusive aggregation of volumes or other consistency groups. A volume can only be associated with one direct parent consistency group.

The total number of volumes across all child consistency groups contained in a consistency group is constrained by the same limit.

iops

The rate of I/O operations observed at the storage object.

Name

Type

Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Performance metric for write I/O operations.

latency

The round trip latency observed at the storage object, in microseconds.

Name

Type

Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Performance metric for write I/O operations.

throughput

The rate of throughput bytes per second observed at the storage object.

Name

Type

Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Performance metric for write I/O operations.

metric

Performance and capacity numbers, such as, IOPS, latency, throughput, used space, and available space.

Name

Type

Description

available_space

integer

The total space available in the consistency group, in bytes.

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

iops

The rate of I/O operations observed at the storage object.

latency

The round trip latency observed at the storage object, in microseconds.

size

integer

The total size of the consistency group, in bytes.

status

string

Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput

The rate of throughput bytes per second observed at the storage object.

timestamp

string

The timestamp of the performance and capacity data.

used_space

integer

The total space used in the consistency group, in bytes.

replication_relationships

Name

Type

Description

is_protected_by_svm_dr

boolean

Indicates whether or not this consistency group is protected by SVM DR.

is_source

boolean

Indicates whether or not this consistency group is the source for replication.

uuid

string

The unique identifier of the SnapMirror relationship.

iops_raw

The number of I/O operations observed at the storage object. This can be used along with delta time to calculate the rate of I/O operations per unit of time.

Name

Type

Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Performance metric for write I/O operations.

latency_raw

The raw latency observed at the storage object, in microseconds. This can be divided by the raw IOPS value to calculate the average latency per I/O operation.

Name

Type

Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Performance metric for write I/O operations.

throughput_raw

Throughput bytes observed at the storage object. This can be used along with delta time to calculate the rate of throughput bytes per unit of time.

Name

Type

Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Performance metric for write I/O operations.

statistics

These are raw performance and space numbers, such as, IOPS, latency, throughput, used space, and available space. These numbers are aggregated across all nodes in the cluster and increase with the uptime of the cluster.

Name

Type

Description

available_space

integer

The total space available in the consistency group, in bytes.

iops_raw

The number of I/O operations observed at the storage object. This can be used along with delta time to calculate the rate of I/O operations per unit of time.

latency_raw

The raw latency observed at the storage object, in microseconds. This can be divided by the raw IOPS value to calculate the average latency per I/O operation.

size

integer

The total size of the consistency group, in bytes.

status

string

throughput_raw

Throughput bytes observed at the storage object. This can be used along with delta time to calculate the rate of throughput bytes per unit of time.

timestamp

string

The timestamp of the performance data.

used_space

integer

The total used space in the consistency group, in bytes.

consistency_group

Name

Type

Description

_tags

array[string]

Tags are an optional way to track the uses of a resource. Tag values must be formatted as key:value strings.

application

clone

Creates a clone of an existing consistency group from the current contents or an existing snapshot.

consistency_groups

array[consistency_groups]

A consistency group is a mutually exclusive aggregation of volumes or other consistency groups. A consistency group can only be associated with one direct parent consistency group.

luns

array[luns]

namespaces

array[namespaces]

minItems: 0
uniqueItems: 1
Introduced in: 9.10

parent_consistency_group

The parent consistency group.

provisioning_options

Options that are applied to the operation.

qos

replicated

boolean

Indicates whether or not replication has been enabled on this consistency group.

replication_relationships

array[replication_relationships]

Indicates the SnapMirror relationship of this consistency group.

replication_source

boolean

Since support for this field is to be removed in the next release, use replication_relationships.is_source instead.

restore_to

Use to restore a consistency group to a previous snapshot

snapshot_policy

snapshot_policy_reference

This is a reference to the snapshot policy.

uuid

string

The unique identifier of the consistency group. The UUID is generated by ONTAP when the consistency group is created.

example: 1cd8a442-86d1-11e0-ae1c-123478563412
readOnly: 1
Introduced in: 9.10
x-nullable: true

vdisk_type

string

Type of objects in the consistency group.

volumes

array[volumes]

A consistency group is a mutually exclusive aggregation of volumes or other consistency groups. A volume can only be associated with one direct parent consistency group.

The total number of volumes across all child consistency groups contained in a consistency group is constrained by the same limit.

error_arguments

Name

Type

Description

code

string

Argument code

message

string

Message argument

returned_error

Name

Type

Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.

Update a consistency group

Creating your file...

Related ONTAP commands

Parameters

Request Body

Response

Response

Error

Definitions