This section describes Transaction Language 1 (TL1) commands related to Signaling Gateway (SG).
SG Command Groupings
The following figure lists the SG objects that can be configured using TL1 commands.
This section includes the information for the SG command set.
SG Configuration
CHG-SIGGW
CHG-SIGGW:::[CTAG]:::::[SG_DEBUG_LEVEL=<epx_log_level>],[SCTP_DEBUG_LEVEL=<int>],[LDL_DEBUG_LEVEL=<int>],[NPEER_DEBUG_LEVEL=<int>],[DB_ERROR=<FeatureBoolean>],[DB_MGMT=<FeatureBoolean>],[DB_FILE_MGMT=<FeatureBoolean>],[AS_MSTR_DBG=<FeatureBoolean>],[MSA_DBG=<FeatureBoolean>];
SET-SIGGW
SET-SIGGW:::[CTAG]:::[RESTORE_DBG];
VFY-SIGGW
VFY-SIGGW:::[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
:::<SG_DEBUG_LEVEL=epx_log_level>,<SCTP_DEBUG_LEVEL=int>,<LDL_DEBUG_LEVEL=int>,<NPEER_DEBUG_LEVEL=int>,<DB_ERROR=FeatureBoolean>,<DB_MGMT=FeatureBoolean>,<DB_FILE_MGMT=FeatureBoolean>,<AS_MSTR_DBG=FeatureBoolean>,<MSA_DBG=FeatureBoolean>,<SLOT=string>;
Attribute Details
SG_DEBUG_LEVEL - SG Debug Level
Permission: Writeable
Type: epx_log_level={NONE,CRITICAL,MAJOR,MINOR,LOG,INFO}
Description: Signaling Gateway logging level
SCTP_DEBUG_LEVEL - SCTP Debug Level
Permission: Writeable
Type: int
Description: SCTP logging level
LDL_DEBUG_LEVEL - LDL Debug Level
Permission: Writeable
Type: int
Description: LDL logging level
NPEER_DEBUG_LEVEL - NPeer Debug Level
Permission: Writeable
Type: int
Description: NPeer logging level
DB_ERROR - DB Error
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Binary DB Error Logging
DB_MGMT - DB Mgmt
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Binary DB Management
DB_FILE_MGMT - DB File Mgmt
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Binary DB File Management
AS_MSTR_DBG - AS Master Debug
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: AS Master Debug Management
MSA_DBG - MSA Debug
Permissions: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: MSA Debug Management
SLOT - Active Slot
Permission: Read-only
Type: string
Description: Slot running the SG
M3UA
CHG-M3UA
CHG-M3UA:::[CTAG]:::::[PENDING_TIMER=<PendingTimer>],[IMF=<FeatureBoolean>],[SCTP_PROTO_ID_VAL=<FeatureBoolean>],[AS_MASTER_TMR=<int>],[AS_MSTR_PENDING_TMR=
<ASMasterPendingTimer>],[MAX_CAP=<int>],[HU_ONSET=<Percent>],[HU_ABATE=<Percent>];
SET-M3UA
SET-M3UA:::[CTAG]:::[START/STOP];
VFY-M3UA
VFY-M3UA:::[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
:::<PENDING_TIMER=PendingTimer>,<IMF=FeatureBoolean>,<SCTP_PROTO_ID_VAL=FeatureBoolean>,<AS_MASTER_TMR=int>,<AS_MSTR_PENDING_TMR=ASMasterPendingTimer>,<MONITOR=FeatureBoolean>,<MAX_CAP=int>,<HU_ONSET=Percent>,<HU_ABATE=Percent>,<INT_SECS=int>;
Attribute Details
PENDING_TIMER - Pending Timer
Permission: Writeable
Type: PendingTimer={DISABLED, 1 to 2000} (Range: [0..2000])
Description: Duration of PENDING state in msecs for an M3UA AS. Pending timer is started when an AS transitions out of ACTIVE state. If an ASP sends an ASPAC before the timer expires, the AS will immediately transition back to the ACTIVE status. Otherwise, when the timer expires the AS will either transition to INACTIVE or DOWN state. This timer is used by all M3UA AS of type other than AS Master. Messages will be queued while in PENDING state. Valid range of this timer is 1 to 2000. To disable the timer, set to 0. Default value is 2000 msecs.
IMF - IMF Support
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Integrated Monitoring Feed feature support for M3UA. IMF must be licensed to enable this attribute.
SCTP_PROTO_ID_VAL - SCTP Protocol ID Validation
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Validation of protocol ID of received data. When enabled, the SG will discard all M3UA messages that do not have an SCTP Protocol ID of either 0 or 3 as described in RFC 4666. When disabled, the SG will not inspect the SCTP protocol ID and accept all M3UA messages.
AS_MASTER_TMR - AS Master Timer
Permission: Writeable
Type: int(Range: [10..300])
Description: Amount of time (in seconds) all AS of type AS Master must be in ACTIVE state before the SONUS_C20 Application ID is registered with MTP3. This feature ensures a more stable system start-up procedure for SP2000 deployments as MTP3 links, based on link type, will only initiate alignment or clear local processor outage on the SONUS_C20 Application ID registration. Following AS Master recovery due to maintenance or connection loss beyond the AS Master Pending Timer, the MTP3 links will remain unavailable (out of service or processor outage) until this timer expires and SONUS_C20 registration is triggered. Valid values: 10 to 300 seconds. Default value: 60 seconds.
AS_MSTR_PENDING_TMR - AS Master Pending Timer
Permission: Writeable
Type: ASMasterPendingTimer={DISABLED, 1 to 120000} (Range: [0..120000])
Description: Duration of PENDING state in msecs for an M3UA AS of type AS Master. Pending timer is started when an AS of transitions out of ACTIVE state. If an ASP sends an ASPAC before the timer expires, the AS will immediately transition back to the ACTIVE status. Otherwise, when the timer expires the AS will either transition to INACTIVE or DOWN state. Messages bound for an AS, of type AS Master, during PENDING state will not be queued. To disable the timer, set to 0. Valid values: 0 to 120000 milliseconds. Default value: 30000 msecs.
MONITOR - Monitoring
Permission: Read-only
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Monitoring feature (ENABLED/DISABLED).
MAX_CAP - Association Capacity
Type: int(Range: [0..2.14748e+09])
Description: Bandwidth of SCTP association. Number of bytes per second support by association.
HU_ONSET - High Usage Onset
Type: Percent={DEFAULT, 0 to 100} (Units: %)
Description: Traffic level at which high usage alarms are triggered. (% of association capacity). This setting is used for both the transmit and receive high usage alarms for SCTP associations used by M3UA ASPs. The alarm is automatically cleared when traffic levels fall below the High Usage Abatement setting.
HU_ABATE - High Usage Abatement
Type: Percent={DEFAULT, 0 to 100} (Units: %)
Description: Traffic level at which high usage alarms are cleared. (% of association capacity). This setting is used for both the transmit and receive high usage alarms for SCTP associations used by M3UA ASPs.
USAGE_LOWER - Usage Lower Threshold
Permission: Writeable
Type: Percent={DEFAULT, 0 to 100} (Units: %)
Description: Percentage of the lower threshold for logging.
USAGE_UPPER - Usage Upper Threshold
Permission: Writeable
Type: Percent={DEFAULT, 0 to 100} (Units: %)
Description: Percentage of the upper threshold for logging.
INT_MINS - Usage Interval Minutes
Permission: Writeable
Type: int
Description: Interval in minutes used to calculate average traffic load.
INT_SECS - Usage Interval Seconds
Permission: Read-only
Type: int
Description: Interval in seconds used to calculate average traffic load.
M3UA App Server
DLT-M3UA-APPSRV
DLT-M3UA-APPSRV::[<M3UA App Server/Routing Context>]:[CTAG];
ADD-M3UA-APPSRV
ADD-M3UA-APPSRV::[<M3UA App Server/Routing Context>]:[CTAG]:::::[NA=<int>],[DPC=<pointcode>],[SI=<int>],[TRAFFIC_MODE=<TrafficMode>],[AI=<string>];
SET-M3UA-APPSRV
SET-M3UA-APPSRV::[<M3UA App Server/Routing Context>]:[CTAG]:::[GO_ONLINE];
CHG-M3UA-APPSRV
CHG-M3UA-APPSRV::[<M3UA App Server/Routing Context>]:[CTAG]:::::[ASP_TYPE=<ASPType>];
VFY-M3UA-APPSRV
VFY-M3UA-APPSRV::[<M3UA App Server/Routing Context>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<M3UA App Server/Routing Context>]:<RC=int>,<NA=int>,<DPC=pointcode>,<SI=int>,<TRAFFIC_MODE=TrafficMode>,<AI=string>,<ASP_TYPE=ASPType>,<STATUS=StatusAS>;
AID Description
Routing Context - Position 1
Type: int (Range [1...2.14748e+09])
Description: M3UA AS Routing context.
Attribute Details
RC - Routing Context
Permissions: Createable
Type: int(Range: [1..2.14748e+09])
Description: M3UA AS Routing context.
NA - Network Appearance
Permission: Createable
Type: int
Description: M3UA AS Network appearance.
DPC - DPC
Permission: Createable
Type: pointcode
Description: Point Codes are set to UNSET when routing on Application ID is configured
SI - SI
Permission: Createable
Type: int
Description: SIs are set to 0 when routing on Application ID is configured
TRAFFIC_MODE - Traffic Mode
Permission: Createable
Type: TrafficMode={OVERRIDE,LOADSHARE,BROADCAST}
Description: M3UA Application Server Traffic Mode. Traffic modes, override, loadshare and broadcast are supported.
AI - Application ID
Permission: Createable
Type: string
Description: M3UA AS Application ID (optional).
ASP_TYPE - ASP Type
Permission: Writeable
Type: ASPType={SINGLE ASSOCIATION,MULTI ASSOCIATION,AS MASTER}
Description: ASP Type can be set to SINGLE/MULTI ASSOCIATION as long the AS is not online
STATUS - Status
Permission: Read-only
Type: StatusAS={ACTIVE,INACTIVE,PENDING REG,DOWN,OFF LINE,PENDING}
Description: M3UA AS Status.
M3UA OPC CIC Range
DLT-M3UA-CICRANGE
DLT-M3UA-CICRANGE::[<M3UA App Server/Routing Context>]-[<M3UA OPC CIC Range/OPC>-<M3UA OPC CIC Range/CIC Minimum>-<M3UA OPC CIC Range/CIC Maximum>]:[CTAG];
ADD-M3UA-CICRANGE
ADD-M3UA-CICRANGE::[<M3UA App Server/Routing Context>]-[<M3UA OPC CIC Range/OPC>-<M3UA OPC CIC Range/CIC Minimum>-<M3UA OPC CIC Range/CIC Maximum>]:[CTAG];
VFY-M3UA-CICRANGE
VFY-M3UA-CICRANGE::[<M3UA App Server/Routing Context>]-[<M3UA OPC CIC Range/OPC>-<M3UA OPC CIC Range/CIC Minimum>-<M3UA OPC CIC Range/CIC Maximum>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<M3UA App Server/Routing Context>]-[<M3UA OPC CIC Range/OPC>-<M3UA OPC CIC Range/CIC Minimum>-<M3UA OPC CIC Range/CIC Maximum>]:<OPC=pointcode>,<CIC_MIN=UndefinedCIC>,<CIC_MAX=UndefinedCIC>;
AID Description
OPC - Position 1
Type: pointcode
Description: The OPC is an optional parameter which is used to augment M3UA Routing Keys. The addition of an OPC or a list of OPCs enables a Routing Key to be created where by an ASP can restrict the traffic it receives to only come from those originators listed. Please Note that if an OPC is configured then the ASP will not receive traffic from any other originating point codes.
CIC Minimum - Position 2
Type: UndefinedCIC={UNDEFINED, 0 to 65535}
Description: The Maximum CIC value is used in conjunction with the Minimum CIC value in order to augment the M3UA Routing Key to which the CIC range belongs. The range allows the ASP to restrict the traffic that it will receive to only that for those circuits included in the configured CIC ranges
CIC Maximum - Position 3
Type: UndefinedCIC={UNDEFINED, 0 to 65535}
Description: Maximum CIC value (optional if OPC defined).
Attribute Details
OPC - OPC
Permission: Createable
Type: pointcode
Description: The OPC is an optional parameter which is used to augment M3UA Routing Keys. The addition of an OPC or a list of OPCs enables a Routing Key to be created where by an ASP can restrict the traffic it recieves to only come from those originators listed. Please Note that if an OPC is configured then the ASP will not receive traffic from any other originating point codes.
CIC_MIN - CIC Minimum
Permission: Createable
Type: UndefinedCIC={UNDEFINED, 0 to 65535}
Description: The Minimum CIC value is used in conjunction with the Maximum CIC value in order to augment the M3UA Routing Key to which the CIC range belongs. The range allows the ASP to restrict the traffic that it will receive to only that traffic for those circuits included in the configured CIC ranges.
CIC_MAX - CIC Maximum
Permission: Createable
Type: UndefinedCIC={UNDEFINED, 0 to 65535}
Description: The Maximum CIC value is used in conjunction with the Minimum CIC value in order to augment the M3UA Routing Key to which the CIC range belongs. The range allows the ASP to restrict the traffic that it will receive to only that for those circuits included in the configured CIC ranges.
M3UA ASP Status
VFY-M3UA-ASPSTATUS
VFY-M3UA-ASPSTATUS::[<M3UA App Server/Routing Context>]-[<M3UA ASP Status/Slot>-<M3UA ASP Status/ASP ID>-<M3UA ASP Status/Server ID>]:[CTAG];
::[<M3UA App Server/Routing Context>]-[<M3UA ASP Status/Slot>-<M3UA ASP Status/ASP ID>-<M3UA ASP Status/Server ID>]:<SLOT=int>,<ASPID=int>,<SERVER_ID=int>,<NAME=string>,<STATUS=StatusASP>,<ASSOCID=int>;
AID Description
Slot - Position 1
Type: int
Description: M3UA AS ASP corresponding slot.
ASP ID - Position 2
Type: int
Description: M3UA AS ASP unique identifier.
Server ID - Position 3
Type: int
Description: M3UA AS ASP corresponding server ID.
Attribute Details
SLOT - Slot
Permissions: Read-only
Type: int
Description: M3UA AS ASP corresponding slot.
ASPID - ASP ID
Permissions: Read-only
Type: int
Description: M3UA AS ASP unique identifier.
SERVER_ID - Server ID
Permissions: Read-only
Type: int
Description: M3UA AS ASP corresponding server ID.
NAME - Name
Permissions: Read-only
Type: string
Description: M3UA AS ASP corresponding name.
STATUS - State
Permissions: Read-only
Type: StatusASP={UP,ACTIVE,INACTIVE,DOWN}
Description: M3UA AS ASP status.
ASSOCID - Association ID
Permissions: Read-only
Type: int
Description: M3UA AS ASP Association unique identifier.
M3UA ASP
CHG-M3UA-ASP
CHG-M3UA-ASP::[<M3UA ASP/Slot>-<M3UA ASP/ID>]:[CTAG]:::::[HB=<FeatureBoolean>],[HB_INTV=<int>],[RTO_INIT=<int>],[RTO_MIN=<int>],[RTO_MAX=<int>],[MAX_INIT_RETRANS=<int>],[MAX_ASSOC_RETRANS=<int>],[MAX_PATH_RETRANS=<int>],[BUNDLING=<FeatureBoolean>],[BUNDLING_TO=<int>],[DELAYACK_TO=<int>],[INSTREAMS=<int>],[OUTSTREAMS=<int>];
SET-M3UA-ASP
SET-M3UA-ASP::[<M3UA ASP/Slot>-<M3UA ASP/ID>]:[CTAG]:::[TERMINATE/SHUTDOWN];
VFY-M3UA-ASP
VFY-M3UA-ASP::[<M3UA ASP/Slot>-<M3UA ASP/ID>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<M3UA ASP/Slot>-<M3UA ASP/ID>]:<SLOT=int>,<ServerID=int>,<ID=int>,<AssocID=int>,<HOST1=string>,<HOST2=string>,<PORT=int>,<NAME=string>,<STATUS=StatusASP>,<UASPID=string>,<RXMSG=int>,<TXMSG=int>,<HB=FeatureBoolean>,<HB_INTV=int>,<RTO_INIT=int>,<RTO_MIN=int>,<RTO_MAX=int>,<MAX_INIT_RETRANS=int>,<MAX_ASSOC_RETRANS=int>,<MAX_PATH_RETRANS=int>,<BUNDLING=FeatureBoolean>,<BUNDLING_TO=int>,<DELAYACK_TO=int>,<CHECKSUM=SCTPCheckSum>,<INSTREAMS=int>,<OUTSTREAMS=int>;
AID Description
Slot - Position 1
Type: int
Description: A Peers Slot in the chassis.
ID - Position 2
Type: int
Description: M3UA ASP unique identifier.
Attribute Details
SLOT - Slot
Permission: Read-only
Type: int
Description: A Peers Slot in the chassis.
ServerID - Server ID
Permission: Read-only
Type: int
Description: M3UA SCTP Server ID.
ID - ID
Permission: Read-only
Type: int
Description: M3UA ASP unique identifier.
AssocID - AssocID
Permissions: Read-only
Type: int
Description: M3UA ASP Association ID.
HOST1 - IP Address 1
Permission: Read-only
Type: string
Description: M3UA ASP primary IP address.
HOST2 - IP Address 2
Permission: Read-only
Type: string
Description: M3UA ASP secondary IP address.
PORT - Port
Permission: Read-only
Type: int
Description: M3UA ASP port.
NAME - Name
Permission: Read-only
Type: string
Description: M3UA ASP name.
STATUS - State
Permission: Read-only
Type: StatusASP={UP,ACTIVE,INACTIVE,DOWN}
Description: M3UA ASP status.
UASPID - User ASP ID
Permission: Read-only
Type: string
Description: M3UA ASP Identifier received from a preconfigured user. This value can differ from the ID if ASP ID Validation for the pre-configured ASP has been set to DISABLED. The User ASP ID is used (rather than the ID) when sending NOTIFY messages concerning this ASP.
RXMSG - Rx MSG Count
Permissions: Read-only
Type: int
Description: Number Received Messages per second
TXMSG - Tx MSG Count
Permissions: Read-only
Type: int
Description: Number Transmitted Messages per second
HB - Heartbeat
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Enable or disable the Heartbeat feature.
HB_INTV - Heartbeat Interval
Permission: Writeable
Type: int(Range: [0..65355])
Description: Heartbeat interval (ms).
RTO_INIT - RTO Initial
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Initial Retransmission Timeout (ms).
RTO_MIN - RTO Minimum
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Minimum Retransmission Timeout (ms).
RTO_MAX - RTO Maximum
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum Retransmission Timeout (ms).
MAX_INIT_RETRANS - Maximum Init Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum initial retransmissions.
MAX_ASSOC_RETRANS - Maximum Assoc Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum association retransmissions.
MAX_PATH_RETRANS - Maximum Path Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum path retransmissions.
BUNDLING - Bundling
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Enable or disable the Bundling feature.
BUNDLING_TO - Bundling Timeout
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Bundling timeout (msecs).
DELAYACK_TO - Delayed Ack Timeout
Permission: Writeable
Type: int(Range: [0..500])
Description: Delayed acknowledgement timeout.
CHECKSUM - Checksum
Permission: Writeable
Type: SCTPCheckSum={ADLER32,CRC32C,NONE}
Description: Checksum algorithm
INSTREAMS - In Streams
Permission: Writeable
Type: int(Range: [0..65355])
Description: Number of in streams.
OUTSTREAMS - Out Streams
Permission: Writeable
Type: int(Range: [0..65355])
Description: Number of out streams.
M3UA SCTP Servers
CHG-M3UA-SERVERS
CHG-M3UA-SERVERS:::[CTAG]:::::[DFLT_NA=<int>],[ASP_MGMT=<ASPMgmt>],[HB=<FeatureBoolean>],[HB_INTV=<int>],[RTO_INIT=<int>],[RTO_MIN=<int>],[RTO_MAX=<int>],[MAX_INIT_RETRANS=<int>],[MAX_ASSOC_RETRANS=<int>],[MAX_PATH_RETRANS=<int>],[BUNDLING=<FeatureBoolean>],[BUNDLING_TO=<int>],[DELAYACK_TO=<int>],[INSTREAMS=<int>],[OUTSTREAMS=<int>];
SET-M3UA-SERVERS
SET-M3UA-SERVERS:::[CTAG]:::[ACT/DEACT];
VFY-M3UA-SERVERS
VFY-M3UA-SERVERS:::[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
:::<DFLT_NA=int>,<ASP_MGMT=ASPMgmt>,<STATUS=FeatureBoolean>,<HB=FeatureBoolean>,<HB_INTV=int>,<RTO_INIT=int>,<RTO_MIN=int>,<RTO_MAX=int>,<MAX_INIT_RETRANS=int>,<MAX_ASSOC_RETRANS=int>,<MAX_PATH_RETRANS=int>,<BUNDLING=FeatureBoolean>,<BUNDLING_TO=int>,<DELAYACK_TO=int>,<CHECKSUM=SCTPCheckSum>,<INSTREAMS=int>,<OUTSTREAMS=int>;
Attribute Details
DFLT_NA - Default Network Appearance
Permission: Writeable
Type: int
Description: M3UA default network appearance. If the NA is not provided in the transfer message the default NA is used to select the MTP3 NA Connection.
ASP_MGMT - ASP Management
Permission: Writeable
Type: ASPMgmt={CONFIGURED AND DYNAMIC,CONFIGURED ONLY}
Description: ASP Dynamic and/or preconfigured setup.
STATUS - Status
Permission: Read-only
Type: FeatureBoolean={DISABLED,ENABLED}
Description: M3UA SCTP Over All Server status.
HB - Heartbeat
Permissions: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Enable or disable the Heartbeat feature. SCTP Server must be de-activated and re-activated to take effect.
HB_INTV - Heartbeat Interval
Permission: Writeable
Type: int(Range: [0..65355])
Description: Heartbeat interval (ms). SCTP Server must be de-activated and re-activated to take effect.
RTO_INIT - RTO Initial
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Initial Retransmission Timeout (ms). SCTP Server must be de-activated and re-activated to take effect.
RTO_MIN - RTO Minimum
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Minimum Retransmission Timeout (ms). SCTP Server must be de-activated and re-activated to take effect.
RTO_MAX - RTO Maximum
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum Retransmission Timeout (ms). SCTP Server must be de-activated and re-activated to take effect.
MAX_INIT_RETRANS - Maximum Init Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum initial retransmissions. SCTP Server must be de-activated and re-activated to take effect.
MAX_ASSOC_RETRANS - Maximum Assoc Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum association retransmissions. SCTP Server must be de-activated and re-activated to take effect.
MAX_PATH_RETRANS - Maximum Path Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum path retransmissions. SCTP Server must be de-activated and re-activated to take effect.
BUNDLING - Bundling
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Enable or disable the Bundling feature. SCTP Server must be de-activated and re-activated to take effect.
BUNDLING_TO - Bundling Timeout
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Bundling timeout (msecs). SCTP Server must be de-activated and re-activated to take effect.
DELAYACK_TO - Delayed Ack Timeout
Permission: Writeable
Type: int(Range: [0..500])
Description: Delayed acknowledgement timeout. SCTP Server must be de-activated and re-activated to take effect.
CHECKSUM - Checksum
Permission: Writeable
Type: SCTPCheckSum={ADLER32,CRC32C,NONE}
Description: Checksum algorithm. SCTP Server must be de-activated and re-activated to take effect.
INSTREAMS - In Streams
Permission: Writeable
Type: int(Range: [0..65355])
Description: Number of in streams. SCTP Server must be de-activated and re-activated to take effect.
OUTSTREAMS - Out Streams
Permission: Writeable
Type: int(Range: [0..65355])
Description: Number of out streams. SCTP Server must be de-activated and re-activated to take effect.
M3UA SCTP Server
DLT-M3UA-SERVER
DLT-M3UA-SERVER::[<M3UA SCTP Server/Slot>-<M3UA SCTP Server/Server ID>]:[CTAG];
ADD-M3UA-SERVER
CHG-M3UA-SERVER
CHG-M3UA-SERVER::[<M3UA SCTP Server/Slot>-<M3UA SCTP Server/Server ID>]:[CTAG]:::::[IP1=<string>],[IP2=<string>],[PORT=<int>],[USE DEFAULT=<default_sctp_values>],[HB=<FeatureBoolean>],[HB_INTV=<int>],[RTO_INIT=<int>],[RTO_MIN=<int>],[RTO_MAX=<int>],[MAX_INIT_RETRANS=<int>],[MAX_ASSOC_RETRANS=<int>],[MAX_PATH_RETRANS=<int>],[BUNDLING=<FeatureBoolean>],[BUNDLING_TO=<int>],[DELAYACK_TO=<int>],[INSTREAMS=<int>],[OUTSTREAMS=<int>];
SET-M3UA-SERVER
SET-M3UA-SERVER::[<M3UA SCTP Server/Slot>-<M3UA SCTP Server/Server ID>]:[CTAG]:::[ACT/DEACT];
VFY-M3UA-SERVER
VFY-M3UA-SERVER::[<M3UA SCTP Server/Slot>-<M3UA SCTP Server/Server ID>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<M3UA SCTP Server/Slot>-<M3UA SCTP Server/Server ID>]:<SLOT=int>,<ServerID=int>,<IP1=string>,<IP2=string>,<PORT=int>,<STATUS=FeatureBoolean>,<USE DEFAULT=default_sctp_values>,<HB=FeatureBoolean>,<HB_INTV=int>,<RTO_INIT=int>,<RTO_MIN=int>,<RTO_MAX=int>,<MAX_INIT_RETRANS=int>,<MAX_ASSOC_RETRANS=int>,<MAX_PATH_RETRANS=int>,<BUNDLING=FeatureBoolean>,<BUNDLING_TO=int>,<DELAYACK_TO=int>,<CHECKSUM=SCTPCheckSum>,<INSTREAMS=int>,<OUTSTREAMS=int>;
AID Description
Slot - Position 1
Type: int
Description: The Slot where the server is being configured
Server ID - Position 2
Type: int
Description: M3UA SCTP Server ID.
Attribute Details
SLOT - Slot
Permission: Createable
Type: int
Description: The Slot where the server is being configured.
ServerID - Server ID
Permission: Read-only
Type: int
Description: M3UA SCTP Server ID.
IP1 - IP Address 1
Permissions: Writeable and Createable
Type: string
Description: M3UA SCTP Server primary address. This may be a hostname or an IP Address. If a hostname is used it must be provisioned either in /etc/hosts or via a properly-configured DNS Server and should resolve to a subset of the local IP Addresses configured for the slot where the SCTP server is hosted. Hostname resolution is attempted periodically. Resolution updates take effect ONLY when the server is restarted.
IP2 - IP Address 2
Permissions: Writeable and Createable
Type: string
Description: M3UA SCTP Server secondary address. This may be a hostname or an IP Address. If a hostname is used it must be provisioned either in /etc/hosts or via a properly-configured DNS Server and should resolve to a subset of the local IP Addresses configured for the slot where the SCTP server is hosted. Hostname resolution is attempted periodically. Resolution updates take effect ONLY when the server is restarted.
PORT - Port
Permissions: Writeable and Createable
Type: int
Description: M3UA SCTP Server port.
STATUS - Status
Permission: Read-only
Type: FeatureBoolean={DISABLED,ENABLED}
Description: M3UA SCTP Over All Server status.
USE DEFAULT - Default SCTP Values
Permission: Writeable
Type: default_sctp_values={NO,YES}
Description: Use M3UA SCTP default parameters.
HB - Heartbeat
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Enable or disable the Heartbeat feature. SCTP Server must be de-activated and re-activated to take effect.
HB_INTV - Heartbeat Interval
Permission: Writeable
Type: int(Range: [0..65355])
Description: Heartbeat interval (ms). SCTP Server must be de-activated and re-activated to take effect.
RTO_INIT - RTO Initial
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Initial Retransmission Timeout (ms). SCTP Server must be de-activated and re-activated to take effect.
RTO_MIN - RTO Minimum
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Minimum Retransmission Timeout (ms). SCTP Server must be de-activated and re-activated to take effect.
RTO_MAX - RTO Maximum
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum Retransmission Timeout (ms). SCTP Server must be de-activated and re-activated to take effect.
MAX_INIT_RETRANS - Maximum Init Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum initial retransmissions. SCTP Server must be de-activated and re-activated to take effect.
MAX_ASSOC_RETRANS - Maximum Assoc Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum association retransmissions. SCTP Server must be de-activated and re-activated to take effect.
MAX_PATH_RETRANS - Maximum Path Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum path retransmissions. SCTP Server must be de-activated and re-activated to take effect.
BUNDLING - Bundling
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Enable or disable the Bundling feature. SCTP Server must be de-activated and re-activated to take effect.
BUNDLING_TO - Bundling Timeout
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Bundling timeout (msecs). SCTP Server must be de-activated and re-activated to take effect.
DELAYACK_TO - Delayed Ack Timeout
Permission: Writeable
Type: int(Range: [0..500])
Description: Delayed acknowledgement timeout. SCTP Server must be de-activated and re-activated to take effect.
CHECKSUM - Checksum
Permission: Writeable
Type: SCTPCheckSum={ADLER32,CRC32C,NONE}
Description: Checksum algorithm. SCTP Server must be de-activated and re-activated to take effect.
INSTREAMS - In Streams
Permission: Writeable
Type: int(Range: [0..65355])
Description: Number of in streams. SCTP Server must be de-activated and re-activated to take effect.
OUTSTREAMS - Out Streams
Permission: Writeable
Type: int(Range: [0..65355])
Description: Number of out streams. SCTP Server must be de-activated and re-activated to take effect.
DLT-M3UA-CONFASP
DLT-M3UA-CONFASP::[<M3UA Configured ASP/ID>]:[CTAG];
ADD-M3UA-CONFASP
ADD-M3UA-CONFASP::[<M3UA Configured ASP/ID>]:[CTAG]:::::[IP1=<string>],[IP2=<string>],[PORT=<int>];
CHG-M3UA-CONFASP
CHG-M3UA-CONFASP::[<M3UA Configured ASP/ID>]:[CTAG]:::::[NAME=<string>],[IDVAL=<FeatureBoolean>],[INCOMING_APPID=<string>],[INCRC=<FeatureBoolean>],[INCNA=<FeatureBoolean>],[SERVER_ID=<serverId>],[SLOT=<slotId>],[NATRANS=<NARange>],[DEFAULT_NA=<DefaultNA>];
SET-M3UA-CONFASP
SET-M3UA-CONFASP::[<M3UA Configured ASP/ID>]:[CTAG]:::[ACT/DEACT];
VFY-M3UA-CONFASP
VFY-M3UA-CONFASP::[<M3UA Configured ASP/ID>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<M3UA Configured ASP/ID>]:<ID=int>,<IP1=string>,<IP2=string>,<PORT=int>,<NAME=string>,<IDVAL=FeatureBoolean>,<INCOMING_APPID=string>,<INCRC=FeatureBoolean>,<INCNA=FeatureBoolean>,<SERVER_ID=serverId>,<SLOT=slotId>,<ACTIVATED=FeatureBoolean>,<NATRANS=NARange>,<DEFAULT_NA=DefaultNA>;
AID Description
ID - Position 1
Type: int (Range [1...2.14748e+09])
Description: M3UA configured ASP unique identifier.
Attribute Details
ID - ID
Permission: Createable
Type: int (Range [1...2.14748e+09])
Description: M3UA configured ASP unique identifier.
IP1 - IP Address 1
Permissions: Createable
Type: string
Description: M3UA Configured ASP primary address. This may be a hostname or an IP Address. If a hostname is used it must be provisioned either in /etc/hosts or via a properly-configured DNS Server and should resolve to a subset of the remote IP Addresses configured for the host where the ASP terminates. Hostname resolution is attempted periodically. This attribute defines the primary IP address specifying the SCTP primary path to the remote SCTP endpoint. If the resolution returns more than one IP address, no guarantee is made as to non-ambiguous definition of the SCTP primary path.
IP2 - IP Address 2
Permissions: Createable
Type: string
Description: M3UA Configured ASP secondary address. This may be a hostname or an IP Address. If a hostname is used it must be provisioned either in /etc/hosts or via a properly-configured DNS Server and should resolve to a subset of the remote IP Addresses configured for the host where the ASP terminates. Hostname resolution is attempted periodically.
PORT - Port
Permission: Createable
Type: int
Description: Remote port from which ASP will connect.
NAME - Name
Permission: Writeable
Type: string
Description: M3UA configured ASP name. Alphanumeric with dash and underscore for a maximum of 16 characters. Automatically moved to upper-case. Must be unique in M3UA. Reserved value DYNAMIC for non-configured ASPs.
IDVAL - ASP ID Validation
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: It is highly recommended that for increased security that this attribute remain enabled. When enabled the ASP using the configured endpoint MUST either NOT send the ASP ID parameter OR send the preconfigured ID. If an ASP ID parameter contains an identifier other than what is preconfigured, an ERROR (Invalid ASP Identifier) will be sent. When disabled, the ASP Identifier contained in the ASPUP is not validated. This is typically useful when changing the ID used by the ASP is especially troublesome
INCOMING_APPID - Incoming AppID
Permission: Writeable
Type: string
Description: M3UA Incoming AppID for Gateway Screening. On creation, the attribute is defaulted to M3UA_DEFAULT.
INCRC - RC in DATA Message
Permissions: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: When ENABLED, the Routing Context parameter is included in DATA messages destined for the ASP. Per RFC4666, the inclusion of the Routing Context parameter in DATA messages is conditional. On creation, the attribute is defaulted to ENABLED.
INCNA - NA in DATA Message
Permissions: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: When ENABLED, the Network Appearance parameter is included in DATA messages destined for the ASP. Per RFC4666, the inclusion of the Network Appearance parameter in DATA messages is optional. On creation, the attribute is defaulted to ENABLED.
SERVER_ID - Server ID
Permission: Writeable
Type: serverId={ANY, 1 to 3}
Description: The Id of the server to which the configured ASP will connect
SLOT - Slot
Permission: Writeable
Type: slotId={ANY, 1 to 99}
Description: The Id of the slot to which the configured ASP will connect
ACTIVATED - User Activated
Permissions: Read-only
Type: FeatureBoolean={DISABLED,ENABLED}
Description: M3UA ASP Association User State (ENABLED/DISABLED)
NATRANS - NA Translation
Permissions: Writeable
Type: NARange={DISABLED, 1 to 99}
Description: NA Translation for M3UA Configured ASPs. If enabled, all M3UA messages from the ASP containing a Network Appearance parameter of 0 will be interpreted to mean the configured value chosen. This value will be used for pertinent statistics. A default value of 0 disables the feature.
M3UA Routing Context
DLT-M3UA-RC
DLT-M3UA-RC::[<M3UA Configured ASP/ID>]-[<M3UA Routing Context/Routing Context>]:[CTAG];
ADD-M3UA-RC
ADD-M3UA-RC::[<M3UA Configured ASP/ID>]-[<M3UA Routing Context/Routing Context>]:[CTAG];
CHG-M3UA-RC
CHG-M3UA-RC::[<M3UA Configured ASP/ID>]-[<M3UA Routing Context/Routing Context>]:[CTAG]:::::[REMOTERC=<RemoteRC>];
VFY-M3UA-RC
VFY-M3UA-RC::[<M3UA Configured ASP/ID>]-[<M3UA Routing Context/Routing Context>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<M3UA Configured ASP/ID>]-[<M3UA Routing Context/Routing Context>]:<RC=int>,<REMOTERC=RemoteRC>;
AID Description
Routing Context - Position 1
Type: int (Range [1...2.14748e+09])
Description: Routing context.
Attribute Details
RC - Routing Context
Permission: Createable
Type: int (Range [1...2.14748e+09])
Description: Routing context.
REMOTERC - Remote Routing Context
Permission: Writeable
Type: RemoteRC={UNDEFINED, 0 to 2147483647}
Description: Remote routing context is used to connect a group of configured RCs. An ASP may go active for the group of RCs by sending a single ASP Active message containing only the remote routing context. All notifications and Acks pertaining to any AS in the group will contain the remote routing context. This feature should only be used in loadshare and broadcast traffic modes. To set the value to UNDEFINED, enter -1.
M3UA Multi Association ASP
DLT-M3UA-MAASP
DLT-M3UA-MAASP::[<M3UA Multi Association ASP/ID>]:[CTAG];
ADD-M3UA-MAASP
ADD-M3UA-MAASP::[<M3UA Multi Association ASP/ID>]:[CTAG]:::::[ASP_TYPE=<MultiASPType>],[ROLE=<SCTPRole>],[M3UA VERSION=<M3UAVersion>];
CHG-M3UA-MAASP
CHG-M3UA-MAASP::[<M3UA Multi Association ASP/ID>]:[CTAG]:::::[NAME=<string>],[IDVAL=<FeatureBoolean>],[INCOMING_APPID=<string>],[INCRC=<FeatureBoolean>],[INCNA=<FeatureBoolean>],[NATRANS=<NARange>],[NA=<DefaultNA>],[IMF=<FeatureBoolean>],[NA_OVERRIDE=<NaOverride>],[HB=<FeatureBoolean>],[HB_INTV=<int>],[RTO_INIT=<int>],[RTO_MIN=<int>],[RTO_MAX=<int>],[MAX_INIT_RETRANS=<int>],[MAX_ASSOC_RETRANS=<int>],[MAX_PATH_RETRANS=<int>],[BUNDLING=<FeatureBoolean>],[BUNDLING_TO=<int>],[DELAYACK_TO=<int>],[INSTREAMS=<int>],[OUTSTREAMS=<int>],[DSCP=<Dscp>],[TXABTL1=<TxQueuePercent>],[TXONSTL1=<TxQueuePercent>],[TXABTL2=<TxQueuePercent>],[TXONSTL2=<TxQueuePercent>],[TXABTL3=<TxQueuePercent>],[TXONSTL3=<TxQueuePercent>],[DISCARD_LVL=<MessageDiscard>],[REPORT_CONGESTION=<FeatureBoolean>];
VFY-M3UA-MAASP
VFY-M3UA-MAASP::[<M3UA Multi Association ASP/ID>]:[CTAG];
::[<M3UA Multi Association ASP/ID>]:<ID=int>,<NAME=string>,<IDVAL=FeatureBoolean>,<INCOMING_APPID=string>,<INCRC=FeatureBoolean>,<INCNA=FeatureBoolean>,<ASP_TYPE=MultiASPType>,<ROLE=SCTPRole>,<M3UA VERSION=M3UAVersion>,<NATRANS=NARange>,<NA=DefaultNA>,<IMF=FeatureBoolean>,<NA_OVERRIDE=NaOverride>,<HB=FeatureBoolean>,<HB_INTV=int>,<RTO_INIT=int>,<RTO_MIN=int>,<RTO_MAX=int>,<MAX_INIT_RETRANS=int>,<MAX_ASSOC_RETRANS=int>,<MAX_PATH_RETRANS=int>,<BUNDLING=FeatureBoolean>,<BUNDLING_TO=int>,<DELAYACK_TO=int>,<CHECKSUM=SCTPCheckSum>,<INSTREAMS=int>,<OUTSTREAMS=int>,<DSCP=Dscp>,<TXABTL1=TxQueuePercent>,<TXONSTL1=TxQueuePercent>,<TXABTL2=TxQueuePercent>,<TXONSTL2=TxQueuePercent>,<TXABTL3=TxQueuePercent>,<TXONSTL3=TxQueuePercent>,<CONGESTION_LVL=CongestionLevel>,<DISCARD_LVL=MessageDiscard>,<REPORT_CONGESTION=FeatureBoolean>;
AID Description
ID - Position 1
Type: int
Description: M3UA Multi Association ASP unique identifier.
Attribute Details
ID - ID
Permission: Createable
Type: int
Description: M3UA Multi Association ASP unique identifier.
NAME - Name
Permission: Writeable
Type: string
Description: M3UA configured ASP name. Alphanumeric with dash and underscore for a maximum of 16 characters. Automatically moved to upper-case. Must be unique in M3UA. Reserved value DYNAMIC for non-configured ASPs.
IDVAL - ASP ID Validation
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: It is highly recommended that for increased security that this attribute remain enabled. When enabled the ASP using the configured endpoint MUST either NOT send the ASP ID parameter OR send the preconfigured ID. If an ASP ID parameter contains an identifier other than what is preconfigured, an ERROR (Invalid ASP Identifier) will be sent. When disabled, the ASP Identifier contained in the ASPUP is not validated. This is typically useful when changing the ID used by the ASP is especially troublesome
INCOMING_APPID - Incoming AppID
Permission: Writeable
Type: string
Description: M3UA Incoming AppID for Gateway Screening. On creation, the attribute is defaulted to M3UA_DEFAULT.
INCRC - RC in DATA Message
Permissions: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: When ENABLED the Routing Context parameter is included in DATA messages destined for the ASP. Per RFC4666, the inclusion of the Routing Context parameter in DATA messages is conditional. On creation, the attribute is defaulted to ENABLED. This setting has no affect when using M3UA Version M3UAv2.
INCNA - NA in DATA Message
Permissions: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: When ENABLED the Network Appearance parameter is included in DATA messages destined for the ASP. Per RFC4666, the inclusion of the Network Appearance parameter in DATA messages is optional. On creation, the attribute is defaulted to ENABLED. This setting has no affect when using M3UA Version M3UAv2.
ASP_TYPE - ASP Type
Permission: Createable
Type: MultiASPType={STANDARD,C20,GWC}
Description: Type of ASP.
ROLE - SCTP Role
Permission: Createable
Type: SCTPRole={CLIENT,SERVER}
Description: M3UA Multi Association ASP SCTP Role (CLIENT/SERVER). In a client configuration, each association (once activated) opens its SCTP pipe and tries to connect to the remote end point. In a server configuration, each association (once activated) starts listening for incoming connections on the local end point.
M3UA VERSION - M3UA Version
Permission: Createable
Type: M3UAVersion={M3UA VRFC,M3UA V2}
Description: M3UA Multi Association ASP M3UA Version (M3UAvRFC/M3UAv2). On Creation, this attribute is defaulted to M3UAvRFC.
HB - Heartbeat
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Enable or disable the Heartbeat feature. SCTP Association must be de-activated and re-activated to take effect.
HB_INTV - Heartbeat Interval
Permission: Writeable
Type: int(Range: [0..65355])
Description: Heartbeat interval (ms). SCTP Association must be de-activated and re-activated to take effect.
RTO_INIT - RTO Initial
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Initial Retransmission Timeout (ms). SCTP Association must be de-activated and re-activated to take effect.
RTO_MIN - RTO Minimum
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Minimum Retransmission Timeout (ms). SCTP Association must be de-activated and re-activated to take effect.
RTO_MAX - RTO Maximum
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum Retransmission Timeout (ms). SCTP Association must be de-activated and re-activated to take effect.
MAX_INIT_RETRANS - Maximum Init Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum initial retransmissions. SCTP Association must be de-activated and re-activated to take effect.
MAX_ASSOC_RETRANS - Maximum Assoc Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum association retransmissions. SCTP Association must be de-activated and re-activated to take effect.
MAX_PATH_RETRANS - Maximum Path Retrans
Permission: Writeable
Type: int(Range: [0..214748e+09])
Description: Maximum path retransmissions. SCTP Association must be de-activated and re-activated to take effect.
BUNDLING - Bundling
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Enable or disable the Bundling feature. SCTP Association must be de-activated and re-activated to take effect.
BUNDLING_TO - Bundling Timeout
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Bundling timeout (msecs). SCTP Association must be de-activated and re-activated to take effect.
DELAYACK_TO - Delayed Ack Timeout
Permission: Writeable
Type: int(Range: [0..500])
Description: Delayed acknowledgement timeout. SCTP Association must be de-activated and re-activated to take effect.
CHECKSUM - Checksum
Permission: Writeable
Type: SCTPCheckSum={ADLER32,CRC32C,NONE}
Description: Checksum algorithm. SCTP Association must be de-activated and re-activated to take effect.
INSTREAMS - In Streams
Permission: Writeable
Type: int(Range: [0..65355])
Description: Number of in streams. SCTP Association must be de-activated and re-activated to take effect.
OUTSTREAMS - Out Streams
Permission: Writeable
Type: int(Range: [0..65355])
Description: Number of out streams. SCTP Association must be de-activated and re-activated to take effect.
NATRANS - NA Translation
Permissions: Writeable
Type: NARange={DISABLED, 1 to 99}
Description: NA Translation for M3UA Multi Association ASPs. If enabled, all M3UA messages from the ASP containing a Network Appearance parameter of 0 will be interpreted to mean the configured value chosen. This value will be used for pertinent statistics. A default value of 0 disables the feature.
DSCP - DSCP
Permission: Writeable
Type: int(Range: [0..63])
Description: Differentiated Services Code Point is used to classify traffic within a network in order to determine the priority of the various classes of traffic (0 to 63).
Default value: 0.
TXABTL1 - TX Abatement L1
Permission: Writeable
Type: Percent10to100={10 to 100} (Units: %)
Description: Transmit Congestion Abatement Level 1 (% of buffer usage)
TXONSTL1 - TX Onset L1
Permission: Writeable
Type: Percent10to100={10 to 100} (Units: %)
Description: Congestion Onset Level 1 (% of buffer usage)
TXABTL2 - TX Abatement L2
Permission: Writeable
Type: Percent10to100={10 to 100} (Units: %)
Description: Transmit Congestion Abatement Level 2 (% of buffer usage)
TXONSTL2 - TX Onset L2
Permission: Writeable
Type: Percent10to100={10 to 100} (Units: %)
Description: Transmit Congestion Onset Level 2 (% of buffer usage)
TXABTL3 - TX Abatement L3
Permission: Writeable
Type: Percent10to100={10 to 100} (Units: %)
Description: Transmit Congestion Abatement Level 3 (% of buffer usage)
TXONSTL3 - TX Onset L3
Permission: Writeable
Type: Percent10to100={10 to 100} (Units: %)
Description: Transmit Congestion Onset Level 3 (% of buffer usage)
ASSOC_TXQSIZE - TX Queue Size
Permission: Writeable
Type: int(Range: [4000..2147483647])
Description: Size of the SCTP Association Transmit buffer in bytes. Read from /proc/net/sctp/assocs, the TX Queue Size attribute shows the current buffer allocated by the OS for the association. The size of the TX Queue being currently used is also read from /proc/net/sctp/assocs. The current usage is calculated as a percentage of the allocated Buffer Size and determines the congestion level of the SCTP association based on the configured onset and abatement values.
CONGESTION_LVL - Congestion Level
Permission: Read-only
Type: CongestionLevel={FALSE,LEVEL1,LEVEL2,LEVEL3,TRUE}
Description: Congestion level of this link. For ANSI networks the values range from 1 to 3 or FALSE if not congested. For ITU networks the value is either TRUE or FALSE.
DISCARD_LVL - M3UA Message DiscardPermission: Writeable
Type: Feature={DISABLED,ENABLED}
Description: M3UA Message Discard Congestion level of this Link. ANSI variant has 3 congestion levels, while ITU uses only 1. Valid values range from 1 to 3, or DISABLED to never discard. A data message will be discarded if the message priority is less than or equal to both the configured discard level and the current congestion level of the association.
REPORT_CONGESTION - Report CongestionPermission: Writeable
Type: Feature={DISABLED,ENABLED}
Description: Used to determine if congestion alarms are raised.
M3UA ASP Association
DLT-M3UA-ASSOC
DLT-M3UA-ASSOC::[<M3UA Multi Association ASP/ID>]-[<M3UA ASP Association/Association ID>]:[CTAG];
ADD-M3UA-ASSOC
ADD-M3UA-ASSOC::[<M3UA Multi Association ASP/ID>]:[CTAG]:::::[SLOT=<int>],[LIP1=<string>],[LIP2=<string>],[LPORT=<int>],[RIP1=<string>],[RIP2=<string>],[RPORT=<int>];
SET-M3UA-ASSOC
SET-M3UA-ASSOC::[<M3UA Multi Association ASP/ID>]-[<M3UA ASP Association/Association ID>]:[CTAG]:::[ACT/DEACT];
VFY-M3UA-ASSOC
VFY-M3UA-ASSOC::[<M3UA Multi Association ASP/ID>]-[<M3UA ASP Association/Association ID>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<M3UA Multi Association ASP/ID>]-[<M3UA ASP Association/Association ID>]:<ASSOC_ID=int>,<SLOT=int>,<LIP1=string>,<LIP2=string>,<LPORT=int>,<RIP1=string>,<RIP2=string>,<RPORT=int>,<ACTIVATED=FeatureBoolean>,<SSTATE=AssocState>,<MSTATE=AssocState>,<RXMSG=int>,<TXMSG=int>;
AID Description
Association ID - Position 1
Type: int
Description: M3UA ASP Association unique identifier.
Attribute Details
ASSOC_ID - Association ID
Permission: Read-only
Type: int
Description: M3UA ASP Association unique identifier.
SLOT - Slot
Permission: Createable
Type: int
Description: M3UA ASP Association corresponding slot.
LIP1 - Local IP Address 1
Permissions: Createable
Type: string
Description: M3UA ASP Association primary local address. This may be a hostname or an IP Address. If a hostname is used it must be provisioned either in /etc/hosts or via a properly-configured DNS Server and should resolve to a subset of the local IP Addresses configured for the slot where the ASP terminates. Hostname resolution is attempted periodically.
LIP2 - Local IP Address 2
Permissions: Createable
Type: string
Description: M3UA ASP Association secondary local address. This may be a hostname or an IP Address. If a hostname is used it must be provisioned either in /etc/hosts or via a properly-configured DNS Server and should resolve to a subset of the local IP Addresses configured for the slot where the ASP terminates. Hostname resolution is attempted periodically.
LPORT - Local Port
Permission: Createable
Type: int
Description: Local port from/to which ASP Association will connect.
RIP1 - Remote IP Address 1
Permissions: Createable
Type: string
Description: M3UA ASP Association primary remote address. This may be a hostname or an IP Address. If a hostname is used it must be provisioned either in /etc/hosts or via a properly-configured DNS Server and should resolve to a subset of the remote IP Addresses configured for the host where the ASP terminates. Hostname resolution is attempted periodically. This attribute defines the primary IP address specifying the SCTP primary path to the remote SCTP endpoint. If the resolution returns more than one IP address, no guarantee is made as to non-ambiguous definition of the SCTP primary path.
RIP2 - Remote IP Address 2
Permissions: Createable
Type: string
Description: M3UA ASP Association secondary remote address. This may be a hostname or an IP Address. If a hostname is used it must be provisioned either in /etc/hosts or via a properly-configured DNS Server and should resolve to a subset of the remote IP Addresses configured for the host where the ASP terminates. Hostname resolution is attempted periodically.
RPORT - Remote Port
Permission: Createable
Type: int
Description: Remote port from/to which ASP Association will connect.
ACTIVATED - User Activated
Permission: Read-only
Type: FeatureBoolean={DISABLED,ENABLED}
Description: M3UA ASP Association User State (ENABLED/DISABLED).
SSTATE - SCTP State
Permission: Read-only
Type: AssocState={DOWN,UP}
Description: M3UA ASP Association SCTP State (UP/DOWN).
MSTATE - M3UA State
Permission: Read-only
Type: AssocState={DOWN,UP}
Description: M3UA ASP Association M3UA State (UP/DOWN).
RXMSG - Rx MSG Count
Permissions: Read-only
Type: int
Description: Number Received Messages per second
TXMSG - Tx MSG Count
Permissions: Read-only
Type: int
Description: Number Transmitted Messages per second
M3UA Multi Association RC
DLT-M3UA-MARC
DLT-M3UA-MARC::[<M3UA Multi Association ASP/ID>]-[<M3UA Multi Association RC/Routing Context>]:[CTAG];
ADD-M3UA-MARC
ADD-M3UA-MARC::[<M3UA Multi Association ASP/ID>]-[<M3UA Multi Association RC/Routing Context>]:[CTAG];
CHG-M3UA-MARC
CHG-M3UA-MARC::[<M3UA Multi Association ASP/ID>]-[<M3UA Multi Association RC/Routing Context>]:[CTAG]:::::[REMOTERC=<RemoteRC>];
VFY-M3UA-MARC
VFY-M3UA-MARC::[<M3UA Multi Association ASP/ID>]-[<M3UA Multi Association RC/Routing Context>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<M3UA Multi Association ASP/ID>]-[<M3UA Multi Association RC/Routing Context>]:<RC=int>,<REMOTERC=RemoteRC>;
AID Description
Routing Context - Position 1
Type: int (Range [1...2.14748e+09])
Description: Routing context.
Attribute Details
RC - Routing Context
Permission: Createable
Type: int (Range [1...2.14748e+09])
Description: Routing context.
REMOTERC - Remote Routing Context
Permission: Writeable
Type: RemoteRC={UNDEFINED, 0 to 2147483647}
Description: Remote routing context is used to connect a group of configured RCs. An ASP may go active for the group of RCs by sending a single ASP Active message containing only the remote routing context. All notifications and Acks pertaining to any AS in the group will contain the remote routing context. This feature should only be used in loadshare and broadcast traffic modes. To set the value to UNDEFINED, enter -1.
M3UA MHD Record
VFY-M3UA-MHD
VFY-M3UA-MHD::[<M3UA MHD Record/Routeset ID>-<M3UA MHD Record/CIC>]:[CTAG]::[RSID=<RoutesetID>]::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<M3UA MHD Record/Routeset ID>-<M3UA MHD Record/CIC>]:;
AID Description
Routeset ID - Position 1
Type: RoutesetID={UNDEFINED, 0 to 4000}
Description: MHD record associated Routeset ID.
CIC - Position 2
Type: int
Description: MHD record associated CIC.
Attribute Details
RSID - Routeset ID
Permission: Writeable
Type: RoutesetID={UNDEFINED, 0 to 4000}
Description: Filter by Routeset ID. Set to UNDEFINED to display all records.
SUA
CHG-SUA
CHG-SUA:::[CTAG]:::::[PENDING_TIMER=<PendingTimer>],[IMF=<FeatureBoolean>],[SCTP_PROTO_ID_VAL=<FeatureBoolean>],[ASSOC_CAP=<int>],[HU_ONSET=<Percent>],[HU_ABATE=<Percent>],[T_CX_ESTABLISHED=<TimerEnable>],[T_INACTIVITY_SEND=<TimerEnable>],[T_INACTIVITY_RX=<TimerEnable>],[T_RELEASE=<TimerEnable>],[T_REPEAT_RELEASE=<TimerEnable>],[T_SRN_FREEZE=<TimerEnable>];
SET-SUA
SET-SUA:::[CTAG]:::[START/STOP];
VFY-SUA
VFY-SUA:::[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
:::<PENDING_TIMER=PendingTimer>,<IMF=FeatureBoolean>,<SCTP_PROTO_ID_VAL=FeatureBoolean>,<MONITOR=FeatureBoolean>,<ASSOC_CAP=int>,<HU_ONSET=Percent>,<HU_ABATE=Percent>,<INT_SECS=int>,<T_CX_ESTABLISHED=TimerEnable>,<T_INACTIVITY_SEND=TimerEnable>,<T_INACTIVITY_RX=TimerEnable>,<T_RELEASE=TimerEnable>,<T_REPEAT_RELEASE=TimerEnable>,<T_SRN_FREEZE=TimerEnable>;
Attribute Details
PENDING_TIMER - Pending Timer
Permission: Writeable
Type: TimerEnable={DISABLED, 1 to 1000000}
Description: Duration of PENDING state in msecs for an SUA AS. Pending timer is started when an AS transitions out of ACTIVE state. If an ASP sends an ASPAC before the timer expires, the AS will immediately transition back to the ACTIVE status. Otherwise, when the timer expires the AS will either transition to INACTIVE or DOWN state. Messages will be queued while in PENDING state. Valid range of this timer is 1 to 2000. To disable the timer, set to 0. Default value is 2000 msecs.
IMF - IMF Support
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Integrated Monitoring Feed feature support for SUA. IMF must be licensed to enable this attribute.
SCTP_PROTO_ID_VAL - SCTP Protocol ID Validation
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Validation of protocol ID of received data. When enabled, the SG will discard all SUA messages that do not have an SCTP Protocol ID of either 0 or 4 as described in RFC 3868. When disabled, the SG will not inspect the SCTP protocol ID and accept all SUA messages.
ASSOC_CAP - Association Capacity
Description: Maximum number of bytes per second sent on a AS association.
MONITOR - Monitoring
Permission: Read-only
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Monitoring feature (ENABLED/DISABLED).
MAX_CAP - Association Capacity
Type: int(Range: [0..2.14748e+09])
Description: Bandwidth of SCTP association. Number of bytes per second support by association.
HU_ONSET - High Usage Onset
Description: Traffic level at which high usage alarms are triggered. (% of association capacity).This setting is used for both the transmit and receive high usage alarms for SCTP associations used by SUA ASPs.The alarm is automatically cleared when traffic levels fall below the High Usage Abatement setting.
HU_ABATE - High Usage Abatement
Description: Traffic level at which high usage alarms are cleared. (% of association capacity). This setting is used for both the transmit and receive high usage alarms for SCTP associations used by SUA ASPs.
USAGE_LOWER - Usage Lower Threshold
Permission: Writeable
Type: Percent={DEFAULT, 0 to 100} (Units: %)
Description: Percentage of the lower threshold for logging.
USAGE_UPPER - Usage Upper Threshold
Permission: Writeable
Type: Percent={DEFAULT, 0 to 100} (Units: %)
Description: Percentage of the upper threshold for logging.
INT_MINS - Usage Interval Minutes
Permission: Writeable
Type: int
Description: Interval in minutes used to calculate average traffic load.
INT_SECS - Usage Interval Seconds
Permission: Writeable
Type: int
Description: Interval in seconds used to calculate average traffic load.
T_CX_ESTABLISHED - Connection Established
Permission: Writeable
Type: TimerEnable={DISABLED, 1 to 1000000}
Description: Connection establish timer.
T_INACTIVITY_SEND - Inactivity Send
Permission: Writeable
Type: TimerEnable={DISABLED, 1 to 1000000}
Description: Inactivity send timer.
T_INACTIVITY_RX - Inactivity Receive
Permission: Writeable
Type: TimerEnable={DISABLED, 1 to 1000000}
Description: Inactivity receive timer.
T_RELEASE - Release
Permission: Writeable
Type: TimerEnable={DISABLED, 1 to 1000000}
Description: Release timer.
T_REPEAT_RELEASE - Repeat Release
Permission: Writeable
Type: TimerEnable={DISABLED, 1 to 1000000}
Description: Repeat release timer.
T_SRN_FREEZE - SRN Freeze
Permission: Writeable
Type: TimerEnable={DISABLED, 1 to 1000000}
Description: SRN freeze timer.
SUA App Server
DLT-SUA-APPSRV
DLT-SUA-APPSRV::[<SUA App Server/Routing Context>]:[CTAG];
ADD-SUA-APPSRV
ADD-SUA-APPSRV::[<SUA App Server/Routing Context>]:[CTAG]:::::[NA=<int>],[DPC=<pointcode>],[SSN=<int>],[TRAFFIC_MODE=<TrafficMode>],[AI=<string>];
VFY-SUA-APPSRV
VFY-SUA-APPSRV::[<SUA App Server/Routing Context>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<SUA App Server/Routing Context>]:<RC=int>,<NA=int>,<DPC=pointcode>,<SSN=int>,<TRAFFIC_MODE=TrafficMode>,<AI=string>,<STATUS=StatusAS>;
AID Description
Routing Context - Position 1
Type: int (Range [1...2.14748e+09])
Description: SUA AS Routing context.
Attribute Details
RC - Routing Context
Permission: Createable
Type: int (Range [1...2.14748e+09])
Description: SUA AS Routing context.
NA - Network Appearance
Permission: Createable
Type: int
Description: SUA AS Network appearance.
DPC - DPC
Permission: Createable
Type: pointcode
Description: Point Codes are set to UNSET when routing on Application ID is configured
SSN - SSN
Permission: Createable
Type: int
Description: SSNs are set to 0 when routing on Application ID is configured
TRAFFIC_MODE - Traffic Mode
Permission: Createable
Type: TrafficMode={OVERRIDE,LOADSHARE,BROADCAST}
Description: SUA Application Server Traffic Mode. Traffic modes, override, loadshare and broadcast are supported.
AI - Application ID
Permission: Createable
Type: string
Description: SUA AS Application ID (optional).
STATUS - Status
Permission: Read-only
Type: StatusAS={ACTIVE,INACTIVE,PENDING REG,DOWN,OFF LINE,PENDING}
Description: SUA AS Status.
SUA ASP Status
VFY-SUA-ASPSTATUS
VFY-SUA-ASPSTATUS::[<SUA App Server/Routing Context>]-[<SUA ASP Status/Slot>-<SUA ASP Status/ASP ID>-<SUA ASP Status/Server ID>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<SUA App Server/Routing Context>]-[<SUA ASP Status/Slot>-<SUA ASP Status/ASP ID>-<SUA ASP Status/Server ID>]:<SLOT=int>,<ASPID=int>,<SERVER_ID=int>,<NAME=string>,<STATUS=StatusASP>;
AID Description
Slot - Position 1
Type: int
Description: SUA AS ASP corresponding slot.
ASP ID - Position 2
Type: int
Description: SUA AS ASP unique identifier for given slot.
Server ID - Position 3
Type: int
Description: SUA AS ASP corresponding server ID.
Attribute Details
SLOT - Slot
Permission: Read-only
Type: int
Description: SUA AS ASP corresponding slot.
ASPID - ASP ID
Permission: Read-only
Type: int
Description: SUA AS ASP unique identifier for given slot.
SERVER_ID - Server ID
Permission: Read-only
Type: int
Description: SUA AS ASP corresponding server ID.
NAME - Name
Permission: Read-only
Type: string
Description: SUA AS ASP corresponding name.
STATUS - State
Permission: Read-only
Type: StatusASP={UP,ACTIVE,INACTIVE,DOWN}
Description: SUA AS ASP status.
SUA ASP
CHG-SUA-ASP
CHG-SUA-ASP::[<SUA ASP/Slot>-<SUA ASP/ID>]:[CTAG]:::::[HB=<FeatureBoolean>],[HB_INTV=<int>],[RTO_INIT=<int>],[RTO_MIN=<int>],[RTO_MAX=<int>],[MAX_INIT_RETRANS=<int>],[MAX_ASSOC_RETRANS=<int>],[MAX_PATH_RETRANS=<int>],[BUNDLING=<FeatureBoolean>],[BUNDLING_TO=<int>],[DELAYACK_TO=<int>],[INSTREAMS=<int>],[OUTSTREAMS=<int>];
SET-SUA-ASP
SET-SUA-ASP::[<SUA ASP/Slot>-<SUA ASP/ID>]:[CTAG]:::[TERMINATE/SHUTDOWN];
VFY-SUA-ASP
VFY-SUA-ASP::[<SUA ASP/Slot>-<SUA ASP/ID>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<SUA ASP/Slot>-<SUA ASP/ID>]:<SLOT=int>,<ServerID=int>,<ID=int>,<AssocID=int>,<HOST1=string>,<HOST2=string>,<PORT=int>,<NAME=string>,<STATUS=StatusASP>,<UASPID=string>,<RXMSG=int>,<TXMSG=int>,<HB=FeatureBoolean>,<HB_INTV=int>,<RTO_INIT=int>,<RTO_MIN=int>,<RTO_MAX=int>,<MAX_INIT_RETRANS=int>,<MAX_ASSOC_RETRANS=int>,<MAX_PATH_RETRANS=int>,<BUNDLING=FeatureBoolean>,<BUNDLING_TO=int>,<DELAYACK_TO=int>,<CHECKSUM=SCTPCheckSum>,<INSTREAMS=int>,<OUTSTREAMS=int>;
AID Description
Slot - Position 1
Type: int
ID - Position 2
Type: int
Description: SUA ASP unique identifier.
Attribute Details
SLOT - Slot
Permission: Read-only
Type: int
Description: SUA AS ASP corresponding slot.
ServerID - Server ID
Permission: Read-only
Type: int
Description: SUA SCTP Server ID.
ID - ID
Permission: Read-only
Type: int
Description: SUA ASP unique identifier.
AssocID - AssocID
Permissions: Read-only
Type: int
Description: SUA ASP Association ID.
HOST1 - IP Address 1
Permission: Read-only
Type: string
Description: SUA ASP primary IP address.
HOST2 - IP Address 2
Permission: Read-only
Type: string
Description: SUA ASP secondary IP address.
PORT - Port
Permission: Read-only
Type: int
Description: SUA ASP port.
NAME - Name
Permission: Read-only
Type: string
Description: SUA ASP name.
STATUS - State
Permission: Read-only
Type: StatusASP={UP,ACTIVE,INACTIVE,DOWN}
Description: SUA ASP status.
UASPID - User ASP ID
Permission: Read-only
Type: string
Description: SUA ASP Identifier received from a preconfigured user. This value can differ from the ID if ASP ID Validation for the pre-configured ASP has been set to DISABLED. The User ASP ID is used (rather than the ID) when sending NOTIFY messages concerning this ASP.
HB - Heartbeat
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Enable or disable the Heartbeat feature.
HB_INTV - Heartbeat Interval
Permission: Writeable
Type: int(Range: [0..65355])
Description: Heartbeat interval (ms).
RTO_INIT - RTO Initial
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Initial Retransmission Timeout (ms).
RTO_MIN - RTO Minimum
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Minimum Retransmission Timeout (ms).
RTO_MAX - RTO Maximum
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum Retransmission Timeout (ms).
MAX_INIT_RETRANS - Maximum Init Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum initial retransmissions.
MAX_ASSOC_RETRANS - Maximum Assoc Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum association retransmissions.
MAX_PATH_RETRANS - Maximum Path Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum path retransmissions.
BUNDLING - Bundling
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Enable or disable the Bundling feature.
BUNDLING_TO - Bundling Timeout
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Bundling timeout (msecs).
DELAYACK_TO - Delayed Ack Timeout
Permission: Writeable
Type: int(Range: [0..500])
Description: Delayed acknowledgement timeout.
CHECKSUM - Checksum
Permission: Writeable
Type: SCTPCheckSum={ADLER32,CRC32C,NONE}
Description: Checksum algorithm
INSTREAMS - In Streams
Permission: Writeable
Type: int(Range: [0..65355])
Description: Number of in streams.
OUTSTREAMS - Out Streams
Permission: Writeable
Type: int(Range: [0..65355])
Description: Number of out streams.
RXMSG - Rx MSG Count
Permissions: Read-only
Type: int
Description: Number Received Messages per second
TXMSG - Tx MSG Count
Permissions: Read-only
Type: int
Description: Number Transmitted Messages per second
SUA SCTP Servers
CHG-SUA-SERVERS
CHG-SUA-SERVERS:::[CTAG]:::::[DFLT_NA=<int>],[ASP_MGMT=<ASPMgmt>],[HB=<FeatureBoolean>],[HB_INTV=<int>],[RTO_INIT=<int>],[RTO_MIN=<int>],[RTO_MAX=<int>],[MAX_INIT_RETRANS=<int>],[MAX_ASSOC_RETRANS=<int>],[MAX_PATH_RETRANS=<int>],[BUNDLING=<FeatureBoolean>],[BUNDLING_TO=<int>],[DELAYACK_TO=<int>],[INSTREAMS=<int>],[OUTSTREAMS=<int>];
SET-SUA-SERVERS
SET-SUA-SERVERS:::[CTAG]:::[ACT/DEACT];
VFY-SUA-SERVERS
VFY-SUA-SERVERS:::[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
:::<DFLT_NA=int>,<ASP_MGMT=ASPMgmt>,<STATUS=FeatureBoolean>,<HB=FeatureBoolean>,<HB_INTV=int>,<RTO_INIT=int>,<RTO_MIN=int>,<RTO_MAX=int>,<MAX_INIT_RETRANS=int>,<MAX_ASSOC_RETRANS=int>,<MAX_PATH_RETRANS=int>,<BUNDLING=FeatureBoolean>,<BUNDLING_TO=int>,<DELAYACK_TO=int>,<CHECKSUM=SCTPCheckSum>,<INSTREAMS=int>,<OUTSTREAMS=int>;
Attribute Details
DFLT_NA - Default Network Appearance
Permission: Writeable
Type: int
Description: SUA default network appearance. If the NA is not provided in the transfer message the default NA is used to select the SCCP NA Connection.
ASP_MGMT - ASP Management
Permission: Writeable
Type: ASPMgmt={CONFIGURED AND DYNAMIC,CONFIGURED ONLY}
Description: ASP Dynamic and/or preconfigured setup.
STATUS - Status
Permission: Read-only
Type: FeatureBoolean={DISABLED,ENABLED}
Description: SUA SCTP Server status.
HB - Heartbeat
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Enable or disable the Heartbeat feature.
HB_INTV - Heartbeat Interval
Permission: Writeable
Type: int(Range: [0..65355])
Description: Heartbeat interval (ms).
RTO_INIT - RTO Initial
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Initial Retransmission Timeout (ms).
RTO_MIN - RTO Minimum
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Minimum Retransmission Timeout (ms).
RTO_MAX - RTO Maximum
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum Retransmission Timeout (ms).
MAX_INIT_RETRANS - Maximum Init Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum initial retransmissions.
MAX_ASSOC_RETRANS - Maximum Assoc Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum association retransmissions.
MAX_PATH_RETRANS - Maximum Path Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum path retransmissions.
BUNDLING - Bundling
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Enable or disable the Bundling feature.
BUNDLING_TO - Bundling Timeout
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Bundling timeout (msecs).
DELAYACK_TO - Delayed Ack Timeout
Permission: Writeable
Type: int(Range: [0..500])
Description: Delayed acknowledgement timeout.
CHECKSUM - Checksum
Permission: Writeable
Type: SCTPCheckSum={ADLER32,CRC32C,NONE}
Description: Checksum algorithm
INSTREAMS - In Streams
Permission: Writeable
Type: int(Range: [0..65355])
Description: Number of in streams.
OUTSTREAMS - Out Streams
Permission: Writeable
Type: int(Range: [0..65355])
Description: Number of out streams.
SUA SCTP Server
DLT-SUA-SERVER
DLT-SUA-SERVER::[<SUA SCTP Server/Slot>-<SUA SCTP Server/Server ID>]:[CTAG];
ADD-SUA-SERVER
ADD-SUA-SERVER::[<SUA SCTP Server/Slot>]:[CTAG]:::::[IP1=<string>],[IP2=<string>],[PORT=<int>];
CHG-SUA-SERVER
CHG-SUA-SERVER::[<SUA SCTP Server/Slot>-<SUA SCTP Server/Server ID>]:[CTAG]:::::[IP1=<string>],[IP2=<string>],[PORT=<int>],[USE DEFAULT=<default_sctp_values>],[HB=<FeatureBoolean>],[HB_INTV=<int>],[RTO_INIT=<int>],[RTO_MIN=<int>],[RTO_MAX=<int>],[MAX_INIT_RETRANS=<int>],[MAX_ASSOC_RETRANS=<int>],[MAX_PATH_RETRANS=<int>],[BUNDLING=<FeatureBoolean>],[BUNDLING_TO=<int>],[DELAYACK_TO=<int>],[INSTREAMS=<int>],[OUTSTREAMS=<int>];
SET-SUA-SERVER
SET-SUA-SERVER::[<SUA SCTP Server/Slot>-<SUA SCTP Server/Server ID>]:[CTAG]:::[ACT/DEACT];
VFY-SUA-SERVER
VFY-SUA-SERVER::[<SUA SCTP Server/Slot>-<SUA SCTP Server/Server ID>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<SUA SCTP Server/Slot>-<SUA SCTP Server/Server ID>]:<SLOT=int>,<ServerID=int>,<IP1=string>,<IP2=string>,<PORT=int>,<STATUS=FeatureBoolean>,<USE DEFAULT=default_sctp_values>,<HB=FeatureBoolean>,<HB_INTV=int>,<RTO_INIT=int>,<RTO_MIN=int>,<RTO_MAX=int>,<MAX_INIT_RETRANS=int>,<MAX_ASSOC_RETRANS=int>,<MAX_PATH_RETRANS=int>,<BUNDLING=FeatureBoolean>,<BUNDLING_TO=int>,<DELAYACK_TO=int>,<CHECKSUM=SCTPCheckSum>,<INSTREAMS=int>,<OUTSTREAMS=int>;
AID Description
Slot - Position 1
Type: int
Description: The Slot where the server is being configured
Server ID - Position 2
Type: int
Description: SUA SCTP Server ID
Attribute Details
SLOT - Slot
Permission: Createable
Type: int
Description: The Slot where the server is being configured
ServerID - Server ID
Permission: Read-only
Type: int
Description: SUA SCTP Server ID
IP1 - IP Address 1
Permissions: Writeable and Createable
Type: string
Description: SUA SCTP Server primary address. This may be a hostname or an IP Address. If a hostname is used it must be provisioned either in /etc/hosts or via a properly-configured DNS Server and should resolve to a subset of the local IP Addresses configured for the slot where the SCTP server is hosted. Hostname resolution is attempted periodically. Resolution updates take effect ONLY when the server is restarted.
IP2 - IP Address 2
Permissions: Writeable and Createable
Type: string
Description: SUA SCTP Server secondary address. This may be a hostname or an IP Address. If a hostname is used it must be provisioned either in /etc/hosts or via a properly-configured DNS Server and should resolve to a subset of the local IP Addresses configured for the slot where the SCTP server is hosted. Hostname resolution is attempted periodically. Resolution updates take effect ONLY when the server is restarted.
PORT - Port
Permissions: Writeable and Createable
Type: int
Description: SUA SCTP Server port.
STATUS - Status
Permission: Read-only
Type: FeatureBoolean={DISABLED,ENABLED}
Description: SUA SCTP Over All Server status.
USE DEFAULT - Default SCTP Values
Permission: Writeable
Type: default_sctp_values={NO,YES}
Description: Use SUA SCTP default parameters.
HB - Heartbeat
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Enable or disable the Heartbeat feature. SCTP Server must be de-activated and re-activated to take effect.
HB_INTV - Heartbeat Interval
Permission: Writeable
Type: int(Range: [0..65355])
Description: Heartbeat interval (ms). SCTP Server must be de-activated and re-activated to take effect.
RTO_INIT - RTO Initial
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Initial Retransmission Timeout (ms). SCTP Server must be de-activated and re-activated to take effect.
RTO_MIN - RTO Minimum
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Minimum Retransmission Timeout (ms). SCTP Server must be de-activated and re-activated to take effect.
RTO_MAX - RTO Maximum
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum Retransmission Timeout (ms). SCTP Server must be de-activated and re-activated to take effect.
MAX_INIT_RETRANS - Maximum Init Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum initial retransmissions. SCTP Server must be de-activated and re-activated to take effect.
MAX_ASSOC_RETRANS - Maximum Assoc Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum association retransmissions. SCTP Server must be de-activated and re-activated to take effect.
MAX_PATH_RETRANS - Maximum Path Retrans
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Maximum path retransmissions. SCTP Server must be de-activated and re-activated to take effect.
BUNDLING - Bundling
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Enable or disable the Bundling feature. SCTP Server must be de-activated and re-activated to take effect.
BUNDLING_TO - Bundling Timeout
Permission: Writeable
Type: int(Range: [0..2147483647])
Description: Bundling timeout (msecs). SCTP Server must be de-activated and re-activated to take effect.
DELAYACK_TO - Delayed Ack Timeout
Permission: Writeable
Type: int(Range: [0..500])
Description: Delayed acknowledgement timeout. SCTP Server must be de-activated and re-activated to take effect.
CHECKSUM - Checksum
Permission: Writeable
Type: SCTPCheckSum={ADLER32,CRC32C,NONE}
Description: Checksum algorithm. SCTP Server must be de-activated and re-activated to take effect.
INSTREAMS - In Streams
Permission: Writeable
Type: int(Range: [0..65355])
Description: Number of in streams. SCTP Server must be de-activated and re-activated to take effect.
OUTSTREAMS - Out Streams
Permission: Writeable
Type: int(Range: [0..65355])
Description: Number of out streams. SCTP Server must be de-activated and re-activated to take effect.
DLT-SUA-CONFASP
DLT-SUA-CONFASP::[<SUA Configured ASP/ID>]:[CTAG];
ADD-SUA-CONFASP
ADD-SUA-CONFASP::[<SUA Configured ASP/ID>]:[CTAG]:::::[ASP_TYPE=<SuaASPType>],[IP1=<string>],[IP2=<string>],[PORT=<int>];
CHG-SUA-CONFASP
CHG-SUA-CONFASP::[<SUA Configured ASP/ID>]:[CTAG]:::::[NAME=<string>],[IDVAL=<FeatureBoolean>],[XMSG=<FeatureBoolean>],[INCOMING_APPID=<string>],[NA=<DefaultNA>],[IMF=<FeatureBoolean>],[INC_OPC=<pointcode>],[REMOVE_DPC=<FeatureBoolean>];
SET-SUA-CONFASP
SET-SUA-CONFASP::[<SUA Configured ASP/ID>]:[CTAG]:::[ACT/DEACT];
VFY-SUA-CONFASP
VFY-SUA-CONFASP::[<SUA Configured ASP/ID>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<SUA Configured ASP/ID>]:<ID=int>,<ASP_TYPE=SuaASPType>,<IP1=string>,<IP2=string>,<PORT=int>,<NAME=string>,<IDVAL=FeatureBoolean>,<XMSG=FeatureBoolean>,<INCOMING_APPID=string>,<ACTIVATED=FeatureBoolean>,<NA=DefaultNA>,<IMF=FeatureBoolean>,<INC_OPC=pointcode>,<REMOVE_DPC=FeatureBoolean>;
AID Description
ID - Position 1
Type: int (Range [1...2.14748e+09])
Description: SUA configured ASP unique identifier.
Attribute Details
ASP_TYPE - ASP Type
Permission: Read-only
Type: SuaASPType={STANDARD, PSX}
Description: Type of ASP.
STANDARD: Standard ASP configuration.
PSX: Specialized type of ASP, only to be used for interoperation with the PSX product.
Default value: STANDARD
ID - ID
Permission: Createable
Type: int (Range [1...2.14748e+09])
Description: SUA configured ASP unique identifier.
IP1 - IP Address 1
Permissions: Createable
Type: string
Description: SUA Configured ASP primary address. This may be a hostname or an IP Address. If a hostname is used it must be provisioned either in /etc/hosts or via a properly-configured DNS Server and should resolve to a subset of the remote IP Addresses configured for the host where the ASP terminates. Hostname resolution is attempted periodically. This attribute defines the primary IP address specifying the SCTP primary path to the remote SCTP endpoint. If the resolution returns more than one IP address, no guarantee is made as to non-ambiguous definition of the SCTP primary path.
IP2 - IP Address 2
Permissions: Createable
Type: string
Description: SUA Configured ASP secondary address. This may be a hostname or an IP Address. If a hostname is used it must be provisioned either in /etc/hosts or via a properly-configured DNS Server and should resolve to a subset of the remote IP Addresses configured for the host where the ASP terminates. Hostname resolution is attempted periodically.
PORT - Port
Permission: Createable
Type: int
Description: Remote port from which ASP will connect.
NAME - Name
Permission: Writeable
Type: string
Description: SUA configured ASP name. Alphanumeric with dash and underscore for a maximum of 16 characters. Automatically moved to upper-case. Must be unique in SUA. Reserved value DYNAMIC for non-configured ASPs.
IDVAL - ASP ID Validation
Permission: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: It is highly recommended that for increased security that this attribute remain enabled. When enabled the ASP using the configured endpoint MUST either NOT send the ASP ID parameter OR send the preconfigured ID. If an ASP ID parameter contains an identifier other than what is preconfigured, an ERROR (Invalid ASP Identifier) will be sent. When disabled, the ASP Identifier contained in the ASPUP is not validated. This is typically useful when changing the ID used by the ASP is especially troublesome.
XMSG - Extended Message Support
Permissions: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: SUA support of extended message outgoing from this ASP. Enabled by default, the SUA data message Hop Counter parameter is forwarded as received into the SCCP UAP QoS parameter hop counter field. SCCP automatically converts the message to a XUDT(S) to include non-zero Hop Counter values. Disabling this feature ignores the SUA hop counter value and always send to SCCP the UAP QoS with a hop counter 0. SCCP will only generate and XUDT(S) message in this scenario if segmentation is required (too large MSU).
INCOMING_APPID - Incoming AppID
Permission: Writeable
Type: string
Description: SUA Incoming AppID for Gateway Screening. On creation, the attribute is defaulted to SUA_DEFAULT.
Activated - User Activated
Permission: Read-only
Type: FeatureBoolean={DISABLED,ENABLED}
Description: SUA ASP Association User State (ENABLED/DISABLED).
NA - Default Network Appearance
Permissions: Writeable
Type: DefaultNA={UNSET, 1 to 99}
Description: Upon receipt of an SUA message which does not contain a Routing Context or Network Appearance parameter, the SG uses this value to determine the destination SS7 network. If this value is UNSET (-1), the Default Network Appearance specified in the SUA SCTP Servers is used to determine the destination SS7 network. The Network Appearance must also be configured as an SCCP NA. The default value is UNSET. Changing this attribute value can impact traffic.
INCLUDE_OPC - Include OPC
Permissions: Writeable
Type: pointcode
Description: Upon receipt of an SUA Data message which does not contain an OPC, the SG will populate the PC in the Source Address. If the value is UNSET, no modification is applied.
Default value: UNSET
REMOVE_DPC- Remove DPC
Permissions: Writeable
Type: FeatureBoolean
Description: When sending Data messages to the PSX, if the Destination Address contains Global Title digits, the Routing Indicator will be changed to route on GT and the destination point code will be removed.
Default value: DISABLED
SUA Routing Context
DLT-SUA-RC
DLT-SUA-RC::[<SUA Configured ASP/ID>]-[<SUA Routing Context/Routing Context>]:[CTAG];
ADD-SUA-RC
ADD-SUA-RC::[<SUA Configured ASP/ID>]-[<SUA Routing Context/Routing Context>]:[CTAG];
CHG-SUA-RC
CHG-SUA-RC::[<SUA Configured ASP/ID>]-[<SUA Routing Context/Routing Context>]:[CTAG]:::::[REMOTERC=<RemoteRC>];
VFY-SUA-RC
VFY-SUA-RC::[<SUA Configured ASP/ID>]-[<SUA Routing Context/Routing Context>]:[CTAG];
::[<SUA Configured ASP/ID>]-[<SUA Routing Context/Routing Context>]:<RC=int>,<REMOTERC=RemoteRC>;
AID Description
Routing Context - Position 1
Type: int (Range [1...2.14748e+09])
Description: Routing context.
Attribute Details
RC - Routing Context
Permission: Createable
Type: int (Range [1...2.14748e+09])
Description: Routing context.
REMOTERC - Remote Routing Context
Permission: Writeable
Type: RemoteRC={UNDEFINED, 0 to 2147483647}
Description: Remote routing context is used to connect a group of configured RCs. An ASP may go active for the group of RCs by sending a single ASP Active message containing only the remote routing context. All notifications and Acks pertaining to any AS in the group will contain the remote routing context. This feature should only be used in loadshare and broadcast traffic modes. To set the value to UNDEFINED, enter -1.
CIC UA
VFY-CICUA
VFY-CICUA:::[CTAG];
CHG-CICUA
CHG-CICUA:::[CTAG]:::::[MSG_ACK_TM=<TimerEnable>],[EXCESS_ACK_TM=<TimerEnable>],[MSG_LIFESPAN=<TimerEnable>],[IMF=<FeatureBoolean>],[MAX_CAP=<int>],[USAGE_LOWER=<Percent>],[USAGE_UPPER=<Percent>],[INT_MINS=<int>],[INT_SECS=<int>];
SET-CICUA
SET-CICUA:::[CTAG]:::[START/STOP];
:::<MSG_ACK_TM=TimerEnable>,<EXCESS_ACK_TM=TimerEnable>,<MSG_LIFESPAN=TimerEnable>,<IMF=FeatureBoolean>,<MONITOR=FeatureBoolean>,<MAX_CAP=int>,<USAGE_LOWER=Percent>,<USAGE_UPPER=Percent>,<INT_MINS=int>,<INT_SECS=int>;
Attribute Details
MSG_ACK_TM - Message Ack Timer
Permissions: Writeable
Type: TimerEnable={DISABLED, 1 to 1000000}
Description: Message Acknowledgement Timer.
EXCESS_ACK_TM - Excessive Ack Delay
Permissions: Writeable
Type: TimerEnable={DISABLED, 1 to 1000000}
Description: Detects excessive acknowledgement delay.
MSG_LIFESPAN - Message Lifespan
Permissions: Writeable
Type: TimerEnable={DISABLED, 1 to 1000000}
Description: Lifetime of a queued message.
IMF - IMF Support
Permissions: Writeable
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Integrated Monitoring Feed feature support for CIC UA. IMF must be licensed to enable this attribute.
MONITOR - Monitoring
Permissions: Read-only
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Monitoring feature (ENABLED/DISABLED).
MAX_CAP - Maximum Connection Capacity
Permissions: Writeable
Type: int
Description: Maximum number of bytes per second sent on a AS connection.
USAGE_LOWER - Usage Lower Threshold
Permissions: Writeable
Type: Percent={DEFAULT, 0 to 100} (Units: %)
Description: Percentage of the lower threshold for logging.
USAGE_UPPER - Usage Upper Threshold
Permissions: Writeable
Type: Percent={DEFAULT, 0 to 100} (Units: %)
Description: Percentage of the upper threshold for logging.
INT_MINS - Usage Interval Minutes
Permissions: Writeable
Type: int
Description: Interval in minutes used to calculate average traffic load.
INT_SECS - Usage Interval Seconds
Permissions: Writeable
Type: int
Description: Interval in seconds used to calculate average traffic load.
CIC UA App Server
VFY-CICUA-APPSRV
VFY-CICUA-APPSRV:::[CTAG];
:::<NA=int>,<DPC=pointcode>,<OPC=pointcode>,<SI=int>,<STATUS=StatusASUA>;
Attribute Details
NA - Network Appearance
Permissions: Read-only
Type: int
Description: CIC UA App Server Network Appearance.
DPC - DPC
Permissions: Read-only
Type: pointcode
Description: CIC UA App Server Destination Point Code.
OPC - OPC
Permissions: Read-only
Type: pointcode
Description: CIC UA App Server Originating Point Code.
SI - SI
Permissions: Read-only
Type: int
Description: CIC UA App Server Signaling Indicator.
STATUS - Status
Permissions: Read-only
Type: StatusASUA={DOWN,PENDING REG,UP}
Description: CIC UA App Server Status (UP/DOWN/PENDING REG).
CIC UA AS CIC
VFY-CICUA-CICUAASCIC
VFY-CICUA-CICUAASCIC:::[CTAG];
:::<CIC_MIN=int>,<CIC_MAX=int>,<COST=int>,<TRANS_TYPE=TransferType>,<SLOT=int>,<ASP_ID=int>;
Attribute Details
CIC_MIN - CIC Minimum
Permissions: Read-only
Type: int(Range: [0..65355])
Description: The minimum CIC in range.
CIC_MAX - CIC Maximum
Permissions: Read-only
Type: int(Range: [0..65355])
Description: The maximum CIC in range.
COST - Cost
Permissions: Read-only
Type: int(Range: [0..255])
Description: The associated cost.
TRANS_TYPE - Transfer Type
Permissions: Read-only
Type: TransferType={NATIVE,ROUTING LABEL,NATIVE CONFIRMED,ROUTING LABEL CONFIRMED}
Description: The associated transfer type.
SLOT - Slot
Permissions: Read-only
Type: int
Description: The associated slot.
ASP_ID - ASP ID
Permissions: Read-only
Type: int
Description: Correlated ASP ID.
CIC UA ASP
VFY-CICUA-CICUAASP
VFY-CICUA-CICUAASP:::[CTAG]
:::<SLOT=int>,<ASP_ID=int>,<HOST=string>,<PORT=int>;
Attribute Details
SLOT - Slot
Permissions: Read-only
Type: int
Description: CIC UA ASP Slot.
ASP_ID - ASP ID
Permissions: Read-only
Type: int
Description: CIC UA ASP unique identifier.
HOST - Host
Permissions: Read-only
Type: string
Description: CIC UA ASP Host (remote).
PORT - Port
Permissions: Read-only
Type: int
Description: CIC UA ASP Port (remote).
CIC UA TCP Server
VFY-CICUA-CICUATCP
VFY-CICUA-CICUATCP:::[CTAG];
CHG-CICUA-CICUATCP
CHG-CICUA-CICUATCP:::[CTAG]:::::[DEFAULT_NA=<int>],[PORT=<int>],[KA_TIMER=<TimerEnable>];
SET-CICUA-CICUATCP
SET-CICUA-CICUATCP:::[CTAG]:::[ACT/DEACT];
:::<DEFAULT_NA=int>,<PORT=int>,<STATUS=FeatureBoolean>,<KA_TIMER=TimerEnable>;
Attribute Details
DEFAULT_NA - Default Network Appearance
Permissions: Writeable
Type: int
Description: CIC UA default network appearance. If the NA is not provided in the transfer message the default NA is used to select the MTP3 NA Connection. Changing this attribute value can impact traffic.
PORT - Port
Permissions: Writeable
Type: int
Description: CIC UA TCP Server Port
STATUS - Status
Permissions: Read-only
Type: FeatureBoolean={DISABLED,ENABLED}
Description: CIC UA TCP Server Status.
KA_TIMER - Keep Alive Timer
Permissions: Writeable
Type: TimerEnable={DISABLED, 1 to 1000000}
Description: The Keep Alive timer is the interval between Keep Alive pulses on the TCP server connections. (ms).
SFG UA
CHG-SFGUA
CHG-SFGUA:::[CTAG]:::::[INCOMING_APPID=<string>];
VFY-SFGUA
VFY-SFGUA:::[CTAG];
:::<EXCHANGE_NAME=string>,<EXCHANGE_STATUS=ConnState>,<INCOMING_APPID=string>;
Attribute Details
EXCHANGE_NAME - Exchange Name
Permission: Read-only
Type: string
Description: SFG UA Exchange Name.
EXCHANGE_STATUS - Exchange Status
Permission: Read-only
Type: ConnState={NOT CONNECTED,CONNECTED}
Description: SFG UA Exchange Status.
INCOMING_APPID - Incoming AppID
Permission: Writeable
Type: string
Description: SFG UA Incoming AppID for Gateway Screening.
SFG UA MTP3 App Server
DLT-SFGUA-MTP3APPSRV
DLT-SFGUA-MTP3APPSRV::[<SFG UA MTP3 App Server/Routing Context>]:[CTAG];
ADD-SFGUA-MTP3APPSRV
ADD-SFGUA-MTP3APPSRV::[<SFG UA MTP3 App Server/Routing Context>]:[CTAG]:::::[NA=<int>],[PC=<pointcode>],[SI=<int>],[AI=<string>],[SH_ID=<SHType>];
VFY-SFGUA-MTP3APPSRV
VFY-SFGUA-MTP3APPSRV::[<SFG UA MTP3 App Server/Routing Context>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<SFG UA MTP3 App Server/Routing Context>]:<RC=int>,<NA=int>,<PC=pointcode>,<SI=int>,<AI=string>,<SH_ID=SHType>,<STATUS=StatusASUA>;
AID Description
Routing Context - Position 1
Type: int (Range [1...2.14748e+09])
Description: SFG UA MTP3 App Server Routing Context.
Attribute Details
RC - Routing Context
Permission: Createable
Type: int (Range [1...2.14748e+09])
Description: SFG UA MTP3 App Server Routing Context.
NA - Network Appearance
Permission: Createable
Type: int
Description: SFG UA MTP3 App Server Network Appearance.
PC - PC
Permission: Createable
Type: pointcode
Description: SFG UA MTP3 App Server Point Code (optional).
SI - SI
Permission: Createable
Type: int
Description: SFG UA MTP3 App Server Signaling Indicator (optional).
AI - Application ID
Permission: Createable
Type: string
Description: SFG UA MTP3 App Server Application ID (optional).
SH_ID - Service Handler ID
Permission: Createable
Type: SHType={1 to 255}
Description: SFG UA MTP3 App Server Service Handler ID.
STATUS - Status
Permission: Read-only
Type: StatusASUA={DOWN,PENDING REG,UP}
Description: SFG UA MTP3 App Server Status (UP/DOWN/PENDING REG).
SFG UA SCCP App Server
DLT-SFGUA-SCCPAPPSRV
DLT-SFGUA-SCCPAPPSRV::[<SFG UA SCCP App Server/Routing Context>]:[CTAG];
ADD-SFGUA-SCCPAPPSRV
ADD-SFGUA-SCCPAPPSRV::[<SFG UA SCCP App Server/Routing Context>]:[CTAG]:::::[NA=<int>],[PC=<pointcode>],[SSN=<int>],[AI=<string>],[SH_ID=<SHType>];
VFY-SFGUA-SCCPAPPSRV
VFY-SFGUA-SCCPAPPSRV::[<SFG UA SCCP App Server/Routing Context>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<SFG UA SCCP App Server/Routing Context>]:<RC=int>,<NA=int>,<PC=pointcode>,<SSN=int>,<AI=string>,<SH_ID=SHType>,<STATUS=StatusASUA>;
AID Description
Routing Context - Position 1
Type: int (Range [1...2.14748e+09])
Description: SFG UA SCCP App Server Routing Context.
Attribute Details
RC - Routing Context
Permission: Createable
Type: int (Range [1...2.14748e+09])
Description: SFG UA SCCP App Server Routing Context.
NA - Network Appearance
Permission: Createable
Type: int
Description: SFG UA SCCP App Server Network Appearance.
PC - PC
Permission: Createable
Type: pointcode
Description: SFG UA SCCP App Server Point Code (optional).
SSN - SSN
Permission: Createable
Type: int
Description: SFG UA SCCP App Server Sub-System Number (optional).
AI - Application ID
Permission: Createable
Type: string
Description: SFG UA SCCP App Server Application ID (optional).
SH_ID - Service Handler ID
Permission: Createable
Type: SHType={1 to 255}
Description: SFG UA SCCP App Server Service Handler ID.
STATUS - Status
Permission: Read-only
Type: StatusASUA={DOWN,PENDING REG,UP}
Description: SFG UA SCCP App Server Status (UP/DOWN/PENDING REG).
MTP3 NA
DLT-SGMTP-NA
DLT-SGMTP-NA::[<MTP3 NA/Network Appearance>]:[CTAG];
ADD-SGMTP-NA
ADD-SGMTP-NA::[<MTP3 NA/Network Appearance>]:[CTAG];
CHG-SGMTP-NA
CHG-SGMTP-NA::[<MTP3 NA/Network Appearance>]:[CTAG]:::::[KEEP_ALIVE_TIMER=<TimerEnable>];
SET-SGMTP-NA
SET-SGMTP-NA::[<MTP3 NA/Network Appearance>]:[CTAG]:::[ACT/DEACT/C20DELETE/FORCEC20DELETE];
VFY-SGMTP-NA
VFY-SGMTP-NA::[<MTP3 NA/Network Appearance>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<MTP3 NA/Network Appearance>]:<NA=int>,<SS7_VARIANT=SS7VariantType>,<LPC=pointcode>,<NA_STATUS=NAStatus>,<MTP_STATUS=AvailStatus>,<KEEP_ALIVE_TIMER=TimerEnable>,<DELETE_STATUS=DeleteStatus>,<RXMSG=int>,<TXMSG=int>;
AID Description
Network Appearance - Position 1
Type: int
Description: The MTP3 corresponding network appearance.
Attribute Details
NA - Network Appearance
Permission: Createable
Type: int
Description: The MTP3 corresponding network appearance.
SS7_VARIANT - SS7 Variant
Permission: Read-only
Type: SS7VariantType={UNDEFINED,ANSI,ITU,CHINA,NTT,TTC}
Description: The MTP3 SS7 Variant for the given NA.
LPC - Local Point Code
Permission: Read-only
Type: pointcode
Description: The MTP3 local point code for the given NA. A value of Undefined indicates that the LPC has not yet been received from the MTP3.
NA_STATUS - NA Status
Permission: Read-only
Type: NAStatus={INACTIVE,ACTIVE}
Description: MTP3 NA activation status.
MTP_STATUS - MTP3 Local Status
Permission: Read-only
Type: AvailStatus={UNAVAILABLE,AVAILABLE}
Description: Obsolete as of 9.1. MTP3 NA local status.
KEEP_ALIVE_TIMER - Keep Alive Timer
Permission: Writeable
Type: TimerEnable={DISABLED, 1 to 1000000}
Description: The Keep Alive timer is the interval between Keep Alive pulses on the MTP3 NA Connections (ms).
DELETE_STATUS - Delete Status
Permissions: Read-only
Type: DeleteStatus={DELETABLE,UNDELETABLE}
Description: MTP3 NA Delete status. If the NA is C20 NA and it has previously synchronised with the C20 then the NA can only be deleted if the C20 has successfully responded to an NA Delete provisioning message.
RXMSG - Rx MSG Count
Permissions: Read-only
Type: int
Description: Number Received Messages per second
TXMSG - Tx MSG Count
Permissions: Read-only
Type: int
Description: Number Transmitted Messages per second
MTP3 NA Connection
VFY-SGMTP-NACX
VFY-SGMTP-NACX::[<MTP3 NA/Network Appearance>]-[<MTP3 NA Connection/Slot>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<MTP3 NA/Network Appearance>]-[<MTP3 NA Connection/Slot>]:<SLOT=int>,<STATUS=ConnState>;
AID Description
Slot - Position 1
Type: int
Description: The MTP3 NA Connection corresponding slot.
Attribute Details
SLOT - Slot
Permission: Read-only
Type: int
Description: The MTP3 NA Connection corresponding slot.
STATUS - Status
Permission: Read-only
Type: ConnState={NOT CONNECTED,CONNECTED}
Description: The MTP3 NA Connection status (CONNECTED/NOT CONNECTED).
SCCP NA
DLT-SGSCCP-NA
DLT-SGSCCP-NA::[<SCCP NA/Network Appearance>]:[CTAG];
ADD-SGSCCP-NA
ADD-SGSCCP-NA::[<SCCP NA/Network Appearance>]:[CTAG];
CHG-SGSCCP-N
CHG-SGSCCP-NA::[<SCCP NA/Network Appearance>]:[CTAG]:::::[KEEP_ALIVE_TIMER=<TimerEnable>],[ADDR_IND_ENC=<AddrEncInd>];
SET-SGSCCP-NA
SET-SGSCCP-NA::[<SCCP NA/Network Appearance>]:[CTAG]:::[ACT/DEACT];
VFY-SGSCCP-NA
VFY-SGSCCP-NA::[<SCCP NA/Network Appearance>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<SCCP NA/Network Appearance>]:<NA=int>,<SS7_VARIANT=SS7VariantType>,<LPC=pointcode>,<NA_STATUS=NAStatus>,<SCCP_STATUS=AvailStatus>,<KEEP_ALIVE_TIMER=TimerEnable>,<ADDR_IND_ENC=AddrEncInd>,<RXMSG=int>,<TXMSG=int>;
AID Description
Network Appearance - Position 1
Type: int
Description: The SCCP corresponding network appearance.
Attribute Details
NA - Network Appearance
Permission: Createable
Type: int
Description: The SCCP corresponding network appearance.
SS7_VARIANT - SS7 Variant
Permission: Read-only
Type: SS7VariantType={UNDEFINED,ANSI,ITU,CHINA,NTT,TTC}
Description: The SCCP SS7 Variant for the given NA.
LPC - Local Point Code
Permission: Read-only
Type: pointcode
Description: The MTP3 local point code for the given NA. A value of Undefined indicates that the LPC has not yet been received from the SCCP.
NA_STATUS - NA Status
Permission: Read-only
Type: NAStatus={INACTIVE,ACTIVE}
Description: SCCP NA activation status.
SCCP_STATUS - SCCP Local Status
Permission: Read-only
Type: AvailStatus={UNAVAILABLE,AVAILABLE}
Description: Obsolete as of 9.1. SCCP NA local status.
KEEP_ALIVE_TIMER - Keep Alive Timer
Permission: Writeable
Type: TimerEnable={DISABLED, 1 to 1000000}
Description: The Keep Alive timer is the interval between Keep Alive pulses on the SCCP NA Connections (ms).
ADDR_IND_ENC - Address Indicator Encoding
Permissions: Writeable
Type: AddrEncInd={INTERNATIONAL,NATIONAL}
Description: Address Indicator Encoding is used to specify the encoding method of the SCCP Address parameters in message destined for the SS7 network. The default value is INTERNATIONAL and can only be set to NATIONAL for ANSI networks.
RXMSG - Rx MSG Count
Permissions: Read-only
Type: int
Description: Number Received Messages per second
TXMSG - Tx MSG Count
Permissions: Read-only
Type: int
Description: Number Transmitted Messages per second
SCCP NA Connection
VFY-SGSCCP-NACX
VFY-SGSCCP-NACX::[<SCCP NA/Network Appearance>]-[<SCCP NA Connection/Slot>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<SCCP NA/Network Appearance>]-[<SCCP NA Connection/Slot>]:<SLOT=int>,<STATUS=ConnState>;
AID Description
Slot - Position 1
Type: int
Description: The SCCP NA Connection corresponding slot.
Attribute Details
SLOT - Slot
Permission: Read-only
Type: int
Description: The SCCP NA Connection corresponding slot.
STATUS - Status
Permission: Read-only
Type: ConnState={NOT CONNECTED,CONNECTED}
Description: The SCCP NA Connection status (CONNECTED/NOT CONNECTED).
