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

Retrieve Ethernet switch details

Contributors
PDFs

GET /network/ethernet/switches/{name}

Introduced In: 9.8

Retrieves the details of an Ethernet switch.

  • system switch ethernet show

Learn more

Parameters

Name Type In Required Description

name

string

path

True

Name

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

self_link

address

string

IP Address.

discovered

boolean

Discovered By ONTAP CDP/LLDP

  • readOnly: 1

  • Introduced in: 9.8

  • x-nullable: true

model

string

Model Number.

monitoring

monitoring

name

string

Name.

network

string

Switch Network.

serial_number

string

Serial Number.

snmp

snmp

version

string

Software Version.
Example response 
{
  "_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

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.

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.