Managing Services

Clients and management users access the services available on the Solace Messaging Platform through TCP service ports on a Solace router.

Solace routers support the following services:

  • Solace Message Format (SMF) service—This service allows clients to communicate with a router on the Message Backbone interface.
  • Solace Element Management Protocol (SEMP) service—This service allows management applications to communicate with a router on the Management interface.
  • Web transport service—This service allows Web clients to communicate with a router.
  • Solace Representational State Transfer (REST) service—This service allows REST clients to communicate with a router using standard HTTP requests.
  • Message Queuing Telemetry Transport (MQTT) service—This service allows clients to communicate with a router using the MQTT messaging protocol.

Managing Service Event Thresholds

To configure the thresholds that define when system‑level events are generated for the number of simultaneous client connections to the router, enter the following Service CONFIG commands:

solace(configure/service)# event

solace(configure/service/event)#

The CLI is now at a level at which you can configure the set and clear event thresholds at which system-level events are generated for the number of simultaneous client connections. These thresholds are set according to the service type used (SMF, Web Transport, or REST).

For information on how system-level service events can be generated and how to set the event thresholds for them, refer to Configuring System Event Thresholds.

Managing MQTT Service

Solace routers can support Message Queuing Telemetry Transport (MQTT) clients. At the system-level, you can enable or disable MQTT service on the router.

Enabling MQTT Service

  • To stop MQTT service on the Solace router, enter the following CONFIG command:

    solace(configure/service)# mqtt

    solace(configure/service/mqtt)# shutdown

    When the service is disabled, all currently connected MQTT clients are disconnected and new MQTT clients will not be able to connect.

  • To start MQTT service on the Solace router, enter the following CONFIG command:

    solace(configure/service)# mqtt

    solace(configure/service/mqtt)# no shutdown

Managing REST Service

Solace routers can support Representational State Transfer (REST) clients. At the system-level, you can enable or disable REST incoming and/or outgoing connections to the router, and you can configure REST events and event thresholds.

Enabling Incoming REST Connections

  • To enable incoming REST service connections on the router, enter the following CONFIG commands:

    solace(configure/service)# rest

    solace(configure/service/rest)# incoming

    solace(configure/service/rest/incoming)# no shutdown

  • To disable incoming REST service connections on the router, enter the following CONFIG commands:

    solace(configure/service)# rest

    solace(configure/service/rest)# incoming

    solace(configure/service/rest/incoming)# shutdown

Enabling Outgoing REST Connections

  • To enable outgoing REST service connections on the router, enter the following CONFIG commands:

    solace(configure/service)# rest

    solace(configure/service/rest)# outgoing

    solace(configure/service/rest/out)# no shutdown

  • To disable outgoing REST service connections on the router, enter the following CONFIG commands:

    solace(configure/service)# rest

    solace(configure/service/rest/out)# shutdown

    solace(configure/service/rest)# outgoing

Configuring REST Events

For information on configuring REST events and event thresholds, refer to Configuring REST Outgoing Service Event Thresholds.

Managing SEMP Service

At the system-level, you can configure a listen port for Solace Element Management Protocol (SEMP) service and enable or disable that SEMP service on all Message VPNs on the router.

Setting a SEMP Listen Port

To configure the TCP port number for SEMP clients to use when connecting to the Solace router, enter the following CONFIG command:

solace(configure/service)# semp

solace(configure/service/semp)# listen-port <port> [ssl]

Where:

<port> specifies the TCP port number to use for a SEMP connection to the router. The default value of 80 for plain text connections.

ssl specifies the port number is for TLS/SSL Transport Layer Security (TLS)/ Secure Sockets Layer (SSL) encrypted connections. The default value is 443.

Note:   

  • You must first run the shutdown SEMP Service Port CONFIG command to stop SEMP services on the router before running the listen-port SEMP Service Port CONFIG command, otherwise an error message is received.
  • The no version versions of this command (no listen-port or no listen-port ssl) resets the port to the default value for plain text or SSL connections:
    • no listen-port resets the port to the default value for plain text connections.
    • no listen-port ssl resets the port to the default value

Enabling SEMP Service

Alert ! The shutdown SEMP Service Port CONFIG command will cause a disruption in management service when run since it disconnects all SEMP and SolAdmin connections from the router. It is best to stop SEMP-based services at a time when a service disruption is of minimal impact to the management of the message routed network.

  • To start SEMP services on the Solace router, enter the following CONFIG command:

    solace(configure/service/semp)# no shutdown

  • To stop SEMP services on the Solace router, enter the following CONFIG command:

    solace(configure/service/semp)# shutdown

Managing SMF Service

At the system-level, you can configure a listen port for Solace Message Format (SMF) service and enable or disable SMF service on all Message VPNs on the router, and you can configure SMF events and event thresholds.

Setting SMF Listen Ports

To configure the TCP port number that SMF clients use when connecting to the Solace router, enter the following CONFIG command:

solace(configure/service)# smf

solace(configure/service/smf)# listen-port <port> {[compressed] [routing-control] [ssl]}

Where:

<port> specifies the TCP port number that SMF clients use when connecting to the router. The default value is 55555.

compressed specifies the port to connect to for exchanging compressed messages. The no version of this command (no listen-port compressed) resets the port to the default value of 55003.

routing-control specifies the port to connect to for exchanging inter-node routing control messages. The no version of this command (no listen-port routing-control) resets the port to the default value of 55556.

ssl specifies the port to connect to for exchanging TLS/SSL traffic. The no version of this command (no listen-port ssl) resets the port to the default value of 443.

