The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The backup and restore script is a Python script that is used to take the backup of the requested configuration item, available locally on Cluster Manager VM or on other VMs. When a restore is required, the configuration supplied is copied to the requested location within Cluster Manager VM or the specific VM.
Name : config_br.py
Path : /var/qps/install/current/scripts/modules
VM : Cluster Manager
When you run this script, you provide options and specify the location for the backup file. For a description of the script options, see Script Options.
config_br.py -a export --etc --etc-oam --svn --stats /mnt/backup/backup_27092016.tar.gz
Back up /etc/broadhop configuration data from OAM (pcrfclient) VM, Policy Builder configuration, and logstash
config_br.py -a import --etc --etc-oam --svn --stats /mnt/backup/backup_27092016.tar.gz
Restore data from /etc/broadhop configuration from OAM (pcrfclient) VM, Policy Builder configuration, and logstash
The following table describes the options you can use with the backup and restore script:
Option |
Description |
||
---|---|---|---|
Positional Arguments |
|||
tar |
Location of the tarball of the configuration data. The backup and restore script (config_br.py) creates a tarball in tar.gz format and the same tar.gz type is used to restore configuration data. |
||
Optional Arguments |
|||
-h or --help |
Displays help message. |
||
--action ACTION or -a ACTION where ACTION is either export or import |
Specifies whether you want to export (backup) or import (restore) VM configuration data. |
||
--quiet or -q |
Specifies whether you want to be notified if the tarball with same name exists. The same tarball name can be used for multiple backup commands. If tarball with the configuration data already exists, the tar is overwritten with a warning. You can choose to avoid the display of the warning with the --quiet or -q option. The script will automatically overwrite the existing tar. Not applicable for restore operations. |
||
--all |
Specifies backup or restore of all VMs. This option is equivalent to --auth-htpasswd --etc --etc-oam --grafanadb --haproxy --mongo-all --network --svn --users --stats |
||
--auth-htpasswd |
Specifies the backup or restore of .htpasswd file (/var/broadhop/.htpasswd). |
||
--etc |
Specifies the backup or restore of /etc/broadhop cluster configuration. |
||
--etc-oam |
Specifies the backup or restore of /etc/broadhop configuration from OAM (pcrfclient) VM. |
||
--grafanadb |
Specifies the backup or restore of the Grafana databases (data such as dashboard and user information). |
||
--haproxy |
Specifies the backup or restore of HAproxy configurations on Policy Director (Load Balancer) VM. |
||
--mongo |
Specifies the backup and restore of the default database and the data about Admin, Balance, Cluster, Customer Reference Data, Diameter Peers and Diameter Queuing, Sharding, SPR. |
||
--mongo-all |
Specifies the backup or restore of default database and the Audit, Policy Reporting, Portal, Voucher databases.
|
||
--network |
Specifies the backup or restore of network configuration /etc/hosts, /etc/sysconfig, /network-scripts/route-* |
||
--svn |
Specifies the backup or restore of Policy Builder configuration data. |
||
--users |
Specifies the backup or restore of user and password information on the deployed VMs. Required for backup of all VMs. |
||
--stats |
Specifies the backup or restore of Logstash (/var/broadhop/stats, /var/lib/carbon) |