Skip to main content
REST API reference

Update an Ethernet switch

PDFs

PATCH /network/ethernet/switches/{name}

Introduced In: 9.8

Configures monitoring settings for an Ethernet switch.

  • system switch ethernet modify

Learn more

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

address

string

IP Address.

discovered

boolean

Discovered By ONTAP CDP/LLDP

  • readOnly: 1

  • Introduced in: 9.8

  • x-nullable: true

monitoring

monitoring

rcf_version

string

The switch reference configuration file (RCF) version.

role

string

Switch role based on the interface configurations. Using '+' to combine multiple roles. Available role types are: cluster, multicluster, storage, multistorage, metrocluster.

serial_number

string

Serial Number.

snmp

snmp

version

string

Software Version.
Example request 
{
  "address": "string",
  "monitoring": {
    "reason": "string"
  },
  "rcf_version": "RCF NX9336C-FX2 v1.13 1-CLUSTER",
  "role": [
    "cluster+storage"
  ],
  "serial_number": "string",
  "snmp": {
    "user": "string",
    "version": "string"
  },
  "version": "string"
}

Response

Status: 200, Ok
Name Type Description

job

job_link
Example response 
{
  "job": {
    "uuid": "string"
  }
}

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

5636148

Failed to discover SNMPv3 engine ID of the remote switch.

5636149

The "\" must be a valid SNMPv3 user belonging to remote switch \"\" and must also be configured in ONTAP.

5636152

0.0.0.0 cannot be specified as the IP address for the "\" parameter.

8912900

Invalid IP address.

9044009

SNMPv3 client feature is not available until the effective cluster version is ONTAP 9.3 or later.

12517379

Warning: Settings updated, but the IP "\" is not reachable. Verify that the address is valid, or check the network path.

12517381

Warning: Settings updated, but the SNMP validation request timed out. Verify that the "\" parameter is valid.

12517383

Warning: Settings updated, but the SNMPv3 validation request timed out. Verify that the "\" parameter is valid (i.e., the SNMPv3 user exists in ONTAP and on the remote switch). If the \"\" parameter is valid, verify that the SNMPv3 user's credentials are the same both in ONTAP as well as in the remote switch. If a custom engine-id was provided for the SNMPv3 user, ensure it is the same as that of the remote switch.

12517411

The input value for "\", \"\" and/or \"\" must match its discovered value.

Also see the table of common errors in the Response body overview section of this documentation.

Definitions

See Definitions

href

Name Type Description

href

string

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

address

string

IP Address.

discovered

boolean

Discovered By ONTAP CDP/LLDP

  • readOnly: 1

  • Introduced in: 9.8

  • x-nullable: true

monitoring

monitoring

rcf_version

string

The switch reference configuration file (RCF) version.

role

string

Switch role based on the interface configurations. Using '+' to combine multiple roles. Available role types are: cluster, multicluster, storage, multistorage, metrocluster.

serial_number

string

Serial Number.

snmp

snmp

version

string

Software Version.

_links

Name Type Description

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

returned_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.