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

Retrieve Ethernet switches attached to a chassis

PDFs

GET /network/ethernet/switches

Introduced In: 9.8

Retrieves the ethernet switches attached to the chassis.

  • system switch ethernet show

Learn more

Parameters

Name Type In Required Description

snmp.version

string

query

False

Filter by snmp.version

snmp.user

string

query

False

Filter by snmp.user

serial_number

string

query

False

Filter by serial_number

address

string

query

False

Filter by address

name

string

query

False

Filter by name

model

string

query

False

Filter by model

discovered

boolean

query

False

Filter by discovered

version

string

query

False

Filter by version

network

string

query

False

Filter by network

monitoring.enabled

boolean

query

False

Filter by monitoring.enabled

monitoring.monitored

boolean

query

False

Filter by monitoring.monitored

monitoring.reason

string

query

False

Filter by monitoring.reason

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: 15

  • 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

collection_links

num_records

integer

Number of Records

records

array[switch]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "address": "string",
      "model": "string",
      "monitoring": {
        "reason": "string"
      },
      "name": "string",
      "network": "string",
      "serial_number": "string",
      "snmp": {
        "user": "string",
        "version": "string"
      },
      "version": "string"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

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
Name Type Description

next

href

self

href
Name Type Description

self

href

monitoring

Name Type Description

enabled

boolean

Enable Health Monitoring.

monitored

boolean

Is Monitored.

reason

string

Reason For Not Monitoring.

snmp

Name Type Description

user

string

Community String or SNMPv3 Username.

version

string

SNMP Version.

switch

Ethernet Switch REST API

Name Type Description

_links

self_link

address

string

IP Address.

discovered

boolean

Discovered By ONTAP CDP/LLDP

  • readOnly: 1

  • Introduced in: 9.8

model

string

Model Number.

monitoring

monitoring

name

string

Name.

network

string

Switch Network.

serial_number

string

Serial Number.

snmp

snmp

version

string

Software Version.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.