Managing the Message VPN

Developers can manage the Message VPN associated with a service instance by connecting to the VMR with the SolAdmin administration tool.

Retrieve Information

To retrieve the information required to connect to the VMR, perform the following steps:

  1. Log in to your deployment and choose the org and space where your Solace Messaging service instance and bound application exists.
    $ cf login
    API endpoint: https://api.YOUR-SYSTEM-DOMAIN
    Email> user@example.com
    Password>
    
  2. View the VCAP_SERVICES environment variable by retrieving the environment variables associated with your bound application:
    $ cf env YOUR-APP
    
  3. Locate your Solace Messaging service instance in VCAP_SERVICES and record the following fields:
    • managementUsername: The service instance’s management username
    • managementPassword: The service instance’s management password
    • managementHttpUris: The VMR’s IP address and management port, in the format http://IP-ADDRESS:MANAGEMENT-PORT/SEMP/V2

      For more information about the VCAP_SERVICES fields, see the Understanding Credentials topic.

Connect to the Solace VMR

The procedure for connecting to the Solace VMR varies depending on whether you have direct connectivity to the network where you installed Solace Messaging. This was the network that was picked in the Tile Installation and Configuration section.

Connect with Direct Connectivity

If you have direct connectivity to the network where you installed Solace Messaging, perform the following steps to connect to the Solace VMR:

  1. Download and install the SolAdmin administration tool from the Solace Developers Portal Download Page.
  2. Start SolAdmin.
  3. Click Manage to open the Manage Appliance window. Soladmin manage
  4. Under Management IP Address, enter the IP address of the VMR recorded above.
  5. Under User Name and Password, enter the management username and password recorded above.
  6. Click Ok. The VMR should now appear in the Managed Appliances list. Soladmin router list
  7. To learn how to use SolAdmin to manage your Message VPN, see the included context specific tool help within the SolAdmin tool itself.

Connect without Direct Connectivity

If you do not have direct connectivity to the network where you installed Solace Messaging, perform the following steps to connect to the Solace VMR:

  1. Download and install the SolAdmin administration tool from the Solace Developers Portal Download Page.
  2. Open an ssh session to a host with connectivity to PCF’s internal network and create a tunnel to the VMR SEMP port:
    $ ssh -L LOCAL-PORT:IP-ADDRESS:MANAGEMENT-PORT USER@HOST
    
    Replace the placeholders with the following values:
    • LOCAL-PORT: A free port on your local machine
    • IP-ADDRESS and MANAGEMENT-PORT: The VMR’s IP address and management port, recorded above in the Retrieve Information section
    • USER: The username you use to log in to the host
    • HOST: The IP address or FQDN of the host
  3. Once you have established the SSH session, start SolAdmin.
  4. Click Manage to open the Manage Appliance window. Soladmin manage tunnel
  5. Under Management IP Address, enter 127.0.0.1.
  6. Under Management Port, enter the local port chosen above when the SSH tunnel was created.
  7. Under User Name and Password, enter the management username and password recorded above.
  8. Click Ok. The VMR should now appear in the Managed Appliances list. Soladmin router list
  9. To learn how to use SolAdmin to manage your Message VPN, see the included context specific tool help within the SolAdmin tool itself.

Note: The requirement to forward ports is a current limitation of the Solace Messaging tile in Open Beta. This will be improved in a future release to simplify this procedure.

Was this helpful?
What can we do to improve?
Create a pull request or raise an issue on the source for this page in GitHub