Skip to main content
REST API reference

Retrieve the ONTAP Mediator state and configuration

Accesses the Mediator state and configuration, which provides details about the current status and setup.

HTTP method and endpoint

GET /cluster/mediators/{uuid}

Introduced in

ONTAP 9.8

Usage notes

"Retrieves the Mediator state and configuration."

  • storage iscsi-initiator show

Parameters

Name Type In Required Description

uuid

string

path

True

  • format: uuid

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

connection_type

string

Connection type from ONTAP MetroCluster to mediator. Applicable only to on-prem mediator used in ONTAP MetroCluster configurations.

  • Default value: 1

  • enum: ["iscsi_mediator", "https_mediator"]

  • Introduced in: 9.19

  • readCreate: 1

  • x-nullable: true

dr_group

dr_group

DR group reference.

ip_address

string

The IP address of the mediator.

local_mediator_connectivity

string

Indicates the mediator connectivity status of the local cluster. Possible values are connected, unreachable, unusable and down-high-latency. This field is only applicable to the mediators in SnapMirror active sync configuration.

peer_cluster

peer_cluster

The peer cluster that the mediator service is used for.

peer_mediator_connectivity

string

Indicates the mediator connectivity status of the peer cluster. Possible values are connected, unreachable, unknown and down-high-latency.

port

integer

The REST server's port number on the mediator.

reachable

boolean

Indicates the connectivity status of the mediator.

strict_cert_validation

boolean

Indicates if strict validation of certificates is performed while making REST API calls to the mediator. This field is only applicable to the ONTAP Cloud Mediator.

  • Default value: 1

  • example: true

  • Introduced in: 9.17

  • x-nullable: true

type

string

Mediator type. This field is only applicable to the mediators in SnapMirror active sync configuration.

use_http_proxy_local

boolean

Indicates if the local cluster should use an http-proxy server while making REST API calls to the mediator. This field is only applicable to the ONTAP cloud mediator.

  • Default value: 1

  • example: true

  • Introduced in: 9.17

  • x-nullable: true

uuid

string

The unique identifier for the mediator service.

Example response
{
  "connection_type": "string",
  "dr_group": {
    "id": 0
  },
  "ip_address": "10.10.10.7",
  "local_mediator_connectivity": "connected",
  "peer_cluster": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "cluster2",
    "uuid": "ebe27c49-1adf-4496-8335-ab862aebebf2"
  },
  "peer_mediator_connectivity": "connected",
  "port": 31784,
  "reachable": 1,
  "strict_cert_validation": 1,
  "type": "string",
  "use_http_proxy_local": 1,
  "use_http_proxy_remote": 1,
  "uuid": "string"
}

Error

Status: Default, Error
Name Type Description

error

returned_error

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

Definitions

See Definitions

dr_group

DR group reference.

Name Type Description

id

integer

DR Group ID

href

Name Type Description

href

string

Name Type Description

self

href

peer_cluster

The peer cluster that the mediator service is used for.

Name Type Description

_links

_links

name

string

uuid

string

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.