msgvpn Command

Manage Individual Message VPN

% ./splus msgvpn 
Usage: splus msgvpn [OPTIONS] COMMAND [ARGS]...

  Manage the Message VPNs

Options:
  --help  Show this message and exit.

Commands:
  create  Create a new Message VPN
  list    List all the Message VPNs on Solace PubSub+ Broker
  remove  Remove an existing Message VPN
  show    Show details of an existing Message VPN
  update  Update an existing Message VPN

Creating a VPN

Typically the first thing you will need to do is create a new Message VPN. There are a huge number of parameters that can be tweaked while creating or updating a VPN. Most of the parameters have a sensible default and at the very basic you can use the below command to create a VPN

splus msgvpn create vpn1

Execute splus msgvpn create --help to see a help page with all the possible options

VPN created with maximum 100 MB of message spool and but keeping it disabled

 --max-spool INTEGER             Maximum message spool usage, in megabytes
                                  (MB)  [default: 0]
 --enable / --no-enable          Enable or disable the Message VPN  [default:
                                  True]

splus msgvpn create vpn2 --max-spool 100 --no-enable

Updating an existing Message VPN

With so many parameters available to be set for a Message VPN, you can use the below to update.

% ./splus msgvpn update --help
Usage: splus msgvpn update [OPTIONS] NAME

  Update an existing Message VPN

Click here to see all the options available.

Update Message VPN to enable JNDI

  --jndi / --no-jndi              Enable or disable JNDI access for clients

% ./splus msgvpn update vpn1 --jndi

Update Message VPN to enable AMQP

  --amqp-plaintext / --no-amqp-plaintext
                                  Enable or disable the plain-text AMQP
                                  service in the Message VPN
  --amqp-port INTEGER             Port number for plain-text AMQP clients.
                                  Port must be unique across the message
                                  backbone
 
% ./splus msgvpn update vpn1 --amqp-plaintext --amqp-port 44444

Disable Message VPN

  --enable / --no-enable          Enable or disable the Message VPN  [default:
                                  True]
% ./splus msgvpn update vpn1 --no-enable

Show details for a Message VPN

splus % ./splus msgvpn show --help
Usage: splus msgvpn show [OPTIONS] VPNNAME

  Show details of an existing Message VPN

Options:
  --broker-url TEXT       MsgVPN URL (default from config file
  --broker-username TEXT  Admin username (default from config file)
  --broker-password TEXT  Admin password (default from config file)
  --help                  Show this message and exit.

splus % ./splus msgvpn show vpn1  

Remove a Message VPN

Note that you will need to remove/disable some pre-requisite objects before a Message VPN can be deleted. @Todo Create a --force remove

splus % ./splus msgvpn remove --help
Usage: splus msgvpn remove [OPTIONS] VPNNAME

  Remove an existing Message VPN

Options:
  --broker-url TEXT       MsgVPN URL (default from config file
  --broker-username TEXT  Admin username (default from config file)
  --broker-password TEXT  Admin password (default from config file)
  --help                  Show this message and exit.

List all Message VPNs on a broker

splus % ./splus msgvpn list --help      
Usage: splus msgvpn list [OPTIONS]

  List all the Message VPNs on Solace PubSub+ Broker