Oracle® Communications Service Broker Configuration Guide Release 5.0 Part Number E15182-01 |
|
|
View PDF |
The following sections describe how to configure Service Broker Diameter SSUs using the Service Broker Administration Console and Java MBeans:
This section describes how to configure the Diameter SSU using the Service Broker Administration Console.
Caution:
You cannot complete the Diameter SSU configuration using only the Administration Console. Some parts of the configuration are available only with Java MBeans. To complete the configuration, you must also configure some Java MBeans.The configuration process includes setting up parameters on the subtabs described in Table 10-1.
Table 10-1 Diameter SSUs Subtabs
Subtab | Description |
---|---|
Incoming Routing Rules |
Enables you to define how the Diameter SSU routes incoming messages to internal Service Broker IMs. For more information, see "Incoming Routing Rules". |
To access the Diameter SSU configuration screen:
In the Domain Navigation pane, select OCSB > Signaling Tier > SSU Diameter. The SSU Diameter Configuration screen is displayed in the Configuration pane.
The Incoming Routing Rules subtab enables you to define how the Diameter SSU routes incoming Diameter messages to internal Service Broker IMs.
The Incoming Routing Rules subtab contains a table in which each row represents one routing rule. When configuring a routing rule, you need to specify the fields described in Table 10-2.
Table 10-2 Incoming Routing Rule Fields
Name | Type | Description |
---|---|---|
Name |
STRING |
Specifies a unique rule name |
Origin Host |
STRING |
Specifies an Origin Host by which a Service Broker IM is known to external entities. The Diameter SSU routes incoming messages destined for this Origin Host to an IM, based on what you specify in the Alias parameter. Example: us.charge-online.com You can set this field to Any. In this case, a routing rule applies to any Diameter incoming message, regardless of its destination Origin Host. This value is generally used to define a default routing rule that ensures that the incoming Diameter message is routed to a default IM, so long as no other routing rule has been applied. |
Alias |
STRING |
Specifies a URI of an IM to which the Diameter SSU routes an incoming session. The alias has the following format: <IM-instance-name>.<IM-type>@<domain-id>
Example: r-imocf_instance.RIMOCF@processing-domain.1 |
Service Broker provides a set of MBeans that exposes attributes and operations for configuring the Diameter SSU through JMX, shown in Figure 10-1.
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 is a container for instances of DiameterIncomingRoutingRuleMBean. Each instance of DiameterIncomingRoutingRuleMBean represents an individual incoming routing rule.
Created automatically
None.
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
Each instance of DiameterIncomingRoutingRuleMBean represents an individual incoming routing rule that defines how the Diameter SSU routes incoming Diameter messages to internal Service Broker IMs.
DiameterIncomingRoutingRules.createDiameterIncomingRoutingRule()
Name
Origin Host
Alias
For more information on each of these parameters, see Table 10-2.
None
DiameterConfigMBean is a root MBean for this Diameter SSU configuration.
Created automatically
Table 10-3 DiameterConfigMBean Attribute
Name | Type | Description |
---|---|---|
Name |
STRING |
Specifies a name for the Diameter configuration |
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
diameterConfig.addNode()
NodeMBean represents all Diameter SSUs as a Diameter node.
None
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 node
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 peer nodes
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 node has to wait for an answer 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 node in the network with which the Signaling Server 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
Node.addHost()
HostMBean defines the host identity of this Diameter node.
Table 10-5 HostMBean Attribute
Name | Type | Description |
---|---|---|
Host |
String |
Specifies the host identity of this Diameter node. |
None
Node.addPort()
PortMBean defines the listen port for a Diameter node.
Table 10-6 PortMBean Attribute
Name | Type | Description |
---|---|---|
Port |
STRING |
Specifies the listen port number for this node |
None
Node.addTarget()
TargetMBean defines the ID of the Signaling Server for this node, as defined in the domain configuration.
Table 10-7 TargetMBean Attribute
Name | Type | Description |
---|---|---|
Target |
STRING |
Specifies the ID of the Signaling Server for this node, as defined in the domain configuration. |
None
Node.addRealm()
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.
Table 10-8 RealmMBean Attribute
Name | Type | Description |
---|---|---|
Realm |
STRING |
Specifies the name of a realm for which this node is responsible |
None
Node.addAddress()
AddressMBean defines the listen address for a Diameter node using either the DNS name or IP address.
Table 10-9 AddressMBean Attribute
Name | Type | Description |
---|---|---|
Address |
STRING |
Specifies the listen address for this Diameter node using either the DNS name or IP address |
None
Node.addTls_enabled()
Tls_enabledMBean defines whether or not the Transport Layer Security (TLS) is enabled.
Table 10-10 Tls_enabledMBean Attribute
Name | Type | Description |
---|---|---|
Tls_enabled |
BOOL |
Specifies whether or not the Transport Layer Security (TLS) is enabled. This attribute is used to advertise TLS capabilities when the node is interrogated by another Diameter node. Possible values:
Default value: False |
None
Node.addSctp_enabled()
Sctp_enabledMBean defines whether or not the Stream-Control Transmission Protocol (SCTP) is enabled.
Table 10-11 Sctp_enabledMBean Attribute
Name | Type | Description |
---|---|---|
Sctp_enanbled |
BOOL |
Specifies whether or not the Stream-Control Transmission Protocol (SCTP) is enabled. Possible values:
|
None
Node.addDebug_enabled()
Debug_enabledMBean defines whether or not generation of debug messages is enabled.
Table 10-12 Debug_enabledMBean Attribute
Name | Type | Description |
---|---|---|
Debug_enabled |
BOOL |
Specifies whether or not generation of debug messages is enabled. Possible values:
Default value: False |
None
Node.addMessageDebug()
Message_debugMBean writes Diameter events to the log
Table 10-13 Message_debugMBean Attribute
Name | Type | Description |
---|---|---|
Message_debug |
STRING |
Diameter event written to the log |
None
Node.addMessage_debug_enabled()
Message_debug_enabledMBean defines whether or not tracing for Diameter messages processed by this node is enabled.
Table 10-14 Message_debug_enabledMBean Attribute
Name | Type | Description |
---|---|---|
Message_debug_enabled |
STRING |
Specifies whether or not tracing for Diameter messages processed by this node is enabled. |
None
Node.addPeer_retry_delay()
Peer_retry_delayMBean defines period of time, in seconds, between retries to peer nodes.
Table 10-15 Peer_retry_delayMBean Attribute
Name | Type | Description |
---|---|---|
Peer_retry_delay |
STRING |
Specifies period of time, in seconds, between retries to peer nodes |
None
Node.addAllow_dynamic_peers()
Allow_dynamic_peersMBean defines whether or not dynamic peers are allowed.
Table 10-16 Allow_dynamic_peersMBean Attribute
Name | Type | Description |
---|---|---|
Allow_dynamic_peers |
BOOL |
Specifies whether or not dynamic peers are allowed. Possible values:
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. |
None
Node.addRequest_timeout()
Request_timeoutMBean defines period of time, in milliseconds, that the node has to wait for an answer before timing out.
Table 10-17 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 |
None
Node.addWatchdog_timeout()
Watchdog_timeoutMBean defines period of time, in seconds, for the Diameter Tw watchdog timer.
Table 10-18 Watchdog_timeoutMBean Attribute
Name | Type | Description |
---|---|---|
Watchdog_timeout |
STRING |
Specifies period of time, in seconds, for the Diameter Tw watchdog timer |
None
Node.addInclude_origin_state_id()
Include_origin_state_idMBean defines whether the Origin-State-Id attribute-value pair (AVP) is included in each request.
Table 10-19 Include_origin_state_idMBean Attribute
Name | Type | Description |
---|---|---|
Include_origin_state_id |
BOOL |
Specifies whether the Origin-State-Id attribute-value pair (AVP) is included in each request. Possible values:
|
None
PeerMBean defines a Diameter node in the network which the Signaling Server communicate with. A Diameter node (NodeMBean) defines peer connection for each other Diameter node.
Node.addPeer()
None
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 node's host identity
void removeHost()
Removes an instance of HostMBean
void addAddress()
Adds a new instance of AddressMBean that defines the peer node'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 node
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 defines the peer node's listen address.
Peer.addAddress()
Table 10-20 AddressMBean Attribute
Name | Type | Description |
---|---|---|
Address |
STRING |
Specifies the peer node's listen address (DNS name or IP address) |
None
HostMBean defines the peer node's host identity
Peer.addHost()
Table 10-21 HostMBean Attribute
Name | Type | Description |
---|---|---|
Host |
STRING |
Specifies the peer node's host identity |
None
PortMBean defines the listen port number of the peer node
Peer.addPort()
Table 10-22 PortMBean Attribute
Name | Type | Description |
---|---|---|
Port |
STRING |
Specifies the listen port number of the peer node |
None
ProtocoMBean defines the protocol used to communicate with the peer.
Peer.addProtocol()
Table 10-23 ProtocolMBean Attribute
Name | Type | Description |
---|---|---|
Protocol |
STRING |
Specifies the protocol used to communicate with the peer. Possible values:
Default value: TCP |
None
Watchdog-enabledMBean defines whether or not the peer supports the Diameter Tw watchdog timer interval
Peer.addWatchdog-enabled()
Table 10-24 Watchdog-enabledMBean Attribute
Name | Type | Description |
---|---|---|
WatchdogEnabled |
BOOL |
Specifies whether or not the peer supports the Diameter Tw watchdog timer interval. Possible values:
Default value: False |
None
RouteMBean defines a server to which an IM-OCF forwards a Diameter message with the specified host realm and application ID.
Node.createRoute()
None
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 defined a Diameter interface used.
Node.createRoute()
Table 10-25 Application-idMBean Attribute
Name | Type | Description |
---|---|---|
Application-id |
STRING |
Specifies a Diameter interface. Possible values:
|
None
Default-routeMBean defines a route to use when a request does not match a configured route.
Created automatically
None
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 defines the name of the default route.
Default-route.addName()
Table 10-26 NameMBean Attribute
Name | Type | Description |
---|---|---|
Name |
STRING |
Specifies the name of the default route. |
None
ActionMBean defines an action that the node performs when using the configured route.
Default-route.addAction()
Table 10-27 ActionMBean Attribute
Name | Type | Description |
---|---|---|
Action |
STRING |
Specifies an action that the node performs when using the configured route. Possible values:
Possible values: Local |
None