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

Update an IP interface

Contributors
PDFs

PATCH /network/ip/interfaces/{uuid}

Introduced In: 9.6

Updates an IP interface.

  • network interface migrate

  • network interface modify

  • network interface rename

  • network interface revert

Parameters

Name Type In Required Description

uuid

string

path

True

IP interface UUID

Request Body

Name Type Description

_links

_links

ddns_enabled

boolean

Indicates whether or not dynamic DNS updates are enabled. Defaults to true if the interface supports "data_nfs" or "data_cifs" services, otherwise false.

dns_zone

string

Fully qualified DNS zone name

enabled

boolean

The administrative state of the interface.

fail_if_subnet_conflicts

boolean

This command fails if the specified IP address falls within the address range of a named subnet. Set this value to false to use the specified IP address and to assign the subnet owning that address to 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. For PATCH, set is_home to true to revert a LIF back to its home port.

metric

metric

The most recent sample of I/O metrics for the interface.

name

string

Interface name

probe_port

integer

Probe port for Cloud load balancer

rdma_protocols

array[string]

Supported RDMA offload protocols

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.

statistics

statistics

The real time I/O statistics for the interface.

subnet

ip_subnet_reference

A named subnet. Either UUID or name can be supplied on input.

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"
    }
  },
  "dns_zone": "storage.company.com",
  "ip": {
    "address": "10.10.10.7",
    "family": "string",
    "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": "string",
    "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"
    }
  },
  "metric": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "duration": "PT15S",
    "status": "ok",
    "throughput": {
      "read": 200,
      "total": 1000,
      "write": 100
    },
    "timestamp": "2017-01-25 11:20:13 +0000"
  },
  "name": "dataLif1",
  "probe_port": 64001,
  "rdma_protocols": [
    "roce"
  ],
  "scope": "string",
  "service_policy": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "default-intercluster",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "services": [
    "data_nfs"
  ],
  "state": "string",
  "statistics": {
    "status": "ok",
    "throughput_raw": {
      "read": 200,
      "total": 1000,
      "write": 100
    },
    "timestamp": "2017-01-25 11:20:13 +0000"
  },
  "subnet": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "subnet1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "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

262196

Field cannot be set in this operation.

1376663

Cannot add interface to DNS zone because all interfaces from a single DNS zone must be in the same SVM.

1376963

Duplicate IP address.

1376976

The specified port is not capable of hosting this LIF.

1376986

The interface could not migrate because no additional interfaces can be hosted on the specified node.

1376997

Interface failed to migrate because the node hosting the port is not healthy.

1376998

The specified location.node does not own any ports in the same broadcast domain as the home port of the interface.

1376999

Interface failed to migrate because port is in the down admin state.

1377607

The specified location.port is not in the same broadcast domain as the home port of the interface.

1377666

Subnet does not have any addresses available.

1966081

Failed to lookup the port on the node.

1966133

The netmask cannot represent the entire IP subnet.

1966135

Cluster configuration can only be changed from node where the cluster LIF resides.

1966138

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

1966141

Invalid DNS zone name.

1966142

Only data LIFs can be assigned a DNS zone.

1966191

The interface could not be created because interface identifier creation failed.

1966197

Migration of cluster interfaces must be done from the local node.

1966238

Cannot change the home-node or home-port of an active SAN or NVMe data interface.

1966267

IPv6 addresses must have a prefix length between 1 and 127.

1966269

IPv4 addresses must have a prefix length between 1 and 32.

1966419

Subnet not found in the IPspace of the SVM.

1966476

DNS Update is supported only on data interfaces.

1966477

DNS Update is supported only on interfaces configured with the NFS or CIFS protocol.

1966507

A port on the node has been identified as potentially unhealthy.

1966685

There are no ports on the node that are in the broadcast domain associated with the IPspace.

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.

1967385

VIP interface address and netmask error.

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.

1967389

Patching location.is_home to the value "false" is not supported. The value "true" would revert a network interface to its home port if the current value is "false".

