system_options¶
Overview¶
System-Options
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config/
Schemes : HTTP
Tags¶
- system_options : Operations related to system_options
Paths¶
POST operation for system_options¶
POST /system_options
Description¶
Reboots the SD-WAN Appliance
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | action required |
Select if action is other that ADD | enum (reboot, configuration_reset, factory_reset) |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | system_options_post_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 |
Produces¶
application/json
Tags¶
- system_options
Get operation for system_options¶
GET /system_options
Description¶
Get System Information.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | system_options_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¶
- system_options
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
appliance_mode¶
Appliance Mode
Type : enum (MCN, Client)
appliance_uptime¶
Uptime of the appliance (Will be shown once Virtual WAN is enabled)
Type : string
license_state¶
The appliance is licensed or not
Type : boolean
management_ip¶
Management IP Of System
Type : string
model¶
Model Of the system
Type : string
os_ver¶
OS Version
Type : string
product¶
Product name.
Type : string
serial_no¶
Serial Number of the system
Type : string
service_uptime¶
Service up time. Will be shown once Virtual WAN is Enabled
Type : string
site_name¶
Site Name
Type : string
sw_version¶
S/W Version The Site is currently running on
Type : string
system_options_delete_success_schema¶
| Name | Schema |
|---|---|
| system_options optional |
system_options |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
system_options_post_success_schema¶
| Name | Schema |
|---|---|
| system_options optional |
system_options |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
system_options_put_success_schema¶
| Name | Schema |
|---|---|
| system_options optional |
system_options |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
system_options_response_schema¶
Type : < system_options_response_schema > array
system_options_response_schema
| Name | Schema |
|---|---|
| appliance_mode optional |
appliance_mode |
| appliance_uptime optional |
appliance_uptime |
| license_state optional |
license_state |
| management_ip optional |
management_ip |
| model optional |
model |
| os_ver optional |
os_ver |
| product optional |
product |
| serial_no optional |
serial_no |
| service_uptime optional |
service_uptime |
| site_name optional |
site_name |
| sw_version optional |
sw_version |
| system_time optional |
system_time |
system_time¶
Shows the current time of system
Type : string