Skip to main content
REST API reference

Create and connect an ONTAP Mediator

PDFs

POST /cluster/mediators

Introduced In: 9.8

Creates and connect a mediator.

Parameters

Name Type In Required Description

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

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

bluexp_account_token

string

BlueXP account token. This field is only applicable to the ONTAP cloud mediator.

  • x-ntap-createOnly: true

  • Introduced in: 9.17

  • x-nullable: true

bluexp_org_id

string

BlueXP organization ID. This field is only applicable to the ONTAP cloud mediator.

  • x-ntap-createOnly: true

  • Introduced in: 9.17

  • x-nullable: true

ca_certificate

string

CA certificate for ONTAP Mediator. This is optional if the certificate is already installed.

  • x-ntap-createOnly: true

  • Introduced in: 9.8

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

password

string

The password used to connect to the REST server on the mediator.

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.

service_account_client_id

string

Client ID of the BlueXP service account. This field is only applicable to the ONTAP cloud mediator.

  • x-ntap-createOnly: true

  • Introduced in: 9.17

  • x-nullable: true

service_account_client_secret

string

Client secret token of the BlueXP service account. This field is only applicable to the ONTAP cloud mediator.

  • x-ntap-createOnly: true

  • Introduced in: 9.17

  • x-nullable: true

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

use_http_proxy_remote

boolean

Indicates if the remote 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

  • writeOnly: 1

  • x-nullable: true

user

string

The username used to connect to the REST server on the mediator.

uuid

string

The unique identifier for the mediator service.
Example request 
{
  "bluexp_account_token": "string",
  "bluexp_org_id": "string",
  "ca_certificate": "string",
  "dr_group": {
    "id": 0
  },
  "ip_address": "10.10.10.7",
  "local_mediator_connectivity": "connected",
  "password": "mypassword",
  "peer_cluster": {
    "name": "cluster2",
    "uuid": "ebe27c49-1adf-4496-8335-ab862aebebf2"
  },
  "peer_mediator_connectivity": "connected",
  "port": 31784,
  "reachable": 1,
  "service_account_client_id": "string",
  "service_account_client_secret": "string",
  "strict_cert_validation": 1,
  "type": "string",
  "use_http_proxy_local": 1,
  "use_http_proxy_remote": 1,
  "user": "myusername",
  "uuid": "string"
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "uuid": "string"
  }
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Response

Status: 201, Created

Error

Status: Default

ONTAP Error Response codes

Error code Description

13369351

Update to mediator failed. Reason: does not authorized for that command. Check that the peer cluster and mediator are reachable.

2430758

Mediator cannot be added. Reason: Some of the nodes in the cluster have incorrect MetroCluster IP configuration.

2430734

Unable to add Mediator. Reason : Authentication failed.

2430774

Failed to add Mediator. Reason : Node is not reachable or does not exist.

2432871

Failed to add Mediator. Reason : Some of the parameters in the request is invalid.

Definitions

See Definitions

dr_group

DR group reference.

Name Type Description

id

integer

DR Group ID

href

Name Type Description

href

string

_links

peer_cluster

The peer cluster that the mediator service is used for.

Name Type Description

name

string

uuid

string

mediator

Mediator information

Name Type Description

bluexp_account_token

string

BlueXP account token. This field is only applicable to the ONTAP cloud mediator.

  • x-ntap-createOnly: true

  • Introduced in: 9.17

  • x-nullable: true

bluexp_org_id

string

BlueXP organization ID. This field is only applicable to the ONTAP cloud mediator.

  • x-ntap-createOnly: true

  • Introduced in: 9.17

  • x-nullable: true

ca_certificate

string

CA certificate for ONTAP Mediator. This is optional if the certificate is already installed.

  • x-ntap-createOnly: true

  • Introduced in: 9.8

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

password

string

The password used to connect to the REST server on the mediator.

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.

service_account_client_id

string

Client ID of the BlueXP service account. This field is only applicable to the ONTAP cloud mediator.

  • x-ntap-createOnly: true

  • Introduced in: 9.17

  • x-nullable: true

service_account_client_secret

string

Client secret token of the BlueXP service account. This field is only applicable to the ONTAP cloud mediator.

  • x-ntap-createOnly: true

  • Introduced in: 9.17

  • x-nullable: true

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:

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

  • example: true

  • Introduced in: 9.17

  • x-nullable: true

use_http_proxy_remote

boolean

Indicates if the remote 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:

  • example: true

  • Introduced in: 9.17

  • writeOnly: 1

  • x-nullable: true

user

string

The username used to connect to the REST server on the mediator.

uuid

string

The unique identifier for the mediator service.
Name Type Description

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

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.