5 Configuring Diameter Signaling Server Units

This chapter describes how to configure the Service Broker Diameter SSU using the Service Broker Administration Console and Java MBeans.

About the Diameter SSU

Using the Diameter SSU, Service Broker communicates with network entities and charging applications through the Diameter protocol.

The Diameter SSU is automatically deployed and running on all Signaling Servers in the Signaling Domain.

When configuring the Diameter SSU, you set up the following:

Incoming routes, which define how the Diameter SSU routes incoming messages to internal Service Broker components, such as Interworking Modules. See "Configuring Incoming Routes" for more information.
Outbound destinations, which define Diameter peers to which the Diameter SSU routes outbound messages. See "Configuring Outbound Destinations" for more information.
Diameter nodes, which define how Diameter peers access the Diameter SSU. See "Configuring Diameter Nodes" for more information.

Configuring Incoming Routes

When the Diameter SSU receives a message from the network, you need to define the internal Service Broker component to which the Diameter SSU routes the message. The routing is conditional. This means that you can set up conditions that must be met in order the message to be sent to a specific component.

To set up these conditions, you configure the following:

Incoming Routes, defining the internal Service Broker components, such as Interworking Modules, to which the Diameter SSU routes incoming messages. See "Setting Up Incoming Routing Rules" for more information.
Route Criteria, which define conditions for incoming routing rules. If these conditions are met, the Diameter SSU routes the incoming message to the component specified in the incoming routing rule. See "Setting Up Incoming Routing Criteria" for more information.

Setting Up Incoming Routing Rules

The Diameter SSU routes incoming Diameter requests to Service Broker components based on the value of AVPs in the request. An incoming routing rule defines a destination of Diameter requests. Criteria for routing requests to the destination, are specified in the Incoming Routing Criteria table.

The priority of the rules defines the order in which the Diameter SSU checks incoming routing rules. The Diameter SSU applies the first found rule whose criteria are met.

For example, you can create multiple rules for the same IM. The Diameter SSU begins with the rule that has the highest priority. If an incoming session fits the criteria defined in this rule, the Diameter SSU applies the rule and does not check the rest of the rules. Otherwise, the Diameter SSU checks whether an incoming session fits the criteria of a rule with a lower priority. The Diameter SSU performs this check until the Diameter SSU finds a rule whose criteria are met by an incoming session.

You can set up incoming routing rules with the Administration Console or Java MBeans.

Setting Up Incoming Routing Rules with the Administration Console

To set up incoming routing rules:

In the navigation tree in the domain navigation pane, expand OCSB.
Expand the Signaling Tier node.
Select the SSU Diameter node.
In the SSU Diameter configuration pane, click the SSU Diameter tab.
Click the Routing subtab.
Click the Incoming Routing Rules subtab.

The Incoming Routing Rules configuration pane appears. This pane displays a table. The table contains rules that define the component to which the Diameter SSU routes an incoming message and the priority of the rule. Each row in the table represents a single rule.
Click New at the bottom of the Incoming Routing Rules pane.

The New dialog box appears.

Fill in the fields described in Table 5-1.

Table 5-1 Diameter SSU Incoming Routing Rule Fields

Name Type Description

Name	Type	Description
Name	STRING	Specifies a unique rule name.
Priority	INT	Specifies an order in which the Diameter SSU checks routing rules to evaluate if an incoming session fits rule's criteria. The Diameter SSU applies the first found rule which criteria are met by an incoming session. The lower the number, the higher the priority. For example, if you created two rules and set Priority of one rule to" 1" and set Priority of another rule to "2", the Diameter SSU checks the rule with Priority set to "1" first. You can define an incoming routing rule that the Diameter SSU applies if no other rule can be applied, by setting the Priority parameter of this rule to the largest number (that is lowest priority). There is no need to specify incoming routing criteria for such a rule.
Module Instance	STRING	Specifies the URI of the destination Service Broker component to which the Diameter SSU routes incoming sessions. The URI has the following format: SSU:IM-instance-name.IM-type@domain-id IM-instance-name: The IM instance name that you specified when you added this IM in the IM Management Configuration screen. IM-type: The type of the IM instance domain-id: Name of the Processing Domain or Processing Domain Group where the relevant IM or application is deployed. This parameter is required only when your Service Broker deployment includes two or more Processing Domains. Use the name given to the domain when it was created. This name is specified by the axia.domain.id property. To set a Processing Domain Group, you must specify the group name. See "Managing Processing Domain Groups" in the Oracle Communications Service Broker Processing Domain Configuration Guide for more information. domain-id is required only if your deployment includes two or more Processing Domains. For example: `ssu:imocf_instance.IMOCF@processing-domain-1`

Name

STRING

Specifies a unique rule name.

Priority

INT

Specifies an order in which the Diameter SSU checks routing rules to evaluate if an incoming session fits rule's criteria. The Diameter SSU applies the first found rule which criteria are met by an incoming session.

The lower the number, the higher the priority. For example, if you created two rules and set Priority of one rule to" 1" and set Priority of another rule to "2", the Diameter SSU checks the rule with Priority set to "1" first.

You can define an incoming routing rule that the Diameter SSU applies if no other rule can be applied, by setting the Priority parameter of this rule to the largest number (that is lowest priority). There is no need to specify incoming routing criteria for such a rule.

Module Instance

STRING

Specifies the URI of the destination Service Broker component to which the Diameter SSU routes incoming sessions.

The URI has the following format:

SSU:IM-instance-name.IM-type@domain-id

IM-instance-name: The IM instance name that you specified when you added this IM in the IM Management Configuration screen.
IM-type: The type of the IM instance
domain-id: Name of the Processing Domain or Processing Domain Group where the relevant IM or application is deployed. This parameter is required only when your Service Broker deployment includes two or more Processing Domains.

Use the name given to the domain when it was created. This name is specified by the axia.domain.id property.

