Try PubSub+

Automating configuration with cli scripts

rdesojurdesoju Member Posts: 66

Is there an option to automate configuration scripts written with cli commands. For example:

message-pool message-vpn default
create queue <MYQUEUE>
no shutdown

Having a file with above statements and execute a command something like:
solacectl cli
Is there any option to achieve this?



  • uherbstuherbst Member, Employee Posts: 31 Solace Employee

    Hi Raghu,
    yes, there are options to do so.

    If you are inside the cli and the script with the commands is located in cliscripts/queue.cli, then you can enter:

    source cliscripts/queue.cli [stop-on-error] [no-prompt]

    If you are in a location, where you can start cli (eg with: "docker exec -it solace bash"), you can also do:

    cli -A -s [SCRIPT_NAME]

    Beware: cli is not able to replace any variables (eg your queue name in your example) - if you want do that, you have to do that outside the cli (I would do that in the calling bash script and write the cli-script-file with the correct queue name)


  • swenhelgeswenhelge Member, Employee Posts: 60 Solace Employee

    If you need configuration on the Message VPN level (queues, ACLs ...) then a good option may be to use SEMPv2 via e.g. Ansible. Ansible then takes care of doing variable substitutions such as broker connection parameters and queue names.
    There are some examples/open source projects for Ansible:

  • rdesojurdesoju Member Posts: 66

    Thank you all for valuable information.

  • AaronAaron Member, Moderator, Employee Posts: 195 Solace Employee

    Agreed... you should really be using the RESTful SEMPv2 management API, rather than scripting CLI scripts and trying to execute them remotely. It's much safer, cleaner, and doesn't run the the risk of leaving the system in a weird/bad state if a CLI script fails halfway through a configuration item. CLI scripts were great 10 years ago, but SEMPv2 is very much the recommended way of going now.

    For your example, here's how you can create a queue with SEMP in a single command:

    curl http://localhost:8080/SEMP/v2/config/msgVpns/default/queues \
    -X POST \
    -u admin:admin \
    -H "Content-type:application/json" \
    -d '{ "queueName":"testQ",
          "egressEnabled":true }'
  • rdesojurdesoju Member Posts: 66

    Thank you for the info @Aaron !

Sign In or Register to comment.