Note:   

  • Inter-node routing control messages cannot run over the compressed port. Therefore, you cannot specify compressed along with routing-control.
  • You must first run the shutdown SMF Service Port CONFIG command to stop SMF services on the router before running thelisten-port SMF Service Port CONFIG command, otherwise an error message is received.
  • The no version of this command (no listen-port) resets the port to the default value of 55555.

Enabling SMF Service

Alert ! Executing the shutdown SMF Service Port CONFIG command will disrupt client service because it disconnects all client and router connections to the router. Therefore, it is recommended that you stop SMF service on the router when a service disruption is of minimal impact to SMF clients on the messaging network.

  • To start SMF service on the Solace router, enter the following CONFIG command:

    solace(configure/service)# smf

    solace(configure/service/smf)# no shutdown

    SMF services are enabled by default on both Solace appliances and VMRs.

  • To stop SMF services on the Solace router, enter the following CONFIG command:

    solace(configure/service)# smf

    solace(configure/service/smf)# shutdown

Configuring SMF Events

This SMF service events configuration command mode allows you to configure the set and clear thresholds at which system-level events are generated for a number or percentage of simultaneous SMF client connections.

For information on how system-level service events can be generated and how to set the event thresholds for them, refer to Configuring System Event Thresholds.

Managing Web Transport Service

At the system-level, you can configure a listen port for Web Transport service, specify the Web URL suffixes, and enable or disable Web Transport service on all Message VPNs on the router, and you can configure SMF events and event thresholds.

To configure Web transport service ports on the Solace router, enter the following CONFIG command:

solace(configure/service)# web-transport

The CLI is now at the Web Transport Service CONFIG level, and you can perform the following tasks for the Web transport service ports on the router:

Setting Web Transport Listen Ports

To configure the TCP port number that Web clients use when connecting to the Solace router, enter the following CONFIG command:

solace(configure/service)# web-transport

solace(configure/service/web-transport)# listen-port <port> [ssl]

Where:

<port> specifies the TCP port number that Web clients use when connecting to the router. the no version of this command (no listen-port) resets the port to the default value of 80.

ssl specifies the port to connect to for exchanging TLS/SSL traffic. The no version of this command (no listen-port ssl) resets the port to the default value of 443.

Note:  You must first run the shutdown Web Transport Service Port CONFIG command to stop the Web Transport services on the router before running thelisten-port Web Transport Service Port CONFIG command, otherwise an error message is received.

Enabling Web Transport Service

Alert ! The shutdown Web Transport Service Port CONFIG command will cause a disruption in customer service when run since it disconnects all Web Transport client connections from the router. It is best to stop Web-based services at a time when a service disruption is of minimal impact to the Web clients on the message routed network.

  • To start Web transport service on the router, enter the following CONFIG command:

    solace(configure/service)# web-transport

    solace(configure/service/web-transport)# no shutdown

    By default, Web Transport service is not running on a Solace router.

  • To stop Web transport service on a Solace router, enter the following CONFIG command:

    solace(configure/service)# web-transport

    solace(configure/service/web-transport)# shutdown

Note:   

  • By default, Web transport service on a Solace appliance is locked. You must have a valid product key supplied by Solace to unlock Web Transport service on a router. (Refer to Appliance Product Key Feature Locking.)
  • To enable Web clients to connect to the router, you must run the no shutdown SMF Service Port CONFIG command to start SMF services on the router. SMF services must be started on the router because Web Transport clients are also considered to be SMF clients. (Refer to Enabling SMF Service.)
  • When the Web Transport facility is enabled, the router listens for HTTP connections on the TCP port configured through the listen-portWeb Transport Service Port CONFIG command (refer to Setting Web Transport Listen Ports).

Specifying Web URL Suffixes

To specify the Web URL suffix that Web clients will receive from the router when they login, and then use when communicating with the Solace router (for example, for the purpose of load balancing client sessions), enter the following CONFIG command:

solace(configure/service)# web-transport

solace(configure/service/web-transport)# web-url-suffix <suffix>

Where:

<suffix> specifies the text for a Solace Messaging Application Programming Interface (API) to append to the Web URL when communicating with the router. This text can contain up to 127 alphanumeric characters and should be unique among all created Web URL suffixes.

Note:   

  • For more information on session load balancing and use of URLs, refer to Web Messaging Overview.
  • The no version of this command (no web-url-suffix) resets the Web URL suffix to the default value of empty string (that is, “”).
  • You must first run the shutdown Web Transport Service Port CONFIG command to stop Web Transport services on the router before running the web-url-suffixWeb Transport Service Port CONFIG command.

Enabling All Messaging Services

The Solace router Message Backbone is a Virtual Routing and Forwarding (VRF) object that contains all Solace router interfaces (physical, LAG, and IP), and transports message and topic subscription traffic between client applications and the virtual routers on the Solace router.

The message backbone acts as a global switch that enables or disables all messaging services at the global level. Disabling the message backbone disables all messaging services until the message backbone is re-enabled.

Services that are disabled using the message backbone switch will retain their individually configured states when the message backbone is re-enabled. For example, if Web transport service is in a disabled state when the message backbone is disabled, Web transport service will remain disabled when the message backbone is re-enabled.

To shutdown the message backbone to disable all messaging services at a global level, enter the following CONFIG command:

solace(configure/service)# msg-backbone shutdown

All clients will be disconnected.

Do you want to continue (y/n)? y

Note:  The no version of this command (no msg-backbone shutdown) globally enables messaging service. Services that were disabled before the message backbone was shutdown will remain disabled when this command is run.