To set a Processing Domain Group, you must specify the group name. See "Managing Processing Domain Groups" in the Oracle Communications Service Broker Processing Domain Configuration Guide for more information.

domain-id is required only if your deployment includes two or more Processing Domains.

For example:

ssu:imocf_instance.IMOCF@processing-domain-1

Click OK.

Setting Up Incoming Routing Rules with Java MBeans

Figure 5-1 shows the hierarchy of the configuration MBeans that you use to configure incoming routing rules. See "Diameter SSU Configuration MBeans Reference" for object names of these MBeans.

Figure 5-1 Diameter Incoming Routing Rules Configuration MBeans

Each incoming routing rule is represented by DiameterIncomingRoutingRuleMBean. You need to create a separate instance of DiameterIncomingRoutingRuleMBean for each incoming routing rule.

To create an incoming routing rule:

Create an instance of DiameterIncomingRoutingRuleMBean by invoking the following operation of DiameterIncomingRoutingRulesMBean:
```
ObjectName createDiameterIncomingRoutingRule(string RuleName)
```
Set the following attributes of the newly created instance of DiameterIncomingRoutingRuleMBean:
- Name
- Priority
- ModuleInstance
See Table 5-1 for more information about these attributes.

Setting Up Incoming Routing Criteria

Incoming routing criteria define conditions for incoming routing rules. If these conditions are met, the Diameter SSU routes the incoming message to the IM specified in the incoming routing rule.

The conditions are based on AVPs. You can specify the attribute to be set in the incoming message and the value that this attribute must have. If these parameters match the actual attribute and its value set in the incoming message, the Diameter SSU routes this message to the IM that you defined in the appropriate incoming routing rule.

You can set up incoming routing criteria with the Administration Console and Java MBeans.

Setting Up Incoming Routing Criteria with the Administration Console

To set up incoming routing criteria:

In the navigation tree in the domain navigation pane, expand OCSB.
Expand the Signaling Tier node.
Select the SSU Diameter node.
In the SSU Diameter configuration pane, click the SSU Diameter tab.
Click the Routing subtab.
Click the Incoming Routing Criteria subtab.

The Incoming Routing Criteria configuration pane appears. This pane displays a table. The table contains criteria that define the conditions to be met in order the incoming message to be sent to the Service Broker component that you defined in the incoming routing rules. Each row in the table represents a single rule.
Click New at the bottom of the Incoming Routing Criteria pane.

The New dialog box appears.

Fill in the fields described in Table 5-2.

Table 5-2 Diameter SSU Incoming Routing Criteria Fields

Name	Type	Description
Parent	STRING	Specifies the name of the rule for which you define criteria. This list contains names of the rules that you created on the Incoming Routing Rules subtab.
Name	STRING	Specifies a unique rule name.
Attribute	STRING	Specifies an attribute of a Diameter AVP based on which the Diameter SSU performs routing. The Diameter SSU routes incoming messages to the specified module instance, if the value of this parameter matches the value set in the Value parameter. Possible values: APPLICATION_ID ORIGIN_REALM ORIGIN_HOST Default value: APPLICATION_ID
Value	STRING	Specifies a value that the Attribute parameter must match, in order for the rule specified in Parent to apply. You can define one of the following in the Value parameter: Single value Range of dash-separated values Comma-separated values

Setting Up Incoming Routing Criteria with Java MBeans

Figure 5-2 shows the hierarchy of the configuration MBeans that you use to configure incoming routing criteria. See "Diameter SSU Configuration MBeans Reference" for object names of these MBeans.

Figure 5-2 Diameter Incoming Routing Criteria Configuration MBeans

Each incoming routing criterion is represented by DiameterIncomingRoutingCriteriaMBean. You need to create a separate instance of DiameterIncomingRoutingCriteriaMBean for each incoming routing criterion.

To create an incoming routing criterion:

Create an instance of DiameterIncomingRoutingRuleMBean by invoking the following operation of DiameterIncomingRoutingRulesMBean:
```
ObjectName createDiameterIncomingRoutingRule(string RuleName)
```
Create an instance of DiameterIncomingRoutingCriteriaMBean by invoking the following operation of DiameterIncomingRoutingRuleMBean:
```
ObjectName createDiameterIncomingRoutingCriteria (string CriterionName)
```
Set the following attributes of the newly created instance of DiameterIncomingRoutingCriteriaMBean:
- Parent
- Name
- Attribute
- Value
See Table 5-2 for more information about these attributes.

Configuring Outbound Destinations

You can specify the destination Diameter peers to which outbound messages are routed. You can also assign an alias which is shared among multiple destination peers in the realm. The messages are dispatched based on a preconfigured strategy, according to a fixed random load share.

When configuring IMs supporting Diameter traffic, you can set a value in the Destination-Realm AVP field that matches the alias you assign to the destination peers in Outbound Destinations. The message is then redirected to the destination specified in the Outbound Destinations table.If the value in the Destination-Realm AVP field does not match the alias you set in the Outbound Destinations table, the message is sent to the destination specified in the Destination-Host AVP field.

See "Configuring AVPs" in Oracle Communications Server Broker Processing Domain Configuration Guide for more information.

Configuring Outbound Destinations with the Administration Console

To add outbound destinations:

In the navigation tree in the domain navigation pane, expand OCSB.
Expand the Signaling Tier node.
Select the SSU Diameter node.
In the SSU Diameter configuration pane, click the SSU Diameter tab.
Click the Outbound Destinations subtab.

The Outbound Destinations configuration pane appears. This pane displays a table. The table contains rules that define the destination Diameter peer to which the Diameter SSU routes an outgoing message. Each row in the table represents a single rule.
Click the New button at the bottom of the Outbound Destinations pane.

The New dialog box appears.

Fill in the fields described in Table 5-3.

Table 5-3 Diameter SSU Outbound Destinations Parameters

