How do I manage auxiliary database backups?

Purpose

Perform this procedure to modify, replace, or delete the auxiliary database backup scheme.

Steps
 

Log in to a station that has access to the NSP cluster.


Open a console window.


To modify the current backup scheme, issue the following RESTCONF API call:

Note: In order to issue a RESTCONF API call, you require a token; see the My First NSP API Client tutorial on the Network Developer Portal for information.

PATCH https://address/restconf/data/nsp-auxdb-backup:config

where

address is the NSP advertised address

The request body is the following:

{

    "nsp-auxdb-backup:config": {

        "parameter": value,

    }

}

where

parameter is the name of a parameter listed in Step 4

value is the parameter value to assign

The backup scheme is modified.


To replace the current backup scheme, issue the following RESTCONF API call:

Note: In order to issue a RESTCONF API call, you require a token; see the My First NSP API Client tutorial on the Network Developer Portal for information.

PUT https://address/restconf/data/nsp-auxdb-backup:config

where

address is the NSP advertised address

The request body is the following:

{

    "nsp-auxdb-backup:config": {

        "backup-location": "path",

        "backups-to-keep": max_backups,

        "enabled": true,

        "interval": 2,

        "sync-time": first_run

    }

}

where

path is the directory in which to store the backup files, typically /opt/nsp/nfmp/auxdb/backup

max_backups is the number of previous backups to retain; the range is 0 to 7, and the default is 2

interval is how often a backup is performed, in hours

first_run is the Unix epoch time at which the first backup is to occur; marks the start of the schedule defined by interval

The new backup scheme is enabled.


CAUTION 

CAUTION

Data at Risk

Deleting the auxiliary database backup scheme means that no auxiliary database backup schedule is in place, and may place the auxiliary database data at risk in the event of a failure.

Ensure that you delete the auxiliary database backup scheme only for maintenance purposes, or as directed by technical support, and that you create a new backup scheme when normal database operation resumes.

To delete the current backup scheme, issue the following RESTCONF API call:

Note: In order to issue a RESTCONF API call, you require a token; see the My First NSP API Client tutorial on the Network Developer Portal for information.

DELETE https://address/restconf/data/nsp-auxdb-backup:config

The auxiliary database backup scheme is deleted.


Close the console window.

End of steps