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

Update an Ethernet switch

Contributors
PDFs

PATCH /network/ethernet/switches/{name}

Introduced In: 9.8

Update Ethernet Switch REST API

Parameters

Name Type In Required Description

name

string

path

True

Switch Name

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

Request Body

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.
Example request 
{
  "_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"
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "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.

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.

_links

Name Type Description

self

href
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

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.