Field	Descriptions
Name	Specifies a unique destination identifier.
Alias	Specifies the alias you assign to the destination Diameter peer. You can assign the same alias to a number of Diameter peers in the realm to dispatch messages to multiple nodes in the realm.
Destination Host	Specifies the host of the destination Diameter peer.
Destination Realm	Specifies the realm to which the destination Diameter peer belongs.

Click OK.

The Diameter SSU dispatches messages to destination Diameter peers in the realm according to a preconfigured strategy.

Configuring Outbound Destinations with JavaMBeans

Figure 5-3 shows the hierarchy of the configuration MBeans that you use to configure outbound destinations. See "Diameter SSU Configuration MBeans Reference" for object names of these MBeans.

Figure 5-3 Diameter Outbound Destination Configuration MBeans

Each destination is represented by DiameterOutboundDestinationMBean. You need to create a separate instance of DiameterOutboundDestinationMBean for each destination.

To create an outbound destination:

Create an instance of DiameterOutboundDestinationMBean by invoking the following operation of DiameterOutboundRoutingMBean:
```
ObjectName createDiameterOutboundDestination(string RuleName)
```
Set the following attributes of the newly created instance of DiameterIncomingRoutingRuleMBean:
- Name
- Alias
- DestinationHost
- DestinationRealm
See Table 5-3 for more information about these attributes.

Configuring Diameter Nodes

The Diameter SSU is a process that implements the Diameter protocol. You define the Diameter SSU as a Diameter node and configure how other Diameter entities access the Diameter node.

By default, the Diameter SSU is configured as one Diameter node, where all Signaling Servers provide a Diameter network channel on the same port. If you deploy the Diameter SSU on multiple Signaling Servers running on the same physical machine, you must configure each Signaling Server to listen on a different port, otherwise the ports will collide. In this case, you define a Diameter node for each Signaling Server. In general, when you need to define a different address, host or port to Diameter SSU deployments running on different Signaling Servers, you create a Diameter node for each Signaling Server.

You can perform the following actions with Diameter nodes:

Creating a new node. See "Creating a Diameter Node" for more information.
Setting up the default route. See "Configuring the Default Route" for more information.
Setting up routes. See "Configuring Routes" for more information.
Setting up peers. See "Configuring Peers" for more information.

Creating a Diameter Node

You can create a new Diameter node with the Administration Console or Java MBeans.

Creating a Diameter Node with the Administration Console

To create a Diameter node:

In the navigation tree in the domain navigation pane, expand OCSB.
Expand the Signaling Tier node.
Select the SSU Diameter node.
In the SSU Diameter configuration pane, click the DIAMETER tab.

The Diameter configuration pane appears. This pane contains the tools that you need to configure Diameter nodes.
In the Node area, click the Plus icon.

The fields of the General tab appear.

Fill in the fields described in Table 5-4.

Table 5-4 Diameter Node Parameters

Field	Description
Name	Specifies a unique name for the Diameter configuration.
Realm	Specifies the realm name of the Diameter node. For example: host@oracle.com Multiple Diameter nodes can be run on a single host using different realms and listen port numbers.
Address	Specifies the listen address for this Diameter node, using either the DNS name or the IP address. The host identity is used as the listen address when this field is blank. The host identity might or might not match the DNS name. Oracle recommends configuring the Address property with an explicit DNS name or IP address to avoid configuration errors.
Host	Specifies the host name of the Diameter node. The host identity might or might not match the DNS name.
Port	Specifies the network port number to use with the listen address.
Target	Specifies the name of a single Signaling Server (JVM) that provides the Diameter network channel. Leave the field blank to specify that all the Signaling Servers in the domain provide Diameter network channels. There can be only one blank entry for the Target field, which makes it the default Signaling Server. The Target field includes the following options: Include Origin State ID: Specifies that the Origin State ID AVP is included in each request, which allows for the rapid detection of terminated sessions. Diameter AVPs carry specific authentication, accounting, authorization routing and security information, as well as configuration details for request and reply. SCTP: Indicates that the Diameter node is configured with support for SCTP. TLS: Indicates that the Diameter node is configured with support of Transport Layer Security (TLS). This field is used to advertise TLS capabilities when the node is interrogated by another Diameter node.
Request Timeout	Specifies the amount of time, from 0 milliseconds, this node waits for an answer message before timing out.
Watchdog Timeout	Specifies the amount of time, from 0 seconds, this node uses for the value of the Diameter Tw watchdog timer interval.

After you have created a general node configuration, the configuration name appears in the list of Diameter nodes. You can select the node to configure Diameter routes and peers as described in the following sections:

Configuring the Default Route with the Administration Console
Configuring Routes with the Administration Console
Configuring Peer with the Administration Console

Creating a Diameter Node with Java MBeans

Figure 5-4 shows the hierarchy of the configuration MBeans that you use to create a Diameter node. See "Diameter SSU Configuration MBeans Reference" for the object names of these MBeans.

Figure 5-4 Diameter Node Configuration MBeans

Each Diameter node is represented by an instance of NodeMBean. You need to create a separate instance of NodeMBean for each Diameter node. When you create an instance of NodeMBean, the set of child MBeans are created. Each child MBean represent a single parameter of the Diameter node.

For example, RealmMBean has the Realm attribute that represents the Realm parameter.

To create a Diameter node:

Create an instance of NodeMBean by invoking the following operation of DiameterConfigMBean:
```
void addNode()
```
NodeMBean is created with the following child MBeans:
- addressMBean
- nameMBean
- realmMBean
- message-debug-enabledMBean

Create additional child MBeans of NodeMBean by invoking the following operations of NodeMBean:

void addHost()
void addPort()
void addTarget()
void addRequest_timeout()
void addWatchdog_timeout()

Set the attributes of the child MBeans as described in Table 5-5.

