![]() ![]() ![]() ![]() ![]() ![]() |
The following sections provide a complete reference to the Diameter configuration file, diameter.xml
:
The diameter.xml
file configures attributes of a Diameter node, such as:
The Diameter protocol implementation reads the configuration file at boot time. diameter.xml
is stored in the DOMAIN_DIR/config/custom
subdirectory where DOMAIN_DIR
is the root directory of the WebLogic SIP Server domain.
Figure 3-1 shows the element hierarchy of the diameter.xml
file.
You should never move, modify, or delete the diameter.xml
file during normal operations.
BEA recommends using the Administration Console to modify diameter.xml
indirectly, rather than editing the file by hand. Using the Administration Console ensures that the diameter.xml
document always contains valid XML.
You may need to manually view or edit diameter.xml
to troubleshoot problem configurations, repair corrupted files, or to roll out custom Diameter node configurations to a large number of machines when installing or upgrading WebLogic SIP Server. When you manually edit diameter.xml
, you must reboot Diameter nodes to apply your changes.
WARNING: | Always use the Diameter node in the Administration Console or the WLST utility, as described in Configuring Engine Tier Container Properties in the Configuration Guide to make changes to a running WebLogic SIP Server deployment. |
If you need to modify diameter.xml
on a production system, follow these steps:
/config/custom/diameter.xml
file, where DOMAIN_DIR
is the root directory of the WebLogic SIP Server domain.diameter.xml
file as necessary. See XML Element Description for a full description of the XML elements.WARNING: | Always use the Diameter node in the Administration Console or the WLST utility, as described in Configuring Engine Tier Container Properties in the Configuration Guide, to make changes to a running WebLogic SIP Server deployment. |
The full schema for the diameter.xml
file is available at
http://www.bea.com/ns/wlcp/diameter.xsd. The schema for the applications
element is available at
http://www.bea.com/ns/wlcp/diameter_app.xsd.
Both schema files are also bundled within the wlssdiameter.jar
library, installed in the WL_HOME/server/lib/wlss
directory.
See
Configuring Diameter Sh Client Nodes and Relay Agents in Configuring Network Resources for multiple listings of example diameter.xml
configuration files.
The following sections describe each XML element in diameter.xml
.
The top level configuration
element contains the entire diameter node configuration.
Specifies one or more target WebLogic SIP Server instances to which the node configuration is applied. The target servers must be defined in the config.xml
file for your domain.
Specifies the host identity for this Diameter node. If no host
element is specified, the identity is taken from the local server's host name. Note that the host identity may or may not match the DNS name.
Note: | When configuring Diameter support for multiple Sh client nodes, it is best to omit the host element from the diameter.xml file. This enables you to deploy the same Diameter Web Application to all servers in the engine tier cluster, and the host name is dynamically obtained for each server instance. |
Specifies the realm name for which this Diameter node has responsibility. You can run multiple Diameter nodes on a single host using different realms and listen port numbers. The HSS, Application Server, and relay agents must all agree on a realm name or names. The realm name for the HSS and Application Server need not match.
If you omit the realm
element, the realm named is derived using the domain name portion of the host name, if the host name is fully-qualified (for example, host@bea.com).
Specifies the listen address for this Diameter node, using either the DNS name or IP address. If you do not specify an address, the node uses the host
identity as the listen address.
Note: | The host identity may or may not match the DNS name of the Diameter node. BEA recommends configuring the address element with an explicit DNS name or IP address to avoid configuration errors. |
Specifies the TCP or TLS listen port for this Diameter node. The default port is 3868.
This element is used only for standalone node operation to advertise TLS capabilities.
WebLogic SIP Server ignores the tls-enabled
element for nodes running within a server instance. Instead, TLS transport is reported as enabled if the server instance has configured a Network Channel having TLS support (a diameters channel). See
Creating Network Channels for the Diameter Protocol in Configuring Network Resources.
This element is used only for standalone node operation to advertise SCTP capabilities.
WebLogic SIP Server ignores the sctp-enabled
element for nodes running within a server instance. Instead, SCTP transport is reported as enabled if the server instance has configured a Network Channel having SCTP support (a diameter-sctp channel). See
Creating Network Channels for the Diameter Protocol in Configuring Network Resources.
Specifies a boolean value to enable or disable debug message output. Debug messages are disabled by default.
Specifies a boolean value to enable or disable tracing of Diameter messages. This element is disabled by default.
Configures a particular Diameter application to run on the selected node. WebLogic SIP Server includes applications to support nodes that act as Diameter Sh, Ro, and Rf clients, Diameter relay agents, or Home Subscriber Servers (HSS). Note that the HSS application is a simulator that is provided only for development or testing purposes.
Specifies the application class file to load.
Specifies one or more optional parameters to pass to the application class.
Specifies the name of the application parameter.
Specifies the value of the parameter.
Specifies the number of seconds this node waits between retries to Diameter peers. The default value is 30 seconds.
Specifies a boolean value that enables or disables dynamic peer configuration. Dynamic peer support is disabled by default. BEA recommends enabling dynamic peers only when using the TLS transport, because no access control mechanism is available to restrict hosts from becoming peers.
Specifies the number of milliseconds to wait for an answer from a peer before timing out.
Specifies the number of seconds used for the Diameter Tw watchdog timer.
Specifies whether the node should include the origin state AVP in requests and answers.
Specifies connection information for an individual Diameter peer. You can choose to configure connection information for individual peer nodes, or allow any node to be dynamically added as a peer. BEA recommends using dynamic peers only if you are using the TLS transport, because there is no way to filter or restrict hosts from becoming peers when dynamic peers are enabled.
When configuring Sh client nodes, the peers
element should contain peer definitions for each Diameter relay agent deployed to your system. If your system does not use relay agents, you must include a peer entry for the Home Subscriber Server (HSS) in the system, as well as for all other engine tier nodes that act as Sh client nodes.
When configuring Diameter relay agent nodes, the peers
element should contain peer entries for all Diameter client nodes that access the peer, as well as the HSS.
Specifies the host identity for a Diameter peer.
Specifies the listen address for a Diameter peer. If you do not specify an address, the host identity is used.
Specifies the TCP or TLS port number for this Diameter peer. The default port is 3868.
Specifies the protocol used by the peer. This element may be one of tcp
or sctp
.
Defines a realm-based route that this node uses when resolving messages.
When configuring Sh client nodes, you should specify a route to each Diameter relay agent node deployed in the system, as well as a default-route
to a selected relay. If your system does not use relay agents, simply configure a single default-route
to the HSS.
When configuring Diameter relay agent nodes, specify a single default-route
to the HSS.
The target realm used by this route.
The target application ID for the route.
An action type that describes the role of the Diameter node when using this route. The value of this element can be one of the following:
Specifies one or more target servers for this route. Note that any server specified in the server
element must also be defined as a peer
to this Diameter node, or dynamic peer support must be enabled.
Defines a default route to use when a request cannot be matched to a configured route.
Specifies the default routing action for the Diameter node. See action.
Specifies one or more target servers for the default route. Any server you include in this element must also be defined as a peer
to this Diameter node, or dynamic peer support must be enabled.
![]() ![]() ![]() |