# Module `netapp_ontap.resources.metrocluster_interconnect`

Copyright © 2022 NetApp Inc. All rights reserved.

## Overview

You can use this API to retrieve and display relevant information pertaining to MetroCluster interconnect status. The `/cluster/metrocluster/interconnects` endpoint returns a list of all the interconnects in MetroCluster and their status. Each individual interconnect can be queried individually using the `/cluster/metrocluster/interconnects/{node.uuid}/{partner_type}/{adapter}` endpoint. You can also use this API to modify relevant information related to MetroCluster interconnect. These include address, netmask, and gateway. Modify a MetroCluster interconnect using the `/cluster/metrocluster/interconnects/{node.uuid}/{partner_type}/{adapter}` endpoint.

####

### Examples

### Retrieving MetroCluster interconnects

    GET <https://<mgmt-ip>>/api/cluster/metrocluster/interconnects
    {
        "records": [
            {
                "node": {
                    "name": "cluster1_01",
                    "uuid": "6fead8fe-8d81-11e9-b5a9-005056826931",
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/6fead8fe-8d81-11e9-b5a9-005056826931"
                        }
                    }
                },
                "partner_type": "ha",
                "adapter": "e0f",
                "_links": {
                    "self": {
                        "href": "/api/cluster/metrocluster/interconnects/6fead8fe-8d81-11e9-b5a9-005056826931/ha/e0f"
                    }
                }
            },
            {
                "node": {
                    "name": "cluster1_01",
                    "uuid": "6fead8fe-8d81-11e9-b5a9-005056826931",
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/6fead8fe-8d81-11e9-b5a9-005056826931"
                        }
                    }
                },
                "partner_type": "ha",
                "adapter": "e0g",
                "_links": {
                    "self": {
                        "href": "/api/cluster/metrocluster/interconnects/6fead8fe-8d81-11e9-b5a9-005056826931/ha/e0g"
                    }
                }
            },
            {
                "node": {
                    "name": "cluster1_01",
                    "uuid": "6fead8fe-8d81-11e9-b5a9-005056826931",
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/6fead8fe-8d81-11e9-b5a9-005056826931"
                        }
                    }
                },
                "partner_type": "dr",
                "adapter": "e0f",
                "_links": {
                    "self": {
                        "href": "/api/cluster/metrocluster/interconnects/6fead8fe-8d81-11e9-b5a9-005056826931/dr/e0f"
                    }
                }
            },
            {
                "node": {
                    "name": "cluster1_01",
                    "uuid": "6fead8fe-8d81-11e9-b5a9-005056826931",
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/6fead8fe-8d81-11e9-b5a9-005056826931"
                        }
                    }
                },
                "partner_type": "dr",
                "adapter": "e0g",
                "_links": {
                    "self": {
                        "href": "/api/cluster/metrocluster/interconnects/6fead8fe-8d81-11e9-b5a9-005056826931/dr/e0g"
                    }
                }
            },
            {
                "node": {
                    "name": "cluster1_01",
                    "uuid": "6fead8fe-8d81-11e9-b5a9-005056826931",
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/6fead8fe-8d81-11e9-b5a9-005056826931"
                        }
                    }
                },
                "partner_type": "aux",
                "adapter": "e0f",
                "_links": {
                    "self": {
                        "href": "/api/cluster/metrocluster/interconnects/6fead8fe-8d81-11e9-b5a9-005056826931/aux/e0f"
                    }
                }
            },
            {
                "node": {
                    "name": "cluster1_01",
                    "uuid": "6fead8fe-8d81-11e9-b5a9-005056826931",
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/6fead8fe-8d81-11e9-b5a9-005056826931"
                        }
                    }
                },
                "partner_type": "aux",
                "adapter": "e0g",
                "_links": {
                    "self": {
                        "href": "/api/cluster/metrocluster/interconnects/6fead8fe-8d81-11e9-b5a9-005056826931/aux/e0g"
                    }
                }
            },
            {
                "node": {
                    "name": "cluster1_02",
                    "uuid": "f5435191-8d81-11e9-9d4b-00505682dc8b",
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/f5435191-8d81-11e9-9d4b-00505682dc8b"
                        }
                    }
                },
                "partner_type": "ha",
                "adapter": "e0f",
                "_links": {
                    "self": {
                        "href": "/api/cluster/metrocluster/interconnects/f5435191-8d81-11e9-9d4b-00505682dc8b/ha/e0f"
                    }
                }
            },
            {
                "node": {
                    "name": "cluster1_02",
                    "uuid": "f5435191-8d81-11e9-9d4b-00505682dc8b",
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/f5435191-8d81-11e9-9d4b-00505682dc8b"
                        }
                    }
                },
                "partner_type": "ha",
                "adapter": "e0g",
                "_links": {
                    "self": {
                        "href": "/api/cluster/metrocluster/interconnects/f5435191-8d81-11e9-9d4b-00505682dc8b/ha/e0g"
                    }
                }
            },
            {
                "node": {
                    "name": "cluster1_02",
                    "uuid": "f5435191-8d81-11e9-9d4b-00505682dc8b",
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/f5435191-8d81-11e9-9d4b-00505682dc8b"
                        }
                    }
                },
                "partner_type": "dr",
                "adapter": "e0f",
                "_links": {
                    "self": {
                        "href": "/api/cluster/metrocluster/interconnects/f5435191-8d81-11e9-9d4b-00505682dc8b/dr/e0f"
                    }
                }
            },
            {
                "node": {
                    "name": "cluster1_02",
                    "uuid": "f5435191-8d81-11e9-9d4b-00505682dc8b",
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/f5435191-8d81-11e9-9d4b-00505682dc8b"
                        }
                    }
                },
                "partner_type": "dr",
                "adapter": "e0g",
                "_links": {
                    "self": {
                        "href": "/api/cluster/metrocluster/interconnects/f5435191-8d81-11e9-9d4b-00505682dc8b/dr/e0g"
                    }
                }
            },
            {
                "node": {
                    "name": "cluster1_02",
                    "uuid": "f5435191-8d81-11e9-9d4b-00505682dc8b",
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/f5435191-8d81-11e9-9d4b-00505682dc8b"
                        }
                    }
                },
                "partner_type": "aux",
                "adapter": "e0f",
                "_links": {
                    "self": {
                        "href": "/api/cluster/metrocluster/interconnects/f5435191-8d81-11e9-9d4b-00505682dc8b/aux/e0f"
                    }
                }
            },
            {
                "node": {
                    "name": "cluster1_02",
                    "uuid": "f5435191-8d81-11e9-9d4b-00505682dc8b",
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/f5435191-8d81-11e9-9d4b-00505682dc8b"
                        }
                    }
                },
                "partner_type": "aux",
                "adapter": "e0g",
                "_links": {
                    "self": {
                        "href": "/api/cluster/metrocluster/interconnects/f5435191-8d81-11e9-9d4b-00505682dc8b/aux/e0g"
                    }
                }
            }
        ],
        "num_records": 12,
        "_links": {
            "self": {
                "href": "/api/cluster/metrocluster/interconnects"
            }
        }
    }

