Skip to main content
A newer release of this product is available.

Retrieve configuration information for all SVM pairs in a MetroCluster configuration

Contributors
PDFs

GET /cluster/metrocluster/svms

Introduced In: 9.11

Retrieves configuration information for all pairs of SVMs in MetroCluster. REST /api/cluster/metrocluster/svms/?

Parameters

Name Type In Required Description

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

cluster.name

string

query

False

Filter by cluster.name

cluster.uuid

string

query

False

Filter by cluster.uuid

configuration_state

string

query

False

Filter by configuration_state

failed_reason

string

query

False

Filter by failed_reason

partner_svm.name

string

query

False

Filter by partner_svm.name

partner_svm.uuid

string

query

False

Filter by partner_svm.uuid

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

collection_links

num_records

integer

Number of Records

records

array[metrocluster_svm]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "cluster": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "cluster1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "configuration_state": "degraded",
    "failed_reason": {
      "arguments": {
        "code": "string",
        "message": "string"
      },
      "code": "4",
      "message": "entry doesn't exist",
      "target": "uuid"
    },
    "partner_svm": {
      "name": "string",
      "uuid": "string"
    },
    "svm": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    }
  }
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string
Name Type Description

next

href

self

href
Name Type Description

self

href

_links

Name Type Description

self

href

cluster

Name Type Description

_links

_links

name

string

uuid

string

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Reason for SVM object replication failure.

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.

partner_svm

Name Type Description

name

string

MetroCluster partner SVM name.

uuid

string

MetroCluster partner SVM UUID.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

metrocluster_svm

Retrieves configuration information for all pairs of SVMs in MetroCluster. REST /api/cluster/metrocluster/svms/?

Name Type Description

_links

self_link

cluster

cluster

configuration_state

string

Configuration state.

failed_reason

error

Reason for SVM object replication failure.

partner_svm

partner_svm

svm

svm

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.