Dell N3200-ON Networking N-Series Switches RESTful API User Guide version 6.8.
Dell N3200-ON Manual
View all Dell N3200-ON manuals
Add to My Manuals
Save this manual to your list of manuals |
Dell N3200-ON manual content summary:
- Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 1
Dell Networking N-Series N2200-ON, and N3200-ON Switches RESTful API User Guide Version 6.8.0 Regulatory Models: E04W, E05W, E06W, E07W, E15W, E16W, E17W, E18W, E30W, E31W, E32W, E41W - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 2
CAUTION indicates potential damage to hardware or loss of data if instructions are not followed. India This product conforms to the relevant Essential U.S. and international copyright and intellectual property laws. Dell™ and the Dell logo are trademarks of Dell Inc. in the United States and/or other - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 3
Parameters 10 Response Status Message 11 HTTP Response Codes 11 Error Codes 12 3 REST Document Requests 15 Sessions 15 4 Rest API Reference 17 Authentication 17 Switching 17 Overlay Networking 17 Contents 3 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 4
Logout 23 dot1dbaseconfig 25 dot1dtpconfig 28 dot1dtpfdbentries 32 dot1dtpportentries 36 dot1sconfig 40 dot1sinterfaces 45 dot1smstientries 54 fdbs 65 fdbstats 71 Switching 76 Interfaces 76 VLANs 91 Overlay Networking 105 IP 105 lagports 111 lags 115 mfdbs 125 System 130 Registry - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 5
swportmonitor 193 System1213 200 systemconfig 205 systemcontrol 210 systemmisc 213 Contents 5 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 6
6 Contents - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 7
configure various operational parameters and attributes, including selected protocols on the target switch. It is intended for software developers who design RESTful applications that target Dell Networking switch platforms. Acronyms and Abbreviations In most cases, acronyms and abbreviations are - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 8
for the Dell Networking N-Series switches are available at www.dell.com/support: • Dell Networking N1108EP-ON, N1500, N2200-ON, and N3200-ON Series Switches User's Configuration Guide-discusses and provides examples on how to configure, monitor, and maintain Dell Networking N-Series switches by - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 9
interface. Most modern programming languages provide support for constructing and parsing JSON, IP address or host name of the target switch. • RESTful_port is the configured Layer 4 used to redirect the request to the Dell Networking N-Series RESTful APIs for Dell OpEN. • Versioning is mandatory and - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 10
several resource keywords that are used to expand and complement the REST API. The supported keywords are as follows: • debug - Debugging capabilities are available for each request in an effort to assist and provide some insight into the details of - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 11
- The offset and limit keywords relate to pagination when used within a GET request. The offset denotes the starting index, whereas the limit identifies the number of resources to return. The default is also offset:1 and limit:10. Note that offset and limit can be specified independently. - The - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 12
Table 2-3. HTTP Response Codes Response Code Description 200 The request has succeeded. 400 The request could not be understood by the server due to malformed syntax or invalid parameters. 401 The request is not authorized. 403 The request is well-formed, but forbidden for the requested - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 13
-27 -28 -29 -30 -31 Code Name OPEN_E_FAIL OPEN_E_DISABLED OPEN_E_UNAVAIL OPEN_E_NOT_FOUND OPEN_E_EMPTY OPEN_E_ERROR Description Operation fail. Disabled. Parameter/feature is not supported. Parameter not found. Nothing to report or table is empty. Error conditions. RESTful OpEN API Overview 13 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 14
14 RESTful OpEN API Overview - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 15
3 REST Document Requests Note that the markdown formatted document, as well as specific subsections of the document, are available as resources. Document requests can be made using a doc resource as shown in the following examples: http://10.10.10.1:8080/open/v1/doc http://10.10.10.1:8080/open/v1/ - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 16
16 REST Document Requests - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 17
resources: Authentication • Login • Logout • dot1dbaseconfig • dot1dtpconfig • dot1dtpfdbentries • dot1dtpportentries • dot1sconfig • dot1sinterfaces • dot1smstientries • fdbs • fdbstats Switching • Interfaces • VLANs Overlay Networking • IP • lagports • lags • mfdbs Rest API Reference 17 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 18
System • Registry • serviceport • Snooping Configuration • Snooping Interfaces • snoopingqueriers • snoopingssms • Snooping VLANs • stormcontrolports • swmirror • swmonitor • swportmonitor • System1213 • systemconfig • systemcontrol • systemmisc 18 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 19
and invalidates the session. Note that the SID will automatically be deleted if the hard or soft time-out is exceeded. The username, password, and switch access level, as well as the session time-out parameters, are managed by your system administrator. It is recommended that you always use HTTPS to - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 20
Response Details Table 4-6. Login CREATE Response Details Parameter SID SIDSSL accessLevel Type String String Integer Description Unique session ID for HTTP requests. Unique session ID for HTTPS requests. 15 = Read/write. 1 = Read only. HTTP and HTTPS Response Codes The possible HTTP response - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 21
Response Example Returns an appropriate status message. NOTE: For Internet browser requests, the SID value is returned as a cookie and is not returned as part of the following JSON data. { "SIDSSL" : rQAVUkzFbLUwhNvDHnfBIezOAETHpQFiGIddSDITQeSXuncbchCKO DaohTVYldhSLMVfRfYIjsh, "accessLevel" : 15, " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 22
Login READ Login does not support read semantics. Login UPDATE Login does not support update semantics. Login DELETE Login does not support delete semantics. 22 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 23
Logout Implements a RESTful API providing user session logout. Logout CREATE POST /open/v1/logout Use this call to logout of a session. A successful logout request deletes the session ID and invalidates the session. Request Details Table 4-8. Logout CREATE Request Details Parameter SID SIDSSL - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 24
Example { "status": { "response_code": 401, "msg": "Unauthorized", "more_info": "", "error_code": -26 } } Logout READ Logout does not support read semantics. Logout UPDATE Logout does not support update semantics. Logout DELETE Logout does not support delete semantics. 24 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 25
" object defined by that RFC. dot1dbaseconfig CREATE This component does not support create semantics. dot1dbaseconfig READ GET /open/v1/dot1dbaseconfig Retrieves the various attributes supported by this resource. Request Details Table 4-10. dot1dbaseconfig READ Request Details Parameter - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 26
http://10.10.10.1:8080/open/v1/dot1dbaseconfig Response Example { "baseBridgeAddress": "11:22:33:44:55:66", "baseNumPorts": 20, "baseType": 2, "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Partial Request Example The response can be reduced by using the partial - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 27
=-99 Response Example Returns an appropriate status message. { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid parameter", "error_code": -22 } } dot1dbaseconfig UPDATE This component does not support update semantics dot1dbaseconfig DELETE This component does not - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 28
the dot1dBridge object defined by that RFC. dot1dtpconfig CREATE This component does not support create semantics. dot1dtpconfig READ GET /open/v1/dot1dtpconfig Retrieves the various attributes supported by this resource. Request Details Table 4-12. dot1dtpconfig READ Request Details Parameter - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 29
Request Example curl -GET 10.10.10.1:8080/open/v1/dot1dtpconfig browser http://10.10.10.1:8080/open/v1/dot1dtpconfig Response Example { "learnedEntryDiscards": 7, "agingTime": 15, "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Error Example curl -GET -d "tenant=- - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 30
Request Details Table 4-14. dot1dtpconfig UPDATE Request Details Parameter Type Description agingTime integer Timeout period for aging out dynamically learned forwarding information (mandatory). NOTE: Minimum = 10 seconds, maximum = 1 000,000 seconds Response Details HTTP Response Codes The - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 31
.1:8080/open/v1/dot1dtpconfig?method=put Response Example { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid parameter" "error_code": -22 } } dot1dtpconfig DELETE This component does not support delete semantics. Rest API Reference 31 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 32
dot1dBridge object defined by that RFC. dot1dtpfdbentries CREATE This component does not support create semantics. dot1dtpfdbentries READ GET /open/v1/dot1dtpfdbentries Retrieves the various attributes supported by this resource. Request Details Table 4-16. dot1dtpfdbentries READ request Details - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 33
Table 4-17. dot1dtpfdbentries READ Internal Error Codes Error Code Code Name 0 OPEN_E_NONE -21 OPEN_E_INTERNAL -22 OPEN_E_PARAM -26 OPEN_E_FAIL Description Success. Internal error. Invalid parameter. Request failed. Multiple dot1dtpfdbentries Request Example The following example shows a - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 34
} Single dot1dtpfdbentries Partial Request Example curl -GET -d "fdbAddress=11:22:33:44:55:66:11:11&fields=port" 10.10.10.1:8080/open/v1/dot1dtpfdbentries browser http://10.10.10.1:8080/open/v1/dot1dtpfdbentries?fdbAddress= 11:22:33:44:55:66:11:11&fields=port Response Example { "dot1dtpfdbentries": - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 35
} } dot1dtpfdbentries UPDATE This component does not support update semantics. dot1dtpfdbentries DELETE This component does not support delete semantics. Rest API Reference 35 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 36
object defined by that RFC. dot1dtpportentries CREATE This component does not support create semantics. dot1dtpportentries READ GET /open/v1/dot1dtpportentries Retrieves the various attributes supported by this resource. Request Details Table 4-18. dot1dtpportentries READ Request Details - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 37
Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-19. dot1dtpportentries READ Internal Error Codes Error Code 0 -21 -22 -26 Code Name OPEN_E_NONE OPEN_E_INTERNAL OPEN_E_PARAM OPEN_E_FAIL Description Success. Internal error. Invalid parameter. - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 38
"inDiscards": 1 } ], "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Single dot1dtpportentries Partial Request Example curl -GET -d "port=0/1&fields=inFrames,outFrames" 10.10.10.1:8080/open/v1/dot1dtpportentries browser http://10.10.10.1:8080/open/v1/ - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 39
=-99 Response Example Returns an appropriate status message. { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid parameter", "error_code": -22 } } dot1dtpportentries UPDATE This component does not support update semantics. dot1dtpportentries DELETE This component does not - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 40
dot1sconfig STP Config CREATE This component does not support create semantics. STP Config READ GET /open/v1/dot1sconfig Retrieves STP configuration. Request Details Table 4-20. STP Config READ Request Details Parameter fields fields Type - - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 41
Table 4-21. dot1sconfig READ Internal Error Codes Error Code 0 -21 -22 -26 Code Name OPEN_E_NONE OPEN_E_INTERNAL OPEN_E_PARAM OPEN_E_FAIL Description Success. Internal error. Invalid parameter. Operation Fail. STP Config Request Example The following example shows STP parameters retrieval. curl - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 42
"Invalid parameter", "error_code": -22 } } STP Config UPDATE PUT /open/v1/dot1sconfig Use this call to update STP Configuration on the switch. Request Details Table 4-22. STP Config UPDATE Request Details Parameter mode Type string configName configRevision forceVersion string integer string - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 43
Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, and 500. Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-23. STP Config UPDATE Internal Error Codes Error Code 0 -21 -22 -26 Code Name OPEN_E_NONE - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 44
/dot1sconfig?method= put&forceVersion=none Response Example { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid parameter", "error_code": -22 } } STP Config DELETE This component does not support delete semantics. 44 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 45
dot1sinterfaces dot1sinterfaces CREATE dot1sinterfaces does not support CREATE semantics. dot1sinterfaces READ GET /open/v1/dot1sinterfaces Retrieves dot1sinterfaces parameters. Request Details Table 4-24. dot1sinterfaces READ Request Details Parameter interface mstId fields fields - - - - - - - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 46
Table 4-24. dot1sinterfaces READ Request Details (Continued) Parameter Type offset integer limit integer Description Denotes beginning index for pagination. Default is 1. This parameter is not valid for single STP retrievals. Denotes total retrieval count. Default is 10. This parameter is not - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 47
"bpduFilterMode": "disabled", "bpduFloodMode": "disabled", "intfEdgePortMode": "disabled", "intfGuardMode": "loop", "intfMode": "enabled" }, { "interface": "0/2", "bpduFilterMode": "enabled", "bpduFloodMode": "disabled", "intfEdgePortMode": "disabled", "intfGuardMode": "loop", "intfMode": "enabled" - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 48
"dot1sinterfaces": [ { "interface": "0/1", "bpduFilterMode": "disabled", "bpduFloodMode": "disabled", "intfEdgePortMode": "disabled", "intfGuardMode": "loop", "intfMode": "enabled" }, { "interface": "0/2", "bpduFilterMode": "enabled", "bpduFloodMode": "disabled", "intfEdgePortMode": "disabled", " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 49
"bpduFilterMode": "disabled", "bpduFloodMode": "disabled", "intfEdgePortMode": "disabled", "intfGuardMode": "loop", "intfMode": "enabled" } ], "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Single dot1sinterfaces Partial Request Example The response can be - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 50
"error_code": 0 } } Ancillary Single Request Example An example using an ancillary request parameter to determine Port Forwarding State and Port Role. curl -GET -d "interface=0/10&mstId=1&fields= intfPortFwdState,intfPortRole" 10.10.10.1:8080/open/v1/dot1sinterfaces browser http://10.10.10.1:8080/ - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 51
-22 } } dot1sinterfaces UPDATE PUT /open/v1/dot1sinterfaces Use this call to update an existing dot1sinterfaces parameters on the switch. The dot1sinterfaces parameters name is mandatory. Request Details Table 4-26. dot1sinterfaces UPDATE Request Details Parameter interface bpduFilterMode Type - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 52
Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-27. dot1sinterfaces UPDATE Internal Error Codes Error Code 0 -21 -22 -26 Code Name OPEN_E_NONE OPEN_E_INTERNAL OPEN_E_PARAM OPEN_E_FAIL Description Success. Internal error. Invalid parameter. - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 53
/v1/dot1sinterfaces?method= put&forceVersion=802.1s Response Example { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid parameter", "error_code": -22 } } INTERFACE DELETE dot1sinterfaces does not support DELETE semantics. Rest API Reference 53 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 54
dot1smstientries MSTI CREATE POST /open/v1/dot1smstientries Use this call to create a MST instance with the ID specified on the switch. The mstId ID is mandatory. Request Details Table 4-28. MSTI CREATE Request Details Parameter mstId Type integer Description The MSTI ID. (0 is not allowed as - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 55
browser http://10.10.10.1:8080/open/v1/dot1smstientries?method= post&mstId=2 Response Example Returns an appropriate status message. { "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Error Example curl -POST -d "mstId=2" 10.10.10.1:8080/open/v1/dot1smstientries - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 56
Retrieves dot1smstientries parameters. Request Details Table 4-30. MST READ Request Details Parameter mstId fields fields - - - - offset limit Type Description integer MSTI ID. - Partial response syntax. mstId Spanning Tree MST Instance ID. fdbIds Forwarding Database IDs for the Spanning - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 57
Table 4-31. MST READ Internal Error Codes Error Code 0 -21 -22 -26 Code Name OPEN_E_NONE OPEN_E_INTERNAL OPEN_E_PARAM OPEN_E_FAIL Description Success. Internal error. Invalid parameter. Operation Fail. Multiple MST Entry Request Example The following example shows a multiple MST entry retrieval. - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 58
{ "mstId" : 2, "fdbIds: [ 3, 4, ], "vlans": [ { "id": 3, "type": "static", "name": "vlan3" } ], "priority" : 2, }, { "mstId" : 3, "fdbIds: [ 5, 6, ], "vlans": [ { "id": 4, "type": "dynamic", "name": "vlan4" } ], "priority" : 3, } ], "status": { "response_code": 200, "msg": "OK", "more_info": "", " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 59
browser http://10.10.10.1:8080/open/v1/dot1smstientries?limit=2 Response Example { "dot1smstientries" : [ { "mstId" : 1, "fdbIds: [ 1, 2, ], "vlans": [ { "id": 1, "type": "default", "name": "vlan1" }, { "id": 2, "type": "default", "name": "vlan2" } ], "priority" : 1, }, { "mstId" : 2, "fdbIds: [ 3, - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 60
"response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Single MST Entry Request Example Single MST entry retrievals are specified by using the mstId of the forwarding entry. All the available data for the dot1smst entry are retrieved by default. curl -GET -d "mstId=1" 10.10.10.1: - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 61
more_info": "Invalid parameter", "error_code": -22 } } MSTI UPDATE PUT /open/v1/dot1smstientries Use this call to update an existing MSTI on the switch. The MSTI ID is mandatory. Request Details Table 4-32. MSTI UPDATE Request Details Parameter mstId vlanId action priority Type integer integer - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 62
Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, 404, and 500. Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-33. MSTI UPDATE Internal Error Codes Error Code 0 -21 -22 -26 Code Name OPEN_E_NONE - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 63
"Invalid parameter", "error_code": -22 } } MSTI DELETE DELETE /open/v1/dot1smstientries Use this call to delete an existing MST instance on the switch. The MST ID is mandatory. Request Details Table 4-34. MSTI DELETE Request Details Parameter mstId Type integer Description MSTI ID. Response - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 64
Table 4-35. MSTI DELETE Internal Error Codes Error Code 0 -21 -22 -26 Code Name OPEN_E_NONE OPEN_E_INTERNAL OPEN_E_PARAM OPEN_E_FAIL Description Success. Internal error. Invalid parameter. Operation Fail. Request Example curl -GET -XDELETE -d "mstId=2" 10.10.10.1:8080/open/v1/dot1smstientries - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 65
{ "response_code": 400, "msg": "Bad request", "more_info": "Invalid parameter", "error_code": -22 } } fdbs FDB CREATE This component does not support create semantics. FDB READ GET /open/v1/fdbs Retrieves all of the variables that are associated with the FDB object. Request Details Table 4-36. - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 66
Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, and 500. Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-37. FDB READ Internal Error Codes Error Code 0 -22 -26 Code Name OPEN_E_NONE OPEN_E_PARAM OPEN_E_FAIL - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 67
"entryType": "learned" }, ], "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Multiple FDB Entries Partial Request Example curl -GET -d "limit=2" 10.10.10.1:8080/open/v1/fdbs browser http://10.10.10.1:8080/open/v1/fdbs?limit=2 Response Example { "fdbEntries": [ { " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 68
Single FDB Entry Partial Request Example curl -GET -d "mac=00:11:22:33:44:55&vlanId=1" 10.10.10.1:8080/open/v1/fdbs browser http://10.10.10.1:8080/open/v1/fdbs?mac= 00:11:22:33:44:55&vlanId=1 Response Example { "fdbEntries": [ { "interface": "1/1", "vlanId": 1, "mac": "00:11:22:33:44:55", "entryType - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 69
"more_info": "Invalid arguments", "error_code": -22 } } FDB UPDATE This component does not support delete semantics. FDB DELETE DELETE /open/v1/fdbs Use this call to delete an existing FDB entry on the switch. Only one of parameters (mac, vlanId, interface, all) is allowed to use per particular - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 70
Table 4-39. FDB DELETE Internal Error Codes Error Code 0 -21 -22 -26 Code Name OPEN_E_NONE OPEN_E_INTERNAL OPEN_E_PARAM OPEN_E_FAIL Description Success. Other internal error. Invalid parameter. Operation Fail. Request Example curl -GET -XDELETE -d "mac=00:11:22:33:44:55" 10.10.10.1:8080/open/v1 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 71
{ "response_code": 400, "msg": "Bad Request", "more_info": "Invalid parameter", "error_code": -22 } } fdbstats fdbstats CREATE This component does not support create semantics. fdbstats READ GET /open/v1/fdbstats Retrieves all of the variables that are associated with the FDB statistics. Request - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 72
Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, and 500. Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-41. fdbstats READ Internal Error Codes Error Code 0 -22 -26 Code Name OPEN_E_NONE OPEN_E_PARAM - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 73
Full Request Example Use additional keyword for additional output. curl -GET "fields=staticEntries,dynamicEntries" 10.10.10.1:8080/open/v1/fdbstats browser http://10.10.10.1:8080/open/v1/fdbstats?fields= staticEntries,dynamicEntries Response Example { "fdbstats": { "staticEntries": 8, " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 74
"error_code": -22 } } fdbstats UPDATE PUT /open/v1/fdbstats Use this call to update attributes of a fdbstats object. Request Details Table 4-42. fdbstats UPDATE Request Details Parameter greatestEntriesReset Type - Description Reset the greatest number of entries in the forwarding database. - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 75
/v1/fdbstats?method=put&test=60 Response Example { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid arguments", "error_code": -22 } } fdbstats DELETE This component does not support delete semantics. Rest API Reference 75 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 76
Switching Interfaces Interface CREATE NOTE: Interfaces cannot be created. However, you can reconfigure or UPDATE their parameters using PUT commands. Interface READ GET /open/v1/interfaces - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 77
Table 4-44. Interface READ Request Details (Continued) Parameter Type Description - linkState The link state of the interface, which is either enabled or disabled. An interface is considered active if the link is up, and the interface is in a forwarding state. - mtuSize Indicates Maximum - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 78
parameter to get the maximum number of interfaces possible for the given platform, i.e., CPU slots, LAG, VLAN, Loopback, Tunnel, Stack, and Service Port interfaces. Ancillary request parameter to get the maximum number of characters allowed for this interface description. Denotes beginning index for - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 79
Table 4-45. Interface READ Internal Error Codes (Continued) Error Code -21 -22 -26 -29 Code Name Description OPEN_E_INTERNAL Internal error. OPEN_E_PARAM Invalid parameter. OPEN_E_FAIL Operation Fail. OPEN_E_NOT_FOUND Parameter not found. Multiple Interface Request Example The following - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 80
"inErrors": 0, "inUnknownProtos": 0, "outOctets": 3, "outUcastPkts": 2, "outDiscards": 0, "outErrors": 0, "tagging": [1, 70], "participation" : [1, 70], } , { "adminMode": "enabled", "autoNegotiate": "enabled", "description": "", "physicalAddress": "00:01:85:48:E0:11", "duplexMode": "half", "pvId": - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 81
} } { "adminMode": "enabled", "autoNegotiate": "enabled", "description": "", "physicalAddress": "00:01:85:48:E0:11", "duplexMode": "half", "pvId": 1, "type": "physical", "linkState": "down", "acceptFrame": "all", "speed": "unknown", "mtuSize": 1500, "interface": "0/10", "lastChange": 1531, " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 82
Multiple Interface Partial Request Example The following is an example of a request that limits the output to the first three interfaces: curl -GET -d "limit=3" 10.10.10.1:8080/open/v1/interfaces browser http://10.10.10.1:8080/open/v1/interfaces?limit=3 Response Example { "interfaces": [ { " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 83
, { "adminMode": "enabled", "autoNegotiate": "enabled", "description": "", "physicalAddress": "00:01:85:48:E0:11", "duplexMode": "half", "pvId": 1, "type": "physical", "linkState": "down", "acceptFrame": "all", "speed": "unknown", "mtuSize": 1500, "interface": "0/2", "lastChange": 1402, "inOctets": - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 84
"speed": "unknown", "mtuSize": 1500, "interface": "0/3", "lastChange": 1102, "inOctets": 2, "inUcastPkts": 1, "inDiscards": 0, "inErrors": 0, "inUnknownProtos": 0, "outOctets": 2, "outUcastPkts": 1, "outDiscards": 0, "outErrors": 0 "tagging": [1, 80], "participation" : [1, 80], } ] , "status": { " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 85
Response Example { "interfaces": [ { "adminMode": "enabled", "autoNegotiate": "enabled", "description": "Engineering Dept.", "physicalAddress": "00:01:85:48:E0:11", "duplexMode": "full", "pvId": 1, "type": "physical", "linkState": "up", "acceptFrame": "all", "speed": "1000-full-duplex", "mtuSize": - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 86
} Single Interface Partial Request Example The response can be reduced by using the partial response syntax as denoted by the fields parameter. Following is an example of a specific interface, while limiting the results to VLAN related attributes. curl -GET -d "interface=0/34fields= participation, - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 87
msg": "OK", "more_info": "", "error_code": "0" } } Interface UPDATE PUT /open/v1/interfaces Use this call to update an existing interface on the switch. The interface name is mandatory. Request Details Table 4-46. Interface UPDATE Request Details Parameter Type acceptFrame all, tagged, untagged - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 88
Table 4-46. Interface UPDATE Request Details (Continued) Parameter Type adminMode enabled, disabled autoNegotiate enabled, disabled description string interface slot/port mtuSize integer participation auto, included, excluded pvId port VLAN id speed tagging See Available Speeds enabled, - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 89
Success. OPEN_E_INTERNAL Internal error. OPEN_E_PARAM Invalid parameter. OPEN_E_FAIL Operation Fail. OPEN_E_UNAVAIL Parameter or feature is not supported. OPEN_E_NOT_FOUND Parameter not found. Update Interface Request Example The following is an example to update the administration - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 90
browser: http://10.10.10.1:8080/open/v1/interfaces?method= put&interface=0/34&adminMode=enabled&speed=1000-full-duplex Response Example { "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": "0" } } Interface DELETE NOTE: Interfaces cannot be deleted. However, you can - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 91
VLANs VLAN CREATE POST /open/v1/vlans Use this call to create a VLAN with the ID specified on the switch. The VLAN ID is mandatory. VLAN name is optional, but recommended. Request Details Table 4-48. VLAN CREATE Request Details Parameter Type Description id integer VLAN - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 92
curl -POST -d "id=2&name=test" 10.10.10.1:8080/open/v1/vlans browser: http://10.10.10.1:8080/open/v1/vlans?method=post&id=2&name= test Response Example Returns an appropriate status message. { "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } VLAN READ GET /open/ - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 93
Table 4-50. VLAN READ Request Details (Continued) Parameter Type offset integer limit integer Description Denotes beginning index for pagination. Default is 1. This parameter is not valid for single VLAN retrievals. Denotes total retrieval count. Default is 10. This parameter is not valid for - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 94
"vlans": [ { "id": 1, "type": "default", "name": "default" }, { "id": 2, "type": "static", "name": "vlan2" }, { "id": 10, "type": "static", "name": "vlan10" }, { "id": 14, "type": "static", "name": "vlan14" }, Multiple VLAN Partial Request Example An example of a request that limits the VLAN output - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 95
{ "id": 2, "type": "static", "name": "vlan2" }, { "id": 10, "type": "static", "name": "vlan10" }, ], "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Single VLAN Request Example Single VLAN retrievals are specified by using the id parameter. The interfaces are - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 96
"name": "vlan2", "interfaces": [ { "pvid": 2, "participation": "include", "tagging": "untagged", "interface": "0/4" } ] } ], "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Single VLAN Partial Request Example The following is an example of a specific VLAN request - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 97
"status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Ancillary Request Example The following is an example using an ancillary request parameter to determine the maximum number of allowed VLANs for the given platform. curl -GET -d "fields=vlanMax" 10.10.10.1:8080/open/ - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 98
], "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Multiple VLAN Partial Request Example An example of a request that limits the VLAN output to 3. curl -GET -d "limit=3" 10.10.10.1:8080/open/v1/vlans browser: http://10.10.10.1:8080/open/v1/vlans?limit=3 Response - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 99
"msg": "OK", "more_info": "", "error_code": 0 } } Single VLAN Request Example Single VLAN retrievals are specified by using the id parameter. The interfaces are included for single VLAN retrievals. As such, all the available interfaces are scanned and if the associated interface is assigned to the - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 100
"msg": "OK", "more_info": "", "error_code": 0 } } Single VLAN Partial Request Example The following is an example of a specific VLAN request excluding the interfaces. curl -GET -d "id=2&fields=name,type" 10.10.10.1:8080/open/v1/vlans browser: http://10.10.10.1:8080/open/v1/vlans?id=2&fields=name, - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 101
200, "msg": "OK", "more_info": "", "error_code": 0 } } VLAN UPDATE PUT /open/v1/vlans Use this call to update an existing VLAN on the switch. The VLAN ID is mandatory. Request Details Table 4-52. VLAN UPDATE Request Details Parameter id name Type integer string Description VLAN ID. VLAN name - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 102
Response Example { "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } VLAN DELETE DELETE /open/v1/vlans Use this call to delete an existing VLAN on the switch. The VLAN ID is mandatory. 102 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 103
Request Example The following is a VLAN DETETE request example: curl -GET -XDELETE -d "id=3" 10.10.10.1:8080/open/v1/vlans browser: http://10.10.10.1:8080/open/v1/vlans?method=delete&id=3 Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, 404, and 500. Request - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 104
"error_code": 0 } } 104 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 105
Overlay Networking IP ip CREATE This component does not support create semantics. ip READ GET /open/v1/ip Retrieves one or more available ip. Request Details Table 4-56. ip READ Request Details Parameter ipAddr fields - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 106
Table 4-56. ip READ Request Details (Continued) Parameter Type limit integer Description Denotes total retrieval count. Default is 10. This parameter is not valid for single IP retrievals. Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, and 500 Internal - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 107
"netMask": "255.255.255.128", "bCast": 1, "reasmMaxSize": 120 }, { "ipAddr": "10.11.12.12", "ifIndex": "0/2", "netMask": "255.255.255.128", "bCast": 1, "reasmMaxSize": 120 }, ... { "ipAddr": "10.11.12.19", "ifIndex": "0/9", "netMask": "255.255.255.128", "bCast": 1, "reasmMaxSize": 120 } } } ], " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 108
"ipAddr": "10.11.12.11", "ifIndex": "0/1", "netMask": "255.255.255.128", "bCast": 1, "reasmMaxSize": 120 }, { "ipAddr": "10.11.12.12", "ifIndex": "0/2", "netMask": "255.255.255.128", "bCast": 1, "reasmMaxSize": 120 }, ], "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 109
.11&fields= ifIndex Response Example { "ip": [ { "ipAddr": "10.11.12.11", "ifIndex": "0/1", } ], "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": "0" } } ip UPDATE This component does not support update semantics. Rest API Reference 109 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 110
ip DELETE This component does not support delete semantics. 110 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 111
lagports lagports implements a RESTful API for the OpEN LAG API. LAG PORT CREATE POST /open/v1/lagports Use this call to set port as a member of a specified LAG. All fields are mandatory. Request Details Table 4-58. LAG PORT CREATE Request Details Parameter Type lag string port string - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 112
port=0/1 Response Example Returns an appropriate status message. { "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } LAG PORT READ lagports does not support read semantics. 'lags' resource should be used to retrieve LAGs configured. LAG PORT UPDATE lagports does not - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 113
http://10.10.10.1:8080/open/v1/lagports?method=delete&lag= 1/1&port=0/1 Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, 404, and 500. Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-60. LAG PORT DELETE - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 114
Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-62. LAG PORT DELETE Internal Error Codes Error Code 0 -21 -22 -26 Code Name OPEN_E_NONE OPEN_E_INTERNAL OPEN_E_PARAM OPEN_E_FAIL Description Success. Internal error. Invalid parameter. Operation - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 115
lags lags implements a RESTful API for the OpEN LAG API. LAG CREATE Note that lags cannot be created. You can however reconfigure or UPDATE their parameters using PUT commands. LAG READ GET /open/v1/lags Retrieves one or more available LAGs. Request Details Table 4-64. LAG READ Request Details - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 116
Table 4-64. LAG READ Request Details (Continued) Parameter Type offset integer limit integer Description Denotes beginning index for pagination. Default is 1. This parameter is not valid for single interface retrievals. Denotes total retrieval count. Default is 10. This parameter is not valid - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 117
"nameMax": 16, "staticMode": "enabled", "lag": "3/1", "loadBalanceMode": "sda_vlan", "name": "lag 1", "membersMax": 32, "minUpLinks": 1, "thresholdMax": 32, "thresholdMin": 1, "members": [ "0/74", "0/75" ], "activeMembers": [ "0/74 more records here **/ { "nameMax": 16, "staticMode": "enabled", " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 118
], "activeMembers status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Multiple LAG Partial Request Example The following example request limits the output to the first two LAGs. curl -GET -d "limit=2" 10.10.10.1:8080/open/v1/lags browser http://10.10.10.1:8080/open/v1 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 119
}, { "nameMax": 16, "staticMode": "enabled", "lag": "3/2", "loadBalanceMode": "sda_vlan", "name": "lag 1", "membersMax": 32, "minUpLinks": 1, "thresholdMax": 32, "thresholdMin": 1, "members": [ "0/3" ], "activeMembers": [ "0/3" ] }, ], "status": { "response_code": 200, "msg": "OK", "more_info": "", - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 120
Response Example { "lags": [ { "nameMax": 16, "staticMode": "enabled", "lag": "3/1", "loadBalanceMode": "sda_vlan", "name": "lag 1", "membersMax": 32, "minUpLinks": 1, "thresholdMax": 32, "thresholdMin": 1, "members": [ "0/74", "0/75" ], "activeMembers": [ "0/74" ] }, ], "status": { "response_code": - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 121
Response Example { "lags": [ { "lag": "3/1", "loadBalanceMode": "sda_vlan", "name": "lag 100", } ], "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Ancillary Request Example The following example uses an ancillary request parameter to determine the maximum number - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 122
": "Not Found", "more_info": "", "error_code": -29 } } LAG UPDATE PUT /open/v1/lags Use this call to update an existing LAG on the switch. The LAG name is mandatory. Request Details Table 4-66. LAG UPDATE Request Details Parameter lag Type string loadBalanceMode minUpLinks string (see Load - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 123
0 -21 -22 -26 -28 -29 Code Name Description OPEN_E_NONE Success. OPEN_E_INTERNAL Internal error. OPEN_E_PARAM Invalid parameter. OPEN_E_FAIL Operation Fail. OPEN_E_UNAVAIL Parameter or feature is not supported. OPEN_E_NOT_FOUND Parameter not found. Rest API Reference 123 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 124
Update LAG Request Example The following example enables the static mode and sets name to lag 100 for LAG located in slot 1, port 1. curl -GET -XPUT -d "lag=1/1&staticMode=enabled&name=lag%20100" 10.10.10.1:8080/open/v1/lags browser http://10.10.10.1:8080/open/v1/lags?method=put&lag= 1/1&staticMode= - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 125
mfdbs MFDB CREATE This component does not support create semantics. MFDB READ GET /open/v1/mfdbs Retrieves all of the variables that are associated with the MFDB object. Request Details Table 4-68. MFDB - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 126
Codes Error Code 0 -22 -26 -28 Code Name OPEN_E_NONE OPEN_E_PARAM OPEN_E_FAIL OPEN_E_UNAVAIL Description Success. Invalid request. Operation failed. Feature is not supported. Multiple MFDB Entries Request Example curl -GET 10.10.10.1:8080/open/v1/mfdbs browser http://10.10.10.1:8080/open/v1 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 127
"source": "Filter", "type": "Static", "description": "Mgmt Config", "absPortMask": "0/1", "frwdIntMask": "0/2,0/3", "fltIntMask": "" }, { "vlanId": 3, "mac": "33:33:33:33:33:33", "source": "Filter", "type": "Static", "description": "Mgmt Config", "absPortMask": "", "frwdIntMask": "", "fltIntMask": - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 128
Response Example { "mfdbEntries": [ { "source": "Filter" }, { "source": "IGMP" } ], "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Single MFDB Entry Partial Request Example curl -GET -d "mac=33:33:33:33:33:33&vlanId=3" 10.10.10.1:8080/open/v1/mfdbs browser http - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 129
&x=-99 Response Example Returns an appropriate status message. { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid arguments", "error_code": -22 } } MFDB UPDATE This component does not support update semantics. MFDB DELETE This component does not - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 130
System Registry The registry resource represents a RESTful API that exposes various data about the switch via its system registry. Registry CREATE This component does not support create semantics. Registry READ GET /open/v1/registry Retrieves all of the data available from the system registry. - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 131
Table 4-71. Registry READ Internal Error Codes (Continued) Error Code -26 Code Name OPEN_E_FAIL Description Operation failed. Request Example curl -GET 10.10.10.1:8080/open/v1/registry browser: http://10.10.10.1:8080/open/v1/registry Response Example { "machineType": "type", "machineModel": " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 132
"more_info": "Invalid arguments", "error_code": -22 } } Registry UPDATE The registry resource does not support update semantics. Registry DELETE This registry resource does not support delete semantics. 132 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 133
serviceport serviceport implements a RESTful API for the OpEN API. This version of the API only supports IPV4. Service port CREATE Create semantics are not supported by this resource Service port READ GET /open/v1/serviceport Retrieves various data associated with the device's serviceport. - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 134
200, 400, and 500. Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-73. Service port READ Internal Error Codes Error Code 0 -22 -26 Code Name OPEN_E_NONE OPEN_E_PARAM OPEN_E_FAIL Description Success. Invalid parameter. Request failed. Request - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 135
complete. It is advised that other means for configuring the serviceport be used in this scenario. Request Details Table 4-74. Service port UPDATE Request Details Parameter ipv4addr ipv4netmask Type string string Description IPV4 dot notation address (required if ipv4netmask present). IPV4 dot - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 136
for OpEN API are shown in the following table. Table 4-75. Service port UPDATE Internal Error Codes Error Code 0 -22 Code Name OPEN_E_NONE or none of the optional parameters was specified. Update failed. Feature is not supported. Request Example curl -GET -XPUT -d "ipv4addr=10.14.240.45& - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 137
browser http://10.10.10.1:8080/open/v1/serviceport?method=put&vlanId=2 Response Example { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid arguments" "error_code": -22 } } Service port DELETE This resource does not support delete semantics. Rest API Reference 137 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 138
Snooping Configuration Snooping configuration CREATE This component does not support create semantics. Snooping configuration READ GET /open/v1/snoopingconfig Retrieves all of the variables that are associated with the snooping configuration. Request Details Table 4-76. - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 139
Request Details (Continued) Parameter - Type Description *isFamilyTypeSupported* Ancillary request parameter to determine if the passed family type snooping is supported or not (true/false). Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, and 500 Internal - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 140
": "", "error_code": 0 } } Ancillary Request Example An example using an ancillary request parameter to determine if the passed family type is snooping supported or not. curl -GET -d "family=igmp&fields=isFamilyTypeSupported" 10.10.10.1:8080/open/v1/snoopingconfig browser http://10.10.10.1:8080/open - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 141
": -22 } } Snooping configuration UPDATE PUT /open/v1/snoopingconfig Use this call to update various properties of the switch snooping configuration. Request Details Table 4-78. Snooping configuration UPDATE Request Details Parameter family Type string adminMode string proxyQuerierAdminMode - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 142
Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-79. Snooping configuration UPDATE Internal Error Codes Error Code 0 -22 -26 Code Name OPEN_E_NONE OPEN_E_PARAM OPEN_E_FAIL Description Config update successful. Error in parameters passed. Config - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 143
Response Example { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid arguments", "error_code": -22 } } Snooping configuration DELETE Snooping configuration does not support delete semantics. Rest API Reference 143 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 144
Snooping Interfaces Snooping Interface CREATE Note that Snooping Interface cannot be created. Snooping Interface GET GET /open/v1/snoopinginterfaces Retrieves Snooping Interfaces. Request Details Table 4-80. Snooping Interface GET Request Details Parameter interface family fields fields - - - - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 145
Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, 404, and 500. Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-81. Snooping Interface GET Internal Error Codes Error Code 0 -21 -22 -26 Code Name OPEN_E_NONE - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 146
"fastLeaveAdminMode": "enabled", "groupMembershipInterval": 10, "intfMode": "enabled", "proxyQuerierMode": "enabled", "responseTime": 10 } ], "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Multiple Snooping Interface Partial Request Example The following example - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 147
"error_code": 0 } } Single Snooping Interface Request Example Single Snooping Interface retrievals are specified by using the interface parameter. All the available Snooping Interface resources are retrieved by default. The following example requests Snooping Interface located in slot 0, port 9. - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 148
Single Snooping Interface Partial Request Example The response can be reduced by using the partial response syntax as denoted by the 'fields' parameter. curl -GET -d "interface=0/1&fields= family,groupMembershipInterval,responseTime" 10.10.10.1:8080/open/v1/snoopinginterfaces browser http://10.10.10 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 149
-29 } } Snooping Interface UPDATE PUT /open/v1/snoopinginterfaces Use this call to update an existing Snooping Interface configuration on the switch. The Interface name is mandatory. Request Details Table 4-82. Snooping Interface UPDATE Request Details Parameter interface Type string family - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 150
Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, 404, and 500. Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-83. Snooping Interface UPDATE Internal Error Codes Error Code 0 -21 -22 -26 -29 Code Name - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 151
} Error Example curl -GET -XPUT -d "interface=0/1&intfMode= enabled&responseTime=100" 10.10.10.1:8080/open/v1/snoopinginterfaces browser http://10.10.10.1:8080/open/v1/snoopinginterfaces?method= put&interface=0/1&intfMode=enabled&responseTime=100 Response Example { "status": { "response_code": 400, - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 152
snoopingqueriers snoopingquerier CREATE This component does not support create semantics snoopingquerier READ GET /open/v1/snoopingqueriers Retrieves all of the variables that are associated with the snooping querier. Request Details Table 4-84. snoopingquerier - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 153
Table 4-84. snoopingquerier READ Request Details (Continued) Parameter Type Description - querierVersion Snooping querier configured version of a snoop instance. - vlanAddress The snooping querier configured address for specified VLAN ID of a snoop instance. - vlanElectionMode Configured - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 154
Response Example { "family": "igmp", "vlanId": 1, "address": "10.11.12.13", "adminMode": "enabled", "family": "igmp", "expiryInterval": 20, "lastQuerierAddress": "10.11.12.14", "lastQuerierVersion": 3, "operMaxRespTime": 35, "operState": "querier", "operVersion": 5, "queryInterval": 15, " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 155
"error_code": -22 } } snoopingquerier UPDATE PUT /open/v1/snoopingqueriers Use this call to update various properties of the switch. Request Details Table 4-86. snoopingquerier UPDATE Request Details Parameter family vlanId address adminMode expiryInterval Type Description string IGMP Snooping - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 156
Table 4-86. snoopingquerier UPDATE Request Details (Continued) Parameter Type Description queryInterval integer Snooping querier query interval of a snoop instance. querierVersion integer Snooping querier configured version of a snoop instance. vlanAddress string The snooping querier - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 157
/v1/snoopingqueriers?method= put&adminMode=enabled Response Example { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid arguments", "error_code": -22 } } snoopingquerier DELETE This component does not support delete semantics. Rest API Reference 157 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 158
snoopingssms snoopingssm CREATE This component does not support create semantics. snoopingssm READ GET /open/v1/snoopingssms Retrieves all available snoopingssm entries. Request Details Table 4-88. snoopingssm READ Request Details Parameter Type Description family - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 159
Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-89. snoopingssm READ Internal Error Codes Error Code 0 -21 -22 -26 Code Name OPEN_E_NONE OPEN_E_INTERNAL OPEN_E_PARAM OPEN_E_FAIL Description Success. Internal error. Invalid parameter. Operation - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 160
"incPortMask": "2/3", "vlanId": 3 } ], "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Partial Request Example The following example request limits the output to 2. curl -GET -d "family=igmp&entryType=mfdb&limit=2" 10.10.10.1:8080/open/v1/snoopingssms browser - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 161
"error_code": 0 } } Partial Request Example curl -GET -d "family=igmp&entryType=mfdb&fields= mfdbCurrEntries" 10.10.10.1:8080/open/v1/snoopingssms browser http://10.10.10.1:8080/open/v1/snoopingssms?family= igmp&entryType=mfdb&limit=2&fields=mfdbCurrEntries Response Example { "mfdbCurrEntries": 3, " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 162
snoopingssm UPDATE This component does not support update semantics. snoopingssm DELETE This component does not support delete semantics. 162 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 163
Snooping VLANs Snooping VLAN CREATE Note that Snooping VLAN cannot be created. Snooping VLAN GET GET /open/v1/snoopingvlans Retrieves Snooping VLANs. Request Details Table 4-90. Snooping VLAN GET Request Details Parameter Type Description vlanId integer VLAN ID. VLAN ID is mandatory. - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 164
Table 4-90. Snooping VLAN GET Request Details (Continued) Parameter Type limit integer Description Denotes total retrieval count. Default is 10. This parameter is not valid for single VLAN retrievals. Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, 404, and - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 165
"reportSuppMode": "enabled", "proxyQuerierMode": "enabled", "groupMembershipInterval": 10, "maxResponseTime": 10 }, ... /** more records here **/ { "vlanId": "10", "family": "igmp", "fastLeaveMode": "enabled", "vlanMode": "enabled", "reportSuppMode": "enabled", "proxyQuerierMode": "enabled", " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 166
"reportSuppMode": "enabled", "proxyQuerierMode": "enabled", "groupMembershipInterval": 10, "maxResponseTime": 10 }, ], "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Single Snooping VLAN Request Example Single Snooping VLAN retrievals are specified by using the - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 167
"msg": "OK", "more_info": "", "error_code": 0 } } Single Snooping VLAN Partial Request Example The response can be reduced by using the partial response syntax as denoted by the 'fields' parameter. curl -GET -d "family=igmp&vlanId=1&fields= vlanMode,maxResponseTime" 10.10.10.1:8080/open/v1/ - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 168
error_code": -22 } } Snooping VLAN UPDATE PUT /open/v1/snoopingvlans Use this call to update an existing Snooping VLAN configuration on the switch. The VLAN ID and family are mandatory. Request Details Table 4-92. Snooping VLAN UPDATE Request Details Parameter Type Description vlanId integer - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 169
Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, 404, and 500. Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-93. Snooping VLAN UPDATE Internal Error Codes Error Code 0 -21 -22 -26 -29 Code Name - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 170
Error Example curl -GET -XPUT -d "vlanMode=enabled&maxResponseTime= 100&family=igmp" 10.10.10.1:8080/open/v1/snoopingvlans browser http://10.10.10.1:8080/open/v1/snoopingvlans?method= put&vlanMode=enabled&maxResponseTime=100&family=igmp Response Example { "status": { "response_code": 400, "msg": " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 171
stormcontrolports stormcontrolports implements a RESTful API for the OpEN Overlay API. Storm Control Interface CREATE Note that Storm Control Interface cannot be created. You can, however, reconfigure or UPDATE their parameters using PUT commands. Storm Control Interface GET GET /open/v1/ - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 172
Table 4-94. Storm Control Interface GET Request Details (Continued) Parameter Type limit integer Description Denotes total retrieval count. Default is 10. This parameter is not valid for single interface retrievals. Response Details HTTP Response Codes The possible HTTP Response codes are 200, - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 173
"thresholdUnicast": 7440000, "thresholdBroadcast": 7440000, "thresholdMulticast": 7440000, "rateUnitUnicast": "pps" "rateUnitBroadcast": "pps" "rateUnitMulticast": "pps more records here **/ { "interface": "0/64", "modeUnicast": "enabled", "modeBroadcast": "enabled", "modeMulticast": "enabled", " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 174
"modeUnicast": "enabled", "modeBroadcast": "enabled", "modeMulticast": "enabled", "thresholdUnicast": 7440000, "thresholdBroadcast": 7440000, "thresholdMulticast": 7440000, "rateUnitUnicast": "pps" "rateUnitBroadcast": "pps" "rateUnitMulticast": "pps" }, { "interface": "0/2", "modeUnicast": "enabled - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 175
Response Example { "stormcontrolports": [ { "interface": "0/9", "modeUnicast": "enabled", "modeBroadcast": "enabled", "modeMulticast": "enabled", "thresholdUnicast": 7440000, "thresholdBroadcast": 7440000, "thresholdMulticast": 7440000, "rateUnitUnicast": "pps" "rateUnitBroadcast": "pps" " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 176
Found", "more_info": "", "error_code": -29 } } Storm Control Interface UPDATE PUT /open/v1/stormcontrolports Use this call to update an existing Storm Control Interface configuration on the switch. The Interface name is mandatory. 176 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 177
Request Details Table 4-96. Storm Control Interface UPDATE Request Details Parameter Type Description interface string Interface name in slot/port format. Identifies the interface. The interface name is mandatory for all updates. modeUnicast string Unicast Storm Control mode (enabled/disabled - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 178
-26 -28 -29 Code Name Description OPEN_E_PARAM Invalid parameter. OPEN_E_FAIL Operation Fail. OPEN_E_UNAVAIL Parameter or feature is not supported. OPEN_E_NOT_FOUND Parameter not found. Update Storm Control Interface Request Example The following example enables the storm control unicast - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 179
Error Codes Error Code 0 -22 -26 -28 Code Name OPEN_E_NONE OPEN_E_PARAM OPEN_E_FAIL OPEN_E_UNAVAIL Description Success. Invalid parameter. Request failed. Parameter not supported. Request Example curl -GET -XCREATE 10.10.10.1:8080/open/v1/swmirror -d 'remoteSpanVlan=7' Rest API Reference 179 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 180
{ "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } SWMIRROR READ GET /open/v1/swmirror?session=1 Retrieves the various attributes supported by this resource. Request Details Table 4-100. SWMIRROR READ Request Details Parameter Type Description session integer Session - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 181
-30 Code Name OPEN_E_NONE OPEN_E_INTERNAL OPEN_E_PARAM OPEN_E_FAIL OPEN_E_UNAVAIL OPEN_E_EMPTY Description Success. Request failed. Invalid parameter. Request failed. Parameter not supported. Returned value is not configured. Request Example curl -GET 10.10.10.1:8080/open/v1/swmirror -d 'session - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 182
"error_code": 0 } } Error Example curl -GET -d "test=0" 10.10.10.1:8080/open/v1/swmirror browser http://10.10.10.1:8080/open/v1/swmirror?method=get&test=0 Response Example Returns an appropriate status message. { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 183
Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-103. SWMIRROR UPDATE Internal Error Codes Error Code 0 -22 -26 Code Name OPEN_E_NONE OPEN_E_PARAM OPEN_E_FAIL Description Update successful. Error in parameters passed. Update failed. Request - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 184
Error Codes Error Code 0 -22 -26 -28 Code Name OPEN_E_NONE OPEN_E_PARAM OPEN_E_FAIL OPEN_E_UNAVAIL Description Success. Invalid parameter. Request failed. Parameter not supported. Request Example curl -GET -XDELETE 10.10.10.1:8080/open/v1/swmirror -d 'remoteSpanVlan=7' 184 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 185
browser http://10.10.10.1:8080/open/v1/swmirror?method= delete&remoteSpanVlan=7 Response Example { "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Rest API Reference 185 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 186
, however, reconfigure or UPDATE parameters using PUT commands. SWMONITOR READ GET /open/v1/swmonitor Retrieves the various attributes supported by this resource. Request Details Table 4-106. SWMONITOR READ Request Details Parameter Type Description session integer Session number. Required - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 187
Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, and 500. Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-107. SWMONITOR READ Internal Error Codes Error Code 0 -22 -26 Code Name OPEN_E_NONE OPEN_E_PARAM - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 188
} } Error Example curl -GET -d "test=0" 10.10.10.1:8080/open/v1/swmonitor browser http://10.10.10.1:8080/open/v1/swmonitor?method=get&test=0 Response Example Returns an appropriate status message. { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid parameter", " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 189
Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, and 500. Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-109. SWMONITOR UPDATE Internal Error Codes Error Code 0 -21 -22 -26 -28 -31 Code Name OPEN_E_NONE - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 190
Error Example curl -GET -XPUT -d "session=20" 10.10.10.1:8080/open/v1/swmonitor browser http://10.10.10.1:8080/open/v1/swmonitor?method=put&session=20 Response Example { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid argument" "error_code": -22 } } SWMONITOR DELETE - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 191
Response Details HTTP Response Codes The possible HTTP Response codes are 200, 400, and 500. Internal Error Codes The possible error codes for OpEN API are shown in the following table. Table 4-111. SWMONITOR DELETE Internal Error Codes Error Code 0 -21 -22 -26 -28 -31 Code Name OPEN_E_NONE - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 192
Error Example curl -GET -XDELETE -d "session=20" 10.10.10.1:8080/open/v1/swmonitor browser http://10.10.10.1:8080/open/v1/swmonitor?method= delete&session=20 Response Example { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid argument" "error_code": -22 } } 192 Rest - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 193
Error Codes Error Code 0 -21 -22 -26 -28 Code Name OPEN_E_NONE OPEN_E_INTERNAL OPEN_E_PARAM OPEN_E_FAIL OPEN_E_UNAVAIL Description Success. Request failed. Invalid parameter. Request failed. Parameter not supported. Rest API Reference 193 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 194
"response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } SWPORTMONITOR READ GET /open/v1/swportmonitor Retrieves the various attributes supported by this resource. Request Details Table 4-114. SWPORTMONITOR READ Request Details Parameter Type Description session integer Session - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 195
Codes Error Code 0 -22 -26 -28 Code Name OPEN_E_NONE OPEN_E_PARAM OPEN_E_FAIL OPEN_E_UNAVAIL Description Success. Invalid parameter. Request failed. Parameter not supported. Request Example curl -GET 10.10.10.1:8080/open/v1/swportmonitor -d 'session=1' browser http://10.10.10.1:8080/open/v1 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 196
http://10.10.10.1:8080/open/v1/swportmonitor?method= get&session=-99 Response Example Returns an appropriate status message. { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid parameter", "error_code": -22 } } SWPORTMONITOR UPDATE PUT /open/v1/swportmonitor Use this - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 197
Table 4-117. SWPORTMONITOR UPDATE Response Details Error Code 0 -22 -26 Code Name OPEN_E_NONE OPEN_E_PARAM OPEN_E_FAIL Description Update successful. Error in parameters passed. Update failed. Request Example curl -GET -XPUT -d "dstPort=0/5&session=1&mode=enabled" 10.10.10.1:8080/open/v1/ - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 198
Error Codes Error Code 0 -21 -22 -26 -28 Code Name OPEN_E_NONE OPEN_E_INTERNAL OPEN_E_PARAM OPEN_E_FAIL OPEN_E_UNAVAIL Description Success. Request failed. Invalid parameter. Request failed. Parameter not supported. Request Example 198 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 199
curl -GET -XDELETE 10.10.10.1:8080/open/v1/swportmonitor -d 'dstPort=true&session=1' browser http://10.10.10.1:8080/open/v1/swportmonitor?method= delete&session=1&dstPort=true Response Example { "status": { "response_code": 200, "msg": "OK", "more_info": "", "error_code": 0 } } Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 200
RFC. Note that a subset of the RFC1213 system object is defined in this version of the API. System RFC1213 CREATE This component does not support create semantics. System RFC 1213 READ GET /open/v1/system1213 Retrieves all of the variables that are associated with the system object in RFC1213 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 201
Table 4-121. System RFC 1213 READ Internal Error Codes (Continued) Error Code -22 -26 Code Name OPEN_E_PARAM OPEN_E_FAIL Description Invalid request. Operation failed. Request Example curl -GET 10.10.10.1:8080/open/v1/system1213 browser: http://10.10.10.1:8080/open/v1/system1213 Response - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 202
Response Example { "sysNameMaxSize":128, "status": { " response_code":200, "msg":"OK", "more_info":"", "error_code":0 } } Error Example curl -GET -d "x=-99" 10.10.10.1:8080/open/v1/system1213 browser: http://10.10.10.1:8080/open/v1/system1213?method=get&x=-99 Response Example Returns an appropriate - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 203
Request Details Table 4-122. System RFC 1213 UPDATE Request Details Parameter sysName sysLocation sysContact Type string string string Description System name (optional). System location (optional). System contact info (optional). NOTE: At least one of the optional arguments must be specified, - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 204
/system1213?method= put&sysUndefined=2 Response Example { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid arguments", "error_code": -22 } } System RFC 1213 DELETE This resource does not support delete semantics. 204 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 205
implements a RESTful API for the OpEN API. System Config CREATE This resource does not support create semantics. System Config READ GET /open/v1/systemconfig Retrieves the various attributes supported by this resource. Request Details Table 4-124. System Config READ Request Details Parameter - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 206
Request Example curl -GET 10.10.10.1:8080/open/v1/systemconfig browser http://10.10.10.1:8080/open/v1/systemconfig Response Example { "sysSerialTimeOut" : 5, "sysTelnetServerAdminMode" : "enabled", "sysWarmRestartStatus" : "true", "status": { "response_code": 200, "msg": "OK", "more_info": "", " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 207
Error Example curl -GET -d "tenant=-99" 10.10.10.1:8080/open/v1/systemconfig browser http://10.10.10.1:8080/open/v1/systemconfig?method=get&tenant= -99 Response Example Returns an appropriate status message. { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid parameter", - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 208
Table 4-126. System Misc UPDATE Request Details (Continued) Parameter Type Description sysSerialTimeOutDefault - Set the serial timeout to default value. Do not use with sysSerialTimeOut parameter. (optional) sysSerialTimeOut integer The serial timeout. Do not use with sysSerialTimeOutDefault - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 209
/open/v1/systemconfig?method=put Response Example { "status": { "response_code": 400, "msg": "Bad Request", "more_info": "Invalid parameter" "error_code": -22 } } System Misc DELETE This resource does not support delete semantics. Rest API Reference 209 - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 210
CREATE POST /open/v1/systemcontrol Use POST requests to support the system reload and configuration save semantics of this are undefined. It is likely that the HTTP connection will be closed by the switch and timeout on the client side. Response Details HTTP Response Codes The possible HTTP - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 211
Table 4-129. System Control CREATE Internal Error Codes (Continued) Error Code Code Name -26 OPEN_E_FAIL Description Requested operations failed or could not be performed. Request Example curl -POST -d "reload=1" 10.10.10.1:8080/open/v1/systemcontrol browser: http://10.10.10.1:8080/open/v1/ - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 212
more_info": "Invalid parameters" "error_code": -22 } } System Control READ Read semantics are not supported by this resource. System Control UPDATE Update semantics are not supported by this resource. System Control DELETE Delete semantics are not supported by this resource. 212 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 213
implements a RESTful API for the OpEN API. System Misc CREATE This resource does not support create semantics. System Misc READ GET /open/v1/systemmisc Retrieves the various attributes supported by this resource. Request Details Table 4-130. System Misc READ Request Details Parameter - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 214
Request Example curl -GET 10.10.10.1:8080/open/v1/systemmisc browser: http://10.10.10.1:8080/open/v1/systemmisc Response Example { "hostname" : "name", "hostnameSize" : 64, "systemPromptMaxSize" : 32, "systemUpTime" : 34563, "systemUptimeMsec" : 430, "systemBurnedInMacAddr" : "0a:34:12:6d:fe:12" " - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 215
"error_code": -22 } } System Misc UPDATE PUT /open/v1/systemmisc Use this call to update various miscellaneous system settings. Use GET (see preceding example) to determine allowed lengths via the hostnameSize and systemPromptMaxSize attributes. Request Details Table 4-132. System Misc UPDATE - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 216
.1:8080/open/v1/systemmisc?method=put&vlanId=2 Response Example { "status": { "response_code": 400, "msg": "Invalid parameter(s)", "more_info": "" "error_code": -22 } } System Misc DELETE This resource does not support delete semantics. 216 Rest API Reference - Dell N3200-ON | Networking N-Series Switches RESTful API User Guide version 6.8. - Page 217
Printed in the U.S.A. www.dell.com | support.dell.com
Dell Networking N
-
Series
N2200-ON, and N3200-ON
Switches
RESTful API User Guide
Version 6.8.0
Regulatory Models: E04W, E05W, E06W,
E07W, E15W, E16W, E17W, E18W, E30W,
E31W, E32W, E41W