Skip to main content

Retrieve ports

Contributors
PDFs

GET /network/ethernet/ports

Introduced In: 9.6

Retrieves a collection of ports (physical, VLAN and LAG) for an entire cluster.

  • network port show

  • network port ifgrp show

  • network port vlan show

Parameters

Name Type In Required Description

state

string

query

False

Filter by state

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

interface_count

integer

query

False

Filter by interface_count

  • Introduced in: 9.11

name

string

query

False

Filter by name

type

string

query

False

Filter by type

metric.timestamp

string

query

False

Filter by metric.timestamp

  • Introduced in: 9.8

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

reachable_broadcast_domains.ipspace.name

string

query

False

Filter by reachable_broadcast_domains.ipspace.name

  • Introduced in: 9.8

reachable_broadcast_domains.name

string

query

False

Filter by reachable_broadcast_domains.name

  • Introduced in: 9.8

reachable_broadcast_domains.uuid

string

query

False

Filter by reachable_broadcast_domains.uuid

  • Introduced in: 9.8

mtu

integer

query

False

Filter by mtu

  • Min value: 68

mac_address

string

query

False

Filter by mac_address

enabled

boolean

query

False

Filter by enabled

speed

integer

query

False

Filter by speed

statistics.device.link_down_count_raw

integer

query

False

Filter by statistics.device.link_down_count_raw

  • Introduced in: 9.8

statistics.device.transmit_raw.discards

integer

query

False

Filter by statistics.device.transmit_raw.discards

  • Introduced in: 9.8

statistics.device.transmit_raw.packets

integer

query

False

Filter by statistics.device.transmit_raw.packets

  • Introduced in: 9.8

statistics.device.transmit_raw.errors

integer

query

False

Filter by statistics.device.transmit_raw.errors

  • Introduced in: 9.8

statistics.device.receive_raw.discards

integer

query

False

Filter by statistics.device.receive_raw.discards

  • Introduced in: 9.8

statistics.device.receive_raw.packets

integer

query

False

Filter by statistics.device.receive_raw.packets

  • Introduced in: 9.8

statistics.device.receive_raw.errors

integer

query

False

Filter by statistics.device.receive_raw.errors

  • Introduced in: 9.8

statistics.device.timestamp

string

query

False

Filter by statistics.device.timestamp

  • Introduced in: 9.8

statistics.timestamp

string

query

False

Filter by statistics.timestamp

  • 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

statistics.status

string

query

False

Filter by statistics.status

  • Introduced in: 9.8

rdma_protocols

string

query

False

Filter by rdma_protocols

  • Introduced in: 9.10

lag.distribution_policy

string

query

False

Filter by lag.distribution_policy

lag.member_ports.name

string

query

False

Filter by lag.member_ports.name

lag.member_ports.node.name

string

query

False

Filter by lag.member_ports.node.name

lag.member_ports.uuid

string

query

False

Filter by lag.member_ports.uuid

lag.active_ports.name

string

query

False

Filter by lag.active_ports.name

lag.active_ports.node.name

string

query

False

Filter by lag.active_ports.node.name

lag.active_ports.uuid

string

query

False

Filter by lag.active_ports.uuid

lag.mode

string

query

False

Filter by lag.mode

uuid

string

query

False

Filter by uuid

reachability

string

query

False

Filter by reachability

  • Introduced in: 9.8

vlan.base_port.name

string

query

False

Filter by vlan.base_port.name

vlan.base_port.node.name

string

query

False

Filter by vlan.base_port.node.name

vlan.base_port.uuid

string

query

False

Filter by vlan.base_port.uuid

vlan.tag

integer

query

False

Filter by vlan.tag

  • Min value: 1

  • Max value: 4094

broadcast_domain.ipspace.name

string

query

False

Filter by broadcast_domain.ipspace.name

broadcast_domain.name

string

query

False

Filter by broadcast_domain.name

broadcast_domain.uuid

string

query

False

Filter by broadcast_domain.uuid

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.

  • Min value: 0

  • Max value: 120

  • Default value: 1

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

records

array[port]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "broadcast_domain": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "ipspace": {
          "name": "ipspace1"
        },
        "name": "bd1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "discovered_devices": [
        {
          "capabilities": [
            "router",
            "switch"
          ],
          "chassis_id": "string",
          "ip_addresses": [
            "192.168.100.24",
            "192.168.100.26"
          ],
          "name": "ETY-R1S4-510Q13.datacenter.example.com",
          "platform": "93180YC-EX",
          "protocol": "cdp",
          "remote_port": "FastEthernet0/12",
          "system_name": "string",
          "version": "Cisco Nexus Operating System (NX-OS) Software, Version 8.1"
        }
      ],
      "interface_count": 0,
      "lag": {
        "active_ports": [
          {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "e1b",
            "node": {
              "name": "node1"
            },
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          }
        ],
        "distribution_policy": "string",
        "member_ports": [
          {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "e1b",
            "node": {
              "name": "node1"
            },
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          }
        ],
        "mode": "string"
      },
      "mac_address": "01:02:03:04:05:06",
      "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"
      },
      "mtu": 1500,
      "name": "e1b",
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "rdma_protocols": [
        "roce"
      ],
      "reachability": "ok",
      "reachable_broadcast_domains": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "ipspace": {
            "name": "ipspace1"
          },
          "name": "bd1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      ],
      "speed": 1000,
      "state": "string",
      "statistics": {
        "device": {
          "link_down_count_raw": 3,
          "receive_raw": {
            "discards": 100,
            "errors": 200,
            "packets": 500
          },
          "timestamp": "2017-01-25 06:20:13 -0500",
          "transmit_raw": {
            "discards": 100,
            "errors": 200,
            "packets": 500
          }
        },
        "status": "ok",
        "throughput_raw": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "timestamp": "2017-01-25 06:20:13 -0500"
      },
      "type": "string",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
      "vlan": {
        "base_port": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "e1b",
          "node": {
            "name": "node1"
          },
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        },
        "tag": 100
      }
    }
  ]
}

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

_links

Name Type Description

self

href

ipspace

Name Type Description

name

string

Name of the broadcast domain's IPspace

broadcast_domain

Broadcast domain UUID along with a readable name. Either the UUID or both names may be provided on input.

Name Type Description

_links

_links

ipspace

ipspace

name

string

Name of the broadcast domain, scoped to its IPspace

uuid

string