### Retrieves information about a specific MetroCluster interconnect

    <https://<mgmt-ip>>/api/cluster/metrocluster/interconnects/774b4fbc-86f9-11e9-9051-005056825c71/aux/e0f
    {
        "node": {
            "name": "cluster1_01",
            "uuid": "46147363-9857-11e9-9a55-005056828eb9",
            "_links": {
                "self": {
                    "href": "/api/cluster/nodes/46147363-9857-11e9-9a55-005056828eb9"
                }
            }
        },
        "partner_type": "ha",
        "adapter": "e0f",
        "state": "up",
        "type": "iwarp",
        "_links": {
            "self": {
                "href": "/api/cluster/metrocluster/interconnects/46147363-9857-11e9-9a55-005056828eb9/ha/e0f"
            }
        }
    }

### This example shows how to modify the network address assigned to the home port. Fields required: address.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import MetroclusterInterconnect

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = MetroclusterInterconnect(
            adapter="e0g",
            partner_type="ha",
            **{"node.uuid": "3e1bfd38-ffd2-11eb-bcb7-005056aceaa9"}
        )
        resource.interfaces = [{"address": "1.2.3.4"}]
        resource.patch()

#### PATCH Response

    HTTP/1.1 200 OK
    Cache-Control: no-cache,no-store,must-revalidate
    Connection: close
    Date: Fri, 20 Aug 2021 21:58:36 GMT
    Server: libzapid-httpd
    Content-Length: 3
    Content-Type: application/hal+json
    X-Content-Type-Options: nosniff
    {
    }

### This example shows how to modify the netmask assigned to the interface. Be sure to change to a valid subnet. Fields required: netmask.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import MetroclusterInterconnect

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = MetroclusterInterconnect(
            adapter="e0g",
            partner_type="ha",
            **{"node.uuid": "3e1bfd38-ffd2-11eb-bcb7-005056aceaa9"}
        )
        resource.interfaces = [{"netmask": "2.2.2.2"}]
        resource.patch()

#### PATCH Response

    HTTP/1.1 200 OK
    Cache-Control: no-cache,no-store,must-revalidate
    Connection: close
    Date: Fri, 20 Aug 2021 22:11:35 GMT
    Server: libzapid-httpd
    Content-Length: 3
    Content-Type: application/hal+json
    X-Content-Type-Options: nosniff
    {
    }

### This example shows how to modify the gateway assigned to the interface. Please make sure to update it on the switch/router first. Assuming it is a new one, the only thing to consider is the IP address and the new gateway must be in the same subnet. Fields required: gateway.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import MetroclusterInterconnect

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = MetroclusterInterconnect(
            adapter="e0g",
            partner_type="ha",
            **{"node.uuid": "3e1bfd38-ffd2-11eb-bcb7-005056aceaa9"}
        )
        resource.interfaces = [{"gateway": "1.2.3.4"}]
        resource.patch()

