This command
specifies a peer address for the Diameter endpoint.
Privilege
Security
Administrator, Administrator
Mode
Exec > Global
Configuration > Context Configuration > Diameter Endpoint Configuration
configure > context
context_name
> diameter endpoint
endpoint_name
Entering the above
command sequence results in the following prompt:
[context_name]host_name(config-ctx-diameter)#
Syntax
peer [*] peer_name [*] [ realm realm_name ] [ destination-host-name host_name ] { address ipv4/ipv6_address [ [ load-ratio load_ratio_range ] [ port port_number ] [ connect-on-application-access ] [ send-dpr-before-disconnect disconnect-cause disconnect_cause ] [ sctp ] ] + | fqdn fqdn [ [ port port_number ] [ send-dpr-before-disconnect disconnect-cause disconnect_cause ] [ rlf-template rlf_template_name enable-snmp-traps ] ] }
no peer peer_name [ realm realm_name ]
no
Removes the
specified peer configuration.
[*]
peer_name
[*]
Specifies the peer's
name as an alphanumeric string of 1 through 63 characters that allows
punctuation characters.
The Diameter server
endpoint can
now
be a wildcarded peer name (with * as a valid wildcard character).
Client peers which satisfy the wild-carded pattern are treated as valid peers
and the connection will be accepted. The wildcarded token indicates that the
peer name is wildcarded and any '*' in the preceding string is treated as a
wildcard.
realm
realm_name
Specifies the realm
of this peer as an alphanumeric string of 1 through 127 characters. The realm
name can be a company or service name.
destination-host-name
host_name
Specifies the
destination host name as an alphanumeric string of 1 through 63 characters.
Note that this is an optional keyword.
If a peer is
selected by Diameter base protocol to forward an application request, then the
host name specified through the "destination-host-name " option will be used to
encode the Destination-Host AVP.
This keyword "destination-host-name " is made optional for
backward compatibility. That means, if the destination-host-name is not
specified in the CLI, the peer name itself is copied to the
destination-host-name for backward compatibility.
In releases prior to
17.0, the endpoint configuration allows each SCTP association to be uniquely
identified by a Diameter peer name. But there was a requirement where two SCTP
associations are identified with the same peer name. This kind of reused
peer-name was used by HSS peers which act as Active and Standby HSS nodes. The
SCTP associations in HSS behave in a manner such that one association is always
SCTP active (for the active HSS) while the other SCTP association with the
standby HSS would be closed and would keep flapping. To avoid this scenario and
address customer's requirement, in 17.0 and later releases, this optional
keyword "destination-host-name " has been introduced in the
peer CLI
command to allow multiple unique peers (Diameter HSS servers) to be configured
with the same host name.
With this
enhancement, MME will be capable of provisioning multiple Diameter SCTP
associations to reach the same HSS peer name. This configuration will also
ensure that all the Diameter messages are exchanged properly with the
configured destination host.
Internally the peers
are identified with unique peer-name. But the Origin-host AVP provided by the
server (in CER/CEA/App-msgs) is validated against both peer-name and
destination-host-name provided in the CLI. Even if multiple peers are
responding with same Origin-Host, this can be validated and accepted based on
the CLI configuration.
address
ipv4/ipv6_address
Specifies the
Diameter peer IP address in IPv4 dotted-decimal or IPv6
colon-separated-hexadecimal notation. This address must be the IP address of
the device with which the chassis is communicating.
load-ratio load_ratio_range
Specifies the Load Ratio for the peer. The Load Ratio can be configured in the range of 0 through 65535.
As a default behavior, the CLI command is not enabled for a peer and the default Load Ratio is 1, which will be used in load
balancing only when at least one peer has non-default Load Ratio configured.
Not specifying the load-ratio
load_ratio_range keyword from peer configuration will put the peer in default Load Ratio, and when all the peers have default Load Ratio,
Diameter load balancing will be round robin.
The CLI takes effect when Diameter applications starts using an endpoint for sending messages.
fqdn
fqdn
Specifies the
Diameter peer FQDN as an alphanumeric string of 1 through 127 characters.
port
port_number
Specifies the port
number for this Diameter peer. The port number must be an integer from 1
through 65535.
connect-on-application-access
Activates peer on
first application access.
send-dpr-before-disconnect
Sends
Disconnect-Peer-Request (DPR).
disconnect-cause
Sends
Disconnect-Peer-Request to the specified peer with the specified disconnect
reason. The disconnect cause must be an integer from 0 through 2, for one of
the following:
rlf-template
rlf_template_name
Specifies the RLF
template to be associated with this Diameter peer.
rlf_template_name must be an alphanumeric string
of 1 through 127 characters.
Important |
Rate Limiting
Function (RLF) is a license-controlled feature. A valid feature license must be
installed prior to configuring this feature. Contact your Cisco account
representative for more information.
|
Important |
Peer level RLF
template takes precedence over the endpoint level template.
|
enable-snmp-traps
Enables the
Diameter RLF related SNMP Traps. Skipping this keyword will disable sending of
RLF related traps.
By default, the
Diameter RLF related traps (“over-threshold”, “over-limit” and “normal-state”)
notifications will not be enabled.
This keyword is
meaningful only with a valid RLF template. As such, the command has the
following meaning:
-
rlf-template
rlf_template_name : Use the RLF template. Disable
traps if previously configured.
-
rlf-template
rlf_template_name
enable-snmp-traps
: Use the RLF template and enable traps.
-
Skip the whole
RLF template block from the peer configuration line to detach the RLF from the
peer along with the traps.
sctp
Uses Stream
Control Transmission Protocol (SCTP) for this peer.
+
Indicates that
more than one of the previous keywords can be entered within a single command.
Usage Guidelines
Use this command
to add a peer to the Diameter endpoint.
If the Diameter
server side endpoint is catering to multiple peers, there has to be an entry
for each peer in the peer list for that endpoint.
In cases where the
client like GGSN does not use a diameter proxy, the peer list can be as large
as the number of session managers on a GGSN. This might lead to a very complex
configuration at the Diameter server endpoint.
To simplify the
configurations, the Diameter server endpoint accepts a wildcarded peer name
(with * as a valid wildcard character).
The client peers
which satisfy the wild-carded pattern are treated as valid peers and the
connection will be accepted. The new token 'wildcarded*' indicates that the
peer name is wildcarded and any '*' in the preceding string should be treated
as a wildcard.
For example, if
the peer name is prefixed and suffixed with *ggsn* (* wildcard character) and
an exact match is not found for the peer name portions peers like
0001-sessmgr.ggsn-gx,
0002-sessmgr.ggsn-gx, will be treated as valid peers at
the Diameter server endpoint.
Example
The following
command adds the peer named
test with IP
address
10.1.1.1
using port
126 :
peer test address 10.1.1.1 port 126