local_change_management¶
Overview¶
This resource provides Local Change management status and operations related to Local Change Management. Use file_upload_to_inbox API to upload file required for Local Change Management.
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config/
Schemes : HTTP
Tags¶
- local_change_management : Operations related to local_change_management
Paths¶
POST operation for local_change_management¶
POST /local_change_management
Description¶
Does Local Change Management activate operation
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | action required |
Select if action is other that ADD | enum (activate) |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | local_change_management_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¶
- local_change_management
Get operation for local_change_management¶
GET /local_change_management
Description¶
Use this operation to get Local Change Management status
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | local_change_management_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¶
- local_change_management
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
active_config¶
Active config time .
Type : string
active_package_filename¶
Filename of currently active package
Type : string
active_registry_timestamp¶
TimeStamp of currently active registries
Type : string
active_sw_revision¶
Currently active software of appliance .
Type : string
id¶
Id of the appliance
Type : string
inbox_files¶
Files in Change Management Inbox Directory
Type : string
local_change_management_delete_success_schema¶
| Name | Schema |
|---|---|
| local_change_management optional |
local_change_management |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
local_change_management_post_success_schema¶
| Name | Schema |
|---|---|
| local_change_management optional |
local_change_management |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
local_change_management_put_success_schema¶
| Name | Schema |
|---|---|
| local_change_management optional |
local_change_management |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
local_change_management_response_schema¶
Type : < local_change_management_response_schema > array
local_change_management_response_schema
| Name | Schema |
|---|---|
| active_config optional |
active_config |
| active_package_filename optional |
active_package_filename |
| active_registry_timestamp optional |
active_registry_timestamp |
| active_sw_revision optional |
active_sw_revision |
| id optional |
id |
| inbox_files optional |
inbox_files |
| message optional |
message |
| model optional |
model |
| staged_config optional |
staged_config |
| staged_package_filename optional |
staged_package_filename |
| staged_registry_timestamp optional |
staged_registry_timestamp |
| staged_sw_revision optional |
staged_sw_revision |
| transfer_state optional |
transfer_state |
message¶
Local Change Management command message
Type : string
model¶
Hardware model of appliance
Type : string
staged_config¶
Staged config time
Type : string
staged_package_filename¶
Filename of currently staged package
Type : string
staged_registry_timestamp¶
TimeStamp of currently staged registries
Type : string
staged_sw_revision¶
Staged software version on appliance
Type : string
transfer_state¶
transfer state of the local change management process
Type : string