Back Up and Restore Solace PubSub+ Configs with SEMPv2

This project is NO longer maintained, please use the solconfig for backup and restore the Solace PS+ Broker Configuration.

Goals

• Back up the config of PS+ broker into a single JSON file
• Restore the config of PS+ broker from a JSON file
• Delete a PS+ object (such as VPN or DMR Cluster)
• Update the config of PS+ broker with the configuration file

Installation

Install the package locally with:

$ pip install .

Caution

Basically all attributes related to credentials (such as passwords) are "write-only", which means that they cannot be exported and cannot be backed up.

Please remember to manually set up all the credential attributes in the JSON file before restoring the VPN or DMR Cluster.

You can find out all "write-only" attributes on the official Solace SEMPv2 Help.

Usage

Run sempv2 to show the help message:

$ sempv2
Usage: sempv2 [OPTIONS] COMMAND [ARGS]...

  Backing Up and Restoring Solace PubSub+ Configs with SEMPv2 protocol

Options:
  --version                  Show the version and exit.
  -u, --admin-user TEXT      The username of the management user  [default:
                             admin]
  -p, --admin-password TEXT  The password of the management user, could be set
                             by env variable [SOL_ADMIN_PWD]  [default: admin]
  -h, --host TEXT            URL to access the management endpoint of the
                             broker  [default: http://localhost:8080]
  --curl-only                Output curl commands only, no effect on BACKUP
                             command  [default: False]
  -v, --verbose              Enables verbose mode.
  --help                     Show this message and exit.

Commands:
  cluster  Back up and Restore the Setting of PubSub+ DMR Cluster
  vpn      Back up and Restore the Setting of PubSub+ VPN

$ sempv2 vpn --help
Usage: sempv2 vpn [OPTIONS] COMMAND [ARGS]...

  Backing Up and Restoring the Setting of PubSub+ VPN

Options:
  --help  Show this message and exit.

Commands:
  backup   Fetches the whole configuration of a VPN
  delete   Delete the VPN
  restore  Restore the VPN with the configuration file
  update   Update the VPN with the configuration file

$ sempv2 cluster --help
Usage: sempv2 cluster [OPTIONS] COMMAND [ARGS]...

  Backing Up and Restoring the Setting of PubSub+ DMR Cluster

Options:
  --help  Show this message and exit.

Commands:
  backup   Fetches the whole configuration of a Cluster
  delete   Delete the Cluster
  restore  Restore the Cluster with the configuration file
  update   Update the Cluster with the configuration file

Jinja2 Template

sempv2 supports Jinja2 template in the configuration json file, so you could create 10 queues as below:

    "queues": [
{% for n in range(1,10) %} 
        {
            "egressEnabled": true,
            "ingressEnabled": true,
            "maxMsgSpoolUsage": 1500,
            "permission": "no-access",
            "queueName": "q{{n}}"
        },
{% endfor %}

Reference

• Solace Element Management Protocol