Skip to main content

Retrieve all IP interface details

Contributors
PDFs

GET /network/ip/interfaces

Introduced In: 9.6

Retrieves the details of all IP interfaces.

  • network interface show

Parameters

Name Type In Required Description

metric.status

string

query

False

Filter by metric.status

  • Introduced in: 9.8

metric.duration

string

query

False

Filter by metric.duration

  • Introduced in: 9.8

metric.throughput.total

integer

query

False

Filter by metric.throughput.total

  • Introduced in: 9.8

metric.throughput.write

integer

query

False

Filter by metric.throughput.write

  • Introduced in: 9.8

metric.throughput.read

integer

query

False

Filter by metric.throughput.read

  • Introduced in: 9.8

metric.timestamp

string

query

False

Filter by metric.timestamp

  • Introduced in: 9.8

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

vip

boolean

query

False

Filter by vip

ipspace.uuid

string

query

False

Filter by ipspace.uuid

ipspace.name

string

query

False

Filter by ipspace.name

probe_port

integer

query

False

Filter by probe_port

  • Introduced in: 9.10

state

string

query

False

Filter by state

ddns_enabled

boolean

query

False

Filter by ddns_enabled

  • Introduced in: 9.9

ip.netmask

string

query

False

Filter by ip.netmask

ip.family

string

query

False

Filter by ip.family

ip.address

string

query

False

Filter by ip.address

service_policy.uuid

string

query

False

Filter by service_policy.uuid

service_policy.name

string

query

False

Filter by service_policy.name

name

string

query

False

Filter by name

dns_zone

string

query

False

Filter by dns_zone

  • Introduced in: 9.9

uuid

string

query

False

Filter by uuid

subnet.uuid

string

query

False

Filter by subnet.uuid

  • Introduced in: 9.11

subnet.name

string

query

False

Filter by subnet.name

  • Introduced in: 9.11

services

string

query

False

Filter by services

location.auto_revert

boolean

query

False

Filter by location.auto_revert

location.is_home

boolean

query

False

Filter by location.is_home

location.home_port.name

string

query

False

Filter by location.home_port.name

location.home_port.node.name

string

query

False

Filter by location.home_port.node.name

location.home_port.uuid

string

query

False

Filter by location.home_port.uuid

location.home_node.uuid

string

query

False

Filter by location.home_node.uuid

location.home_node.name

string

query

False

Filter by location.home_node.name

location.port.name

string

query

False

Filter by location.port.name

location.port.node.name

string

query

False

Filter by location.port.node.name

location.port.uuid

string

query

False

Filter by location.port.uuid

location.node.uuid

string

query

False

Filter by location.node.uuid

location.node.name

string

query

False

Filter by location.node.name

location.failover

string

query

False

Filter by location.failover

enabled

boolean

query

False

Filter by enabled

statistics.timestamp

string

query

False

Filter by statistics.timestamp

  • Introduced in: 9.8

statistics.status

string

query

False

Filter by statistics.status

  • Introduced in: 9.8

statistics.throughput_raw.total

integer

query

False

Filter by statistics.throughput_raw.total

  • Introduced in: 9.8

statistics.throughput_raw.write

integer

query

False

Filter by statistics.throughput_raw.write

  • Introduced in: 9.8

statistics.throughput_raw.read

integer

query

False

Filter by statistics.throughput_raw.read

  • Introduced in: 9.8

rdma_protocols

string

query

False

Filter by rdma_protocols

  • Introduced in: 9.10

scope

string

query

False

Filter by scope

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

recommend

recommend

Response properties specific to the LIF recommendation functionality.

records

array[ip_interface]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "recommend": {
    "messages": [
      {
      }
    ]
  },
  "records": [
    {
      "_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": "Default",
        "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 06:20:13 -0500"
      },
      "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 06:20:13 -0500"
      },
      "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"
    }
  ]
}

Error

Status: Default, Error
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

_links

Name Type Description

next

href

self

href

ip_interface_recommend_message

recommend

Response properties specific to the LIF recommendation functionality.

Name Type Description

messages

array[ip_interface_recommend_message]

Messages describing the results of a LIF recommendation request.

_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 the 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