topic Re: NSO Rollback per Rest API in NSO Developer Hub Discussions

NSO Rollback per Rest API

DTtb — Thu, 18 Jul 2019 13:19:01 GMT

How to rollback the configuration file with the name <name>0</name> from rollback configuration datastore per REST-API?

Do I need a HTTP-POST-requests to start the rollback?

<rollbacks xmlns="http://tail-f.com/ns/rest" xmlns:y="http://tail-f.com/ns/rest">
  <file>
    <name>0</name>
    <creator>admin</creator>
    <date>2019-07-18 13:15:18</date>
    <via>rest</via>
    <label></label>
    <comment></comment>
  </file>
  <file>
    <name>1</name>
    <creator>admin</creator>
    <date>2019-07-18 13:13:16</date>
    <via>rest</via>
    <label></label>
    <comment></comment>
  </file>
  <file>
    <name>2</name>
    <creator>admin</creator>
    <date>2019-07-18 13:01:09</date>
    <via>rest</via>
    <label></label>
    <comment></comment>
  </file>
</rollbacks>

Re: NSO Rollback per Rest API

gmuloche — Fri, 19 Jul 2019 17:03:13 GMT

Hello,

via the REST(CONF) API you have an action apply-rollback-file defined in

$NCS_DIR/src/ncs/yang/tailf-rollback.yang

The documentation of NSO 5.1 has a chapter including an example on how to use this action (the two code snapshots below are from this documentation):

Step 1: (not mandatory if you know for sure which rollback file you want to apply). Get the list of available rollback files using

GET /restconf/data/tailf-rollback:rollback-files

Step 2: you can use the action to apply a rollback file:

POST /restconf/data/tailf-rollback:rollback-files/apply-rollback-file HTTP/1.1
Content-Type: application/yang-data+xml
<input xmlns="http://tail-f.com/ns/rollback">
  <id>0</id>
</input>

Note: there is a second action in the YANG module that allows you to get the content of the rollback file if you need it.

PS: the reason I wrote REST(CONF) is that the REST API will be deprecated in NSO 5.3 as per the release notes of NSO 5.1 and so it is better to start using RESTCONF rather than REST to be future proof.

Re: NSO Rollback per Rest API

DTtb — Sat, 20 Jul 2019 08:57:32 GMT

Thanks for the answer.

Could you provide an example for REST-API (not RESTCONF) with JSON payload?
Only for testing purpose for NSO version 4.7..

Re: NSO Rollback per Rest API

gmuloche — Mon, 29 Jul 2019 13:19:48 GMT

Hello,

using admin:admin as username/password - this will apply the latest rollback file

curl -X POST \
  http://<IP>:<PORT>/api/running/_rollback \
  -H 'Accept: application/vnd.yang.data+json' \
  -H 'Authorization: Basic YWRtaW46YWRtaW4=' \
  -H 'Content-Type: application/vnd.yang.data+json' \
  -d '{ 
  "file": 0
}'

This is documented `$NCS_DIR/doc/html/nso_northbound/ch03s04s06.html` for NSO 4.7.2 if you want more information.