Skip to main content

Update a consistency group

Contributors

PATCH /application/consistency-groups/{uuid}

Introduced In: 9.10

Updates a consistency group.

Note 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.

N/A. There are no ONTAP commands for managing consistency groups.

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

Request Body

Name Type Description

_links

self_link

_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 copy.

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.

metric

metric

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

name

string

Name of the consistency group. The consistency group name must be unique within an SVM.

If not provided and the consistency group contains only one volume, the name will be generated based on the volume name. If the consistency group contains more than one volume, the name is required.

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.

  • maxItems: 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 copy

snaplock

snaplock

snapshot_policy

snapshot_policy_reference

This is a reference to the Snapshot copy policy.

space

space

Space information for the consistency group.

statistics

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.

svm

svm

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

tiering

tiering

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

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
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "_tags": [
    "team:csi",
    "environment:test"
  ],
  "application": {
    "component_type": "string",
    "type": "string"
  },
  "clone": {
    "guarantee": {
      "type": "string"
    },
    "parent_consistency_group": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "my_consistency_group",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    },
    "parent_snapshot": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "this_snapshot",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "parent_svm": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    },
    "split_complete_percent": 0,
    "split_estimate": 0,
    "volume": {
      "prefix": "string",
      "suffix": "string"
    }
  },
  "consistency_groups": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "_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": [
                  {
                    "_links": {
                      "self": {
                        "href": "/api/resourcelink"
                      }
                    },
                    "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",
                "protocol": "string",
                "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
              }
            }
          ],
          "name": "/vol/volume1/lun1",
          "os_type": "string",
          "provisioning_options": {
            "action": "string"
          },
          "qos": {
            "policy": {
              "_links": {
                "self": {
                  "href": "/api/resourcelink"
                }
              },
              "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"
        }
      ],
      "name": "string",
      "namespaces": [
        {
          "comment": "string",
          "create_time": "2018-06-04 15:00:00 -0400",
          "name": "/vol/volume1/qtree1/namespace1",
          "os_type": "string",
          "provisioning_options": {
            "action": "string"
          },
          "space": {
            "block_size": 512,
            "size": 1073741824,
            "used": 0
          },
          "status": {
            "container_state": "string",
            "state": "online"
          },
          "subsystem_map": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "anagrpid": "00103050h",
            "nsid": "00000001h",
            "subsystem": {
              "comment": "string",
              "hosts": [
                {
                  "dh_hmac_chap": {
                    "controller_secret_key": "DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n:",
                    "group_size": "string",
                    "hash_function": "string",
                    "host_secret_key": "DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n:"
                  },
                  "nqn": "nqn.1992-01.example.com:string",
                  "priority": "string"
                }
              ],
              "name": "subsystem1",
              "os_type": "string",
              "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
            }
          },
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      ],
      "parent_consistency_group": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "my_consistency_group",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "provisioning_options": {
        "action": "string",
        "name": "string",
        "storage_service": {
          "name": "string"
        }
      },
      "qos": {
        "policy": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "performance",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      },
      "restore_to": {
        "snapshot": {
          "lun": {
            "name": "string",
            "uuid": "string"
          },
          "name": "string",
          "namespace": {
            "name": "string",
            "uuid": "string"
          },
          "uuid": "string"
        }
      },
      "snapshot_policy": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "default",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "space": {
        "available": 5737418,
        "size": 1073741824,
        "used": 5737418
      },
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "tiering": {
        "control": "string",
        "object_stores": [
          {
            "name": "string"
          }
        ],
        "policy": "string"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
      "volumes": [
        {
          "comment": "string",
          "name": "vol_cs_dept",
          "nas": {
            "cifs": {
              "shares": [
                {
                  "_links": {
                    "self": {
                      "href": "/api/resourcelink"
                    }
                  },
                  "acls": [
                    {
                      "_links": {
                        "self": {
                          "href": "/api/resourcelink"
                        }
                      },
                      "permission": "string",
                      "type": "string",
                      "user_or_group": "ENGDOMAIN\\ad_user"
                    }
                  ],
                  "comment": "HR Department Share",
                  "dir_umask": 18,
                  "file_umask": 18,
                  "name": "HR_SHARE",
                  "offline_files": "string",
                  "unix_symlink": "string",
                  "vscan_profile": "string"
                }
              ]
            },
            "export_policy": {
              "_links": {
                "self": {
                  "href": "/api/resourcelink"
                }
              },
              "id": 0,
              "name": "string",
              "rules": [
                {
                  "_links": {
                    "self": {
                      "href": "/api/resourcelink"
                    }
                  },
                  "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"
                  ]
                }
              ]
            },
            "junction_parent": {
              "_links": {
                "self": {
                  "href": "/api/resourcelink"
                }
              },
              "name": "vs1_root",
              "uuid": "75c9cfb0-3eb4-11eb-9fb4-005056bb088a"
            },
            "path": "/user/my_volume",
            "security_style": "string",
            "unix_permissions": 493
          },
          "provisioning_options": {
            "action": "string",
            "storage_service": {
              "name": "string"
            }
          },
          "qos": {
            "policy": {
              "_links": {
                "self": {
                  "href": "/api/resourcelink"
                }
              },
              "name": "performance",
              "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
            }
          },
          "snapshot_policy": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "default",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          },
          "space": {
            "available": 0,
            "used": 0
          },
          "tiering": {
            "control": "string",
            "object_stores": [
              {
                "name": "string"
              }
            ],
            "policy": "string"
          },
          "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
        }
      ]