Table 5-5 NodeMBean Child MBeans and Their Attributes

MBean	Attribute
nameMBean	Name
realmMBean	Realm
addressMBean	Address
hostMBean	Host
portMBean	Port
targetMBean	Target
request_timeoutMBean	Request_timeout
watchdog_timeoutMBean	Watchdog_timeout

See Table 5-4 for more information about these attributes.

Configuring the Default Route

You can specify the default route with the Administration Console or Java MBeans.

Configuring the Default Route with the Administration Console

To configure the default route:

In the navigation tree in the domain navigation pane, expand OCSB.
Expand the Signaling Tier node.
Select the SSU Diameter node.
In the SSU Diameter configuration pane, click the DIAMETER tab.
In the Node area, select the node for which you set up the default route.
Click the Default Route subtab.

Fill in the fields described in Table 5-6.

Table 5-6 Diameter Default Route Parameters

Field

Description

Name

Specifies an administrative name for the route.

Default Route Action

Specifies an action that this node performs when using the default route. The action type can be any of the following:

None
Local
Relay
Proxy
Redirect

Server

Clicking the New button (+) at the bottom of the Default Route pane opens the New Data dialog box where you specify the name of the target peers that will use the route. The target server maps to the Host field in the Peer panel. See "Configuring Peer with the Administration Console" for more information.

Configuring the Default Route with Java MBeans

Figure 5-5 shows the hierarchy of the configuration MBeans that you use to configure the default route of a Diameter node. See "Diameter SSU Configuration MBeans Reference" for the object names of these MBeans.

Figure 5-5 Diameter Default Route Configuration MBeans

Each default route is represented by an instance of default-routeMBean. When you create an instance of NodeMBean, the set of child MBeans are created. Each child MBean represent a single parameter of the default route.

For example, actionMBean has the Action attribute that represents the Action parameter.

To set up the default route of a Diameter node:

Create an instance of default-routeMBean by invoking the following operation of NodeMBean:
```
void addDefault_route()
```
default-routeMBean is created with the following child MBeans:
- nameMBean
- actionMBean
- serverMBean
Set the attributes of these child MBeans as described in Table 5-7.

Table 5-7 default-routeMBean Child MBeans and Their Attributes

MBean Attribute

nameMBean

Name

actionMBean

Realm

serverMBean

Address

See Table 5-6 for more information about these attributes.

Configuring Routes

Certain Diameter nodes, such as relays, configure realm-based routes for use when resolving Diameter messages.

Configuring Routes with the Administration Console

To configure a new Diameter route:

In the navigation tree in the domain navigation pane, expand OCSB.
Expand the Signaling Tier node.
Select the SSU Diameter node.
In the SSU Diameter configuration pane, click the DIAMETER tab.
In the Node area, select the node for which you set up the routes.
Click the Routes subtab.

Fill in the fields described in Table 5-8.

Table 5-8 Routes Parameters

Field	Description
Name	Specifies an administrative name for the route.
Action	Specifies an action that this node performs when using the route. Possible values: None Local Relay Proxy Redirect
Realm	Specifies the target realm for this route.
Application ID	Specifies the type of Diameter billing to use. Possible values 3 Specifies Diameter Rf charging. 4 Specifies Diameter Ro charging.
Server	Clicking the New button (+) at the bottom of the Default Route pane opens the New Data dialog box where you specify the name of the target peers that will use the route. The target server maps to the Host field in the Peer pane. See "Configuring Peer with the Administration Console" for more information.

Configuring Routes with Java MBeans

Figure 5-6 shows the hierarchy of the configuration MBeans that you use to configure routes of a Diameter node. See "Diameter SSU Configuration MBeans Reference" for the object names of these MBeans.

Figure 5-6 Diameter Route Configuration MBeans

Each route is represented by an instance of routeMBean. You need to create a separate instance of routeMBean for each route of the Diameter node. When you create an instance of routeMBean, the set of child MBeans are created. Each child MBean represent a single parameter of the route.

For example, actionMBean has the Action attribute that represents the Action parameter.

To set up the default route of a Diameter node:

Create an instance of default-routeMBean by invoking the following operation of NodeMBean:
```
void addRoute()
```
routeMBean is created with the following child MBeans:
- nameMBean
- actionMBean
- serverMBean
- realmMBean
- application-idMBean
Set the attributes of these child MBeans as described in Table 5-9.

Table 5-9 routeMBean Child MBeans and Their Attributes

MBean Attribute

nameMBean

Name

actionMBean

Realm

serverMBean

Address

realmMBean

Realm

application-idMBean

Application-id

See Table 5-8 for more information about these attributes.

Configuring Peers

A Diameter node defines peer connection information for each Diameter node in the realm, or enables dynamic peers in combination with TLS transport to allow peers to be recognized automatically.

Configuring Peer with the Administration Console

To configure a new Diameter peer node:

In the navigation tree in the domain navigation pane, expand OCSB.
Expand the Signaling Tier node.
Select the SSU Diameter node.
In the SSU Diameter configuration pane, click the DIAMETER tab.
In the Node area, select the node for which you set up the peers.
Click the Peers subtab.

In the Peers configuration pane, define the parameters described in Table 5-10.

Table 5-10 Peer Recognition Parameters

Field	Description
Allow Dynamic Peers	Enables dynamic discovery of Diameter peers. Dynamic peer support is disabled by default. Oracle recommends enabling dynamic peers only when using the TLS transport, because no access control mechanism is available to restrict hosts from becoming peers. If you enabled dynamic peers, you can set two additional parameters: diameter.watchdog.for.dynamic.peers This parameter defines whether or not the Diameter SSU should send Device-Watchdog-Request (DWR) commands to dynamic Diameter peers. diameter.tcp.keepalive.for.client.peers This parameter defines whether or not the TCP socket option SO_KEEPALIVE for Diameter dynamic peers is set to true. You define these parameters in the start.sh file of the Signaling Server on which the Diameter SSU runs. See the "System Properties" section in the "System Administrator's Reference" chapter of the Oracle Communications Service Broker System Administrator's Guide.
Peer Retry Delay	Specifies the time, in seconds. This node waits before retrying a request to a Diameter peer. The default wait value is 30 seconds.

