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

Update an IP interface

Contributors
PDFs

PATCH /network/ip/interfaces/{uuid}

Updates an IP interface.

  • network interface migrate

  • network interface modify

  • network interface rename

  • network interface revert

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

IP interface UUID

Request Body

Name Type Description

_links

_links

enabled

boolean

The administrative state of the interface.

ip

ip_info

IP information

ipspace

ipspace

Either the UUID or name must be supplied on POST for cluster-scoped objects.

location

location

Current or home location can be modified. Specifying a port implies a node. Specifying a node allows an appropriate port to be automatically selected. Ports are not valid and not shown for VIP interfaces. For POST, broadcast_domain can be specified alone or with home_node.

name

string

Interface name

scope

string

Set to "svm" for interfaces owned by an SVM. Otherwise, set to "cluster".

service_policy

service_policy

services

array[string]

The services associated with the interface.

state

string

The operational state of the interface.

svm

svm

Applies only to SVM-scoped objects. Either the UUID or name must be supplied on POST.

uuid

string

The UUID that uniquely identifies the interface.

vip

boolean

True for a VIP interface, whose location is announced via BGP.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "ip": {
    "address": "10.10.10.7",
    "family": "ipv4",
    "netmask": "24"
  },
  "ipspace": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "exchange",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "location": {
    "broadcast_domain": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "bd1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "failover": "home_port_only",
    "home_node": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "node1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "home_port": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "e1b",
      "node": {
        "name": "node1"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "node": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "node1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "port": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "e1b",
      "node": {
        "name": "node1"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  },
  "name": "dataLif1",
  "scope": "svm",
  "service_policy": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "default-intercluster",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "services": {
  },
  "state": "up",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1376963

Duplicate IP address.

1966138

The same IP address may not be used for both a mgmt interface and a gateway address.

1967106

The specified location.home_port.name does not match the specified port name of location.home_port.uuid.

1967107

The specified location.home_port.uuid is not valid.

1967111

A home node must be specified by at least one location.home_node, location.home_port, or location.broadcast_domain field.

1967113

The specified location.port.name does not match the port name of location.port.uuid.

1967114

The specified location.port.uuid is not valid.

1967115

The specified location.node.name does not match the node name of location.node.uuid.

1967116

The specified location.port.node.name does not match the node name of location.node.uuid.

1967117

The specified location.port.node.name does not match location.node.name.

1967118

A node must be specified by at least one location.node or location.port field.

1967119

The specified location.node.name does not match the node name of location.port.uuid.

1967120

The specified service_policy.name does not match the specified service policy name of service_policy.uuid.

1967121

The specified service_policy.uuid is not valid.

1967125

You cannot patch the "location.node" or "location.port" fields to migrate interfaces using the iSCSI data protocol. Instead perform the following PATCH operations on the interface: set the "enabled" field to "false"; change one or more "location.home_port" fields to migrate the interface; and then set the "enabled" field to "true".

1967129

The specified location.home_port.uuid is not valid.

1967130

The specified location.home_port.name is not valid.

1967131

The specified location.home_port.uuid and location.home_port.name are not valid.

1967132

The specified location.port.uuid is not valid.

1967133

The specified location.port.name is not valid.

1967134

The specified location.port.uuid and location.port.name are not valid.

1967138

Cannot patch port for a VIP interface. The specified parameter location.port.uuid is not valid.

1967139

Cannot patch port for a VIP interface. The specified parameter location.port.name is not valid.

1967140

Cannot patch port for a VIP interface. The specified parameters location.port.uuid and location.port.name are not valid.

1967141

Cannot patch home_port for a VIP interface. The specified parameter location.home_port.uuid is not valid.

1967142

Cannot patch home_port for a VIP interface. The specified parameter location.home_port.name is not valid.

1967143

Cannot patch home_port for a VIP interface. The specified parameters location.home_port.uuid and location.home_port.name are not valid.

1967145

The specified location.failover is not valid.

1967153

No suitable port exists on location.home_node to host the interface.

1967380

Cannot patch home_port for a VIP interface. The specified parameter location.home_port.node.name is not valid. Consider using location.home_node.name instead.

1967386

Cannot patch port for a VIP interface. The specified parameter location.port.node.name is not valid. Consider using location.node.name instead.

1967387

The specified IP address is in use by a subnet in this IPspace.

53281065

The service_policy does not exist in the SVM.

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

ip_info

IP information

Name Type Description

address

string

IPv4 or IPv6 address

family

string

IPv4 or IPv6

netmask

string

Input as netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, you must set the netmask length. The default value is 64. Output is always netmask length.

ipspace

Either the UUID or name must be supplied on POST for cluster-scoped objects.

Name Type Description

_links

_links

name

string

IPspace name

uuid

string

IPspace UUID

broadcast_domain

Broadcast domain UUID along with a readable name.

Name Type Description

_links

_links

name

string

Name of the broadcast domain, scoped to its IPspace

uuid

string

Broadcast domain UUID

home_node

Name Type Description

_links

_links

name

string

uuid

string

node

Name Type Description

name

string

Name of node on which the port is located.

home_port

Port UUID along with readable names. Either the UUID or both names may be supplied on input.

Name Type Description

_links

_links

name

string

node

node

uuid

string

node

Name Type Description

_links

_links

name

string

uuid

string

port

Port UUID along with readable names. Either the UUID or both names may be supplied on input.

Name Type Description

_links

_links

name

string

node

node

uuid

string

location

Current or home location can be modified. Specifying a port implies a node. Specifying a node allows an appropriate port to be automatically selected. Ports are not valid and not shown for VIP interfaces. For POST, broadcast_domain can be specified alone or with home_node.

Name Type Description

auto_revert

boolean

broadcast_domain

broadcast_domain

Broadcast domain UUID along with a readable name.

failover

string

Defines where an interface may failover.

home_node

home_node

home_port

home_port

Port UUID along with readable names. Either the UUID or both names may be supplied on input.

is_home

boolean

node

node

port

port

Port UUID along with readable names. Either the UUID or both names may be supplied on input.

service_policy

Name Type Description

_links

_links

name

string

uuid

string

svm

Applies only to SVM-scoped objects. Either the UUID or name must be supplied on POST.

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

ip_interface

Name Type Description

_links

_links

enabled

boolean

The administrative state of the interface.

ip

ip_info

IP information

ipspace

ipspace

Either the UUID or name must be supplied on POST for cluster-scoped objects.

location

location

Current or home location can be modified. Specifying a port implies a node. Specifying a node allows an appropriate port to be automatically selected. Ports are not valid and not shown for VIP interfaces. For POST, broadcast_domain can be specified alone or with home_node.

name

string

Interface name

scope

string

Set to "svm" for interfaces owned by an SVM. Otherwise, set to "cluster".

service_policy

service_policy

services

array[string]

The services associated with the interface.

state

string

The operational state of the interface.

svm

svm

Applies only to SVM-scoped objects. Either the UUID or name must be supplied on POST.

uuid

string

The UUID that uniquely identifies the interface.

vip

boolean

True for a VIP interface, whose location is announced via BGP.