change_management

Configuration for 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. resource.

Read/write properties

Read only properties

current_config <String>

Name of the active config..

inbox_files <String>

Files in Change Management Inbox Directory.

status <String>

This key indicates status of verify action..

sites_cm_status <sites_cm_info[]>

Change management status for Site.

state <String>

Change Management State.

message <String>

Detailed message about API execution..

failure_reason <String>

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

activate_info <String>

Activation information.

network_staged_selected_filename <String>

Network staged config Filename.

Operations

stage activate_with_rollback migrate_config activate clear_network_staging verify ignore_incomplete get (all) cancel_stage clear_inbox

[stage]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/change_management?action=stage

Description: Start Change Management stage operation

HTTP Method: POST

Request Payload: Request Payload Not Required

Response Payload: JSON

{ "change_management":{}}

[activate_with_rollback]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/change_management?action=activate_with_rollback

Description: Does Change Management activate operation with Rollback enabled. This activation mode ensures, software will revert if an error occurs.

HTTP Method: POST

Request Payload: Request Payload Not Required

Response Payload: JSON

{ "change_management":{}}

[migrate_config]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/change_management?action=migrate_config

Description: Does migrate current config to inbox

HTTP Method: POST

Request Payload: Request Payload Not Required

Response Payload: JSON

{ "change_management":{}}

[activate]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/change_management?action=activate

Description: Does Change Management activate operation.

HTTP Method: POST

Request Payload: Request Payload Not Required

Response Payload: JSON

{ "change_management":{}}

[clear_network_staging]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/change_management?action=clear_network_staging

Description: This API clears the network staging contents of the Change Management server.

HTTP Method: POST

Request Payload: Request Payload Not Required

Response Payload: JSON

{ "change_management":{}}

[verify]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/change_management?action=verify

Description: Does Change Management verify operation

HTTP Method: POST

Request Payload: Request Payload Not Required

Response Payload: JSON

{ "change_management":{}}

[ignore_incomplete]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/change_management?action=ignore_incomplete

Description: This action can be performed while staging operation is in progress. Issuing this action will ignore incomplete staging action and allows user to proceed with Change Management activation.

HTTP Method: POST

Request Payload: Request Payload Not Required

Response Payload: JSON

{ "change_management":{}}

[get (all)]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/change_management

Description: Use this operation to get Change Management status

HTTP Method: GET

Response Payload: JSON

{"change_management":[{ "current_config":<String_value>

, "inbox_files":<String_value> , "status":<String_value> , "sites_cm_status":[{ "status":<String_value> , "staged_sw_revision":<String_value> , "observed_sw_revision":<String_value> , "model":<String_value> , "expected_interruption":<String_value> , "appliance_name":<String_value> , "staged_config":<String_value> , "active_software":<String_value> , "expected_sw_revision":<String_value> , "active_config":<String_value> , "transfer_state":<String_value> , "site_name":<String_value> , "actual_interruption_ms":<String_value> }], "state":<String_value> , "message":<String_value> , "failure_reason":<String_value> , "activate_info":<String_value> , "network_staged_selected_filename":<String_value> }]}

[cancel_stage]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/change_management?action=cancel_stage

Description: Cancel Change Management stage operation

HTTP Method: POST

Request Payload: Request Payload Not Required

Response Payload: JSON

{ "change_management":{}}

[clear_inbox]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/change_management?action=clear_inbox

Description: Clears Change Management inbox folder

HTTP Method: POST

Request Payload: Request Payload Not Required

Response Payload: JSON

{ "change_management":{}}