Updates an Ethernet switch.

put

https://api.9line911.com/v1/ethernetswitches/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ID of the switch.

Body Params

The request body.

A request to update an Ethernet switch.

organizationId

string | null

The organization ID.

bypassValidation

boolean

A value indicating whether validating connectivity with the switch should be bypassed. Applicable only for SNMP v2c or v3 switch management.

name

string | null

The name.

primarySystemId

string | null

The ID of agent managing the switch.

description

string | null

The description.

geolocationId

string | null

An optional ID of the geolocation to assign the switch. Used to geolocate a device when the device's switch port geolocation cannot be resolved.

ipAddress

string | null

^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

The IP address. Only required and permitted for SNMP v2c or v3 switch management.

walkIpPort

string | null

^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$

The SNMP port. Only required and permitted for SNMP v2c or v3 switch management.

trapIpPort

string | null

^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$

The SNMP trap port. Only required and permitted for SNMP v2c or v3 switch management.

managementType

string

enum

Allowed:

community

string | null

The community string. Only required and permitted for SNMP V2 switch management.

username

string | null

The username. Only required and permitted for SNMP v3 switch management.

engineId

string | null

^[0-9a-fA-F]+$

The engine ID. Optional and only permitted for SNMP v3 switch management.

authenticationProvider

string

enum

Allowed:

privacyProtocol

string

enum

authenticationPassword

string | null

The authentication password. Only permitted for SNMP v3 switch management.

privacyPassword

string | null

The privacy password. Only permitted for SNMP v3 switch management.

discoveryProtocol

string

enum

Allowed:

chassisId

string | null

The chassis ID. Only required and permitted for unmanaged switches.

chassisIdSubtype

string

enum

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK when successful with the Ethernet switch in the body.

400BAD REQUEST if any validation errors occur.

401UNAUTHORIZED when the access token is invalid or expired.

403FORBIDDEN when the permissions to update the Ethernet switch is not granted.

404NOT FOUND when the Ethernet switch is not found.

500INTERNAL SERVER ERROR on any unexpected errors.