Skip to main content
Command reference

snapmirror mediator add

Suggest changes

Create mediator config entry

Availability: This command is available to cluster administrators at the admin privilege level.

Description

The snapmirror mediator add command configures the connection between a pair of clusters and an ONTAP Mediator. It is mandatory to initialize the ONTAP Mediator on one of the cluster peers before the SnapMirror active sync relation with policy type automated-failover performs a planned or an unplanned failover. You can initialize the ONTAP Mediator from either cluster. When you issue the ONTAP Mediator add command on one cluster, the ONTAP Mediator is automatically added on the other cluster.

Parameters

-peer-cluster <text> - Peer cluster

Peer cluster with AutomatedFailOver SnapMirror relationships.

[-type {on-prem|cloud}] - Mediator Type

Specifies the type of the mediator. The value on-prem represents ONTAP Mediator. The value cloud represents ONTAP cloud mediator. The default value is on-prem .

{ -mediator-address <IP Address> - Mediator Ip Address

Specifies the IP address of the mediator. This is only applicable for ONTAP Mediator.

-username <text> - Username

User account at the mediator. This is only applicable for ONTAP Mediator.

[-port-number <integer>] - Port Number

This optional parameter specifies the mediator service port number to communicate with the mediator. The port number must be in the range 1025 to 65535 inclusive. The default port number is 31784. This is only applicable to ONTAP Mediator.

| [-bluexp-org-id <text>] - BlueXP Organization ID

BlueXP Organization ID of the user. This is only applicable for ONTAP cloud mediator.

[-service-account-client-id <text>] - Service Account Client ID }

Specifies BlueXP Service Account Client ID. This is only applicable for ONTAP cloud mediator.

[-use-http-proxy-local {true|false}] - Use HTTP Proxy on Local Cluster

Specifies if the local cluster should use http-proxy server while making REST API calls to mediator. This option is only supported for ONTAP cloud mediator.

[-use-http-proxy-remote {true|false}] - Use HTTP Proxy on Remote Cluster

Specifies if the remote cluster should use http-proxy server while making REST API calls to mediator. This option is only supported for ONTAP cloud mediator.

Examples

The following example configures the ONTAP Mediator.

clusA::> snapmirror mediator add -peer-cluster clusB -mediator-address 10.234.102.227 -username mediatoradmin
Notice: Enter the mediator password.
Enter the password:
            Enter the password again:
Info: [Job: 114] 'mediator add' job queued

The following example configures the ONTAP cloud mediator.

clusA::> snapmirror mediator add -peer-cluster clusB -type cloud -bluexp-org-id 2e32bd61-1cf2-4b70-9c5f-xxxxxxxxxxxx -service-account-client-id i7SOpgeAEaxa3tqteaFN39J5xxxxxxxx -service-account-client-secret HaDT6fcZVZWhtTdDuzvaAgJky6T9swAZhLcoF3LSWghBPfUeasjaqSKxxxxxxxxx -use-http-proxy-local true -use-http-proxy-remote true -strict-cert-validation true
Info: [Job: 52] 'mediator add' job queued