Skip to main content

Retrieve details of a collection or consistency group

Contributors
PDFs

GET /application/consistency-groups

Introduced In: 9.10

Retrieve details of a collection or a specific consistency group.

Notes

When volume granular properties, such as, the storage SLC, Fabric Pool tiering are not the same for all the existing volumes of a consistency group, the corresponding property is not reported at consistency group granularity. It is only reported if all the volumes of the consistency group have the same value for that property.

If this consistency group instance has 1 or more replication relationships, the "replicated" parameter is true. If there are no associated replication relationships, it is false. This parameter is only included in the output for Single-CG and Parent-CG, not for Child-CG. If this consistency group instance has 1 or more replication relationships, the "replication_relationships" parameter is included in the output for Single-CG and Parent-CG instances. If there are no associated replication relationships, this parameter is not included in the output. Note that this parameter is an array and as such it has as many elements as the number of replication relationships associated with this consistency group. Each element of the array describes properties of one replication relationship associated with this consistency group. The "uuid" parameter identifies a specific replication relationship and the "href" parameter is a link to the corresponding SnapMirror relationship. The "is_source" parameter is true if this consistency group is the source in that relationship, otherwise it is false.

Expensive properties

There is an added computational cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See DOC Requesting specific fields to learn more.

  • volumes

  • luns

  • namespaces

Parameters

Name Type In Required Description

tiering.policy

string

query

False

Filter by tiering.policy

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

space.available

integer

query

False

Filter by space.available

space.size

integer

query

False

Filter by space.size

space.used

integer

query

False

Filter by space.used

metric.used_space

integer

query

False

Filter by metric.used_space

  • Introduced in: 9.13

metric.size

integer

query

False

Filter by metric.size

  • Introduced in: 9.13

metric.status

string

query

False

Filter by metric.status

  • Introduced in: 9.13

metric.iops.write

integer

query

False

Filter by metric.iops.write

  • Introduced in: 9.13

metric.iops.read

integer

query

False

Filter by metric.iops.read

  • Introduced in: 9.13

metric.iops.other

integer

query

False

Filter by metric.iops.other

  • Introduced in: 9.13

metric.iops.total

integer

query

False

Filter by metric.iops.total

  • Introduced in: 9.13

metric.timestamp

string

query

False

Filter by metric.timestamp

  • Introduced in: 9.13

metric.latency.write

integer

query

False

Filter by metric.latency.write

  • Introduced in: 9.13

metric.latency.read

integer

query

False

Filter by metric.latency.read

  • Introduced in: 9.13

metric.latency.other

integer

query

False

Filter by metric.latency.other

  • Introduced in: 9.13

metric.latency.total

integer

query

False

Filter by metric.latency.total

  • Introduced in: 9.13

metric.throughput.write

integer

query

False

Filter by metric.throughput.write

  • Introduced in: 9.13

metric.throughput.read

integer

query

False

Filter by metric.throughput.read

  • Introduced in: 9.13

metric.throughput.other

integer

query

False

Filter by metric.throughput.other

  • Introduced in: 9.13

metric.throughput.total

integer

query

False

Filter by metric.throughput.total

  • Introduced in: 9.13

metric.duration

string

query

False

Filter by metric.duration

  • Introduced in: 9.13

metric.available_space

integer

query

False

Filter by metric.available_space

  • Introduced in: 9.13

application.component_type

string

query

False

Filter by application.component_type

  • Introduced in: 9.12

application.type

string

query

False

Filter by application.type

  • Introduced in: 9.12

volumes.qos.policy.uuid

string

query

False

Filter by volumes.qos.policy.uuid

volumes.qos.policy.name

string

query

False

Filter by volumes.qos.policy.name

volumes.nas.cifs.shares.continuously_available

boolean

query

False

Filter by volumes.nas.cifs.shares.continuously_available

  • Introduced in: 9.12

volumes.nas.cifs.shares.unix_symlink

string

query

False

Filter by volumes.nas.cifs.shares.unix_symlink

  • Introduced in: 9.12

volumes.nas.cifs.shares.offline_files

string

query

False

Filter by volumes.nas.cifs.shares.offline_files

  • Introduced in: 9.12

volumes.nas.cifs.shares.comment

string

query

False

Filter by volumes.nas.cifs.shares.comment

  • Introduced in: 9.12

  • maxLength: 256

  • minLength: 1

volumes.nas.cifs.shares.file_umask

integer

query

False

Filter by volumes.nas.cifs.shares.file_umask

  • Introduced in: 9.12

volumes.nas.cifs.shares.change_notify

boolean

query

False

Filter by volumes.nas.cifs.shares.change_notify

  • Introduced in: 9.12

volumes.nas.cifs.shares.no_strict_security

boolean

query

False

Filter by volumes.nas.cifs.shares.no_strict_security

  • Introduced in: 9.12

volumes.nas.cifs.shares.acls.permission

string

query

False

Filter by volumes.nas.cifs.shares.acls.permission

  • Introduced in: 9.12

volumes.nas.cifs.shares.acls.user_or_group

string

query

False

Filter by volumes.nas.cifs.shares.acls.user_or_group

  • Introduced in: 9.12

volumes.nas.cifs.shares.acls.type

string

query

False

Filter by volumes.nas.cifs.shares.acls.type

  • Introduced in: 9.12

volumes.nas.cifs.shares.vscan_profile

string

query

False

Filter by volumes.nas.cifs.shares.vscan_profile

  • Introduced in: 9.12

volumes.nas.cifs.shares.name

string

query

False

Filter by volumes.nas.cifs.shares.name

  • Introduced in: 9.12

  • maxLength: 80

  • minLength: 1

volumes.nas.cifs.shares.oplocks

boolean

query

False

Filter by volumes.nas.cifs.shares.oplocks

  • Introduced in: 9.12

volumes.nas.cifs.shares.show_snapshot

boolean

query

False

Filter by volumes.nas.cifs.shares.show_snapshot

  • Introduced in: 9.12

volumes.nas.cifs.shares.encryption

boolean

query

False

Filter by volumes.nas.cifs.shares.encryption

  • Introduced in: 9.12

volumes.nas.cifs.shares.home_directory

boolean

query

False

Filter by volumes.nas.cifs.shares.home_directory

  • Introduced in: 9.12

volumes.nas.cifs.shares.namespace_caching

boolean

query

False

Filter by volumes.nas.cifs.shares.namespace_caching

  • Introduced in: 9.12

volumes.nas.cifs.shares.dir_umask

integer

query

False

Filter by volumes.nas.cifs.shares.dir_umask

  • Introduced in: 9.12

volumes.nas.cifs.shares.access_based_enumeration

boolean

query

False

Filter by volumes.nas.cifs.shares.access_based_enumeration

  • Introduced in: 9.12

volumes.nas.cifs.shares.allow_unencrypted_access

boolean

query