REST API for Oracle SD-WAN Edge Release 9.1.1

Get current change management status

get

http://<SDWAN_TENANT_IP>/restapi/change_management/get_status

Request

There are no request parameters for this operation.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Got status of change management

Root Schema : schema

Type: object

Show Source

data: object object data
state: string

Example: activate
state_int: integer

Example: 6
status: string

Example: success

{
    "type":"object",
    "properties":{
        "data":{
            "type":"object",
            "properties":{
                "activate_info":{
                    "type":"string",
                    "example":"Ready for Activation"
                },
                "contents":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                }
            }
        },
        "state_int":{
            "type":"integer",
            "example":6
        },
        "state":{
            "type":"string",
            "example":"activate"
        },
        "status":{
            "type":"string",
            "example":"success"
        }
    }
}

Nested Schema : data

Type: object

Show Source

activate_info: string

Example: Ready for Activation
contents: array array contents

{
    "type":"object",
    "properties":{
        "activate_info":{
            "type":"string",
            "example":"Ready for Activation"
        },
        "contents":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : contents

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

401 Response

Not Logged into the SDWAN-Edge device

Root Schema : 401NotLoggedin

Type: object

Show Source

message: string

Example: Not logged in.
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Not logged in."
        }
    }
}

403 Response

Insufficient Userlevel

Root Schema : 403InsufficientUserLevel

Type: object

Show Source

message: string

Example: User Level for user <user_name> is not sufficient for this <URL value> operation.
required_user_level: string

Example: ADMIN
status: string

Example: fail
user_level: string

Example: GUEST
user_name: string

Example: username

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "user_name":{
            "type":"string",
            "example":"username"
        },
        "user_level":{
            "type":"string",
            "example":"GUEST"
        },
        "required_user_level":{
            "type":"string",
            "example":"ADMIN"
        },
        "message":{
            "type":"string",
            "example":"User Level for user <user_name> is not sufficient for this <URL value> operation."
        }
    }
}

405 Response

Invalid request method

Root Schema : 405ExpectedGet

Type: object

Show Source

message: string

Example: Operation must use a GET
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Operation must use a GET"
        }
    }
}

Examples

Example of Accessing the API with cURL

The following example shows how to get the current change management status by submitting a GET request on the REST resource using cURL. If the request requires a timestamp, use the timestamp from the response of the /login API. For more information about cURL, see Use cURL.

curl -X GET \
    -b cookies.txt \
    "https://$IPADDR/restapi/change_management/get_status"

Example of the Response Body

The following example shows the contents of the response body in JSON format.