#### PATCH Response

    HTTP/1.1 200 OK
    Cache-Control: no-cache,no-store,must-revalidate
    Connection: close
    Date: Fri, 20 Aug 2021 22:11:35 GMT
    Server: libzapid-httpd
    Content-Length: 3
    Content-Type: application/hal+json
    X-Content-Type-Options: nosniff
    {
    }

## Classes

`class MetroclusterInterconnect (*args, **kwargs)`

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

  Initialize the instance of the resource.

  Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:

      MyResource(name='foo').name == 'foo'

  ## Args

  `*args`
    Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
  `**kwargs`
    each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.

  ### Ancestors

  - Resource

  ### Static methods

  `def count_collection(*args, connection: HostConnection = None, **kwargs) -> int`

    Fetch a count of all objects of this type from the host.

    This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the count of bars for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. These query parameters can affect the count. A return_records query param will be ignored.

    ## Returns

    On success, returns an integer count of the objects of this type. On failure, returns -1.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library.

  `def find(*args, connection: HostConnection = None, **kwargs) -> Resource`

    Retrieves a list of interconnect adapter information for nodes in the MetroCluster.

    ### Related ONTAP Commands

    - `metrocluster interconnect show`

    ### Learn more

    - `DOC /cluster/metrocluster/interconnects`

    Find an instance of an object on the host given a query.

    The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found, None will be returned. If more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A `Resource` object containing the details of the object or None if no matches were found.

    ## Raises

    `NetAppRestError`: If the API call returned more than 1 matching resource.

  `def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[Resource]`

    Retrieves a list of interconnect adapter information for nodes in the MetroCluster.

    ### Related ONTAP Commands

    - `metrocluster interconnect show`

    ### Learn more

    - `DOC /cluster/metrocluster/interconnects`

    Fetch a list of all objects of this type from the host.

    This is a lazy fetch, making API calls only as necessary when the result of this call is iterated over. For instance, if max_records is set to 5, then iterating over the collection causes an API call to be sent to the server once for every 5 records. If the client stops iterating before getting to the 6th record, then no additional API calls are made.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `max_records`
      The maximum number of records to return per call
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A list of `Resource` objects

    ## Raises

    `NetAppRestError`: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

  `def patch_collection(body: dict, *args, records: Iterable[_ForwardRef('MetroclusterInterconnect')] = None, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Updates a MetroCluster interconnect interface.

    ### Related ONTAP commands * `metrocluster configuration-settings interface modify`

    ### Learn more

    - `DOC /cluster/metrocluster/interconnects`

    Patch all objects in a collection which match the given query.

    All records on the host which match the query will be patched with the provided body.

    ## Args

    `body`
      A dictionary of name/value pairs to set on all matching members of the collection. The body argument will be ignored if records is provided.
    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to patch the collection of bars for a particular foo, the foo.name value should be passed.
    `records`
      Can be provided in place of a query. If so, this list of objects will be patched on the host.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  ### Methods

  `def get(self, **kwargs) -> NetAppResponse`

    Retrieves information about a MetroCluster Interconnect for a specific partner type and adapter.

    ### Related ONTAP Commands

    - `metrocluster interconnect show`

    ### Learn more

    - `DOC /cluster/metrocluster/interconnects`

    Fetch the details of the object from the host.

    Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  `def patch(self, hydrate: bool = False, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, **kwargs) -> NetAppResponse`

    Updates a MetroCluster interconnect interface.

    ### Related ONTAP commands * `metrocluster configuration-settings interface modify`

    ### Learn more

    - `DOC /cluster/metrocluster/interconnects`

    Send the difference in the object's state to the host as a modification request.

    Calculates the difference in the object's state since the last time we interacted with the host and sends this in the request body.

    ## Args

    `hydrate`
      If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `**kwargs`
      Any key/value pairs passed will normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  ### Inherited members

  - `Resource`:
    - `from_dict`
    - `get_collection_url`
    - `get_connection`
    - `instance_location`
    - `path_keys`
    - `poll`
    - `set_connection`
    - `to_dict`
`class MetroclusterInterconnectSchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)`

  The fields of the MetroclusterInterconnect object

  ### Ancestors

  - netapp_ontap.resource.ResourceSchema
  - marshmallow.schema.Schema
  - marshmallow.base.SchemaABC

  ### Class variables

  `adapter GET`

    Adapter

  `interfaces GET POST PATCH`

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

  `links GET`

    The links field of the metrocluster_interconnect.

  `node GET POST PATCH`

    The node field of the metrocluster_interconnect.

  `partner_type GET`

    Partner type

    Valid choices:

    - aux
    - dr
    - ha
  `state GET`

    Adapter status

    Valid choices:

    - down
    - up
  `type GET`

    Adapter type

    Valid choices:

    - roce
    - iwarp
    - unknown
  `vlan_id GET`

    VLAN ID