ethernet_adapters¶
Overview¶
View or Modify the Network Adapters through this APIs
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config/
Schemes : HTTP
Tags¶
- ethernet_adapters : Operations related to ethernet_adapters
Paths¶
Get operation for ethernet_adapters¶
GET /ethernet_adapters
Description¶
Use this operation to list all the ethernet adapters
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | ethernet_adapters_response_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- ethernet_adapters
PUT operation for ethernet_adapters¶
PUT /ethernet_adapters
Description¶
Use this option to modify Autonegotiation, Speed and Duplex settings
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
ethernet_adapters_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | ethernet_adapters_put_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- ethernet_adapters
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
autonegotiate¶
Specifies whether autonegotiation is on or off
Type : enum (ON, OFF)
duplex¶
Full or Auto
Type : enum (FULL, AUTO)
ethernet_adapters¶
| Name | Schema |
|---|---|
| autonegotiate optional |
autonegotiate |
| duplex optional |
duplex |
| port_name optional |
port_name |
| speed optional |
speed |
ethernet_adapters_delete_success_schema¶
| Name | Schema |
|---|---|
| ethernet_adapters optional |
ethernet_adapters |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
ethernet_adapters_post_success_schema¶
| Name | Schema |
|---|---|
| ethernet_adapters optional |
ethernet_adapters |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
ethernet_adapters_put_success_schema¶
| Name | Schema |
|---|---|
| ethernet_adapters optional |
ethernet_adapters |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
ethernet_adapters_request_schema¶
| Name | Schema |
|---|---|
| ethernet_adapters optional |
ethernet_adapters |
ethernet_adapters_response_schema¶
Type : < ethernet_adapters_response_schema > array
ethernet_adapters_response_schema
| Name | Schema |
|---|---|
| autonegotiate optional |
autonegotiate |
| duplex optional |
duplex |
| lsp_state optional |
lsp_state |
| mac_address optional |
mac_address |
| port_name optional |
port_name |
| port_state optional |
port_state |
| speed optional |
speed |
lsp_state¶
Specifies whether LSP state is up,down or admin_down when LSP is configured
Type : string
mac_address¶
Specifies the MAC address of the port
Type : string
port_name¶
Port of the appliance
Type : string
port_state¶
Specifies link state whether it is UP or DOWN
Type : enum (ON, OFF)
speed¶
Specifies the configurable speed
Type : enum (10Mb/s, 100Mb/s, 1000Mb/s)