This page describes the commands used to configure and enable the SAS facility. SAS configuration is namespace-aware: all these commands apply to the current namespace for the client (selected with setactivenamespace).

Resource Identifiers

Events sent to SAS are associated with a resource identifier. All components within a Rhino namespace use the same resource identifier. The resource identifier can be set with the setsasresourceid command.

The resource identifier will be in the generated resource bundle that will be imported into SAS.

SAS Servers

Rhino supports connecting to some or all SAS server instances in a federation. This is maintained as an internal list of servers and ports. Servers may be added with addsasserver and removed with removesasserver. By default SAS listens on port 6761. If the port is omitted from the add command, then the default port will be used.

Changing SAS configuration

Note that all commands that change SAS configuration on this page require the SLEE be in the Stopped state on all cluster nodes and/or SAS tracing to be disabled.

If you want to disable SAS tracing without stopping the SLEE, you can do so using setsasenabled false -force true. Then make changes and re-enable SAS using setsasenabled true.

The getsasconfiguration command can be run at any time.

Console command: addsasserver

Command

 
addsasserver <servers>
  Description
    Add one or more servers to the set of configured SAS servers
  Required Arguments
    servers  Comma delimited list of host:port pairs for SAS servers

Example

 
[Rhino@localhost (#1)] addsasserver localhost:12000
Added server(s) to SAS configuration properties:
servers=localhost:12000
[Rhino@localhost (#2)] addsasserver 127.0.0.1:12001,127.0.0.2
Added server(s) to SAS configuration properties:
servers=127.0.0.1:12001,127.0.0.2

Console command: removesasserver

Command

 
removesasserver <servers>
  Description
    Remove one or more servers from the set of configured SAS servers
  Required Arguments
    servers  Comma delimited list of host:port pairs for SAS servers

Example

 
[Rhino@localhost (#1)] removesasserver localhost:12000
Removed server(s) from SAS configuration properties:
servers=localhost:12000
[Rhino@localhost (#2)] removesasserver 127.0.0.1:12001,127.0.0.2
Removed server(s) from SAS configuration properties:
servers=127.0.0.1:12001,127.0.0.2

Console command setsassystemname

Command

 
setsassystemname <systemName> [-appendID <appendID>]
  Description
    Configure the SAS system name.
  Required Arguments
    systemName  The unique system name to use. Cluster wide
  Options
    -appendID  If true, append node ID to system name

Example

 
$ ./rhino-console setsassystemname mmtel
Set SAS system name:
systemName=mmtel
$ ./rhino-console setsassystemname mmtel -appendID true
Set SAS system name:
systemName=mmtel
appendID=true

Console command setsassystemtype

Command

 
setsassystemtype <systemType>
  Description
    Configure the SAS system type.
  Required Arguments
    systemType  The system type to use. Cluster wide

For systems running Sentinel products on the Rhino platform, Metaswitch recommends the following system type strings:

  • VoLTE TAS for Sentinel VoLTE

  • IPSMGW for Sentinel IPSMGW

  • BSF for Sentinel GAA

  • ShCM for Sh Cache Microservice

Example

 
$ ./rhino-console setsassystemtype BSF
Set SAS system type:
systemType=BSF

Console command setsassystemversion

Command

 
setsassystemversion <systemVersion>
  Description
    Configure the SAS system version.
  Required Arguments
    systemVersion  The system version to use. Cluster wide

For systems running Sentinel products on the Rhino platform, Metaswitch recommends using the three-digit version number of the installed product as the system version string, for example 3.0.0.

Example

 
$ ./rhino-console setsassystemversion 3.0.0
Set SAS system version:
systemVersion=3.0.0

Console command setsasresourceid

Command

 
setsasresourceid <resourceIdentifier>
  Description
    Configure the SAS resource identifier.
  Required Arguments
    resourceIdentifier  The resource identifier to use.

Example

 
$ ./rhino-console setsasresourceid com.metaswitch.rhino
Set SAS resource identifier:
resourceIdentifier=com.metaswitch.rhino

Console command setsasqueuesize

Command

 
setsasqueuesize <queueSize>
  Description
    Configure the per server SAS message queue limit.
  Required Arguments
    queueSize  The maximum number of messages to queue for sending to the SAS
    server.

Example

 
$ ./rhino-console setsasqueuesize 100000
Set SAS queue size:
queueSize=100000

Console command: getsasconfiguration

Command

 
getsasconfiguration
  Description
    Display SAS tracing configuration

Example

 
$ ./rhino-console getsasconfiguration
SAS tracing is currently disabled.

Configuration properties for SAS:
servers=[sas-server]
systemName=mmtel
appendNodeIdToSystemName=true
resourceIdentifier=com.metaswitch.rhino
queueSize=10000 per server

MBean methods

Previous page Next page
Rhino Version 3.0.0