Configuration Tools
Description |
Manages running configuration files and snapshots in NEO |
|||||||||||
Request URL |
Configuration Files |
/neo/app/running_config |
||||||||||
Running Configuration Snapshots |
/neo/resources/systems/<system_id>/running_config |
|||||||||||
Main Operations |
Configuration Files |
|
||||||||||
Running Configuration Snapshots |
|
Configuration files are not associated with a specific system and can be manipulated by using simple actions: upload, get and delete.
Upload a Configuration File
Description |
Uploads a new configuration file to NEO's repository |
|
Request URL |
POST /neo/app/running_config |
|
Request Data |
{ |
|
Response |
HTTP Response Location Header will contain URI with file name created from uploading the configuration file |
Get a Configuration File
Description |
Retrieves the content of a configuration file from NEO's repository |
|
Request URL |
GET /neo/app/running_config/<file_name> |
|
Request Data |
N/A |
|
Response |
{ |
Get All Configuration Files
Description |
Retrieves a list of all configuration files from NEO's repository |
|
Request URL |
GET /neo/app/running_config |
|
Request Data |
N/A |
Response:
[{
"file_name"
: "<config file 1>"
,
"system_id"
: "<system_id>"
,
"type"
: "<type>"
,
"file_id"
:"<file_id>"
},
{
"file_name"
: "<config file 2>"
,
"system_id"
: "<system_id>"
,
"type"
: "<type>"
,
"file_id"
:"<file_id>"
}]
Delete a Configuration File
Description |
Deletes a configuration file from NEO's repository |
|
Request URL |
DELETE /neo/app/running_config/<file_name> |
|
Request Data |
N/A |
|
Response |
N/A |
|
Status Codes |
Note: Status code 204 NO CONTENT means that configuration file deleted successfully |
Edit a Configuration File
Description |
Updates the content of a configuration file in NEO's repository |
|
Request URL |
DELETE /neo/app/running_config/<file_id> |
|
Request Data |
{ |
|
Response |
N/A |
Running configuration snapshots are taken for each system separately. NEO saves up to 7 snapshots for each system and takes a snapshot automatically every night (both can be configured). NEO's snapshots mechanism enables to perform 3 actions: get, refresh and apply.
Get a Snapshot of a Specific System
Description |
Retrieves the content of a snapshot of a specific system from NEO's repository |
|
Request URL |
GET /neo/resources/systems/<system_id>/running_config/<snapshot_name> |
|
Request Data |
N/A |
|
Response |
{ |
The "last_checked" attribute marks the last time this snapshot was known to be the current configuration on the system. It will be updated when using the "refresh" operation, or when the nightly refresh takes place.
Get All Snapshots of a Specific System
Description |
Retrieves a list of all snapshots of a specific system from NEO's repository |
|
Request URL |
GET /neo/resources/systems/<system_id>/running_config |
|
Request Data |
N/A |
Response:
[
{
"name"
: "<snapshot 1>"
,
"last_checked"
: "<date 1>"
},
{
"name"
: "<snapshot 2>"
,
"last_checked"
: "<date 2>"
},
{
"name"
: "<snapshot 3>"
,
"last_checked"
: "<date 3>"
}
]
The "last_checked" attribute marks the last time this snapshot was known to be the current configuration on the system. It will be updated when using the "refresh" operation, or when the nightly refresh takes place.
Refresh a Specific System
Description |
Retrieves the content of the current running configuration from a specific system, and take a snapshot of it if the content has changed from the last snapshot. Otherwise, if the latest snapshot is updated, it updates the "last_checked" date of the snapshot. |
|
Request URL |
POST /neo/resources/systems/<system_id>/running_config/refresh |
|
Request Data |
N/A |
|
Response |
HTTP Response Location Header will contain URI with Job ID created for retrieving the configuration from the specified system |
Apply a Snapshot on a Specific System
Description |
Applies a snapshot of a specific system on the same system |
|
Request URL |
POST /neo/resources/systems/<system_id>/running_config/apply |
|
Request Data |
{ |
|
Response |
HTTP Response Location Header will contain URI with Job ID created for applying the snapshot on the specified system |
Apply a Configuration File on a Specific System
Description |
Applies a configuration file from NEO's repository on a system |
|
Request URL |
POST /neo/resources/systems/<system_id>/running_config/apply |
|
Request Data |
{ |
|
Response |
HTTP Response Location Header will contain URI with Job ID created for applying the configuration file on the specified system |