Try PubSub+
If you haven't already, check out our new Developer Portal! You'll find useful information about Solace PubSub+ as well as handy resources to get you started.

Can the SEMP – REST API work with a READ-ONLY user? If so, how do you create one?

We want to delegate monitoring capability to another team, but we don’t want to give them the ability to change the configuration.

Thanks in advance!

Best Answer

Answers

  • surya kumarsurya kumar Member Posts: 4

    Hi, Could you please provide some examples for legacy semp .
    Am trying to create scripts from jenkins pipeline to create/delete destinations/bridges,VPN etc..
    Thanks,
    Surya | 9082961373

  • brendabrenda Member, Employee Posts: 4 Solace Employee

    Example:
    Legacy SEMP to create a queue

    platform: Solace PubSub+ Enterprise Version 9.2.0.14

    We want to do the following CLI commands over SEMP:

    enable > configure > message-spool message-vpn default > create queue Q1
    enable > configure > message-spool message-vpn default > queue Q1 > access-type exclusive
    enable > configure > message-spool message-vpn default > queue Q1 > permission all delete
    enable > configure > message-spool message-vpn default > queue Q1 > subscription topic a/>
    enable > configure > message-spool message-vpn default > queue Q1 > no shutdown
    

    So we issue the following legacy SEMP messages (illustrated with curl)

    curl -u admin:admin -d '<rpc semp-version="soltr/9_2_0VMR">
        <message-spool>
            <vpn-name>default</vpn-name>
            <create>
                <queue>
                    <name>Q1</name>
                </queue>
            </create>
        </message-spool>
    </rpc>' http://192.168.133.77:8080/SEMP
    
    curl -u admin:admin -d '<rpc semp-version="soltr/9_2_0VMR">
        <message-spool>
            <vpn-name>default</vpn-name>
            <queue>
                <name>Q1</name>
                <access-type>
                    <exclusive></exclusive>
                </access-type>
            </queue>
        </message-spool>
    </rpc>' http://192.168.133.77:8080/SEMP
    
    
    curl -u admin:admin -d '<rpc semp-version="soltr/9_2_0VMR">
        <message-spool>
            <vpn-name>default</vpn-name>
            <queue>
                <name>Q1</name>
                <permission>
                    <all></all>
                    <delete></delete>
                </permission>
            </queue>
        </message-spool>
    </rpc>' http://192.168.133.77:8080/SEMP
    
    curl -u admin:admin -d '<rpc semp-version="soltr/9_2_0VMR">
        <message-spool>
            <vpn-name>default</vpn-name>
            <queue>
                <name>Q1</name>
                <subscription>
                    <topic>a/&gt;</topic>
                </subscription>
            </queue>
        </message-spool>
    </rpc>' http://192.168.133.77:8080/SEMP
    
    curl -u admin:admin -d '<rpc semp-version="soltr/9_2_0VMR">
        <message-spool>
            <vpn-name>default</vpn-name>
            <queue>
                <name>Q1</name>
                <no>
                   <shutdown></shutdown>
                </no>
            </queue>
        </message-spool>
    </rpc>' http://192.168.133.77:8080/SEMP
    

    Of course, you will need a management username with more than read-only permission for this. I have illustrated using the admin user.

    To find the xml syntax to use, there is a "cli-to-semp" utility on the broker. If you ssh to the broker and get a shell in the application container (eg by running solacectl shell) you will be able to run cli-to-semp. Here is an example:

    [[email protected] ~]$ cli-to-semp 'enable configure message-spool message-vpn default queue Q1 access-type exclusive'
    SEMP Request:
    <rpc semp-version="soltr/9_2_0VMR">
        <message-spool>
            <vpn-name>default</vpn-name>
            <queue>
                <name>Q1</name>
                <access-type>
                    <exclusive></exclusive>
                </access-type>
            </queue>
        </message-spool>
    </rpc>
    
  • TD_asilvaTD_asilva Member Posts: 10

    Which user type is needed for using authentication with REST messaging? I have tried creating a user from the cli as detailed under the Configuring REST Consumer Authentication Schemes section here: https://docs.solace.com/Configuring-and-Managing/Managing-RDPs.htm. That did not work. I've also tried using the user that I log in to the admin panel of my pub/sub instance with. I am testing using the curl call provided on that page as well. If I turn off REST authentication, the call works, but if it's on, none of the credentials from the users mentioned above work - they just produce 401s.

  • TD_asilvaTD_asilva Member Posts: 10

    OK, I figured this out after re-reading the docs and your answer above. My confusion came from a couple places, which I will list here in case anyone else has the same questions/thoughts. Firstly, I had been adding users via the admin control panel under the "Users" page in the side bar. I thought that these were messaging users, but they were not. I had been using their credentials to log in and interact with my event broker, but in actuality, it seems like I had actually been logging in with the "default" client-username (which comes out of the box with no password). Also, the event broker comes out of the box with authentication enabled, but authentication method as none - so when I turned that to internal database and tried to use the users I had created under the "Users" tab, I was getting the 401s because those credentials were not client-username/messaging credentials. So after further research, I ended up giving my "default" client-username a password and turning on internal database authentication and now I am able to log in (and more importantly, lock down my event broker). Hope this helps someone else.

    Solace employees: if I could make a suggestion, I would suggest that maybe somewhere in the initial setup/config docs, explain that the default configuration is open to the world. Also, while your docs do explain how to lock the event broker down in general, it might be useful to have a tutorial that explains how to go from initial (open to the world) configuration to a more secure configuration.

  • marcmarc Member, Administrator, Moderator, Employee Posts: 60 admin

    @TD_asilva - thank you for the great feedback! We'll definitely take it under consideration :smile:

    Solace employees: if I could make a suggestion, I would suggest that maybe somewhere in the initial setup/config docs, explain that the default configuration is open to the world. Also, while your docs do explain how to lock the event broker down in general, it might be useful to have a tutorial that explains how to go from initial (open to the world) configuration to a more secure configuration.

Sign In or Register to comment.