{
  "status": "success",
  "state": "network_staging",
  "state_int": 0,
  "data": {
      "inbox_files": [],
      "contents": [{
          "active_config": "18:38 on 7/23/21",
          "active_file_transfer_received_byte_count": null,
          "active_package_file_name": "IPSEC-TB-NCN+0/talari_VT800.zip",
          "active_software": "R9_1_1_0_0_CI_07192021",
          "active_total_size_bytes": null,
          "active_transfer_finished_reason": null,
          "active_transfer_state": null,
          "actual_interruption_time_ms": "308 ms",
          "appliance_id": "0",
          "appliance_name": "IPSEC-NCN",
          "base_registry_name": "IPSEC-TB-NCN_1627089756.ncn",
          "config_active": "IPSecTB-sasetest.cfg",
          "config_staged": "IPSecTB-sase6.cfg",
          "expected_interruption": "<1 sec",
          "expected_registry_timestamp": "1627090688",
          "expected_sw_revision": "R9_1_1_0_0_CI_07192021",
          "file_name": "Talari_APNWare_VT800_install_R9_1_1_0_0_07192021.tar.gz",
          "file_transfer_received_byte_count": null,
          "file_transfer_total_size_bytes": null,
          "hw_model": "VT800",
          "is_ha": "0",
          "is_ncn": "1",
          "last_observation_time_s": "1627308405",
          "observed_registry_timestamp": "1627090688",
          "observed_staging_registry_timestamp": "1627089756",
          "observed_staging_sw_revision": "R9_1_1_0_0_CI_07192021",
          "observed_sw_revision": "R9_1_1_0_0_CI_07192021",
          "orig_staged_sw_revision": "R9_1_1_0_0_CI_07192021",
          "site_name": "IPSEC-TB-NCN",
          "staged_appliance_id": "0",
          "staged_appliance_name": "IPSEC-NCN",
          "staged_config": "18:22 on 7/23/21",
          "staged_hw_model": "VT800",
          "staged_package_file_name": "IPSEC-TB-NCN+0/talari_VT800.zip",
          "staged_registry_timestamp": "1627089756",
          "staged_site_name": "IPSEC-TB-NCN",
          "staged_sw_revision": "R9_1_1_0_0_CI_07192021",
          "status_val": "",
          "transfer_finished_reason": null,
          "transfer_state": null
      }, {
          "active_config": "",
          "active_file_transfer_received_byte_count": null,
          "active_package_file_name": "IPSEC-TB-CL-1+0/talari_VT800.zip",
          "active_software": "R9_1_1_0_0_CI_07192021",
          "active_total_size_bytes": null,
          "active_transfer_finished_reason": null,
          "active_transfer_state": null,
          "actual_interruption_time_ms": "",
          "appliance_id": "0",
          "appliance_name": "IPSEC-CL1",
          "base_registry_name": "IPSEC-TB-CL-1_1627089756.client",
          "config_active": "IPSecTB-sasetest.cfg",
          "config_staged": "IPSecTB-sase6.cfg",
          "expected_interruption": "Loc Chg Mgt",
          "expected_registry_timestamp": "1627090688",
          "expected_sw_revision": "R9_1_1_0_0_CI_07192021",
          "file_name": "Talari_APNWare_VT800_install_R9_1_1_0_0_07192021.tar.gz",
          "file_transfer_received_byte_count": null,
          "file_transfer_total_size_bytes": null,
          "hw_model": "VT800",
          "is_ha": "0",
          "is_ncn": "0",
          "last_observation_time_s": null,
          "observed_registry_timestamp": null,
          "observed_staging_registry_timestamp": null,
          "observed_staging_sw_revision": null,
          "observed_sw_revision": null,
          "orig_staged_sw_revision": "R9_1_1_0_0_CI_07192021",
          "site_name": "IPSEC-TB-CL-1",
          "staged_appliance_id": "0",
          "staged_appliance_name": "IPSEC-CL1",
          "staged_config": "",
          "staged_hw_model": "VT800",
          "staged_package_file_name": "IPSEC-TB-CL-1+0/talari_VT800.zip",
          "staged_registry_timestamp": "1627089756",
          "staged_site_name": "IPSEC-TB-CL-1",
          "staged_sw_revision": "",
          "status_val": "",
          "transfer_finished_reason": null,
          "transfer_state": null
      }, {
          "active_config": "",
          "active_file_transfer_received_byte_count": null,
          "active_package_file_name": "IPSEC-TB-CL-2+0/talari_VT800.zip",
          "active_software": "R9_1_1_0_0_CI_07192021",
          "active_total_size_bytes": null,
          "active_transfer_finished_reason": null,
          "active_transfer_state": null,
          "actual_interruption_time_ms": "",
          "appliance_id": "0",
          "appliance_name": "IPSEC-CL2",
          "base_registry_name": "IPSEC-TB-CL-2_1627089756.client",
          "config_active": "IPSecTB-sasetest.cfg",
          "config_staged": "IPSecTB-sase6.cfg",
          "expected_interruption": "Loc Chg Mgt",
          "expected_registry_timestamp": "1627090688",
          "expected_sw_revision": "R9_1_1_0_0_CI_07192021",
          "file_name": "Talari_APNWare_VT800_install_R9_1_1_0_0_07192021.tar.gz",
          "file_transfer_received_byte_count": null,
          "file_transfer_total_size_bytes": null,
          "hw_model": "VT800",
          "is_ha": "0",
          "is_ncn": "0",
          "last_observation_time_s": null,
          "observed_registry_timestamp": null,
          "observed_staging_registry_timestamp": null,
          "observed_staging_sw_revision": null,
          "observed_sw_revision": null,
          "orig_staged_sw_revision": "R9_1_1_0_0_CI_07192021",
          "site_name": "IPSEC-TB-CL-2",
          "staged_appliance_id": "0",
          "staged_appliance_name": "IPSEC-CL2",
          "staged_config": "",
          "staged_hw_model": "VT800",
          "staged_package_file_name": "IPSEC-TB-CL-2+0/talari_VT800.zip",
          "staged_registry_timestamp": "1627089756",
          "staged_site_name": "IPSEC-TB-CL-2",
          "staged_sw_revision": "",
          "status_val": "",
          "transfer_finished_reason": null,
          "transfer_state": null
      }],
      "network_staged_configs": {
          "selected_filename": "",
          "filenames": []
      },
      "network_staged_software": []
  }
}