Field

Description

Allow Dynamic Peers

Enables dynamic discovery of Diameter peers. Dynamic peer support is disabled by default.

Oracle recommends enabling dynamic peers only when using the TLS transport, because no access control mechanism is available to restrict hosts from becoming peers.

If you enabled dynamic peers, you can set two additional parameters:

diameter.watchdog.for.dynamic.peers

This parameter defines whether or not the Diameter SSU should send Device-Watchdog-Request (DWR) commands to dynamic Diameter peers.
diameter.tcp.keepalive.for.client.peers

This parameter defines whether or not the TCP socket option SO_KEEPALIVE for Diameter dynamic peers is set to true.

You define these parameters in the start.sh file of the Signaling Server on which the Diameter SSU runs. See the "System Properties" section in the "System Administrator's Reference" chapter of the Oracle Communications Service Broker System Administrator's Guide.

Peer Retry Delay

Specifies the time, in seconds. This node waits before retrying a request to a Diameter peer. The default wait value is 30 seconds.

In the Peers configuration pane, click the New button (+) to define a new peer entry.

The New Data dialog box appears.

Fill in the fields described in Table 5-11.

Table 5-11 Peer Recognition Parameters

Field	Description
Address	Specifies the peer's address, using either the DNS name or IP address.
Host	Specifies the peer's host identity.
Port	Specifies the listen port number of the peer.
Protocol	Specifies the protocol used to communicate with the peer. Possible values: tcp sctp Default value: tcp Note that Service Broker attempts to connect to the peer using only the protocol you specify. The other protocol is not used, even if a connection fails using the selected protocol.
Watchdog	Indicates whether the peer supports the Diameter Tw watchdog timer interval.

Configuring Peers with Java MBeans

Figure 5-7 shows the hierarchy of the configuration MBeans that you use to configure peers. See "Diameter SSU Configuration MBeans Reference" for the object names of these MBeans.

Figure 5-7 Diameter Peers Configuration MBeans

Each peer is represented by an instance of peerMBean. You need to create a separate instance of peerMBean for each peer. When you create an instance of peerMBean, the set of child MBeans are created. Each child MBean represent a single parameter of the route.

For example, portMBean has the Port attribute that represents the Port parameter.

To set up a peer of a Diameter node:

Create an instance of peerMBean by invoking the following operation of NodeMBean:
```
void addPeer()
```
peerMBean is created with the following child MBeans:
- addressMBean
- hostMBean
- portMBean
- protocolMBean
- watchdog_enabledMBean
Set the attributes of these child MBeans as described in Table 5-12.

Table 5-12 peerMBean Child MBeans and Their Attributes

MBean Attribute

addressMBean

Address

hostMBean

Host

portMBean

Port

protocolMBean

Protocol

watchdog_enabledMBean

Watchdog_enabled

See Table 5-10 for more information about these attributes.
Invoke the following operations of NodeMBean:
```
void addAllow_dynamic_peers()
void addPeer_retry_delay()
```
These operations created allow_dynamic_peersMBean and peer_retry_delayMBean accordingly.
Set the allow-dynamic-peers attribute of allow_dynamic_peersMBean as described in Table 5-11.
Set the peer_retry_delay attribute of peer_retry_delayMBean as described in Table 5-11.

MBean	Attribute
addressMBean	Address
hostMBean	Host
portMBean	Port
protocolMBean	Protocol
watchdog_enabledMBean	Watchdog_enabled

Diameter SSU Configuration MBeans Reference

The following sections provide reference information for the Diameter SSU configuration MBeans.

Note:

MBeans described in this guide may include additional advanced attributes, which are not described in the guide. Advanced attributes are reserved for internal use. Do not change these attributes.

DiameterIncomingRoutingRulesMBean

DiameterIncomingRoutingRulesMBean enables you to manage incoming routing rules. Each incoming routing rule is represented by am instance of DiameterIncomingRoutingRuleMBean. Using DiameterIncomingRoutingRulesMBean, you need to create a separate instance of DiameterIncomingRoutingRuleMBean for each rule.

Object Name

com.convergin:Type=DiameterIncomingRoutingRules,Version=MBean_Version,Location=AdminServer,Name=ssudiameter.diameter_inbound_routing

Factory Method

Created automatically

Attributes

None

Operations

ObjectName[] getDiameterIncomingRoutingRules()

Gets an array of references to instances of DiameterIncomingRoutingRuleMBean

ObjectName createDiameterIncomingRoutingRule()

Creates an instance of DiameterIncomingRoutingRuleMBean that enables you to configure an individual rule

ObjectName lookupDiameterIncomingRoutingRule()

Returns the specified DiameterIncomingRoutingRuleMBean

void destroyDiameterIncomingRoutingRule()

Destroys a DiameterIncomingRoutingRuleMBean

DiameterIncomingRoutingRuleMBean

Each instance of DiameterIncomingRoutingRuleMBean represents an individual incoming routing rule that defines an internal Service Broker component to which the Diameter SSU routes the incoming Diameter message and the priority of the rule. You need to create a separate instance of DiameterIncomingRoutingRuleMBean for each rule.

Object Name

com.convergin:Type=DiameterIncomingRoutingRule,Version=MBean_Version,Location=AdminServer,Name=ssudiameter.Instance_Name

Factory Method

DiameterIncomingRoutingRules.createDiameterIncomingRoutingRule()

Attributes

Name
Priority
ModuleInstance

For more information on each of these parameters, see Table 5-13.

Operations

