os_partition¶
Overview¶
Os Partition Operations
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config/
Schemes : HTTP
Tags¶
- os_partition : Operations related to os_partition
Paths¶
POST operation for os_partition¶
POST /os_partition
Description¶
Switch Between active and backup OS
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | action required |
Select if action is other that ADD | enum (switch, install, clear) |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | os_partition_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¶
- os_partition
Get operation for os_partition¶
GET /os_partition
Description¶
Use this operation to Get The OS Partition Version
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | os_partition_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¶
- os_partition
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
active_os¶
Current Active OS Partition Version
Type : string
backup_os¶
Backup OS Partition Version
Type : string
os_partition_delete_success_schema¶
| Name | Schema |
|---|---|
| os_partition optional |
os_partition |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
os_partition_post_success_schema¶
| Name | Schema |
|---|---|
| os_partition optional |
os_partition |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
os_partition_put_success_schema¶
| Name | Schema |
|---|---|
| os_partition optional |
os_partition |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
os_partition_response_schema¶
Type : < os_partition_response_schema > array
| Name | Schema |
|---|---|
| active_os optional |
active_os |
| backup_os optional |
backup_os |
| partition_files optional |
partition_files |
partition_files¶
List of OS Partition files uploaded
Type : string