1967390

Cannot patch a LIF revert as it requires an effective cluster version of 9.9.1 or later.

1967391

Patching the DNS zone requires an effective cluster version of 9.9.1 or later.

1967392

Patching the DDNS enable parameter requires an effective cluster version of 9.9.1 or later.

1967396

The specified subnet.name does not match the subnet name of subnet.uuid.

1967397

The specified subnet.uuid does not match any configured subnet.";

1967398

Address must be specified by either ip.address and ip.netmask, or at least one subnet field, not both.";

2621574

This operation is not permitted on an SVM that is configured as the destination of a MetroCluster SVM relationship.

53281018

Failover policy is not compatible with one or more services in service policy

53281065

The service_policy does not exist in the SVM.

53281072

The failover policy is not valid for interfaces in the SVM.

53281086

LIF would exceed the maximum number of supported intercluster LIFs in IPspace.

53281087

SVM must have an NVMe service to perform this operation.

53281089

LIF on SVM cannot be updated to use service policy because that service policy includes SAN services and the target LIF is not home.

53281093

The specified parameter is only supported on data SVMs.

53281096

LIF could not be modified because the current port does not support the specified rdma-protocols.

53281106

Failed checking the cluster capabilities.

53281109

The interface could not be updated to use the service policy because the interface is currently associated with BGP peer group.

53281111

Cannot update the service policy because the interface is associated with a BGP peer-group.

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

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, the default value is 64 with a valid range of 1 to 127. 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. For PATCH, set is_home to true to revert a LIF back to its home port.

Name Type Description

auto_revert

boolean

broadcast_domain

broadcast_domain

Broadcast domain UUID along with a readable name.

failover

string

Policy that defines where an interface is permitted to move on failover. The policy named “default” implements the recommended best practice for NAS LIFs on the current platform and cluster, and was known as “system_defined” in the CLI.

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.

throughput

The rate of throughput bytes per second observed at the interface.

Name Type Description

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

metric

The most recent sample of I/O metrics for the interface.

Name Type Description

_links

_links

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

status

string

Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput

throughput

The rate of throughput bytes per second observed at the interface.

timestamp

string

The timestamp of the performance data.

service_policy

Name Type Description

_links

_links

name

string

uuid

string

throughput_raw

Throughput bytes observed at the interface. This can be used along with delta time to calculate the rate of throughput bytes per unit of time.

Name Type Description

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

statistics

The real time I/O statistics for the interface.

Name Type Description

status

string

Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput_raw

throughput_raw

Throughput bytes observed at the interface. This can be used along with delta time to calculate the rate of throughput bytes per unit of time.

timestamp

string

The timestamp of the performance data.

ip_subnet_reference

A named subnet. Either UUID or name can be supplied on input.

Name Type Description

_links

_links

name

string

The name of the subnet. If only the name is provided, the IPspace scope must be provided by the object this object is embedded in.

uuid

string

The UUID that uniquely identifies the subnet.

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. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

ip_interface

Name Type Description

_links

_links

ddns_enabled

boolean

Indicates whether or not dynamic DNS updates are enabled. Defaults to true if the interface supports "data_nfs" or "data_cifs" services, otherwise false.

dns_zone

string

Fully qualified DNS zone name

enabled

boolean

The administrative state of the interface.

fail_if_subnet_conflicts

boolean

This command fails if the specified IP address falls within the address range of a named subnet. Set this value to false to use the specified IP address and to assign the subnet owning that address to 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. For PATCH, set is_home to true to revert a LIF back to its home port.

metric

metric

The most recent sample of I/O metrics for the interface.

name

string

Interface name

probe_port

integer

Probe port for Cloud load balancer

rdma_protocols

array[string]

Supported RDMA offload protocols

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.

statistics

statistics

The real time I/O statistics for the interface.

subnet

ip_subnet_reference

A named subnet. Either UUID or name can be supplied on input.

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.