ObjectName createDiameterIncomingRoutingCriteria()

Creates an instance of DiameterIncomingRoutingCriteriaMBean

void destroyDiameterIncomingRoutingCriteria()

Destroys an instance of DiameterIncomingRoutingCriteriaMBean

ObjectName lookupDiameterIncomingRoutingCriteria()

Returns the reference to a specified instance of DiameterIncomingRoutingCriteriaMBean

DiameterIncomingRoutingCriteriaMBean

Each instance of DiameterIncomingRoutingCriteriaMBean represents an individual incoming routing criterion that defines the conditions to be met in order the incoming message to be routed to the internal Service Broker component specified in the incoming routing rule.

Object Name

com.convergin:Type=DiameterIncomingRoutingCriteria,Version=MBean_Version,Location=AdminServer,Name=ssudiameter.Instance_Name

Factory Method

DiameterIncomingRoutingRule.createDiameterIncomingRoutingCriteria()

Attributes

Attribute
Value

For more information on each of these parameters, see Table 5-2.

Operations

None

DiameterOutboundRoutingMBean

DiameterOutboundRoutingMBean enables you to manage outbound routing rules. Each outbound routing rule is represented by an instance of DiameterOutboundDestinationMBean. Using DiameterOutboundRoutingMBean, you need to create a separate instance of DiameterOutboundDestinationMBean for each outbound routing rule.

Object Name

com.convergin:Type=DiameterOutboundRouting,Version=MBean_Version,Location=AdminServer,Name=ssudiameter.diameter_outbound_routing

Factory Method

Created automatically

Attributes

None

Operations

createDiameterOutboundDestination()

Creates an instance of DiameterOutboundDestinationMBean that enables you to configure an outbound destination

destroyDiameterOutboundDestination()

Destroys an instance of DiameterOutboundDestinationMBean

lookupDiameterOutboundDestination()

Searches for instances of DiameterOutboundDestinationMBean

DiameterOutboundDestinationMBean

Each instance of DiameterOutboundRoutingMBean represents an outbound destination that defines how the Diameter SSU routes Diameter messages to a destination peer.

Object Name

com.convergin:Type=DiameterOutboundDestination,Version=MBean_Version,Location=AdminServer,Name=ssudiameter.Instance_Name

Factory Method

DiameterOutboundRouting.createDiameterOutboundDestination()

Attributes

Name
Alias
DestinationHost
DestinationRealm

For more information on each of these parameters, see Table 5-3.

Operations

None

DiameterConfigMBean

DiameterConfigMBean is a root MBean for this Diameter SSU configuration.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig

Factory Method

Created automatically

Attributes

Table 5-13 DiameterConfigMBean Attribute

Name	Type	Description
Name	STRING	Specifies a name for the Diameter configuration

Operations

void addName()

Adds a new instance of NameMBean that enables you to define the name for a Diameter configuration.

void removeName()

Removes an existing instance of NameMBean that defines the name of a Diameter configuration.

addNode()

Adds a new instance of NodeMBean represents all Diameter SSUs as a Diameter node.

removeNode(int NodeIndex)

Removes a specified instance of a NodeMBean.

NameMBean

NameMBean defines the name of a Diameter configuration.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=name

Factory Method

diameterConfig.addName()

Attributes

Table 5-14 NameMBean Attribute

Name	Type	Description
Name	STRING	Name of the Diameter configuration

Operations

None

NodeMBean

NodeMBean represents a Diameter SSU as a Diameter node.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0]

Factory Method

diameterConfig.addNode()

Attributes

None

Operations

void cloneIt()

Adds a copy of the NodeMBean instance that invoked this operation.

void addName()

Adds a new instance of NameMBean that defines the name of the Diameter peer.

void removeName()

Removes an instance of NameMBean.

void addTarget()

Adds a new instance of TargetMBean that defines the ID of the Signaling Server for the Diameter node.

void removeTarget()

Removes an instance of TargetMBean.

void addHost()

Adds a new instance of HostMBean that defines the host identity of the Diameter node.

void removeHost()

Removes an instance of HostMBean.

void addRealm()

Adds a new instance of RealmMBean that defines the name of a realm for which the Diameter node is responsible.

void removeRealm()

Removes an instance of RealmMBean.

void addAddress()

Adds a new instance of AddressMBean that defines the listen address for the Diameter node using either the DNS name or IP address.

void removeAddress()

Removes an instance of AddressMBean.

void addPort()

Adds a new instance of PortMBean that defines the listen port number for the Diameter node.

void removePort()

Removes an instance of PortMBean.

void addTls_enabled()

Adds a new instance of Tls_enabledMBean that defines whether or not the Transport Layer Security (TLS) is enabled.

void removeTls_enabled()

Removes an instance of Tls_enabledMBean.

void addSctp_enabled()

Adds a new instance of Sctp_enabledMBean that defines whether or not the Stream-Control TransmissionProtocol (SCTP) is enabled.

void removeSctp_enabled()

Removes an instance of Sctp_enabledMBean.

void addDebug_enabled()

Adds a new instance of Debug_enabledMBean that defines whether or not generation of debug message is enabled.

void removeDebug_enabled()

Removes an instance of Debug_enabledMBean.

void addMessageDebug_enabled()

Adds a new instance of MessageDebug_enabledMBean that defines whether or not tracing for Diameter messages processed by the Diameter node is enabled.

void removeMessageDebug_enabled()

Removes an instance of MessageDebug_enabledMBean.

void addMessage_debug()

Adds a new instance of Message_debugMBean that writes Diameter events to the log.

void removeMessage_debug()

Removes an instance of Message_debugMBean.

void addPeer_retry_delay()

Adds a new instance of Peer_retry_delayMBean that defines period of time, in seconds, between retries to connect to the peer.

void removePeer_retry_delay()

Removes an instance of Peer_retry_delayMBean.

void addAllow_dynamic_peers()

