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

Create an Ethernet switch

Contributors
PDFs

POST /network/ethernet/switches

Introduced In: 9.11

Creates an ethernet switch.

Required properties

  • name - Name of the switch to create.

  • address - Switch IP address.

  • model - Switch model number.

  • monitoring.enabled - Whether the switch should be monitored by CSHM.

  • network

    • cluster for cluster or shared switches.

    • storage for storage switches.

    • management for management switches.

  • snmp.version - SNMP version.

  • snmp.user - SNMP user.

  • system switch ethernet create

Learn more

Parameters

Name Type In Required Description

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

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

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"
  }
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

12517376

Model number validation failed. Specify correct model number and try the command again.

12517377

IP address "{address}" is not reachable. Verify that the address is valid or check the network path.

12517379

SNMP validation request timed out. Verify that the "snmp.user" parameter is valid.

12517381

SNMP validation request timed out. Verify that the "snmp.user" parameter is valid (i.e., the SNMPv3 user exists in ONTAP and on the remote switch). If the "snmp.user" 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.

12517383

Switch type "{network}" is not valid for specified switch model "{model}".

12517384

SHM is already monitoring a switch with IP address "{address}".

12517385

Model "{model}" is unknown. Use "OTHER" if the switch model is not one of the following: {models}.
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.