Overview Package Class Deprecated Help

diameter
DiameterPeer

A diameter peer defined within a diameter policy. A node can establish a Diameter connection towards such a peer using the policy's configuration and the peer's configuration.

public class DiameterPeer

Stats:
diameter.DiameterPeerStatistics diameter.DiameterPeerStats

Properties
adminState The administrative state of this peer

type=generic.EnabledDisabled
default=disabled
Displayed(tab/group)=Administrative State
connSuspended Indicates whether the peer's Diameter connection that is in I-Open state has been temporarily put on suspension.

type=generic.TruthValue
access=read-only
default=false
Displayed(tab/group)=Connection Suspended (State)
connTimeLeft Indicates the current countdown progress of the Diameter peer's connection timer.

type=long
access=read-only
default=0
units=seconds
Displayed(tab/group)=Connection Time Remaining (State)
connectionTimer Specifies the connection timer (wait time before attempting reconnect to peer after connection was lost) used on all connections by this peer. If property is set to 0 (zero) the peer will use the value defined in the peer's Diameter policy connectionTimer property.

type=int
default=0
minimum=0
maximum=1000
units=seconds
Displayed(tab/group)=Connection Timer (/Timers)
cooldownActive Indicates whether the Diameter Cooldown Sequence is currently running.

type=generic.TruthValue
access=read-only
default=false
Displayed(tab/group)=Active (State/Cooldown)
cooldownPending Indicates whether the Diameter peer's connection manages to get in a non-suspended I-Open state.

type=generic.TruthValue
access=read-only
default=false
Displayed(tab/group)=Pending (State/Cooldown)
cooldownStage While the value of tmnxDiamPeerCooldownSeqActive is 'true', the value of tmnxDiamPeerCooldownSeqStage indicates the current stage of the cooldown sequence.

type=diameter.CooldownStage
access=read-only
default=0
Displayed(tab/group)=Stage (State/Cooldown)
destHost Value of Destination-Host AVP (Attribute Value Pair)

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Destination Host (/AVP Values)
destRealm Value of Destination-Realm AVP (Attribute Value Pair)

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Destination Realm (/AVP Values)
peerAddress Specifies the IP address of this peer

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Peer IP Address
peerAddressType Specifies the address type of the peer

type=rtr.InetAddressType
access=read-only
default=ipv4
peerOrder Indicates the runtime order of the Diameter policy's peers. It is determined both by the configuration level preference and other runtime conditions. A value of zero indicates this field is currently not applicable for this peer.

type=long
access=read-only
default=0
Displayed(tab/group)=Peer Order (State)
pendingMsgsPMQ Indicates the number of request messages in the Pending Message Queue waiting to be matched with the corresponding answer messages from the server.

type=long
access=read-only
default=0
Displayed(tab/group)=Request Messages in the Pending Message Queue (State)
preference Specifies the preference given to this peer with respect to the other peers associated with the same Diameter policy. If multiple peers are available for this policy, only the available peer with the highest preference will be used. If multiple peers with the same preference are available, one of them will be used. The highest preference is specified by the value '1'.

type=int
default=50
minimum=1
maximum=100
Displayed(tab/group)=Preference
priSec Indicates the runtime order of the Diameter policy's peers. It is determined both by the configuration level preference and other runtime conditions. A value of None indicates this field is currently not applicable for this peer.

type=diameter.PriSecType
access=read-only
default=none
Displayed(tab/group)=Primary/Secondary (State)
removePending Indicates whether the execution of a Diameter peer's removal is still pending until the disconnect-peer roundtrip has finished.

type=generic.TruthValue
access=read-only
default=false
Displayed(tab/group)=Removal Pending (State)
state Indicates the current state of the Diameter peer's state machine.

type=diameter.PeerState
access=read-only
default=closed
Displayed(tab/group)=State (State)
stateLastUpdate Indicates the last time the state and operational values were updated.

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Updated (State/Time)
transTimeLeft Indicates the current countdown progress of the Diameter peer's transaction timer.

type=long
access=read-only
default=0
units=seconds
Displayed(tab/group)=Transaction Time Remaining (State)
transactionTimer Specifies the transaction timer (wait time for an answer from peer after sending request) used on all connections by this peer. If property is set to 0 (zero) the peer will use the value defined in the peer's Diameter policy transactionTimer property.

type=int
default=0
minimum=0
maximum=1000
units=seconds
Displayed(tab/group)=Transaction Timer (/Timers)
transportPort Specifies the port number used towards this peer

type=int
default=3868
minimum=1
maximum=65535
Displayed(tab/group)=Port Number (/Transport)
transportProtocol Specifies the transport protocol used towards this peer

type=diameter.PeerTransportProtocol
default=tcp
Displayed(tab/group)=Protocol (/Transport)
watchdogActive Indicates whether the Diameter application-layer watchdog algorithm is currently running.

type=generic.TruthValue
access=read-only
default=false
Displayed(tab/group)=Active (State/Watchdog)
watchdogAnsPend Indicates whether reception of a Diameter Device Watchdog Answer (DWA) is expected for a corresponding Device Watchdog Request (DWR) waiting in the Pending Message Queue (PMQ).

type=generic.TruthValue
access=read-only
default=false
Displayed(tab/group)=Answer Pending (State/Watchdog)
watchdogTimeLeft Indicates the current countdown progress of the Diameter peer's watchdog timer.

type=long
access=read-only
default=0
units=seconds
Displayed(tab/group)=Time Remaining (State/Watchdog)
watchdogTimer Specifies the device/client watchdog timer used on all connections by this peer. If property is set to 0 (zero) the peer will use the value defined in the peer's Diameter policy watchdogTimer property.

type=int
default=0
minimum=0
maximum=1000
units=seconds
Displayed(tab/group)=Watchdog Timer (/Timers)
 
Overridden Properties
displayedName The name of the peer

access=read-create
minimum=1
maximum=32
 
Properties inherited from policy.PolicyItemDefinition
containingPolicyDisplayedName, containingPolicyId
 
Properties inherited from policy.PolicyObject
description, displayedName, globalPolicy, id, isLocal, policyType, siteId, siteName, templateObject
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Supported Network Elements
7450 ESS Supported from 8.0.R4
7750 SR Supported from 8.0.R4
7705 SAR Gen 2
7705 SAR Hm
Product Specifics
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7705 SAR Gen 2 25.0
7705 SAR Hm 20.0
7705 SAR Hm 21.0
7705 SAR Hm 22.0
7705 SAR Hm 23.0
7705 SAR Hm 24.0
7705 SAR Hm 25.0
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0