Adds a new instance of Allow_dynamic_peersMBean that defines whether or not dynamic peers are allowed.

void removeAllow_dynamic_peers()

Removes an instance of Allow_dynamic_peersMBean.

void addRequest_timeout()

Adds a new instance of Request_timeoutMBean that defines period of time, in milliseconds, that the Diameter node has to wait for an answer from the peer before timing out.

void removeRequest_timeout()

Removes an instance of Request_timeoutMBean.

void addWatchdog_timeout()

Adds a new instance of Watchdog_timeoutMBean that defines period of time, in seconds, for the Diameter Tw watchdog timer.

void removeWatchdog_timeout()

Removes an instance of Watchdog_timeoutMBean.

void addInclude_origin_state_id()

Adds a new instance of Include_origin_state_idMBean that defines whether the Origin-State-Id attribute-value pair (AVP) is included in each request.

void removeInclude_origin_state_id()

Removes an instance of Include_origin_state_idMBean.

void addPeer()

Adds a new instance of PeerMBean that defines a Diameter peer in the network with which the Diameter node communicates.

void removePeer()

Removes an instance of PeerMBean.

void addDefaultRoute()

Adds a new instance of DefaultRouteMBean that defines a route to use when a request does not match a configured route.

void removeDefaultRoute()

Removes an instance of DefaultRouteMBean.

HostMBean

HostMBean defines the host identity of this Diameter node.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=host

Factory Method

Node.addHost()

Attributes

Table 5-15 HostMBean Attribute

Name	Type	Description
Host	String	Specifies the host name of the Diameter node

Operations

None

PortMBean

PortMBean defines the listen port for a Diameter node.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=port

Factory Method

Node.addPort()

Attributes

Table 5-16 PortMBean Attribute

Name	Type	Description
Port	STRING	Specifies the listen port number for this node

Operations

None

TargetMBean

TargetMBean defines the ID of the Signaling Server for this node, as defined in the domain configuration.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=target

Factory Method

Node.addTarget()

Attributes

Table 5-17 TargetMBean Attribute

Name	Type	Description
Target	STRING	Specifies the ID of the Signaling Server for this node, as defined in the domain configuration.

Operations

None

RealmMBean

RealmMBean defines the name of a realm for which this node is responsible. An HSS, Application Server, and relay agents must all agree on a realm name or names. The realm name for the HSS and Application Server do not have to match.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=realm

Factory Method

Node.addRealm()

Attributes

Table 5-18 RealmMBean Attribute

Name	Type	Description
Realm	STRING	Specifies the realm name of the Diameter node

Operations

None

AddressMBean

AddressMBean defines the listen address for a Diameter node using either the DNS name or IP address.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=address

Factory Method

Node.addAddress()

Attributes

Table 5-19 AddressMBean Attribute

Name	Type	Description
Address	STRING	Specifies the listen address for this Diameter node using either the DNS name or IP address

Operations

None

Peer_retry_delayMBean

Peer_retry_delayMBean defines period of time, in seconds, between retries to connect to the peer.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0], name2=peer-retry-delay

Factory Method

Node.addPeer_retry_delay()

Attributes

Table 5-20 Peer_retry_delayMBean Attribute

Name	Type	Description
Peer_retry_delay	STRING	Specifies period of time, in seconds, between retries to connect to the peer

Operations

None

Allow_dynamic_peersMBean

Allow_dynamic_peersMBean defines whether or not dynamic peers are allowed.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0], name2=allow-dynamic-peers

Factory Method

Node.addAllow_dynamic_peers()

Attributes

Table 5-21 Allow_dynamic_peersMBean Attribute

Name	Type	Description
Allow_dynamic_peers	BOOL	Specifies whether or not dynamic peers are allowed. Possible values: True False Default value: False Note: It is recommended to enable dynamic peers only when using the TLS transport because no access control mechanism is available to restrict hosts from becoming peers.

Name

Type

Description

Allow_dynamic_peers

BOOL

Specifies whether or not dynamic peers are allowed.

Possible values:

True
False

Default value: False

Note: It is recommended to enable dynamic peers only when using the TLS transport because no access control mechanism is available to restrict hosts from becoming peers.

Operations

None

Request_timeoutMBean

Request_timeoutMBean defines period of time, in milliseconds, that the node has to wait for an answer before timing out.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0], name2=request-timeout

Factory Method

Node.addRequest_timeout()

Attributes

Table 5-22 Request_timeoutMBean Attribute

Name	Type	Description
Request_timeout	STRING	Specifies period of time, in milliseconds, that the node has to wait for an answer before timing out

Operations

None

Watchdog_timeoutMBean

Watchdog_timeoutMBean defines period of time, in seconds, for the Diameter Tw watchdog timer.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0], name2=watchdog-timeout

Factory Method

Node.addWatchdog_timeout()

Attributes

Table 5-23 Watchdog_timeoutMBean Attribute

Name	Type	Description
Watchdog_timeout	STRING	Specifies period of time, in seconds, for the Diameter Tw watchdog timer

Operations

None

PeerMBean

PeerMBean defines a Diameter peer in the network which the Signaling Server communicate with. A Diameter node (NodeMBean) defines peer connection for each other Diameter node.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=peer[0]

Factory Method

Node.addPeer()

Attributes

None

Operations

void cloneIt()

Adds a copy of the PeerMBean instance that invoked this operation

void addHost()

Adds a new instance of HostMBean that defines the peer's host identity

void removeHost()

Removes an instance of HostMBean

void addAddress()

Adds a new instance of AddressMBean that defines the peer's listen address

void removeAddress()

Removes an instance of AddressMBean

void addPort()

Adds a new instance of PortMBean that defines the listen port number of the peer

void removePort()

Removes an instance of PortMBean

void addProtocol()

Adds a new instance of ProtocolMBean that defines the protocol used to communicate with the peer

