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

Update a MetroCluster interconnect interface

Contributors
PDFs

PATCH /cluster/metrocluster/interconnects/{node.uuid}/{partner_type}/{adapter}

Introduced In: 9.10

Updates a MetroCluster interconnect interface.

Parameters

Name Type In Required Description

node.uuid

string

path

True

Node UUID

partner_type

string

path

True

DR Partner type

adapter

string

path

True

Interconnect adapter

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

_links

self_link

adapter

string

Adapter

interfaces

array[interfaces]

List of objects which contain interface information such as its IP address, netmask and gateway.

mirror

mirror

multipath_policy

string

Displays the NVRAM mirror multipath policy for the nodes configured in a MetroCluster.

node

node

partner_type

string

Partner type

state

string

Adapter status

type

string

Adapter type

vlan_id

integer

VLAN ID
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "adapter": "string",
  "interfaces": [
    {
      "address": "10.10.10.7",
      "gateway": "10.1.1.1",
      "netmask": "24"
    }
  ],
  "mirror": {
    "state": "string"
  },
  "multipath_policy": "string",
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "partner_type": "string",
  "state": "string",
  "type": "string",
  "vlan_id": 0
}

Response

Status: 200, Ok
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

2425734

An internal error has occurred. Wait a few minutes, and try the operation again. For further assistance, contact technical support.

2430347

The interface is already configured for port "adapter" with IP address "interfaces.address" on node "node.name". To configure a new IP address, run the "metrocluster configuration-settings interface delete" command to delete this interface and then run the "metrocluster configuration-settings interface create" command with the new IP address.

2430348

The interface is already configured for port "adapter" with gateway "interfaces.gateway" on node "node.name". To configure a new gateway or no gateway, run the "metrocluster configuration-settings interface delete" command to delete this interface and then run the "metrocluster configuration-settings interface create" command with the new gateway or no gateway.

2430352

The interface is already configured for port "adapter" with netmask "interfaces.netmask" on node "node.name". To configure a new netmask, run the "metrocluster configuration-settings interface delete" command to delete this interface and then run the "metrocluster configuration-settings interface create" command with the new netmask.

2430445

Configuration for the interface "port" on node "node.name" in cluster "cluster" does not exist. Use the "metrocluster configuration-settings interface show" command to list the valid interfaces configured for MetroCluster over IP.

2432885

Unable to modify the interface for adapter "port". Reason: At least one interface parameter is required to modify the interface.

Also see the table of common errors in the Response body overview section of this documentation.

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

href

Name Type Description

href

string
Name Type Description

self

href

interfaces

Object to setup an interface along with its default router.

Name Type Description

address

string

IPv4 or IPv6 address

gateway

string

The IPv4 or IPv6 address of the default router.

netmask

string

Input as netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, the default value is 64 with a valid range of 1 to 127. Output is always netmask length.

mirror

Name Type Description

enabled

boolean

Specifies the administrative state of the NVRAM mirror between partner nodes.

state

string

Specifies the operational state of the NVRAM mirror between partner nodes.

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

metrocluster_interconnect

Data for a MetroCluster interconnect. REST: /api/cluster/metrocluster/interconnects

Name Type Description

_links

self_link

adapter

string

Adapter

interfaces

array[interfaces]

List of objects which contain interface information such as its IP address, netmask and gateway.

mirror

mirror

multipath_policy

string

Displays the NVRAM mirror multipath policy for the nodes configured in a MetroCluster.

node

node

partner_type

string

Partner type

state

string

Adapter status

type

string

Adapter type

vlan_id

integer

VLAN ID
Name Type Description

_links

_links

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.