Skip to main content
REST API reference

Modify the mediator configuration

PDFs

PATCH /cluster/mediators/{uuid}

Introduced In: 9.17

Modifies the mediator configuration.

Parameters

Name Type In Required Description

uuid

string

path

True

  • format: uuid

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

dr_group

dr_group

DR group reference.

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_mediator_connectivity

string

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

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

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

uuid

string

The unique identifier for the mediator service.
Example request 
{
  "dr_group": {
    "id": 0
  },
  "local_mediator_connectivity": "connected",
  "peer_mediator_connectivity": "connected",
  "reachable": 1,
  "strict_cert_validation": 1,
  "use_http_proxy_local": 1,
  "use_http_proxy_remote": 1,
  "uuid": "string"
}

Response

Status: 200, Ok
Name Type Description

job

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

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response codes

Error code Description

13369377

Mediator field "mediator.id" does not exist.

13369412

Modification of the mediator configuration succeeded on the peer cluster but failed on the local cluster. Reason : {Reason of failure}. Wait a few minutes, then try the operation again.

13369421

Failed to modify mediator configuration on the cluster. Reason : {Reason of failure}. Wait a few minutes, then try the operation again.

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

dr_group

dr_group

DR group reference.

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_mediator_connectivity

string

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

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

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

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.