void removeProtocol()

Removes an instance of ProtocolMBean

void addWatchdog-enabled()

Adds a new instance of Watchdog-enabledMBean that defines whether or not the peer supports the Diameter Tw watchdog timer interval

void removeWatchdog-enabled()

Removes an instance of Watchdog-enabledMBean

AddressMBean

AddressMBean defines the peer's listen address.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=peer[0], name3=address

Factory Method

Peer.addAddress()

Attributes

Table 5-24 AddressMBean Attribute

Name	Type	Description
Address	STRING	Specifies the peer's listen address (DNS name or IP address)

Operations

None

HostMBean

HostMBean defines the peer node's host identity

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=peer[0], name3=host

Factory Method

Peer.addHost()

Attributes

Table 5-25 HostMBean Attribute

Name	Type	Description
Host	STRING	Specifies the peer's host identity

Operations

None

PortMBean

PortMBean defines the listen port number of the peer

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=peer[0], name3=port

Factory Method

Peer.addPort()

Attributes

Table 5-26 PortMBean Attribute

Name	Type	Description
Port	STRING	Specifies the listen port number of the peer

Operations

None

ProtocolMBean

ProtocoMBean defines the protocol used to communicate with the peer.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=peer[0], name3=protocol

Factory Method

Peer.addProtocol()

Attributes

Table 5-27 ProtocolMBean Attribute

Name	Type	Description
Protocol	STRING	Specifies the protocol used to communicate with the peer. Possible values: tcp sctp Default value: tcp Note that Service Broker attempts to connect to the peer using only the protocol you specify. The other protocol is not used, even if a connection fails using the selected protocol.

Name

Type

Description

Protocol

STRING

Specifies the protocol used to communicate with the peer.

Possible values:

tcp
sctp

Default value: tcp

Note that Service Broker attempts to connect to the peer using only the protocol you specify. The other protocol is not used, even if a connection fails using the selected protocol.

Operations

None

Watchdog-enabledMBean

Watchdog-enabledMBean defines whether or not the peer supports the Diameter Tw watchdog timer interval

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=peer[0], name3=watchdog-enabled

Factory Method

Peer.addWatchdog-enabled()

Attributes

Table 5-28 Watchdog-enabledMBean Attribute

Name	Type	Description
WatchdogEnabled	BOOL	Specifies whether or not the peer supports the Diameter Tw watchdog timer interval. Possible values: True False Default value: False

Name

Type

Description

WatchdogEnabled

BOOL

Specifies whether or not the peer supports the Diameter Tw watchdog timer interval.

Possible values:

True
False

Default value: False

Operations

None

RouteMBean

RouteMBean defines a server to which an IM-OCF forwards a Diameter message with the specified host realm and application ID.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=route[0]

Factory Method

Node.createRoute()

Attributes

None

Operations

void addName()

Adds an instance of NameMBean that defines the name of the default route.

void removeName()

Removes an instance of NameMBean.

void addAction()

Adds an instance of ActionMBean that defines an action that the node performs when using the configured route.

void removeAction()

Removes an instance of ActionMBean.

void addServer ()

Adds an instance of ServerMBean that defines a server to which Service Broker routes a message.

void removeServer(int ServerIndex)

Remove an instance of ServerMBean.

void addApplication_id()

Adds an instance of Application-idMBean that defines a Diameter interface used.

void removeApplication_id()

Remove an instance of Application-idMBean.

void addRealm()

Adds an instance of RealmMBean that defines the name of a realm for which this node is responsible.

void removeRealm()

Remove an instance of RealmMBean.

Application-idMBean

Application-idMBean defined a Diameter interface used.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=route[0], name3=application-id

Factory Method

Node.createRoute()

Attributes

Table 5-29 Application-idMBean Attribute

Name	Type	Description
Application-id	STRING	Specifies a Diameter interface. Possible values: 4 Stands for the Ro interface 16777217 Stands for the Sh interface

Name

Type

Description

Application-id

STRING

Specifies a Diameter interface.

Possible values:

4

Stands for the Ro interface
16777217

Stands for the Sh interface

Operations

None

Default-routeMBean

Default-routeMBean defines a route to use when a request does not match a configured route.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=default-route

Factory Method

Created automatically

Attributes

None

Operations

void addName()

Adds an instance of NameMBean that defines the name of the default route.

void removeName()

Removes an instance of NameMBean.

void addAction()

Adds an instance of ActionMBean that defines an action that the node performs when using the configured route.

void removeAction()

Removes an instance of ActionMBean.

void addServer ()

Adds an instance of ServerMBean that defines a server to which Service Broker routes a message.

void removeServer(int ServerIndex)

Remove an instance of ServerMBean.

NameMBean

NameMBean defines the name of the default route.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0],name2=default-route, name3=name

Factory Method

Default-route.addName()

Attributes

Table 5-30 NameMBean Attribute

Name	Type	Description
Name	STRING	Specifies the name of the default route.

Operations

None

ActionMBean

ActionMBean defines an action that the node performs when using the configured route.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0], name2=default-route,name3=action

Factory Method

Default-route.addAction()

Attributes

Table 5-31 ActionMBean Attribute

Name	Type	Description
Action	STRING	Specifies an action that the node performs when using the configured route. Possible values: Local Relay Proxy Redirect Possible values: Local

Name

Type

Description

Action

STRING

Specifies an action that the node performs when using the configured route.

Possible values:

Local
Relay
Proxy
Redirect

Possible values: Local

Operations

None

ServerMBean

ServerMBean defines a server to which Service Broker routes a message.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.diameter, version=MBean_Version,name0=diameterConfig,name1=node[0], name2=default-route,name3=server[0]

Factory Method

Created automatically

Attributes

Table 5-32 ServerMBean Attribute

Name	Type	Description
Server	STRING	Specifies a server.

Operations

CloneIt