| Attributes |
AlphaIndex |
-
alphaIndex
=
ALPHA_1_8TH
-
RTO alpha index.
Retransmission Timeout (RTO) is the value used to determine the duration of T3 retransmission (T3-rtx) timer which is used to detect missing data reception or lost acknowledgements from the peer SCTP EP.
The RTO is determined using a statistical estimator called "recursive prediction error" algorithm, which uses RTT (Round-Trip Time) measurements as input data for the RTO calculation.
For calculation of the current RTO, the statistical estimator uses two variables: SRTT (Smoothed Round-Trip Time) and RTTVAR (Round-Trip Time variation), which are also determined by the measured RTTs.
Detailed description of the rules governing the computation of SRTT, RTTVAR, and RTO are provided in RFC 4960.
If the calculated RTO is less than the value of the minRto parameter, RTO is set to the predetermined minRto value. Also, if the calculated RTO is greater than the value of the maxRto parameter, RTO is set to the predetermined maxRto value.
Specification: RFC 4960, section 6.3.1
|
Ss7CafSctp__SctpProfile_assocMaxRtx |
-
assocMaxRtx
=
4
-
Association maximum number of consecutive unsuccessful retransmissions packets.
Dependencies: primaryPathMaxRtx <= pathMaxRtx <= assocMaxRtx
Specification: RFC 4960
|
BetaIndex |
-
betaIndex
=
BETA_1_4TH
-
RTO beta index.
Retransmission Timeout (RTO) is the value used to determine the duration of T3 retransmission (T3-rtx) timer which is used to detect missing data reception or lost acknowledgements from the peer SCTP EP.
The RTO is determined using a statistical estimator called "recursive prediction error" algorithm, which uses RTT (Round-Trip Time) measurements as input data for the RTO calculation.
For calculation of the current RTO, the statistical estimator uses two variables: SRTT (Smoothed Round-Trip Time) and RTTVAR (Round-Trip Time variation), which are also determined by the measured RTTs.
Detailed description of the rules governing the computation of SRTT, RTTVAR, and RTO are provided in RFC 4960.
If the calculated RTO is less than the value of the minRto parameter, RTO is set to the predetermined minRto value. Also, if the calculated RTO is greater than the value of the maxRto parameter, RTO is set to the predetermined maxRto value.
Specification: RFC 4960, section 6.3.1
|
boolean |
-
bundlingActivated
=
true
-
States whether bundling is allowed for an endpoint.
Bundling is the act of placing more than one chunk within an SCTP packet.
The bundled chunks can be chunks carrying SCTP user's data or chunks caring SCTP control information such as, for example, data reception selective acknowledgement (SACK).
Whether bundling of the DATA chunks occurs depends on the number of DATA chunks available for transmission in the send buffer as well as on whether the Bundling feature is invoked.
True: An endpoint bundles chunks by including multiple chunks in one outbound SCTP packet.
False: Bundling is not used.
Specification: RFC 4960
|
Ss7CafSctp__SctpProfile_bundlingThreshold |
-
bundlingThreshold
=
0
-
Defines a part of MTU in percent which is used by SCTP to decide if bundling should be enabled.
If the parameter value is 0 the adaptive bundling feature will be disabled.
|
Ss7CafSctp__SctpProfile_bundlingTimer |
-
bundlingTimer
=
16
-
Interval during which SCTP buffers data chunks in order to send them bundled in one SCTP packet.
SCTP will buffer data chunks until either of the following occurs:
- The bundling delay time expires.
- The size of buffered data chunks reaches or exceeds the maximum size of the SCTP packet.
In case there are data chunks still buffered after the transmission of a maximum sized SCTP packet, the bundling timer is restarted. Otherwise, if the send buffer is emptied, the bundling timer is stopped and restarted again when the first data chunk is received and buffered for bundling purpose.
For SCTP implementations that implement the Nagle-like algorithm (RFC 6458), upon arrival of a SACK that acknowledges all outstanding data, if the bundling timer is running and data chunks are stored in the send buffer, the bundling delay timer is stopped and the buffered data chunks are bundled and sent in one SCTP packet. Note that Nagle algorithm is specified in RFC 1122.
|
Ss7CafSctp__SctpProfile_cookieLife |
-
cookieLife
=
60
-
Valid cookie life.
A new value of the attribute does not apply to associations that are already established.
Specification: RFC 4960
|
CrossPathsMode |
-
crossPathsMode
=
CONTROLLED_BY_BLOCK_CROSS_PATHS_FLAG
-
Defines Cross Paths mode.
In comparison with Cross to Primary Paths Blocking, Cross Paths modes 1 and 2 have some differences:
- SCTP defines straight and cross paths differently.
- SCTP does not allow user requested HB to be sent through disabled cross path.
- SCTP disables "Use Cross Paths" when the number of IP paths exceeds 16.
|
DnsSupport |
-
dnsSupport
=
NOT_SUPPORTED
-
Defines support of DNS host names.
|
DiffServCategory[0..1] |
-
dscpCategory
-
The reference to "<NodeName>,Transport=1,DiffServCategory=<InstanceName>" to take dscp value from.
The dscp value is applied to all outgoing traffic.
If is not set dscp=64 will be used. It means that SCTP should take this parameter from user requests.
|
YesNo |
-
ecnCapability
=
NO
-
Determines if the support for Explicit Congestion Notification (ECN) is enabled.
A new value of the attribute does not apply to associations that are already established.
|
Ss7CafSctp__SctpProfile_hbMaxBurst |
-
hbMaxBurst
=
0
-
HB.MaxBurst value.
A new value of the attribute does not apply to associations that are already established.
Specification: RFC 4960
|
Ss7CafSctp__SctpProfile_heartbeatInterval |
-
heartbeatInterval
=
30000
-
SCTP heartbeat interval (HB.interval).
Specification: RFC 4960
|
Ss7CafSctp__SctpProfile_heartbeatReductionTimer |
-
heartbeatReductionTimer
=
50
-
Adjusts "Heartbeat Interval" decreasion.
This parameter sets the number of percents on which current "Heartbeat Interval" should be decreased (comparing to current value) with each new HB attempt.
|
Ss7CafSctp__SctpProfile_incCookieLife |
-
incCookieLife
=
0
-
Allowed increment of parameter valid.Cookie.Life in local node.
Applied when an increase of the parameter is requested from the remote node.
Specification: RFC 4960
|
Ss7CafSctp__SctpProfile_initARWnd |
-
initARWnd
=
8192
-
Value of the initial advertised receiver window credit (a_rwnd sent in the INIT message).
The Advertised Receiver Window Credit is the field in INIT, INIT ACK and SACK chunks that indicates the current available space in the receiver buffer for a specific association.
The a_rwnd is at all times equal to or less than the total allocated size of the receiver buffer for specific association.
During lifetime of association, receiver buffer space advertised by a_rwnd in INIT or INIT ACK chunks can only be decreased due to received DATA (and not due to some administrative, configuration or management actions). However, it can be increased by configuration management actions.
A new value of the attribute does not apply to associations that are already established.
|
Ss7CafSctp__SctpProfile_initialHeartbeatInterval |
-
initialHeartbeatInterval
=
5000
-
Period for acceptance of a heartbeat acknowledge message during path probing.
It limits the intensity of heartbeats for path probing after association start-up.
|
Ss7CafSctp__SctpProfile_initRto |
-
initRto
=
400
-
RTO initial value.
Retransmission Timeout (RTO) is the value used to determine the duration of T3 retransmission (T3-rtx) timer which is used to detect missing data reception or lost acknowledgements from the peer SCTP EP.
The RTO is determined using a statistical estimator called "recursive prediction error" algorithm, which uses RTT (Round-Trip Time) measurements as input data for the RTO calculation.
For calculation of the current RTO, the statistical estimator uses two variables: SRTT (Smoothed Round-Trip Time) and RTTVAR (Round-Trip Time variation), which are also determined by the measured RTTs.
Detailed description of the rules governing the computation of SRTT, RTTVAR, and RTO are provided in RFC 4960.
If the calculated RTO is less than the value of the minRto parameter, RTO is set to the predetermined minRto value. Also, if the calculated RTO is greater than the value of the maxRto parameter, RTO is set to the predetermined maxRto value.
A new value of the attribute does not apply to associations that are already established.
Dependencies: minRto <= initRto <= maxRto
Specification: RFC 4960
|
Ss7CafSctp__SctpProfile_ipv6Pmtu |
-
ipv6Pmtu
=
1460
-
Maximum size of the SCTP PDU for IPv6 paths.
This is the size of IP MTU without underlying overhead like regular IPv6 header, eVIP overhead, IPsec, etc.
For example, if vNIC MTU is 1500, then this parameter shall be calculated: if eVIP is not used, 1500 - 40 = 1460; if eVIP is used, 1500 - 48 - 40 = 1412; where 40 is the size of regular IPv6 header and 48 is the size of eVIP overhead.
If this parameter is set to zero, MTU size will be retrieved from network interface (which corresponds to the used IP address) and SCTP PDU size will be calculated as MTU minus regular IPv6 header size.If eVIP is configured, the network interface will be eVIP ALB interface, and eVIP overhead is already subtracted from its MTU value. Setting this parameter to zero requires the parameter maxSctpPduSize to be also set to zero. Zero value cannot be used if Sctp.pmtudAccuracy parameter has non-zero value (if PMTU discovery is activated).
|
Ss7CafSctp__SctpProfile_maxActivateThr |
-
maxActivateThr
=
1
-
Maximum number of consecutive successful heartbeats.
It must be sent over the data transfer path (DTP) before switchback can be performed.
Dependencies: maxActivateThr <= minActivateThr
|
Ss7CafSctp__SctpProfile_maxBurst |
-
maxBurst
=
4
-
Maximum number of burst packets (Max.Burst).
Specification: RFC 4960
|
Ss7CafSctp__SctpProfile_maxInitRt |
-
maxInitRt
=
8
-
Maximum number of retransmissions allowed for both INIT and COOKIE_ECHO chunks.
|
Ss7CafSctp__SctpProfile_maxInStreams |
-
maxInStreams
=
17
-
Maximum number of inbound streams for an association.
A Stream is a unidirectional logical channel established between two SCTP EPs, within which all user messages are delivered in sequence except for those submitted to the unordered delivery service.
At SCTP association establishment the SCTP EPs negotiate the number of Streams used in each direction within the SCTP association.
Specification: RFC 4096
|
Ss7CafSctp__SctpProfile_maxOutStreams |
-
maxOutStreams
=
17
-
Maximum number of outbound streams for an association.
A Stream is a unidirectional logical channel established between two SCTP EPs, within which all user messages are delivered in sequence except for those submitted to the unordered delivery service.
At SCTP association establishment the SCTP EPs negotiate the number of Streams used in each direction within the SCTP association.
Specification: RFC 4960
|
Ss7CafSctp__SctpProfile_maxRto |
-
maxRto
=
1000
-
RTO.Max according in milliseconds.
Retransmission Timeout (RTO) is the value used to determine the duration of T3 retransmission (T3-rtx) timer which is used to detect missing data reception or lost acknowledgements from the peer SCTP EP.
The RTO is determined using a statistical estimator called "recursive prediction error" algorithm, which uses RTT (Round-Trip Time) measurements as input data for the RTO calculation.
For calculation of the current RTO, the statistical estimator uses two variables: SRTT (Smoothed Round-Trip Time) and RTTVAR (Round-Trip Time variation), which are also determined by the measured RTTs.
Detailed description of the rules governing the computation of SRTT, RTTVAR, and RTO are provided in RFC 4960.
If the calculated RTO is less than the value of the minRto parameter, RTO is set to the predetermined minRto value. Also, if the calculated RTO is greater than the value of the maxRto parameter, RTO is set to the predetermined maxRto value.
Dependencies: minRto <= initRto <= maxRto
minRto < maxRto
Specification: RFC 4960
|
Ss7CafSctp__SctpProfile_maxSctpPduSize |
-
maxSctpPduSize
=
1480
-
Maximum size of the SCTP PDU.
This is the size of IP MTU without underlying overhead like regular IPv4 header, eVIP overhead, IPsec, etc.
For example, if vNIC MTU is 1500, then this parameter shall be calculated as: if eVIP is not used, 1500 - 20 = 1480; if eVIP is used, 1500 - 48 - 20 = 1432; where 20 is the regular IPv4 header size and 48 is the eVIP overhead size.
If this parameter is set to zero, MTU size will be retrieved from network interface (which corresponds to the used IP address) and SCTP PDU size will be calculated as MTU minus regular IPv4 header size. If eVIP is configured, the network interface will be eVIP ALB interface, and eVIP overhead is already subtracted from its MTU value. Setting this parameter to zero requires the parameter ipv6Pmtu to be also set to zero. Zero value cannot be used if Sctp.pmtudAccuracy parameter has non-zero value (if PMTU discovery is activated).
|
Ss7CafSctp__SctpProfile_maxShutdownRt |
-
maxShutdownRt
=
5
-
Maximum number of retransmissions during the shutdown phase of an association.
|
Ss7CafSctp__SctpProfile_minActivateThr |
-
minActivateThr
=
1
-
Minimum initial number of consecutive successful heartbeats before switchback can be performed.
The minimum and initial value for the number of consecutive successful heartbeats which must be sent over the data transfer path (DTP) before switchback can be performed.
Dependencies: maxActivateThr <= minActivateThr
|
Ss7CafSctp__SctpProfile_minRto |
-
minRto
=
30
-
The minimum allowed value for Retransmission Time-Out.
The default value is platform specific.
Dependencies: minRto <= initRto <= maxRto
minRto < maxRto
|
boolean |
-
noSwitchback
=
false
-
Recovery of the failed Primary Path does not invoke change of the (current) data transfer path.
True: No switchback.
False: Switchback.
|
Ss7CafSctp__SctpProfile_pathMaxRtx |
-
pathMaxRtx
=
2
-
Maximum number of consecutive retransmissions on an IP path.
An IP Path is the route in an IP network taken by SCTP packets from a sender to a receiver.
In Ericsson's implementation an IP path is defined by an IP address of the sender and an IP address of the receiver.
The number of paths between two multi-homed SCTP EPs is the number of combinations of IP addresses between the two SCTP EPs.
Dependencies: primaryPathMaxRtx <= pathMaxRtx <= assocMaxRtx
|
boolean |
-
primaryPathAvoidance
=
false
-
Whether SCTP can avoid primary path usage when it didn't work for the latest transmission.
True: Enable functionality.
False: Disable functionality.
|
Ss7CafSctp__SctpProfile_primaryPathMaxRtx |
-
primaryPathMaxRtx
=
0
-
Maximum value of the error counter of the current primary path in case of enabled PPA.
In case of enabled Primary Path Avoidance(PPA), if the error counter of the primary path exceeds this value, SCTP will chooses another current primary path.
Dependencies: primaryPathMaxRtx <= pathMaxRtx <= assocMaxRtx
|
ManagedObject[0..]
readOnly |
-
reservedBy
-
Server part for BiDirAssociation to deprecate SctpProfile MOs deletion if any MO used this.
|
Ss7CafSctp__SctpProfile_sackTimer |
-
sackTimer
=
40
-
Time delay for sending the Selective Acknowledgement (SACK).
Time is measured from reception of the DATA chunk to sending of the SACK chunk.
|
ProfileId
key
mandatory
noNotification
restricted |
-
sctpProfileId
-
Value component of the RDN.
|
Ss7CafSctp__SctpProfile_smoothFactor |
-
smoothFactor
=
50
-
Allows to smooth heartbeat messages in time.
It is recommended to setup un-zero smooth factor if a lot of associations could be started at the same time. Smoothed heartbeats allow to avoid unexpected impact on traffic flow.
|
Ss7CafSctp__SctpProfile_thrTransmitBuffer |
-
thrTransmitBuffer
=
32
-
Threshold of the transmit buffer size.
Upon exceeding this threshold the user of SCTP will be asked to stop sending data. This condition will persist until the occupancy of the transmit buffer drops below thrTransmitBufferCongCeased * thrTransmitBuffer. For description of thrTransmitBufferCongCeased see description of thrTransmitBufferCongCeased attribute.
Dependencies: thrTransmitBuffer<=transmitBufferSize
|
Ss7CafSctp__SctpProfile_thrTransmitBufferCongCeased |
-
thrTransmitBufferCongCeased
=
85
-
Size of threshold of the transmit buffer in percentage when congestion cease indication is sent.
See also description of attribute thrTransmitBuffer.
|
Ss7CafSctp__SctpProfile_transmitBufferSize |
-
transmitBufferSize
=
42
-
Also known as "M".
Recommended value: pmtu * 15. Sets the size of the buffer used to store user-data pending to send or retransmit in an association, i.e. establish the maximum amount of data that SCTP shall store before discarding user messages.
Dependencies: thrTransmitBuffer<=transmitBufferSize
|
YesNo |
-
useHeartbeat
=
YES
-
States whether heartbeat is activated.
YES: Activates heartbeats for SCTP endpoint.
NO: Disables heartbeats for SCTP endpoint.
Specification: RFC 4960
|
string[0..1] |
-
userLabel
=
""
-
Label for free use.
|