Skip to content

change_management

Overview

This resource provides Change management status and operations related to Change Management. Use file_upload_to_inbox API to upload files for Change Managment Operation. Use get_package_file to download packages created by Change Management, to be used in Local Change Management Operation.

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config/
Schemes : HTTP

Tags

  • change_management : Operations related to change_management

Paths

POST operation for change_management

POST /change_management

Description

Cancel Change Management stage operation

Parameters

Type Name Description Schema
Query action
required
Select if action is other that ADD enum (cancel_stage, verify, activate_with_rollback, stage, activate, clear_inbox, migrate_config, clear_network_staging, ignore_incomplete)

Responses

HTTP Code Description Schema
200 Resource successfully added 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

  • change_management

Get operation for change_management

GET /change_management

Description

Use this operation to get Change Management status

Responses

HTTP Code Description Schema
200 API Successfully executed 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

  • change_management

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

activate_info

Activation information

Type : string

change_management_delete_success_schema

Name Schema
change_management
optional
change_management

change_management

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

change_management_post_success_schema

Name Schema
change_management
optional
change_management

change_management

Name Description Schema
message
optional
Example : "resource added succesfully" string

change_management_put_success_schema

Name Schema
change_management
optional
change_management

change_management

Name Description Schema
message
optional
Example : "resource modified succesfully" string

change_management_response_schema

Type : < change_management_response_schema > array

change_management_response_schema

Name Schema
activate_info
optional
activate_info
current_config
optional
current_config
failure_reason
optional
failure_reason
inbox_files
optional
inbox_files
message
optional
message
network_staged_selected_filename
optional
network_staged_selected_filename
sites_cm_status
optional
sites_cm_status
state
optional
state
status
optional
status

current_config

Name of the active config.

Type : string

failure_reason

This key will be present in the response of verify action. This key indicates failure reason of verify action, if applicable.

Type : string

inbox_files

Files in Change Management Inbox Directory

Type : string

message

Detailed message about API execution.

Type : string

network_staged_selected_filename

Network staged config Filename

Type : string

sites_cm_status

Change management status for Site

Type : < sites_cm_status > array

sites_cm_status

Name Description Schema
active_config
optional
read-only
Active config time . string
active_software
optional
read-only
Currently active software of appliance . string
actual_interruption_ms
optional
read-only
Actual Interruption time for activation string
appliance_name
optional
read-only
Name of Appliance string
expected_interruption
optional
read-only
Expected traffic interruption for activation string
expected_sw_revision
optional
read-only
Expected software version on appliance string
model
optional
read-only
Hardware model of appliance string
observed_sw_revision
optional
read-only
Observed software version on appliance string
site_name
optional
read-only
Name of site string
staged_config
optional
read-only
Staged config time string
staged_sw_revision
optional
read-only
Staged software version string
status
optional
read-only
Status indicating connected state string
transfer_state
optional
read-only
transfer state of the change management process string

state

Change Management State

Type : string

status

This key indicates status of verify action.

Type : string