This section describes the DSC TL1 commands.
DSC Command Groupings
The following figure shows the DSC objects that can be configured using TL1 commands.
This section includes the information for the DSC command set.
DSC
CHG-DSC-DSC
CHG-DSC-DSC::[<DSC/DSC Instance ID>]:[CTAG]:::::[NAME=<string>];
VFY-DSC-DSC
VFY-DSC-DSC::[<DSC/DSC Instance ID>]:[CTAG];;
::[<DSC/DSC Instance ID>]:<ID=int>,<NAME=string>,<VERSION=string>,<ENCRYPT_PKG=string>;
AID Description
DSC INSTANCE ID - Position 1
Type: int
Description: DSC instance identifier (1 to 99). If more than one DSC instance is defined, the value is overwritten by the associated command line argument on startup. Default value: 1.
Attribute Details
ID - DSC Instance ID
Permissions: Read-only
Type: int
Description: DSC instance identifier (1 to 99). If more than one DSC instance is defined, the value is overwritten by the associated command line argument on startup. Default value: 1.
NAME - DSC Name
Permissions: Writeable
Type: string
Description: Name used to logically identify the DSC Instance. If more than one DSC Instance is defined, it is recommended that the name be updated to a short and unique value to facilitate logs, alarms, and statistics correlation. Valid values: alphanumeric characters, dashes, and underscores (maximum size of 64). Default value: DSC_X, where X is the DSC Instance ID.
VERSION - DSC Version
Permissions: Read-only
Type: string
Description: Current DSC application version. This is a hard coded value as per the DSC application.
ENCRYPT_PKG - Encryption Package
Permissions: Read-only
Type: string
Description: DSC Encryption Provider. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (https://www.openssl.org/)
DSC Nodes
CHG-DSC-NODES
CHG-DSC-NODES::[<DSC/DSC Instance ID>]:[CTAG]:::::[RTHOPCOUNTER=<int>],[CAPPS=<string>],[REQLIFESPAN=<int>],[REQMRETRY=<RetryLimitType>],[NAME_ALIAS=<NameAlias>],[LOCALOVR=<string>],[RETRYERR=<Feature>],[LOG_ERRORS=<LogBoolean>],[LOG_SETUP_MGMT=<LogBoolean>],[LOG_DIST_MGMT=<LogBoolean>],[PEER_LDL_LVL=<LogLevel>],[MQK=<int>],[QUEUE_SIZE=<QueueUsage>],[QUEUE_USAGE_1=<Percent>],[QUEUE_USAGE_2=<Percent>],[QUEUE_USAGE_3=<Percent>];
VFY-DSC-NODES
VFY-DSC-NODES::[<DSC/DSC Instance ID>]:[CTAG];
SET-DSC-NODES
SET-DSC-NODES::[<DSC/DSC Instance ID>]:[CTAG]:::[RESTORE_DBG];
::[<DSC/DSC Instance ID>]:<DSCLIC=Licensed>,<LICIMF=Licensed>,<LICTOPOM=Licensed>,<LICTPS=int>,<RTHOPCOUNTER=int>,<CAPPS=string>,<REQLIFESPAN=int>,<REQMRETRY=RetryLimitType>,<NAME_ALIAS=NameAlias>,<LOCALOVR=string>,<LOG_ERRORS=LogBoolean>,<LOG_SETUP_MGMT=LogBoolean>,<LOG_DIST_MGMT=LogBoolean>,<PEER_LDL_LVL=LogLevel>,<LICSYSTPS=int>,<CDTPS=int>,<CWTPS=int>,<CMTPS=int>,<CYTPS=int>,<PDTPS=int>,<PWTPS=int>,<PMTPS=int>,<PYTPS=int>,<MQK=int>,<QUEUE_SIZE=QueueUsage>,<QUEUE_USAGE_1=Percent>,<QUEUE_USAGE_2=Percent>,<QUEUE_USAGE_3=Percent>;
Attribute Details
DSCLIC - DSC License
Permissions: Read-only
Type: Licensed={UNLICENSED,LICENSED}
Description: DSC license (UNLICENSED/LICENSED). This license must be available to configure the DSC functionality.
LICIMF - IMF License
Permissions: Read-only
Type: Licensed={UNLICENSED,LICENSED}
Description: IMF license (UNLICENSED/LICENSED). This license must be available to configure the IMF functionality on a per ADN basis.
LICTOPOM - Topology Mapping License
Permissions: Read-only
Type: Licensed={UNLICENSED,LICENSED}
Description: Topology Mapping license (UNLICENSED/LICENSED). This license must be available to configure the Topology Mapping functionality on a per DSC Node basis.
LICTPS - TPS License
Permissions: Read-only
Type: int
Description: Transactions Per Second license (count). The TPS license has an associated MSA for threshold alarms.
RTHOPCOUNTER - Routing Hop Counter
Permissions: Writeable
Type: int(Range: [1..15])
Description: Routing Hop Counter (1 to 15). If a request is processed by more than the defined DSC and/or UA Nodes, it is discarded as unroutable.
MQK - Maximum Queued KBytes
Permissions: Writeable
Type: int(Range: [2000..8e+06])
Description: Maximum number of message bytes in all queues in a DSC process. Excludes overhead like list of nodes and routing information. Range: 2000-8000000 with default is 2000000 (~2GB).
CAPPS - Capacity Parameter Set
Permissions: Writeable
Type: string
Description: Capacity parameter set for nodal congestion.
REQLIFESPAN - Request Lifespan
Permissions: Writeable
Type: int
Description: Request message lifespan in seconds with return error on expiry. Regardless of how many times the request may have been retransmitted, on lifespan expiry, an answer with error UNABLE_TO_DELIVER is returned. Valid values: 1 to 240 seconds. Default value: 60 seconds.
REQMRETRY - Retransmit Limit
Type: RetryLimitType={UNLIMITED, 0 to 50}
Description: Limit to retry individual node messages upon encountering a failure condition (not including redirect attempts). Valid values: UNLIMITED (-1), 0 to 50 attempts. Default value: 10 attempts. Choosing 0 does not allow for any retries. Choosing UNLIMITED provides an unlimited number of retries.
NAME_ALIAS - Realm Stats Name
Permissions: Writeable
Type: NameAlias={NAME,ALIAS}
Description: Realm information used to form the Instances name in statistics files. The Alias is used for configuration purposes and by default will also be used in Realm Accounting statistics reporting. Since the Realm Name is typically more static in nature, some customers may prefer to use the that value, especially in cases where scripts are used to monitor the data for other purposes. Valid values: NAME (0), ALIAS (1). Default value: ALIAS
LOCALOVR - Local Overload Parameters
Permissions: Writeable
Type: string
Description: Capacity parameter set for general Local Overload detection. The indicated capacity parameter set specifies the message delay and queue size limits for the incoming messages that are used to define the severity levels of the local overload condition. The fields used are Queue Size in Seconds, Queue Size in Messages Congestion Onset 1,2,3; Congestion Abatement 1,2,3; Overload Handling 1,2,3. Valid values: Empty (disabled) or existing Capacity Parameter Set. Default value: Empty.
LOG_ERRORS - Errors
Permissions: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: This attribute allows you to enable or disable the logging of DSC Nodes error messages to the debuglog (NOT LOGGED/LOGGED). The logging of DSC Nodes errors should be set to LOGGED for all production systems. Default value: LOGGED.
LOG_SETUP_MGMT - Setup Management
Permissions: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: This attribute allows you to enable or disable the logging of information concerning the process startup and setup to the debuglog (NOT LOGGED/LOGGED). These logs are not related to traffic processing and have no impact on the performance of a running system. The logging of DSC startup and setup information should be set to LOGGED for most production systems. Default value: LOGGED.
LOG_DIST_MGMT - Distribution Management
Permissions: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: This attribute allows you to enable or disable the logging of information concerning the connection between DSC processes to the debuglog (NOT LOGGED/LOGGED). The resultant log messages are intended for Ribbon Networks engineering staff and are not intended for customer use. The logging of DSC inter-process information should be set to NOT_LOGGED on all production systems so that the CPU is not unduly taxed by spurious log messages. Default value: NOT LOGGED.
PEER_LDL_LVL - LDL Debug Level
Permissions: Writeable
Type: LogLevel={NOT LOGGED, 1 to 10}
Description: The LDL Debug Level should be set to 2 (default) or lower on all production systems, unless directed by support. Otherwise the system performance may be impacted by an undue amount of time logging messages. Valid range is (0 [NOT LOGGED], 1 to 10).
LICSYSTPS - System TPS License
Permissions: Read-only
Type: int
Description: System Transactions Per Second license (count). The System TPS license has an associated System TPS MSA for threshold alarms.
CDTPS - Current Day System TPS High Water Mark
Permissions: Read-only
Type: int
Description: Current Day System Transactions Per Second High Water Mark (count). The current System TPS daily data will be moved to previous day data and then reset at 12:00 a.m. every day.
CWTPS - Current Week System TPS High Water Mark
Permissions: Read-only
Type: int
Description: Current Week System Transactions Per Second High Water Mark (count) from Sunday to Saturday. The current System TPS weekly data will be moved to previous week data and reset at 12:00 a.m. every Sunday morning.
CMTPS - Current Month System TPS High Water Mark
Permissions: Read-only
Type: int
Description: Current Month System Transactions Per Second High Water Mark (count). The current System TPS monthly data will be moved to previous month data and reset on the 1st day of each month.
CYTPS - Current Year System TPS High Water Mark
Permissions: Read-only
Type: int
Description: Current Year System Transactions Per Second High Water Mark (count). The current System TPS yearly data will be moved to previous year and reset on the 1st day of each year.
PDTPS - Previous Day System TPS High Water Mark
Permissions: Read-only
Type: int
Description: Previous Day System Transactions Per Second High Water Mark (count). The previous System TPS daily data will be updated with current daily data at 12:00 a.m. every day. If today is Tuesday, this will represent Monday TPS high water mark data.
PWTPS - Previous Week System TPS High Water Mark
Permissions: Read-only
Type: int
Description: Previous Week System Transactions Per Second High Water Mark (count) from Sunday to Saturday. The previous System TPS weekly data will be updated with current weekly data at 12:00 a.m. every Sunday morning.
PMTPS - Previous Month System TPS High Water Mark
Permissions: Read-only
Type: int
Description: Previous Month System Transactions Per Second High Water Mark (count). The previous System TPS monthly data will be updated with current monthly data on the 1st day of each month.
PYTPS - Previous Year System TPS High Water Mark
Permissions: Read-only
Type: int
Description: Previous Year System Transactions Per Second High Water Mark (count). The previous System TPS yearly data will be updated with current yearly data on the 1st day of each year.
LICMPS - MPS License
Permissions: Read-only
Type: int
Description: Message Per Second license (count)
QUEUE_SIZE - Queue Size
Permissions: Writeable
Type: QueueUsage={AUTO, 1 to 2000000} (Units: MB)(Range: [0..50000])
Description: Queue Size in megabytes. The maximum number of message bytes that may be queued, measured in megabytes. Range: 1 to 50000.
QUEUE_USAGE_1 - Queue Usage Threshold 1
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Queue Usage Alarm Threshold 1. If the message queue is used more than this percentage an alarm is raised. Range: 1 to 100.
QUEUE_USAGE_2 - Queue Usage Threshold 2
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Queue Usage Alarm Threshold 2. If the message queue is used more than this percentage an alarm is raised. Range: 1 to 100.
QUEUE_USAGE_3 - Queue Usage Threshold 3
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Queue Usage Alarm Threshold 3. If the message queue is used more than this percentage an alarm is raised. Range: 1 to 100.
RETRYERR - Default Routing Return Primary Error
Permissions: Writeable
Type: Feature={DISABLED,ENABLED}
Description: The attribute is used in the event that during default routing, routing to all candidates fails. If enabled and the error is a 3xxxx series error then the error received from the first routing candidate is returned to message originator. When disabled the error that is received from the final routing candidate is returned to the originator. Default value: Disabled
DSC Node
DLT-DSC-NODE
DLT-DSC-NODE::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]:[CTAG];
ADD-DSC-NODE
ADD-DSC-NODE::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]:[CTAG]:::::[NAME=<string>],[DID_HOST=<string>],[REALM=<string>];
CHG-DSC-NODE
CHG-DSC-NODE::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]:[CTAG]:::::[NAME=<string>],[DID_HOST=<string>],[REALM=<string>],[DID=<string>],[INITRTNAME=<string>],[TOPOMAP=<string>],[RLMRTNAME=<string>],[INGRESS_FILT=<IngressFiltering>],[MAXROUTDEPTH=<int>],[REALMACCOUNTING=<Feature>],[REALMACCTFMT=<RealmAccountingFmtType>],[ALLOWUNKOWN=<Feature>],[ROUNDTRIPACCOUNTING=<Feature>],[REALMREDIND=<RealmRedirectIndType>],[MAX_TRAC_PER_INTV=<int>],[TRAC_INTV=<LogInterval>],[TRAC_HEX=<MsgTraceHex>],[LOG_ERRORS=<LogBoolean>],[LOG_SETUP_MGMT=<LogBoolean>],[LOG_EXEC_TRACE=<LogBoolean>],[LOG_NODE_COM=<LogBoolean>],[LOG_DIST_MGMT=<LogBoolean>];
SET-DSC-NODE
SET-DSC-NODE::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]:[CTAG]:::[ACTIVATE/DEACTIVATE/RESET_TRACING/RESET_IMF/RESTORE_DBG];
VFY-DSC-NODE
VFY-DSC-NODE::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]:[CTAG];
::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]:<NAME=string>,<DID_HOST=string>,<REALM=string>,<DID=string>,<STATUS=NodeStatus>,<INITRTNAME=string>,<TOPOMAP=string>,<RLMRTNAME=string>,<INGRESS_FILT=IngressFiltering>,<MAXROUTDEPTH=int>,<REALMACCOUNTING=Feature>,<REALMACCTFMT=RealmAccountingFmtType>,<ALLOWUNKOWN=Feature>,<ROUNDTRIPACCOUNTING=Feature>,<REALMREDIND=RealmRedirectIndType>,<INTERNALID=int>,<MAX_TRAC_PER_INTV=int>,<TRAC_INTV=LogInterval>,<TRAC_HEX=MsgTraceHex>,<LOG_ERRORS=LogBoolean>,<LOG_SETUP_MGMT=LogBoolean>,<LOG_EXEC_TRACE=LogBoolean>,<LOG_NODE_COM=LogBoolean>,<LOG_DIST_MGMT=LogBoolean>;
AID Description
Type: string
Name used to logically identify the DSC Node. The Name must be unique within the DSC Instance. It is recommended that the name be set to a short and unique value to facilitate logs and alarms correlation. If no Name is entered on creation, or if the Name is modified to an empty string, the Node Diameter ID will be used. Valid values: alphanumeric characters, dashes, and underscores (maximum size of 32). The name is allowed to contain dots (.) and exceed maximum size only when it matches the Node Diameter ID.
Attribute Details
REALM - Realm
Permissions: Createable
Type: string
Description: DSC Node associated realm. If a FQDN is specified, a Realm Definition will be automatically created if none exists. If a Realm Definition is already defined, the FQDN value will be replaced by the associated Alias. Valid values: FQDN format or existing Realm Definition Alias.
STATUS - Status
Permissions: Read-only
Type: NodeStatus={DOWN,UP,INACTIVE,PARTIALLY UP}
Description: Status of the DSC Node (UP/DOWN/INACTIVE). DSC Node status is set to UP when at least one non-DSC INTERNAL and non-DSC DB ADN is UP.
INITRTNAME - Initial Routing Table Name
Permissions: Writeable
Type: string
Description: Node Initial Routing Table Name. Message incoming from the DSC Node will be routed based on this routing table or use default routing if set to dsc_default. Valid values: dsc_default or an existing Routing Table name. Default value: dsc_default.
MAXROUTDEPTH - Maximum Routing Depth
Permissions: Writeable
Type: int(Range: [10..50])
Description: Maximum Routing Depth (10 to 50). When using explicit routing tables, this limits the depth of the search (the number of routing tables that may be used to route a single message). If this limit is exceeded then the message is returned as an error. This is protection against loops in the routing tables causing undue processor usage. Default value: 10.
ALLOWUNKOWN - Accept Unknown ADNs
Permissions: Writeable
Type: Feature={DISABLED,ENABLED}
Description: Accept incoming connections from unknown/unconfigured adjacent nodes (ENABLED/DISABLED).
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: Node unique internal ID. Reserved for internal usage.
ROUNDTRIPACCOUNTING - Round Trip Accounting
Permissions: Writeable
Type: Feature={DISABLED,ENABLED}
Description: Round Trip Accounting feature (DISABLED/ENABLED). If enabled, round trip delays on outbound transactions are calculated and organized according to destination and command type. Standard statistics intervals apply (5 minutes, 30 minutes, and 1 day). Default value: DISABLED.
REALMREDIND - Receive Realm Redirect Indications
Permissions: Writeable
Type: RealmRedirectIndType={DISABLED,RFC7075,PASSTHROUGH}
Description: Receive Realm Redirect Indications (DISABLED,RFC7075,PASSTHROUGH). Default value: DISABLED. The Receive Realm Redirect Indications Attribute is used to specify how DSC handles the Realm Redirect Indications.
If the Receive-Realm-Redirect-Indications attribute is set to DISABLED, the received DIAMETER_REALM_REDIRECT_INDICATION is treated like a DIAMETER_UNABLE_TO_DELIVER.
If the Receive-Realm-Redirect-Indications attribute is set to PASSTHROUGH, the received DIAMETER_REALM_REDIRECT_INDICATION is forwarded to the incoming ADN with the appropriate hop-by-hop id. The Origin-Host and Origin-Realm AVPs in the REALM_REDIRECT_INDICATION are unchanged.
If the Receive-Realm-Redirect-Indications attribute is set to RFC7075, the received DIAMETER_REALM_REDIRECT_INDICATION is handled as specified in RFC7075 where the DSC will forward the original request using the realms provided in the INDICATION message.
MAX_TRAC_PER_INTV - Max Tracing Per Interval
Permissions: Writeable
Type: int(Range: [0..99])
Description: Maximum number of traced MSUs logged in the given interval (0 to 99). MSU tracing, if enabled, assigns a unique identifier to incoming messages matching a Modification trace record. This allows the user to trace the message throughout the Routing Tables for debugging purposes. Set to 0 to disable message tracing. Default value: 10.
TRAC_INTV - Tracing Interval
Permissions: Writeable
Type: LogInterval={FIVE,TEN,FIFTEEN,TWENTY,THIRTY} (Units: MINUTES)
Description: Message Tracing logging interval [5, 10, 15, 20, or 30 minutes]. Default value: 5 minutes.
TRAC_HEX - Tracing Msg Hex
Permissions: Writeable
Type: MsgTraceHex={INCOMING,INCOMING AND OUTGOING}
Description: Message Tracing logging of hexadecimal [INCOMING, INCOMING AND OUTGOING]. Hexadecimal representation of the message (up to 500 bytes). Default value: INCOMING.
LOG_ERRORS - Errors
Permissions: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: This attribute allows you to enable or disable the logging of DSC Node error messages to the debuglog (NOT LOGGED/LOGGED). The logging of DSC Node errors should be set to LOGGED for all production systems. Default value: LOGGED.
LOG_SETUP_MGMT - Setup Management
Permissions: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: This attribute allows you to enable or disable the logging of information concerning the process startup and setup to the debuglog (NOT LOGGED/LOGGED). These logs are not related to traffic processing and have no impact on the performance of a running system. The logging of DSC Node startup and setup information should be set to LOGGED for most production systems. Default value: LOGGED.
LOG_EXEC_TRACE - Execution Trace
Permissions: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: This attribute allows you to enable or disable the logging of detailed information concerning internal execution of the DSC process on this node to the debuglog (NOT LOGGED/LOGGED). The resultant messages are intended for Ribbon Networks engineering staff and are not intended for customer use. The logging of execution trace must be set to NOT LOGGED on all production systems so that the CPU is not unduly taxed by spurious log messages. Default value: NOT LOGGED.
LOG_NODE_COM - Node Communication
Permissions: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: This attribute allows you to enable or disable the logging of information concerning the connection between nodes to the debuglog (NOT LOGGED/LOGGED). The resultant messages are intended for Ribbon Networks engineering staff and are not intended for customer use. The logging of node communication must be set to NOT LOGGED on all production systems so that the CPU is not unduly taxed by spurious log messages. Default value: NOT LOGGED.
LOG_DIST_MGMT - Distribution Management
Permissions: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: This attribute allows you to enable or disable the logging of information concerning the connection between DSC processes to the debuglog (NOT LOGGED/LOGGED). The resultant messages are intended for Ribbon Networks engineering staff and are not intended for customer use. The logging of inter-process communication must be set to NOT LOGGED on all production systems so that the CPU is not unduly taxed by spurious log messages. Default value: NOT LOGGED.
TOPOMAP - Topology Mapping Table Name
Permissions: Writeable
Type: string
Description: Topology Mapping Table to be applied to Nodes in the DSC realm. Valid values: Existing Topology Mapping table name or empty string to disable.
NAME - Name
Permissions: Writeable and Createable
Type: string
Description: Name used to logically identify the DSC Node. The name must be unique within the DSC instance. The name is recommended to be set to a short and unique value to facilitate logs and alarms correlation. If no name is provided on creation, or if the name is emptied on modification, it will be defaulted to the Node Diameter ID. Valid values: Alphanumeric characters, dashes, and underscores with a maximum size of 32 characters. The name is allowed to contain dots (.) and exceed maximum size only when it matches the Node Diameter ID.
DID_HOST - DID Host
Permissions: Writeable and Createable
Type: string
Description: DSC Node Host within the realm. This attribute is optional when creating a DSC Node with a Node Diameter ID. If specified, the value will be prepended to the Realm to create the Node Diameter ID. Valid values: FQDN format or empty string.
DID - Node Diameter ID
Permissions: Writeable and Createable
Type: string
Description: DSC Node unique Diameter ID. The attribute is optional when creating an DSC Node with a DID Host. If not specified, the value will be set to a concatenation of the DID Host and Realm. Valid values: FQDN format or empty string.
RLMRTNAME - Realm Routing Table Name
Permissions: Writeable
Type: string
Description: Node Realm Routing Table Name. Message incoming from the DSC Node will be routed based on this realm routing table. Valid values: Existing Realm Routing table name or empty string to disable.
INGRESS_FILT - Ingress Filtering
Permissions: Writeable
Type: IngressFiltering={DISABLED,ORIGIN REALM}
Description: Node Ingress Filtering (DISABLED/ORIGIN REALM). Ingress Filtering compares information about the realm of the Incoming ADN against the contents of the Origin-Realm AVP in the request message. If the Origin-Realm is the same as Incoming Realm then the message passes ingress filtering. If a message fails ingress filtering, an answer is returned with error ERROR_UNABLE_TO_DELIVER
REALMACCOUNTING - Realm Accounting
Permissions: Writeable
Type: Feature={DISABLED,ENABLED}
Description: Realm Accounting feature (DISABLED/ENABLED). If enabled, traffic statistics are gathered based on incoming and outgoing realms as well as on associated ADNs where relevant. Standard statistics intervals apply (5 minutes, 30 minutes, and 1 day). Default value: DISABLED.
REALMACCTFMT - Realm Accounting Format
Permissions: Writeable
Type: RealmAccountingFmtType={VERSION 1,VERSION 2}
Description: Realm Accounting Format (VERSION 1/VERSION 2). Default value: VERSION 1.
This attribute will take effect only if the Realm Accounting attribute is ENABLED.
Realm accounting is a feature that counts some details of Diameter transactions and writes the counters to a Comma Separated Values (CSV) file. The Instance column contains a formatted string that includes the Incoming ADN, Outgoing ADN, Originating Realm and Destination Realm. In some cases not all fields are relevant. For example, if a message cannot be routed there is no Outgoing ADN.
If this attribute is set to VERSION 1, the format of the Instance column is the format used in release 16.1.0 and earlier releases. Specifically, the format is:
<DSC Instance Name> <DSC Node Name> <Originating Realm of the incoming request>: <Name of the incoming ADN>:<Destination Realm of the incoming request>: <Name of the ADN from which the answer is received>
If this attribute is set to VERSION 2, the Instance column contains the Instance string from VERSION 1 plus the Application Id, Command Code and Destination-Realm of the outgoing request. Specifically, the format is:
- <DSC Instance Name> <DSC Node Name> <Originating Realm of the incoming request>:<Name of the incoming ADN>:<Destination Realm of the incoming request>:<Name of the ADN from which the answer is received>:<Application-Id>:<Command-Code>:<Destination-Realm of the outgoing Request>
If the request is rejected by the DSC without being sent to an outgoing ADN then the <Destination-Realm of the outgoing Request> is set to (null).
For any of the realm components of the instance, the Alias of an associated Realm Definition is used if it exists. Otherwise, the realm component uses the contents of the appropriate AVP, normalized to lower case and escaped: any character other than alphanumeric, dash or underscore is replaced with '%' followed by two hex digits representing the encoded octet.
If the Application-Id in the message is defined as an Application ID Definition, the <Application-Id> is the Application ID Definition Name, otherwise <Application-Id> is a string representing the numeric value of the Application-Id.
If the Command-Code in the message is defined as an Command-Code Definition, the <Command-Code> is the Command Code Definition Name, otherwise <Command-Code> is a string representing the numeric value of the Command-Code.
Using VERSION 2 includes more granularity in the Instance strings, so it is possible to hit the overflow limit of 50000 distinct Instance strings more easily.
Adjacent Diameter Node
DLT-DSC-ADJNODE
DLT-DSC-ADJNODE::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Adjacent Diameter Node/Adjacent Diameter ID>]:[CTAG];
ADD-DSC-ADJNODE
ADD-DSC-ADJNODE::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Adjacent Diameter Node/Adjacent Diameter ID>]:[CTAG]:::::[TYPE=<PeerType>],[NAME=<string>],[DID_HOST=<string>],[REALM=<string>],;
CHG-DSC-ADJNODE
CHG-DSC-ADJNODE::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Adjacent Diameter Node/Adjacent Diameter ID>]:[CTAG]:::::[TYPE=<PeerType>],[NAME=<string>],[DID_HOST=<string>],[REALM=<string>],[DID=<string>],[TWTMR=<DWTimer>],[TCTMR=<int>],[IPVALIDATE=<Feature>],[STRICTAPPID=<Feature>],[IMF=<Feature>],[DISCAUSE=<DisconnectCause>],[DIAMPROTPARMSET=<string>],[OUTREQRTABLE=<string>],[OUTANSRTABLE=<string>],[MAXADVCAPS=<UnlimitedCap200>];
SET-DSC-ADJNODE
SET-DSC-ADJNODE::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Adjacent Diameter Node/Adjacent Diameter ID>]:[CTAG]:::[ACTIVATE/DEACTIVATE];
VFY-DSC-ADJNODE
VFY-DSC-ADJNODE::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Adjacent Diameter Node/Adjacent Diameter ID>]:[CTAG];
::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Adjacent Diameter Node/Adjacent Diameter ID>]:<TYPE=PeerType>,<NAME=string>,<DID_HOST=string>,<REALM=string>,<DID=string>,<STATUS=NodeStatus>,<TWTMR=DWTimer>,<TCTMR=int>,<IPVALIDATE=Feature>,<STRICTAPPID=Feature>,<IMF=Feature>,<DISCAUSE=DisconnectCause>,<DIAMPROTPARMSET=string>,<OUTREQRTABLE=string>,<OUTANSRTABLE=string>,<MAXADVCAPS=UnlimitedCap200>,<INTERNALID=int>;
AID Description
Adjacent Diameter ID - Position 1
Type: string
Description: Adjacent Diameter Node ID. The attribute is optional when creating an Adjacent Diameter Node with a DID Host. If not specified, the value will be set to a concatenation of the DID Host and Realm. Note: This is the value set in the Origin-Host/Destination-Host AVPs. Valid values: FQDN format or empty string.
Attribute Details
TYPE - Type
Permissions: Writeable and Createable
Type: PeerType={DSC INTERNAL,UA,DIAMETER,UA XML,DSC DB}
Description: Adjacent Diameter Node Type (DSC INTERNAL, UA, DIAMETER, UA XML, DSC DB). The type is required to specify traffic restriction to the ADN. DIAMETER type is used for standard DSC node connectivity. UA type is used for Ribbon applications accepting PT enterprise AVPs such as the Ribbon IWF feature. UA XML type is used for applications using the Ribbon DSC XML protocol which may be configured to accept PT enterprise AVPs. DSC DB type is reserved for Diameter databases such as the Ribbon DRA feature. DSC INTERNAL type is reserved for inter-process communication.
REALM - Realm
Permissions: Writeable and Createable
Type: string
Description: Adjacent Diameter Node associated realm. If an FQDN is specified, a Realm Definition will be automatically created if none exists. If a Realm Definition is already defined, the FQDN value will be replaced by the associated alias. Valid values: FQDN format or existing Realm Definition alias.
STATUS - Status
Permissions: Read-only
Type: NodeStatus={DOWN,UP,INACTIVE,PARTIALLY UP}
Description: Status of the Adjacent Diameter Node (UP/DOWN/INACTIVE). ADN status is set to UP when at least one ADN connection is UP.
TWTMR - Tw Timer
Permissions: Writeable
Type: DWTimer={DISABLED, 6000 to 120000}
Description: Device Watchdog Request timer initial value (DISABLED (0), 6000 to 120000 ms). Initial timer value as per RFC3539. The value is adjusted internally higher or lower by a small random amount. Set to 0 to disable. If disabled, received DWR are still answered. Default value: 30000 ms.
TCTMR - Tc Timer
Permissions: Writeable
Type: int(Range: [1000..60000])
Description: Reconnect timer initial value (1000 to 60000 ms). Initial timer value as per RFC6733 Section 2.1. The value is adjusted internally higher or lower by a small random amount. Default value: 30000 ms.
STRICTAPPID - Strict Application ID Matching
Permissions: Writeable
Type: Feature={DISABLED,ENABLED}
Description: Validate application ID of incoming request messages (DISABLED/ENABLED). If enabled, only send requests to peers for whom the application ID is authorized. If the validation fails, an answer message is returned with error UNABLE_TO_DELIVER. Default value: ENABLED.
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: Adjacent Diameter Node unique internal ID. Reserved for internal usage.
IMF - IMF Support
Permissions: Writeable
Type: Feature={DISABLED,ENABLED}
Description: Integrated Monitoring Feed feature support for DSC (DISABLED/ENABLED). IMF must be licensed to enable this attribute. Default value: DISABLED.
DISCAUSE - DPR Disconnect Cause
Permissions: Writeable
Type: DisconnectCause={REBOOTING,BUSY,DO NOT WANT TO TALK TO YOU, 3 to 32}
Description: Disconnect-Cause AVP value sent within the Disconnect-Peer-Request (as per [RFC6733]). The RFC specifies the following values: REBOOTING (0), BUSY (1), DO NOT WANT TO TALK TO YOU (2). Default value is: BUSY (1). Valid values: Integer in the range 0-32
DIAMPROTPARMSET - Diameter Protocol Parameter Set
Permissions: Writeable
Type: string
Description: Diameter Protocol Parameter Set associated with this ADN. Valid values: Existing Diameter Protocol Parameter Set. Default value: default.
OUTREQRTABLE - Outgoing Request Routing Table
Permissions: Writeable
Type: string
Description: Outgoing Request Routing Table. Outgoing request messages to the ADN will be processed based on this table before topology mapping. To bypass set to dsc_default. Valid values: dsc_default or an existing Routing Table name. Default value: dsc_default.
OUTANSRTABLE - Outgoing Answer Routing Table
Permissions: Writeable
Type: string
Description: Associated optional Routing Table to be applied to the answer message. RFC6733 states that a relay or a proxy agent MUST NOT modify the contents of an answer Result-Code AVP indicating a failure. It is recommended to not change this attribute from the default value of dsc_default. Valid values: dsc_default and an existing Routing Table name. Default value: dsc_default.
MAXADVCAPS - Maximum Accepted Advertised Capabilities
Permissions: Writeable
Type: UnlimitedCap200={UNLIMITED, 200 to 2147483647}
Description: Maximum number of Accepted Advertised Capabilities associated with this ADN. Valid values: (200 to UNLIMITED). Default value: 200.
IPVALIDATE - Remote IP Validation
Permissions: Writeable
Type: Feature={DISABLED,ENABLED}
Description: Validate remote IP addresses of incoming connections (DISABLED/ENABLED). If enabled, the resolved values of the Remote Host of the ADN Connection must match the source address(es) of received TCP or SCTP packets. If that fails then an answer message is returned with error DIAMETER_UNKNOWN_PEER. Default value: ENABLED.
NAME - Name
Permissions: Writeable and Createable
Type: string
Description: Name used to logically identify the Adjacent Diameter Node. The name must be unique within the DSC Instance. It is recommended that the name be set to a short and unique value to facilitate logs and alarms correlation. If no Name is entered on creation, or if the Name is modified to an empty string, the Adjacent Diameter ID will be used. Valid values: alphanumeric characters, dashes, and underscores (maximum size of 32). The name is allowed to contain dots (.) and exceed maximum size only when it matches the Adjacent Diameter ID.
DID_HOST - DID Host
Permissions: Writeable and Createable
Type: string
Description: DSC Node Host within the realm. This attribute is optional when creating an Adjacent Diameter Node with an Adjacent Diameter Node ID. If specified, the value will be prepended to the Realm to create the Adjacent Node Diameter ID. Valid values: FQDN format or empty string.
DID - Adjacent Diameter ID
Permissions: Writeable and Createable
Type: string
Description: Adjacent Diameter Node ID. The attribute is optional when creating an Adjacent Diameter Node with a DID Host. If not specified, the value will be set to a concatenation of the DID Host and Realm. Note: This is the value set in the Origin-Host/Destination-Host AVPs. Valid values: FQDN format or empty string.
ADN Connection
DLT-DSC-ADNCONN
DLT-DSC-ADNCONN::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Adjacent Diameter Node/Adjacent Diameter ID>]-[<ADN Connection/Slot>]:[CTAG];
ADD-DSC-ADNCONN
ADD-DSC-ADNCONN::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Adjacent Diameter Node/Adjacent Diameter ID>]-[<ADN Connection/Slot>]:[CTAG];
CHG-DSC-ADNCONN
CHG-DSC-ADNCONN::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Adjacent Diameter Node/Adjacent Diameter ID>]-[<ADN Connection/Slot>]:[CTAG]:::::[TRTYPE=<TransportType>],[LOCALHOST=<string>],[LOCALPORT=<SCTPLocalPort>],[REMOTEHOST=<string>],[REMOTEPORT=<DiameterPort>],[SECPARMSET=<string>],[CAPPARMSET=<string>],[SCTPPARMSET=<string>],[CERPARMSET=<string>];
SET-DSC-ADNCONN
SET-DSC-ADNCONN::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Adjacent Diameter Node/Adjacent Diameter ID>]-[<ADN Connection/Slot>]:[CTAG]:::[ACTIVATE/DEACTIVATE];
VFY-DSC-ADNCONN
VFY-DSC-ADNCONN::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Adjacent Diameter Node/Adjacent Diameter ID>]-[<ADN Connection/Slot>]:[CTAG];
Response Format
::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Adjacent Diameter Node/Adjacent Diameter ID>]-[<ADN Connection/Slot>]:<SLOT=ADNCSlot>,<TRTYPE=TransportType>,<LOCALHOST=string>,<LOCALHOSTSECONDIP=string>,<LOCALPORT=SCTPLocalPort>,<REMOTEHOST=string>,<REMOTEHOSTSECONDIP=string>,<REMOTEPORT=DiameterPort>,<STATUS=NodeStatus>,<SECPARMSET=string>,<CAPPARMSET=string>,<SCTPPARMSET=string>,<CERPARMSET=string>,<MODE=ADNconnectionmode>,<CURTRANSTYPE=ADN Connection Transport Type>,<PRMPATHSTATUS=Information of Primary Path>,<SECONDPATHSTATUS=Information of Secondary Path>,<RXMSG=int>,<TXMSG=int>,<USERACT=Feature>,<ENCRYPT=string>,<INTERNALID=int>,<VENDOR_ID=string>,<PRODUCT_NAME=string>,<FIRMWARE_REVISION=int>;
AID Description
Slot - Position 1
Type: ADNCSlot={ANY, 1 to 65535}
Description: Adjacent Diameter Node associated DSC slot. Valid values: Available routing CPU slot number and ANY (0). When set to ANY, the Adjacent Diameter Node will be associated with any one of the available routing CPU slots that the Local Host attribute can resolve to. All the available routing slots will attempt to bring the connection UP depending on the Transport Type attribute. Once the connection is successful on one of the routing CPUs, the other routing CPUs will stop attempting to bring the connection in service. When the Local host attribute is set to a hostname that resolves to multiple IP addresses defined on different routing CPUs, then the first routing CPU that is able to bring the connection UP is chosen. Other routing CPUs close their connection and stop initiating and accepting connections.
Attribute Description
ENCRYPT - Encryption
Permissions: Read-only
Type: string
Description: Encryption currently used for this ADN Connection.
SLOT - Slot
Permissions: Createable
Type: ADNCSlot={ANY, 1 to 65535}
Description: Adjacent Diameter Node associated DSC slot. Valid values: Available routing CPU slot number and ANY (0). When set to ANY, the Adjacent Diameter Node will be associated with any one of the available routing CPU slots that the Local Host attribute can resolve to. All the available routing slots will attempt to bring the connection UP depending on the Transport Type attribute. Once the connection is successful on one of the routing CPUs, the other routing CPUs will stop attempting to bring the connection in service. When the Local host attribute is set to a hostname that resolves to multiple IP addresses defined on different routing CPUs, then the first routing CPU that is able to bring the connection UP is chosen. Other routing CPUs close their connection and stop initiating and accepting connections.
TRTYPE - Transport Type
Permissions: Writeable
Type: TransportType={SCTP,TCP,TIPC,SERVER ONLY}
Description: Transport Type (SCTP, TCP, TIPC, SERVER ONLY) Set to the transport type between the DSC node and the adjacent Diameter node. The TCP and SCTP types indicate what type of transport will be used for outgoing connections. Incoming connections may still be accepted via transport server of either protocol. The TIPC type is reserved for DSC INTERNAL ADNs. If setting the SERVER ONLY option, no outgoing transport connections will be attempted. Please make sure an associated Transport Server object is available. Note: 3GPP specifications such as TS 29.272 (S6a, S6c, S6d, S13, S7, ...) require the use of SCTP. Default value: SCTP.
LOCALHOST - Local Host
Permissions: Writeable
Type: string
Description: Local host for the Adjacent Diameter Node (ADN) connection. Mandatory or optional based on the connection and transport types. Valid values: Hostname or IP address. Ignored for TIPC & TCP Transport Types. Default value: slot<Slot>.<DSC Node.Node Diameter ID>
LOCALPORT - Local Port
Permissions: Writeable
Type: SCTPLocalPort={EPHEMERAL, 1 to 65535}
Description: Local port for the Adjacent Diameter Node (ADN) connection (EPHEMERAL, 1 to 65535). Only applicable to Transport Type SCTP. For all other types, the value is set to EPHEMERAL and cannot be modified. Only applicable to outgoing connections, and has no relation to the server used to accept incoming connections. Default value: EPHEMERAL.
REMOTEHOST - Remote Host
Permissions: Writeable
Type: string
Description: Remote host for the Adjacent Diameter Node (ADN) connection. Valid values: Hostname or IP address. Ignored for TIPC and SERVER ONLY Transport Types. Default value: ADN.Adjacent Diameter ID.
REMOTEPORT - Remote Port
Permissions: Writeable
Type: DiameterPort={1 to 65535}
Description: Remote port for the Adjacent Diameter Node (ADN) connection (1 to 65535). Default value: 3868.
STATUS - Status
Permissions: Read-only
Type: NodeStatus={DOWN,UP,INACTIVE}
Description: Status of the Adjacent Diameter Node connection (UP/DOWN/INACTIVE).
SECPARMSET - Security Parameter Set
Permissions: Writeable
Type: string
Description: Security Parameter Set associated with this ADN Connection. Valid values: Existing Security Parameter Set. Default value: default.
CAPPARMSET - Capacity Parameter Set
Permissions: Writeable
Type: string
Description: Capacity Parameter Set associated with this ADN Connection. Valid values: Existing Capacity Parameter Set. Default value: default.
SCTPPARMSET - SCTP Parameter Set
Permissions: Writeable
Type: string
Description: SCTP Parameter Set associated with this ADN Connection. Valid values: Existing SCTP Parameter Set. Default value: default.
CERPARMSET - CER Parameter Set
Permissions: Writeable
Type: string
Description: CER Parameter Set associated with this ADN Connection. Valid values: Existing CER Parameter Set. Default value: default.
RXMSG - Rx Message Count
Permissions: Read-only
Type: int
Description: Received message count, per second.
TXMSG - Tx Message Count
Permissions: Read-only
Type: int
Description: Transmitted message count, per second.
USERACT - User Activation
Permissions: Read-only
Type: Feature={DISABLED,ENABLED}
Description: User activation (ENABLED/DISABLED). The ADN Connection can be activated while the ADN itself is inactive. In this scenario, the connection remains INACTIVE but the User Activation attribute is set to ENABLED. When the ADN is activated, the user activated ADN Connections will also be activated. Default value: DISABLED.
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: Adjacent Diameter Node Connection unique internal ID. Reserved for internal use.
VENDOR_ID - Vendor ID
Permissions: Read-only
Type: string
Description: Diameter Software Vendor ID as extracted from the Capabilities Exchange Request (CE-R) or Answer (CE-A) message. If the Vendor-Id AVP received has a value 0 or it was not received, this field will be set to Invalid (0).
PRODUCT_NAME - Product Name
Permissions: Read-only
Type: string
Description: Vendor-assigned name for the product extracted from the Capabilities Exchange Request (CE-R) or Answer (CE-A) message. If no Product-Name AVP is received, this field will be empty.
FIRMWARE_REVISION - Firmware Revision
Permissions: Read-only
Type: int
Description: Firmware revision of the issuing device extracted from the Capabilities Exchange Request (CE-R) or Answer (CE-A) message. If no Firmware-Revision AVP is received, this field will be 0.
LOCALHOSTSECONDIP - Local Host Secondary IP Address
Permissions: Writeable
Type: string
Description: Local host secondary IP address for the Adjacent Diameter Node connection.Optional based on the connection and transport types.
Valid values: IP address (Only to be configured when Local Host is an IP Address and using SCTP/SERVER ONLY Transport Type).
Default value: UNSET.
REMOTEHOSTSECONDIP - Remote Host Secondary IP Address
Permissions: Writeable
Type: string
Description: Remote host secondary IP address for the Adjacent Diameter Node connection.
Valid values: IP address (Only to be configured when Remote Host is an IP Address and using SCTP/SERVER ONLY Transport Type).
Default value: UNSET.
MODE - ADN Connection Mode
Permissions: Read-only
Type: ADNconnectionmode (SERVER/CLIENT/INTERNAL/NO CONNECTION)
Description: If the DSC-ADN-Connection receives a CER message and sends back a CEA message, the role of the ADN-Connection will be Server and it contains a related link to Transport Server. If the DSC-ADN-Connection sends a CER message and receives a CEA message , the role will be Client. If ADN is DSC INTERNAL and Connection is UP, this field will be INTERNAL. If no ADN connection is established, this field will be NO CONNECTION
CURTRANSTYPE - ADN Connection Transport Type
Permissions: Read-only
Type: ADN Connection Transport Type (SCTP/TCP/TIPC/NONE)
Description: If ADN-C Transport Type is TIPC and Connection is UP, this field will be TIPC. If no ADN Connection is established, this field will be NONE.
PRMPATHSTATUS - Information of Primary Path.
Permissions: Read-only
Type: Information of Primary Path
Format: [Primary Remote IP] [Primary Remote Port] [UP/DOWN]
Note: If ADN connection isn't established, this field will be empty.
SECONDPATHSTATUS - Information of Secondary Path.
Permissions: Read-only
Type: Information of Secondary Path
Format: [Secondary Remote IP] [Secondary Remote Port] [UP/DOWN]
Note: If ADN Connection isn't established, this field will be empty. Only applicable for SCTP Transport Type.
Advertised Capability
VFY-DSC-ADV_CAP
VFY-DSC-ADV_CAP::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Adjacent Diameter Node/Adjacent Diameter ID>]-[<ADN Connection/Slot>]-[<Advertised Capability/Vendor ID>-<Advertised Capability/Application ID>-<Advertised Capability/Type>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Adjacent Diameter Node/Adjacent Diameter ID>]-[<ADN Connection/Slot>]-[<Advertised Capability/Vendor ID>-<Advertised Capability/Application ID>-<Advertised Capability/Type>]:<VID=string>,<APPID=string>,<TYPE=NodeTypeCap>;
AID Description
Vendor ID - Position 1
Type: string
Description: Supported Vendor ID extracted from the Capacity Exchange request (CE-R) or answer (CE-A) message.
Application ID - Position 2
Type: string
Description: Supported Application ID extracted from the Capacity Exchange request (CE-R) or answer (CE-A) message.
Type - Position 3
Type: NodeTypeCap={AUTH,ACCT}
Description: Advertised Capability Node Type. ACCT refers to accounting while AUTH refers to authorization/authentication.
Attribute Details
VID - Vendor ID
Permissions: Read-only
Type: string
Description: Supported Vendor ID extracted from the Capacity Exchange request (CE-R) or answer (CE-A) message.
APPID - Application ID
Permissions: Read-only
Type: string
Description: Supported Application ID extracted from the Capacity Exchange request (CE-R) or answer (CE-A) message.
TYPE - Type
Permissions: Read-only
Type: NodeTypeCap={AUTH,ACCT}
Description: Advertised Capability Node Type (ACCT/AUTH). ACCT refers to accounting while AUTH refers to authorization/authentication.
Allowed IP
DLT-DSC-ALLOWIP
DLT-DSC-ALLOWIP::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Transport Server/Slot>-<Transport Server/Transport Type>-<Transport Server/Host>-<Transport Server/Port>]-[<Allowed IP/Host>-<Allowed IP/Port>]:[CTAG];
ADD-DSC-ALLOWIP
ADD-DSC-ALLOWIP::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Transport Server/Slot>-<Transport Server/Transport Type>-<Transport Server/Host>-<Transport Server/Port>]-[<Allowed IP/Host>-<Allowed IP/Port>]:[CTAG];
CHG-DSC-ALLOWIP
CHG-DSC-ALLOWIP::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Transport Server/Slot>-<Transport Server/Transport Type>-<Transport Server/Host>-<Transport Server/Port>]-[<Allowed IP/Host>-<Allowed IP/Port>]:[CTAG]:::::[HOST=<string>],[PORT=<SocketPort>];
VFY-DSC-ALLOWIP
VFY-DSC-ALLOWIP::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Transport Server/Slot>-<Transport Server/Transport Type>-<Transport Server/Host>-<Transport Server/Port>]-[<Allowed IP/Host>-<Allowed IP/Port>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Transport Server/Slot>-<Transport Server/Transport Type>-<Transport Server/Host>-<Transport Server/Port>]-[<Allowed IP/Host>-<Allowed IP/Port>]:<HOST=string>,<PORT=SocketPort>;
AID Description
Host - Position 1
Type: string
Description: Host or IPv4 address or IPv6 address.
Port - Position 2
Type: SocketPort={ANY, 1 to 65535}
Description: Remote Port value to accept connection from. This value may be 0 which indicates that any port is accepted.
Attribute Details
HOST - Host
Permissions: Writeable and Createable
Type: string
Description: Host or IPv4 address or IPv6 address.
PORT - Port
Permissions: Writeable and Createable
Type: SocketPort={ANY, 1 to 65535}
Description: Remote Port value to accept connection from. This value may be 0 which indicates that any port is accepted.
Transport Server
DLT-DSC-SERVER
DLT-DSC-SERVER::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Transport Server/Slot>-<Transport Server/Transport Type>-<Transport Server/Host>-<Transport Server/Port>]:[CTAG];
ADD-DSC-SERVER
ADD-DSC-SERVER::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Transport Server/Slot>-<Transport Server/Transport Type>-<Transport Server/Host>-<Transport Server/Port>]:[CTAG];
CHG-DSC-SERVER
CHG-DSC-SERVER::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Transport Server/Slot>-<Transport Server/Transport Type>-<Transport Server/Host>-<Transport Server/Port>]:[CTAG]:::::[TRANSPORTTYPE=<TransportTypeServer>],[SECPARMSETSERVER=<string>],[PROTO=<ADNProtocol>],[HOST=<string>],[PORT=<DiameterPort>],[IPVALIDATE=<Feature>];
SET-DSC-SERVER
SET-DSC-SERVER::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Transport Server/Slot>-<Transport Server/Transport Type>-<Transport Server/Host>-<Transport Server/Port>]:[CTAG]:::[ACTIVATE/DEACTIVATE];
VFY-DSC-SERVER
VFY-DSC-SERVER::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Transport Server/Slot>-<Transport Server/Transport Type>-<Transport Server/Host>-<Transport Server/Port>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Transport Server/Slot>-<Transport Server/Transport Type>-<Transport Server/Host>-<Transport Server/Port>]:<SLOT=TRSlot>,<TRANSPORTTYPE=TransportTypeServer>,<SECPARMSETSERVER=string>,<PROTO=ADNProtocol>,<HOST=string>,<PORT=DiameterPort>,<STATUS=NodeStatus>,<IPVALIDATE=Feature>,<INTERNALID=int>;
AID Description
Slot - Position 1
Type: TRSlot={ALL, 1 to 65535}
Description: Transport server associated DSC slot. Valid values: Available routing CPU slot number and ALL (0). When set to ALL, the transport server is created on all the available routing CPUs.
Transport Type - Position 2
Type: TransportTypeServer={SCTP,TCP}
Description: Transport Type (TCP/SCTP). The type of transport used for incoming connections. To establish a connection, each ADN connecting to this server requires an associated ADN Connection with matching or SERVER ONLY type. Default value: SCTP.
Host - Position 3
Type: string
Description: Hostname or IP address of this server. If a hostname is provided, then it may resolve to multiple IP addresses. In this case, a TCP server uses the first IP address, whereas the SCTP server uses all IP addresses. The IP addresses must be provisioned on the card hosting the slot for the server to activate. Valid values: Hostname or IP address.
Port - Position 4
Type: DiameterPort={1 to 65535}
Description: Port used for this server (1-65535). RFC6733 recommended port values are: (1) 3868 for non-encrypted or CER/CEA enabled TLS, and (2) 5868 for full-time TLS/TCP or DTLS/SCTP (as per IANA reserved value).
Attribute Details
SLOT - Slot
Permissions: Createable
Type: TRSlot={ALL, 1 to 65535}
Description: Transport server associated DSC slot. Valid values: Available routing CPU slot number and ALL (0). When set to ALL, the transport server is created on all the available routing CPUs.
SECPARMSETSERVER - Security Parameter Set
Permissions: Writeable
Type: string
Description: Security Parameter Set associated with this Transport Server. Set to default for RFC3588 TLS. Valid values: Existing Security Parameter Set. Default value: default.
TRANSPORTTYPE - Transport Type
Permissions: Writeable and Createable
Type: TransportTypeServer={SCTP,TCP}
Description: Transport Type (TCP/SCTP). The type of transport used for incoming connections. To establish a connection, each ADN connecting to this server requires an associated ADN Connection with matching or SERVER ONLY type. Default value: SCTP.
PROTO - ADN Protocol
Permissions: Writeable
Type: ADNProtocol={DIAMETER,XML}
Description: Protocol for ADN spawned by the Transport Server (DIAMETER/XML). Only modifiable when the server is inactive. A DIAMETER server spawns DIAMETER and UA ADNs. A XML server only spawns UA XML ADNs. Default value: DIAMETER.
HOST - Host
Permissions: Writeable and Createable
Type: string
Description: Hostname or IP address of this server. If a hostname is provided, then it may resolve to multiple IP addresses. In this case, a TCP server uses the first IP address, whereas the SCTP server uses all IP addresses. The IP addresses must be provisioned on the card hosting the slot for the server to activate. Valid values: Hostname or IP address.
PORT - Port
Permissions: Writeable and Createable
Type: DiameterPort={1 to 65535}
Description: Port used for this server (1 to 65535). RFC6733 recommended port values are: 3868 for non-encrypted or CE-R/CE-A enabled TLS 5868 for full-time TLS/TCP or DTLS/SCTP (as per IANA reserved value).
STATUS - Status
Permissions: Read-only
Type: NodeStatus={DOWN,UP,INACTIVE,PARTIALLY UP}
Description: Status of the Transport Server (INACTIVE/DOWN/UP/PARTIALLY UP). When the Slot attribute is set to ALL (0), the PARTIALLY UP status means that one or more slots have port conflicts with existing servers and established ADN Connections and cannot bring this server in service. Please check the server unavailable major alarm (1807) for the list of slots that cannot bring the Transport Server in service locally.
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: Transport Server unique internal ID. Reserved for internal use.
IPVALIDATE - Remote IP Validation
Permissions: Writeable
Type: Feature={DISABLED,ENABLED}
Description: Validate remote IP addresses of incoming connections (DISABLED/ENABLED). If enabled, the resolved values of the Allowed IPs list must match the source address(es) of received TCP or SCTP packets. If the validation fails the connection is closed. This value cannot be set to ENABLED if no Allowed IP exist. Default value: DISABLED.
Incoming ADN Routing Table
DLT-DSC-INCADNRT
DLT-DSC-INCADNRT::[<DSC/DSC Instance ID>]-[<Incoming ADN Routing Table/Table Name>]:[CTAG];
ADD-DSC-INCADNRT
ADD-DSC-INCADNRT::[<DSC/DSC Instance ID>]-[<Incoming ADN Routing Table/Table Name>]:[CTAG]:::::[ADNSEARCHTYPE=<AdjNodeSearchType>];
VFY-DSC-INCADNRT
VFY-DSC-INCADNRT::[<DSC/DSC Instance ID>]-[<Incoming ADN Routing Table/Table Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Incoming ADN Routing Table/Table Name>]:<TABLENAME=string>,<ADNSEARCHTYPE=AdjNodeSearchType>;
AID Description
Table Name - Position 1
Type: string
Description: Table Name to uniquely identify the table. The table name must be unique across all table types. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Attribute Details
TABLENAME - Table Name
Permissions: Createable
Type: string
Description: Table Name to uniquely identify the table. The table name must be unique across all table types. Leading and trailing whitespaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
ADNSEARCHTYPE - ADN Search Type
Permissions: Createable
Type: AdjNodeSearchType={EXACT MATCH,LONGEST FROM RIGHT}
Description: Incoming ADN Search Type (EXACT MATCH/LONGEST FROM RIGHT) Exact match must result in existing ADNs in the Incoming ADN records. Default value: EXACT MATCH (reference only).
Incoming ADN Routing Record
DLT-DSC-INCADNREC
DLT-DSC-INCADNREC::[<DSC/DSC Instance ID>]-[<Incoming ADN Routing Table/Table Name>]-[<Incoming ADN Routing Record/Record Type>-<Incoming ADN Routing Record/DSC Node Name>-<Incoming ADN Routing Record/Adjacent Diameter Node>]:[CTAG]
ADD-DSC-INCADNREC
ADD-DSC-INCADNREC::[<DSC/DSC Instance ID>]-[<Incoming ADN Routing Table/Table Name>]-[<Incoming ADN Routing Record/Record Type>-<Incoming ADN Routing Record/DSC Node Name>-<Incoming ADN Routing Record/Adjacent Diameter Node>]:[CTAG]:::::[MODTBLNAME=<string>],[NEXTTBLNAME=<string>];
CHG-DSC-INCADNREC
CHG-DSC-INCADNREC::[<DSC/DSC Instance ID>]-[<Incoming ADN Routing Table/Table Name>]-[<Incoming ADN Routing Record/Record Type>-<Incoming ADN Routing Record/DSC Node Name>-<Incoming ADN Routing Record/Adjacent Diameter Node>]:[CTAG]:::::[MODTBLNAME=<string>],[NEXTTBLNAME=<string>];
VFY-DSC-INCADNREC
VFY-DSC-INCADNREC::[<DSC/DSC Instance ID>]-[<Incoming ADN Routing Table/Table Name>]-[<Incoming ADN Routing Record/Record Type>-<Incoming ADN Routing Record/DSC Node Name>-<Incoming ADN Routing Record/Adjacent Diameter Node>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Incoming ADN Routing Table/Table Name>]-[<Incoming ADN Routing Record/Record Type>-<Incoming ADN Routing Record/DSC Node Name>-<Incoming ADN Routing Record/Adjacent Diameter Node>]:<RECORDTYPE=RecordType>,<NODEID=DSCNodeID>,<NODENAME=string>,<ADJNODE=string>,<MODTBLNAME=string>,<NEXTTBLNAME=string>;
AID Description
Record Type - Position 1
Type: RecordType={DEFAULT,VALUE}
Description: A single non-deleteable DEFAULT record handles routing if no VALUE match is found. Default value: VALUE.
DSC Node Name - Position 2
Type: string
Description: DSC Node Name of the associated DSC Node which owns the ADN. Valid values: ANY (DEFAULT record type). Existing DSC Node Name (VALUE record type).
Adjacent Diameter Node - Position 3
Type: string
Description: Associated Adjacent Diameter Node. Valid values: empty string (DEFAULT record type). FQDN format and empty string (VALUE record type and LONGEST FROM RIGHT ADN search type) existing ADN name (VALUE record type and EXACT MATCH ADN search type).
Attribute Details
RECORDTYPE - Record Type
Permissions: Createable
Type: RecordType={DEFAULT,VALUE}
Description: Record Type. A single non-deleteable DEFAULT record handles routing if no VALUE match is found.
NODEID - DSC Node ID
Permissions: Read-only
Type: DSCNodeID={ANY, 1 to 99}
Description: Internal ID of the associated DSC Node that owns the ADN. Obsolete as of release 14.3. Valid values: ANY (DEFAULT record type). Existing DSC Node ID (VALUE record type).
NODENAME - DSC Node Name
Permissions: string
Type: string
Description: DSC Node Name of the associated DSC Node which owns the ADN. Valid values: ANY (DEFAULT record type). Existing DSC Node Name (VALUE record type).
ADJNODE - Adjacent Diameter Node
Permissions: Createable
Type: string
Description: Associated Adjacent Diameter Node. Valid values: empty string (DEFAULT record type) FQDN format (VALUE record type and LONGEST FROM RIGHT ADN search type) existing ADN name (VALUE record type and EXACT MATCH ADN search type).
MODTBLNAME - Modification Table Name
Permissions: Writeable and Createable
Type: string
Description: Associated optional Modification table to be applied to the message. Valid values: empty string and existing Modification table name. Default value: empty string.
NEXTTBLNAME - Next Table Name
Permissions: Writeable and Createable
Type: string
Description: Next routing table, result table, default routing, or error handling to route the message. Depending on the required routing decision, set to: 1) The name of the next routing table to continue routing. 2) The name of the result table to send the message. 3) dsc_default to apply default routing. 4) dsc_error to return Result-Code 3002, UNABLE_TO_DELIVER. 5) dsc_error<error code> to return Result-Code of <error code>. 6) dsc_error<vendor id>_<error code> to return Experimental-Result with Vendor-Id of <vendor id> and Experimental-Result-Code of <error code>. 7) dsc_discard to drop the request. Optional text may be added after a variant of dsc_error, separated by a space, to indicated a desired Error-Message. The next table cannot be a modification table.
Command Code Routing Table
DLT-DSC-CMDCODERT
DLT-DSC-CMDCODERT::[<DSC/DSC Instance ID>]-[<Command Code Routing Table/Table Name>]:[CTAG];
ADD-DSC-CMDCODERT
ADD-DSC-CMDCODERT::[<DSC/DSC Instance ID>]-[<Command Code Routing Table/Table Name>]:[CTAG];
VFY-DSC-CMDCODERT
VFY-DSC-CMDCODERT::[<DSC/DSC Instance ID>]-[<Command Code Routing Table/Table Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Command Code Routing Table/Table Name>]:<TABLENAME=string>;
AID Description
Table Name - Position 1
Type: string
Description: Table Name to uniquely identify the table. The Table Name must be unique across all table types. Leading and trailing whitespaces are trimmed. Valid values: alphanumeric characters, dashes, underscores, spaces, and dots (maximum size of 64). Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Attribute Details
TABLENAME - Table Name
Permissions: Createable
Type: string
Description: Table Name to uniquely identify the table. The Table Name must be unique across all table types. Leading and trailing whitespaces are trimmed. Valid values: alphanumeric characters, dashes, underscores, spaces, and dots (maximum size of 64). Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Command Code Routing Record
DLT-DSC-CMDCODEREC
DLT-DSC-CMDCODEREC::[<DSC/DSC Instance ID>]-[<Command Code Routing Table/Table Name>]-[<Command Code Routing Record/Record Type>-<Command Code Routing Record/Command Code Name>]:[CTAG];
ADD-DSC-CMDCODEREC
ADD-DSC-CMDCODEREC::[<DSC/DSC Instance ID>]-[<Command Code Routing Table/Table Name>]-[<Command Code Routing Record/Record Type>-<Command Code Routing Record/Command Code Name>]:[CTAG]:::::[MODTBLNAME=<string>],[NEXTTBLNAME=<string>];
CHG-DSC-CMDCODEREC
CHG-DSC-CMDCODEREC::[<DSC/DSC Instance ID>]-[<Command Code Routing Table/Table Name>]-[<Command Code Routing Record/Record Type>-<Command Code Routing Record/Command Code Name>]:[CTAG]:::::[MODTBLNAME=<string>],[NEXTTBLNAME=<string>];
VFY-DSC-CMDCODEREC
VFY-DSC-CMDCODEREC::[<DSC/DSC Instance ID>]-[<Command Code Routing Table/Table Name>]-[<Command Code Routing Record/Record Type>-<Command Code Routing Record/Command Code Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Command Code Routing Table/Table Name>]-[<Command Code Routing Record/Record Type>-<Command Code Routing Record/Command Code Name>]:<RECORDTYPE=RecordType>,<CMDCODENAME=string>,<MODTBLNAME=string>,<NEXTTBLNAME=string>;
AID Description
Record Type - Position 1
Type: RecordType={DEFAULT,VALUE}
Description: Record Type. A single non-deleteable DEFAULT record handles routing if no VALUE match is found.
Command Code Name - Position 2
Type: string
Description: Associated Command Code Definition name. Valid values: existing Command Code definition name..
Attribute Details
RECORDTYPE - Record Type
Permissions: Createable
Type: RecordType={DEFAULT,VALUE}
Description: Record Type (DEFAULT/VALUE). A single non-deleteable DEFAULT record handles routing if no VALUE match is found. Default value: VALUE.
CMDCODENAME - Command Code Name
Permissions: Createable
Type: string
Description: Associated Command Code Definition name. Valid values: existing Command Code definition name.
MODTBLNAME - Modification Table Name
Permissions: Writeable and Createable
Type: string
Description: Associated optional Modification table to be applied to the message. Valid values: empty string and existing Modification table name. Default value: empty string.
NEXTTBLNAME - Next Table Name
Permissions: Writeable and Createable
Type: string
Description: Next routing table, result table, default routing, or error handling to route the message. Depending on the required routing decision, set to: 1) The name of the next routing table to continue routing. 2) The name of the result table to send the message. 3) dsc_default to apply default routing. 4) dsc_error to return Result-Code 3002, UNABLE_TO_DELIVER. 5) dsc_error<error code> to return Result-Code of <error code>. 6) dsc_error<vendor id>_<error code> to return Experimental-Result with Vendor-Id of <vendor id> and Experimental-Result-Code of <error code>. 7) dsc_discard to drop the request. Optional text may be added after a variant of dsc_error, separated by a space, to indicated a desired Error-Message. The next table cannot be a modification table.
Application ID Routing Table
DLT-DSC-APPIDRT
DLT-DSC-APPIDRT::[<DSC/DSC Instance ID>]-[<Application ID Routing Table/Table Name>]:[CTAG];
ADD-DSC-APPIDRT
ADD-DSC-APPIDRT::[<DSC/DSC Instance ID>]-[<Application ID Routing Table/Table Name>]:[CTAG];
VFY-DSC-APPIDRT
VFY-DSC-APPIDRT::[<DSC/DSC Instance ID>]-[<Application ID Routing Table/Table Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Application ID Routing Table/Table Name>]:<TABLENAME=string>;
AID Description
Table Name - Position 1
Type: string
Description: Table Name. Table Name to uniquely identify the table. The table name must be unique across all table types. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Attribute Details
TABLENAME - Table Name
Permissions: Createable
Type: string
Description: Table Name to uniquely identify the table. The table name must be unique across all table types. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Application ID Routing Record
DLT-DSC-APPIDREC
DLT-DSC-APPIDREC::[<DSC/DSC Instance ID>]-[<Application ID Routing Table/Table Name>]-[<Application ID Routing Record/Record Type>-<Application ID Routing Record/Application ID>]:[CTAG];
ADD-DSC-APPIDREC
ADD-DSC-APPIDREC::[<DSC/DSC Instance ID>]-[<Application ID Routing Table/Table Name>]-[<Application ID Routing Record/Record Type>-<Application ID Routing Record/Application ID>]:[CTAG]:::::[MODTBLNAME=<string>],[NEXTTBLNAME=<string>];
CHG-DSC-APPIDREC
CHG-DSC-APPIDREC::[<DSC/DSC Instance ID>]-[<Application ID Routing Table/Table Name>]-[<Application ID Routing Record/Record Type>-<Application ID Routing Record/Application ID>]:[CTAG]:::::[MODTBLNAME=<string>],[NEXTTBLNAME=<string>];
VFY-DSC-APPIDREC
VFY-DSC-APPIDREC::[<DSC/DSC Instance ID>]-[<Application ID Routing Table/Table Name>]-[<Application ID Routing Record/Record Type>-<Application ID Routing Record/Application ID>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Application ID Routing Table/Table Name>]-[<Application ID Routing Record/Record Type>-<Application ID Routing Record/Application ID>]:<RECORDTYPE=RecordType>,<APPIDNAME=string>,<MODTBLNAME=string>,<NEXTTBLNAME=string>;
AID Description
Record Type - Position 1
Type: RecordType={DEFAULT,VALUE}
Description: Record Type (DEFAULT/VALUE) A single non-deleteable DEFAULT record handles routing if no VALUE match is found. Default value: VALUE.
Application ID - Position 2
Type: string
Description: Associated Application ID Definition name. Valid values: existing Application ID definition name.
Attribute Details
RECORDTYPE - Record Type
Permissions: Createable
Type: RecordType={DEFAULT,VALUE}
Description: Record Type (DEFAULT/VALUE). A single non-deleteable DEFAULT record handles routing if no VALUE match is found. Default value: VALUE
APPIDNAME - Application ID
Permissions: Createable
Type: string
Description: Associated Application ID Definition name. Valid values: existing Application ID definition name.
MODTBLNAME - Modification Table Name
Permissions: Writeable and Createable
Type: string
Description: Associated optional Modification table to be applied to the message. Valid values: empty string and existing Modification table name. Default value: empty string.
NEXTTBLNAME - Next Table Name
Permissions: Writeable and Createable
Type: string
Description: Next routing table, result table, default routing, or error handling to route the message. Depending on the required routing decision, set to: 1) The name of the next routing table to continue routing. 2) The name of the result table to send the message. 3) dsc_default to apply default routing. 4) dsc_error to return Result-Code 3002, UNABLE_TO_DELIVER. 5) dsc_error<error code> to return Result-Code of <error code>. 6) dsc_error<vendor id>_<error code> to return Experimental-Result with Vendor-Id of <vendor id> and Experimental-Result-Code of <error code>. 7) dsc_discard to drop the request. Optional text may be added after a variant of dsc_error, separated by a space, to indicated a desired Error-Message. The next table cannot be a modification table.
AVP Routing Table
DLT-DSC-AVPRT
DLT-DSC-AVPRT::[<DSC/DSC Instance ID>]-[<AVP Routing Table/Table Name>]:[CTAG];
ADD-DSC-AVPRT
ADD-DSC-AVPRT::[<DSC/DSC Instance ID>]-[<AVP Routing Table/Table Name>]:[CTAG]:::::[AVPALIAS=<string>],[SEARCHTYPE=<SearchType>],[TARGETAVP=<Feature>];
CHG-DSC-AVPRT
CHG-DSC-AVPRT::[<DSC/DSC Instance ID>]-[<AVP Routing Table/Table Name>]:[CTAG]:::::[PREPROC=<string>],[TARGETAVP=<Feature>];
VFY-DSC-AVPRT
VFY-DSC-AVPRT::[<DSC/DSC Instance ID>]-[<AVP Routing Table/Table Name>]:[CTAG];
::[<DSC/DSC Instance ID>]-[<AVP Routing Table/Table Name>]:<TABLENAME=string>,<AVPALIAS=string>,<SEARCHTYPE=SearchType>,<PREPROC=string>,<TARGETAVP=Feature>;
AID Description
Table Name - Position 1
Type: string
Description: Table Name to uniquely identify the table. The table name must be unique across all table types. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Attribute Details
TABLENAME - Table Name
Permissions: Createable
Type: string
Description: Table Name to uniquely identify the table. The table name must be unique across all table types. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
AVPALIAS - AVP Alias
Permissions: Createable
Type: string
Description: Associated AVP Alias Definition name. Valid values: existing AVP Alias Definition name.
SEARCHTYPE - Search Type
Permissions: Createable
Type: SearchType={EXACT MATCH,LONGEST FROM RIGHT,LONGEST FROM LEFT}
Description: Search Type (EXACT MATCH/LONGEST FROM LEFT/LONGEST FROM RIGHT). Longest search types are only applicable on string based AVP types. Thus AVP types such as Unsigned32, Enumerated, Integer32, and Unsigned64 are restricted to EXACT MATCH searches. Default value: EXACT MATCH (reference only).
PREPROC - Pre-Processing
Permissions: Writeable
Type: string
Description: Pre-Processing - Currently not supported.
AVP Routing Record
DLT-DSC-AVPREC
DLT-DSC-AVPREC::[<DSC/DSC Instance ID>]-[<AVP Routing Table/Table Name>]-[<AVP Routing Record/Record Type>-<AVP Routing Record/AVP Value>]:[CTAG];
ADD-DSC-AVPREC
ADD-DSC-AVPREC::[<DSC/DSC Instance ID>]-[<AVP Routing Table/Table Name>]-[<AVP Routing Record/Record Type>-<AVP Routing Record/AVP Value>]:[CTAG]:::::[MODTBLNAME=<string>],[NEXTTBLNAME=<string>];
CHG-DSC-AVPREC
CHG-DSC-AVPREC::[<DSC/DSC Instance ID>]-[<AVP Routing Table/Table Name>]-[<AVP Routing Record/Record Type>-<AVP Routing Record/AVP Value>]:[CTAG]:::::[MODTBLNAME=<string>],[NEXTTBLNAME=<string>];
VFY-DSC-AVPREC
VFY-DSC-AVPREC::[<DSC/DSC Instance ID>]-[<AVP Routing Table/Table Name>]-[<AVP Routing Record/Record Type>-<AVP Routing Record/AVP Value>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<AVP Routing Table/Table Name>]-[<AVP Routing Record/Record Type>-<AVP Routing Record/AVP Value>]:<RECORDTYPE=AVPRecordType>,<AVPVALUE=string>,<MODTBLNAME=string>,<NEXTTBLNAME=string>;
AID Description
Record Type - Position 1
Type: AVPRecordType={DEFAULT,NO AVP,VALUE STRING,VALUE INT,VALUE HEX STRING,VALUE ADN,VALUE REALM}
Description: Record Type (DEFAULT/NO AVP/VALUE). A single non-deleteable NO AVP record handles routing if the AVP is not found in the message. A single non-deleteable DEFAULT record handles routing if the AVP is found in the message but no VALUE match is found. A VALUE record handles routing if the AVP Value attribute matches the corresponding AVP from the message based on the appropriate format (STRING, HEX STRING, INT, ADN, REALM). A VALUE STRING record must have an AVP Value in the form of a printable ASCII string. A VALUE HEX STRING record must have an AVP Value in the form of space separated hexadecimal pairs. A VALUE INT record must have an AVP Value that represents a decimal encoded integer. A VALUE ADN record must have an AVP Value that represents an existing ADN Name. A VALUE REALM record must have an AVP Value that represents an existing Realm Alias. Default value: VALUE.
AVP Value - Position 2
Type: string
Description: Associated AVP value for the table associated AVP Alias. Valid values: based on the associated AVP Alias AVP Definition AVP Type attribute.
Attribute Details
RECORDTYPE - Record Type
Permissions: Createable
Type: AVPRecordType={DEFAULT,NO AVP,VALUE STRING,VALUE INT,VALUE HEX STRING,VALUE ADN,VALUE REALM}
Description: Record Type (DEFAULT/NO AVP/VALUE). A single non-deleteable NO AVP record handles routing if the AVP is not found in the message. A single non-deleteable DEFAULT record handles routing if the AVP is found in the message but no VALUE match is found. A VALUE record handles routing if the AVP Value attribute matches the corresponding AVP from the message based on the appropriate format (STRING, HEX STRING, INT, ADN, REALM). A VALUE STRING record must have an AVP Value in the form of a printable ASCII string. A VALUE HEX STRING record must have an AVP Value in the form of space separated hexadecimal pairs. A VALUE INT record must have an AVP Value that represents a decimal encoded integer. A VALUE ADN record must have an AVP Value that represents an existing ADN Name. A VALUE REALM record must have an AVP Value that represents an existing Realm Alias. Default value: VALUE.
AVPVALUE - AVP Value
Permissions: Createable
Type: string
Description: Associated AVP value for the table associated AVP Alias. Valid values: based on the associated AVP Alias AVP Definition AVP Type attribute.
MODTBLNAME - Modification Table Name
Permissions: Writeable and Createable
Type: string
Description: Associated optional Modification table to be applied to the message. Valid values: empty string and existing Modification table name. Default value: empty string.
NEXTTBLNAME - Next Table Name
Permissions: Writeable and Createable
Type: string
Description: Next routing table, result table, default routing, or error handling to route the message. Depending on the required routing decision, set to: 1) The name of the next routing table to continue routing. 2) The name of the result table to send the message. 3) dsc_default to apply default routing. 4) dsc_error to return Result-Code 3002, UNABLE_TO_DELIVER. 5) dsc_error<error code> to return Result-Code of <error code>. 6) dsc_error<vendor id>_<error code> to return Experimental-Result with Vendor-Id of <vendor id> and Experimental-Result-Code of <error code>. 7) dsc_discard to drop the request. Optional text may be added after a variant of dsc_error, separated by a space, to indicated a desired Error-Message. The next table cannot be a modification table.
Result Table
DLT-DSC-RSLTRT
DLT-DSC-RSLTRT::[<DSC/DSC Instance ID>]-[<Result Table/Table Name>]:[CTAG];
ADD-DSC-RSLTRT
ADD-DSC-RSLTRT::[<DSC/DSC Instance ID>]-[<Result Table/Table Name>]:[CTAG]:::::[NODENAME=<string>],[LDBALANCE=<LoadBalancingType>],[LBAVP=<string>];
CHG-DSC-RSLTRT
CHG-DSC-RSLTRT::[<DSC/DSC Instance ID>]-[<Result Table/Table Name>]:[CTAG]:::::[LDBALANCE=<LoadBalancingType>],[LBAVP=<string>];
VFY-DSC-RSLTRT
VFY-DSC-RSLTRT::[<DSC/DSC Instance ID>]-[<Result Table/Table Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Result Table/Table Name>]:<TABLENAME=string>,<NODEID=DSCNodeID>,<NODENAME=string>;<LDBALANCE=LoadBalancingType>,<LBAVP=string>;
AID Description
Table Name - Position 1
Type: string
Description: Table Name to uniquely identify the table. The table name must be unique across all table types. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Attribute Details
TABLENAME - Table Name
Permissions: Createable
Type: string
Description: Table Name to uniquely identify the table. The table name must be unique across all table types. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
NODEID - DSC Node ID
Permissions: Read-only
Type: DSCNodeID={ANY, 1 to 99}
Description: Associated DSC Node Internal ID. Obsolete as of release 14.3. Valid values: existing DSC Node identifier.
NODENAME - DSC Node Name
Permissions: Createable
Type: string
Description: Associated DSC Node name. Valid values: existing DSC Node name.
LDBALANCE - Load Balancing
Permissions: Writeable and Createable
Type: LoadBalancingType={ROUND ROBIN WEIGHT,LEAST LOADED,ROUND ROBIN COST,HASH}
Description: Load Balancing. When Round Robin Cost is selected then the lowest cost record is chosen as the routing destination. If more than one record has the same cost then messages are load shared in a round robin manner across the available destinations. Valid costs are values 1 to 99. When Round Robin Weight is selected, the weights represent the ratio of messages delivered to each destination. For example: Candidate A has weight = 10, B = 20 and C = 5. In a group of messages, the first 10 messages are sent to A, then the next 20 to B and the next 5 to C. The process is then restarted at A for the next messages. With Hash based the routing candidate is selected by hashing a defined AVP value in the message. When Least Loaded is selected, the weights indicate the relative message capacity of each server (in messages per second). Default Value: ROUND ROBIN WEIGHT.
LBAVP - AVP Alias
Permissions: Writeable and Createable
Type: string
Description: The name of an AVP Alias. This AVP is used by the hashing algorithm to perform traffic load balancing. Valid values: Must be an AVP Alias which has been created in the DSC AVP Alias Definitions tables. If the AVP is not present in the message, then the hop-by-hop header value is used.
Result Record
DLT-DSC-RSLTREC
DLT-DSC-RSLTREC::[<DSC/DSC Instance ID>]-[<Result Table/Table Name>]-[<Result Record/Cost>-<Result Record/Record Type>-<Result Record/Record Value>]:[CTAG];
ADD-DSC-RSLTREC
ADD-DSC-RSLTREC::[<DSC/DSC Instance ID>]-[<Result Table/Table Name>]-[<Result Record/Cost>-<Result Record/Record Type>-<Result Record/Record Value>]:[CTAG];
CHG-DSC-RSLTREC
CHG-DSC-RSLTREC::[<DSC/DSC Instance ID>]-[<Result Table/Table Name>]-[<Result Record/Cost>-<Result Record/Record Type>-<Result Record/Record Value>]:[CTAG]:::::[COST=<int>],[WEIGHT=<WeightType>],[RECORDVAL=<string>];
VFY-DSC-RSLTREC
VFY-DSC-RSLTREC::[<DSC/DSC Instance ID>]-[<Result Table/Table Name>]-[<Result Record/Cost>-<Result Record/Record Type>-<Result Record/Record Value>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Result Table/Table Name>]-[<Result Record/Cost>-<Result Record/Record Type>-<Result Record/Record Value>]:<COST=int>,<WEIGHT=WeightType>,<RECORDTYPE=ResultRecordType>,<RECORDVAL=string>;
AID Description
Cost - Position 1
Type: int(Range: [1..99])
Description: Cost of the result record (1 to 99). Lowest available record is used for routing. If more than one record have the lowest available cost, load sharing is performed.
REALM_REDIRECT - Position 2
Type: ResultRecordType={RELAY,REDIRECT,REALM_REDIRECT}
Description:
RELAY: The message is forwarded (relayed) to the ADN represented by Record Value.
REDIRECT: An answer message is returned to the originator instructing it to try the peer given in Record Value.
REALM_REDIRECT: An answer message is returned to the originator instructing it to try the realm given in Record Value. Default value: RELAY (reference only).
REALM_REDIRECT - Position 3
Type: string
Description: Record Value representing an ADN for RELAY, URI for REDIRECT, and Realm Definition for REALM_REDIRECT type.
RELAY: If an FQDN Diameter ID is specified, the value will be replaced by the associated ADN name.
Valid values: Existing ADN Diameter ID (FQDN format) or ADN name (RELAY).
URI (REDIRECT):
Examples: URI format
NO Transport security URI format
aaa://FQDN [port] [transport] [protocol]
aaa://host.example.com:1813;transport=tcp;protocol=diameter \n Transport security URI format - \n aaas://FQDN [port] [transport] [protocol]
aaas://host.example.com:1813;transport=tcp;protocol=diameter
REALM_REDIRECT: The Realm Record value must be the Alias of an existing Realm Definition.
Attribute Details
COST - Cost
Permissions: Writeable and Createable
Type: int(Range: [1..99])
Description: Cost of the result record (1 to 99). Lowest available record is used for routing. If more than one record have the lowest available cost, load sharing is performed.
WEIGHT - Weight
Permissions: Writeable
Type: WeightType={0 to 4000000} (Range: [0..4e+06])
Description: Weight of the Diameter ID (0 to 400000). The Diameter ID Weight is used to indicate the relative message capacity of this Diameter ID when load sharing on the server pool. Valid values: 0 to 100 (ROUND ROBIN) 0 to 4000000 (LEAST LOADED). Default value: 10 (ADN) and 0 (non-ADN) (ROUND ROBIN) 2000 (ADN) and 0 (non-ADN) (LEAST LOADED)
RECORDTYPE - Record Type
Permissions: Createable
Type: ResultRecordType={RELAY,REDIRECT}
Description: Record Type (RELAY/REDIRECT). RELAY: The message is forwarded (relayed) to the ADN represented by Record Value. REDIRECT: An answer message is returned to the originator instructing it to try the peer given in Record Value. Default value: RELAY (reference only).
RECORDVAL - Record Value
Permissions: Writeable and Createable
Type: string
Description: Record Value representing an ADN for RELAY and URI for REDIRECT type. For RELAY records, if a FQDN Diameter ID is specified, the value will be replaced by the associated ADN name. Valid values: existing ADN Diameter ID (FQDN format) or ADN name (RELAY). URI format (REDIRECT).
Examples:
URI format NO Transport security URI format - aaa://FQDN [port] [transport] [protocol]
aaa://host.example.com:1813;transport=tcp;protocol=diameter
Transport security URI format - aaas://FQDN [port] [transport] [protocol]
aaas://host.example.com:1813;transport=tcp;protocol=diameter
Modification Table
DLT-DSC-MODRT
DLT-DSC-MODRT::[<DSC/DSC Instance ID>]-[<Modification Table/Table Name>]:[CTAG];
ADD-DSC-MODRT
ADD-DSC-MODRT::[<DSC/DSC Instance ID>]-[<Modification Table/Table Name>]:[CTAG];
VFY-DSC-MODRT
VFY-DSC-MODRT::[<DSC/DSC Instance ID>]-[<Modification Table/Table Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Modification Table/Table Name>]:<TABLENAME=string>;
AID Description
Table Name - Position 1
Type: string
Description: Table Name to uniquely identify the table. The table name must be unique across all table types. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Attribute Details
TABLENAME - Table Name
Permissions: Createable
Type: string
Description: Table Name to uniquely identify the table. The table name must be unique across all table types. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Modification Record
DLT-DSC-MODREC
DLT-DSC-MODREC::[<DSC/DSC Instance ID>]-[<Modification Table/Table Name>]-[<Modification Record/Order>]:[CTAG];
ADD-DSC-MODREC
ADD-DSC-MODREC::[<DSC/DSC Instance ID>]-[<Modification Table/Table Name>]-[<Modification Record/Order>]:[CTAG]:::::[CMD=<string>];
CHG-DSC-MODREC
CHG-DSC-MODREC::[<DSC/DSC Instance ID>]-[<Modification Table/Table Name>]-[<Modification Record/Order>]:[CTAG]:::::[ORDER=<ModRecordOrder>],[CMD=<string>];
VFY-DSC-MODREC
VFY-DSC-MODREC::[<DSC/DSC Instance ID>]-[<Modification Table/Table Name>]-[<Modification Record/Order>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Modification Table/Table Name>]-[<Modification Record/Order>]:<ORDER=ModRecordOrder>,<CMD=string>;
AID Description
Order - Position 1
Type: ModRecordOrder={1 to 100}
Description: Modification order for the message (1 to 100). Rules with lower order are applied first. Order must be unique on a per table basis.
Attribute Details
ORDER - Order
Permissions: Writeable and Createable
Type: ModRecordOrder={1 to 100}
Description: Modification order for the message (1 to 100). Rules with lower order are applied first. Order must be unique on a per table basis.
CMD - Command
Permissions: Writeable and Createable
Type: string
Description: Modification command for the message applied in order. Syntax for the command is defined in the DSC provisioning guide. Supported commands include:
append-avp <avpXML>
count <statsName> <columnNumber>
ingress-filtering
mod-avp-value bitwise and <avpAlias> <0x mask> [offset]
mod-avp-value bitwise or <avpAlias> <0x mask> [offset]
mod-avp-value byte-replace <avpAlias> <0x value> [offset]
mod-avp-value replace <avpAlias> <string>
mod-avp-value delete left <avpAlias> <octetCount>
mod-avp-value delete right <avpAlias> <octetCount>
mod-avp-value insert left <avpAlias> <string>
mod-avp-value insert right <avpAlias> <string>
mod-avp-flag <avpAlias> assign M|P|<0x bits>
mod-avp-flag <avpAlias> clear M|P|<0x bits>
mod-avp-flag <avpAlias> set M|P|<0x bits>
mod-message-flag assign P|E|T|<0x bits>
mod-message-flag clear P|E|T|<0x bits>
mod-message-flag set P|E|T|<0x bits>
realm-accounting
receive-realm-redirect-indications DISABLED
receive-realm-redirect-indications PASSTHROUGH
receive-realm-redirect-indications RFC7075
remove-avp <avpAlias>
replace-avp <avpAlias> <avpXML>
set-answer-rt <routingTableName>
set-importance <importance>
use-rate-limiter <rateLimiter>
trace
rta on|off
Examples:
ingress-filtering
mod-message-flag set P
append-avp <avp avp-name=''Origin-Host'' value=''sonus.net''/>
mod-avp-code OldAVP NewAVP
trace
Realm Routing Table
DLT-DSC-RLMRT
DLT-DSC-RLMRT::[<DSC/DSC Instance ID>]-[<Realm Routing Table/Table Name>]:[CTAG];
ADD-DSC-RLMRT
ADD-DSC-RLMRT::[<DSC/DSC Instance ID>]-[<Realm Routing Table/Table Name>]:[CTAG];
VFY-DSC-RLMRT
VFY-DSC-RLMRT::[<DSC/DSC Instance ID>]-[<Realm Routing Table/Table Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Realm Routing Table/Table Name>]:<TABLENAME=string>;
AID Description
Table Name - Position 1
Type: string
Description: Table Name to uniquely identify the table. The table name must be unique across all table types. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Attribute Details
TABLENAME - Table Name
Permissions: Createable
Type: string
Description: Table Name to uniquely identify the table. The table name must be unique across all table types. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Realm Routing Record
DLT-DSC-RLMRTREC
DLT-DSC-RLMRTREC::[<DSC/DSC Instance ID>]-[<Realm Routing Table/Table Name>]-[<Realm Routing Record/Remote Realm>-<Realm Routing Record/Adjacent Realm>]:[CTAG];
ADD-DSC-RLMRTREC
ADD-DSC-RLMRTREC::[<DSC/DSC Instance ID>]-[<Realm Routing Table/Table Name>]-[<Realm Routing Record/Remote Realm>-<Realm Routing Record/Adjacent Realm>]:[CTAG]:::::[TYPE=<RecordType>],[COST=<RlmRtgCost>],;
CHG-DSC-RLMRTREC
CHG-DSC-RLMRTREC::[<DSC/DSC Instance ID>]-[<Realm Routing Table/Table Name>]-[<Realm Routing Record/Remote Realm>-<Realm Routing Record/Adjacent Realm>]:[CTAG]:::::[RRLM=<string>],[COST=<RlmRtgCost>],[ARLM=<string>];
VFY-DSC-RLMRTREC
VFY-DSC-RLMRTREC::[<DSC/DSC Instance ID>]-[<Realm Routing Table/Table Name>]-[<Realm Routing Record/Remote Realm>-<Realm Routing Record/Adjacent Realm>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Realm Routing Table/Table Name>]-[<Realm Routing Record/Remote Realm>-<Realm Routing Record/Adjacent Realm>]:<TYPE=RecordType>,<RRLM=string>,<COST=RlmRtgCost>,<ARLM=string>;
AID Description
Remote Realm - Position 1
Type: string
Description: Remote Realm that a message is to be routed. If a FQDN is specified, a Realm Definition will be automatically created if none exists. If a Realm Definition is already defined, the FQDN value will be replaced by the associated alias. Valid values: empty string (DEFAULT) FQDN format or existing Realm Definition alias (VALUE).
Adjacent Realm - Position 2
Type: string
Description: Adjacent Realm to which a message from Remote Realm is to be routed to. If an FQDN is specified, a Realm Definition will be automatically created if none exists. If a Realm Definition is already defined, the FQDN value will be replaced by the associated alias. Valid values: FQDN format or existing Realm Definition alias (VALUE).
Attribute Details
TYPE - Record Type
Permissions: Createable
Type: RecordType={DEFAULT,VALUE}
Description: Record Type (DEFAULT/VALUE). There may be only one record of type DEFAULT in each Realm Routing table. Records of type DEFAULT are not allowed to specify a Remote Realm and should therefore be left unspecified upon creation. Records of type VALUE must specify both a Remote Realm and an Adjacent Realm. Default value: VALUE.
RRLM - Remote Realm
Permissions: Writeable and Createable
Type: string
Description: Remote Realm that a message is to be routed. If an FQDN is specified, a Realm Definition will be automatically created if none exists. If a Realm Definition is already defined, the FQDN value will be replaced by the associated alias. Valid values: empty string (DEFAULT) FQDN format or existing Realm Definition alias (VALUE).
COST - Cost
Permissions: Writeable and Createable
Type: RlmRtgCost={INCOMING ONLY, 1 to 100}
Description: Cost of routing a message to Adjacent Realm from Remote Realm (INCOMING ONLY (-1), 1 to 100). A value of INCOMING ONLY (-1) will prevent requests from being sent by the Adjacent Realm. Default value: 10 (reference only).
ARLM - Adjacent Realm
Permissions: Writeable and Createable
Type: string
Description: Adjacent Realm to which a message from Remote Realm is to be routed to. If an FQDN is specified, a Realm Definition will be automatically created if none exists. If a Realm Definition is already defined, the FQDN value will be replaced by the associated alias. Valid values: FQDN format or existing Realm Definition alias (VALUE).
SCTP Parameter Set
DLT-DSC-SCTPPARM
DLT-DSC-SCTPPARM::[<DSC/DSC Instance ID>]-[<SCTP Parameter Set/Name>]:[CTAG];
ADD-DSC-SCTPPARM
ADD-DSC-SCTPPARM::[<DSC/DSC Instance ID>]-[<SCTP Parameter Set/Name>]:[CTAG];
CHG-DSC-SCTPPARM
CHG-DSC-SCTPPARM::[<DSC/DSC Instance ID>]-[<SCTP Parameter Set/Name>]:[CTAG]:::::[RTO_INIT=<int>],[RTO_MIN=<int>],[RTO_MAX=<int>],[MX_PATH_RETRANS=<int>],[MX_ASSOC_RETRANS=<int>],[HB=<Feature>],[BUNDLING=<Feature>],[HB_INV=<int>],[DELAYACK_TO=<DelayedACKTO>],[DSCP=<int>];
VFY-DSC-SCTPPARM
VFY-DSC-SCTPPARM::[<DSC/DSC Instance ID>]-[<SCTP Parameter Set/Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<SCTP Parameter Set/Name>]:<RTO_INIT=int>,<RTO_MIN=int>,<RTO_MAX=int>,<MX_PATH_RETRANS=int>,<MX_ASSOC_RETRANS=int>,<HB=Feature>,<BUNDLING=Feature>,<HB_INV=int>,<DELAYACK_TO=DelayedACKTO>,<DSCP=int>,<INTERNALID=int>;
AID Description
Name - Position 1
Type: string
Description: Name to uniquely identify the parameter set. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Attribute Details
RTO_INIT - RTO Initial
Permissions: Writeable
Type: int(Range: [0..2.14748e+09])
Description: Retransmission Timeout (RTO) Initial sets the initial expected time for packets to be sent and returned (0 to + ms). Must be greater than or equal to the RTO Minimum and less than or equal to the RTO Maximum. Default value: 2000 ms.
RTO_MIN - RTO Minimum
Permissions: Writeable
Type: int(Range: [0..2.14748e+09])
Description: Retransmission Timeout (RTO) Minimum is the smallest expected time for packets to be sent and returned (0 to + ms). Default value: 60 ms.
RTO_MAX - RTO Maximum
Permissions: Writeable
Type: int(Range: [0..2.14748e+09])
Description: Retransmission Timeout (RTO) Maximum is the largest expected time for packets to be sent and returned (0 to + ms). Default value: 2000 ms.
MX_PATH_RETRANS - Maximum Path Retrans
Permissions: Writeable
Type: int(Range: [0..2.14748e+09])
Description: Maximum Path Retransmissions sets the number of retransmissions that will be attempted over the current transmission path without success before the path is deemed unavailable and a new transmission path is sought. Valid values: 0 to +. Default value: 4 (tailored for a single-homed association).
MX_ASSOC_RETRANS - Maximum Assoc Retrans
Permissions: Writeable
Type: int(Range: [0..2.14748e+09])
Description: Maximum Association Retransmissions sets the number of retransmissions to a remote device over all possible paths that will be attempted without success before deeming the end device as unavailable. Valid values: 0 to +. Default value: 4 (tailored for a single-homed association).
HB - Heartbeat
Permissions: Writeable
Type: Feature={DISABLED,ENABLED}
Description: Heartbeat feature (DISABLED/ENABLED). Enabling the Heartbeat feature triggers the sending of cyclical test messages on the connection to determine its availability on the network. Default value: ENABLED.
BUNDLING - Bundling
Permissions: Writeable
Type: Feature={DISABLED,ENABLED}
Description: Bundling feature (DISABLED/ENABLED). Enabling Bundling allows the bundling of messages into larger packets for greater line efficiency. Default value: ENABLED.
HB_INV - Heartbeat Interval
Permissions: Writeable
Type: int(Range: [0..65535])
Description: Heartbeat interval for the SCTP association (0 to 65535 ms). Default value: 150 ms.
DELAYACK_TO - Delayed ACK TO
Permissions: Writeable
Type: DelayedACKTO={DISABLED, 10 to 500}
Description: Delayed Acknowledgement Time Out (ACK TO) sets the time that the system waits after receiving a packet before sending an acknowledgement (10 to 500 ms). To disable Delayed ACK feature, set the value to 0. Default value: 20 ms.
DSCP - DSCP
Permissions: Writeable
Type: int
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.
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: Parameter set unique internal ID. Reserved for internal usage.
CER Parameter Set
DLT-DSC-CERPARM
DLT-DSC-CERPARM::[<DSC/DSC Instance ID>]-[<CER Parameter Set/Name>]:[CTAG];
ADD-DSC-CERPARM
ADD-DSC-CERPARM::[<DSC/DSC Instance ID>]-[<CER Parameter Set/Name>]:[CTAG];
CHG-DSC-CERPARM
CHG-DSC-CERPARM::[<DSC/DSC Instance ID>]-[<CER Parameter Set/Name>]:[CTAG]:::::[LOCAL_DID=<string>];
VFY-DSC-CERPARM
VFY-DSC-CERPARM::[<DSC/DSC Instance ID>]-[<CER Parameter Set/Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<CER Parameter Set/Name>]:<LOCAL_DID=string>,<INTERNALID=int>;
AID Description
Name - Position 1
Type: string
Description: Name to uniquely identify the Parameter Set. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64.
Attribute Details
LOCAL_DID - Local Diameter ID Override
Permissions: Writeable
Type: string
Description: Override the local Diameter ID of the DSC Node when sending CE[A/R] messages, resolving elections, etc. If empty string, use the local Diameter ID of the DSC Node. Valid values: FQDN format or empty string. Default value: empty string.
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: Parameter set unique internal ID. Reserved for internal usage.
CER Supported Vendor ID
VFY-DSC-CERSUPVENIDPARM
VFY-DSC-CERSUPVENIDPARM::[<DSC/DSC Instance ID>]-[<CER Parameter Set/Name>]-[<CER Supported Vendor ID/Vendor ID>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
DLT-DSC-CERSUPVENIDPARM
DLT-DSC-CERSUPVENIDPARM::[<DSC/DSC Instance ID>]-[<CER Parameter Set/Name>]-[<CER Supported Vendor ID/Vendor ID>]:[CTAG];
ADD-DSC-CERSUPVENIDPARM
ADD-DSC-CERSUPVENIDPARM::[<DSC/DSC Instance ID>]-[<CER Parameter Set/Name>]-[<CER Supported Vendor ID/Vendor ID>]:[CTAG];
::[<DSC/DSC Instance ID>]-[<CER Parameter Set/Name>]-[<CER Supported Vendor ID/Vendor ID>]:<INTERNALID=int>;
AID Description
Vendor ID - Position 1
Type: string
Description: Vendor ID - Supported-Vendor-Id AVP is added to CE. Valid values: existing Vendor ID definition name.
Attribute Details
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: CER Supported Vendor ID unique internal ID. Reserved for internal use.
Diameter Parameter Set
DLT-DSC-DIAMPARM
DLT-DSC-DIAMPARM::[<DSC/DSC Instance ID>]-[<Diameter Protocol Parameter Set/Name>]:[CTAG];
ADD-DSC-DIAMPARM
ADD-DSC-DIAMPARM::[<DSC/DSC Instance ID>]-[<Diameter Protocol Parameter Set/Name>]:[CTAG];
CHG-DSC-DIAMPARM
CHG-DSC-DIAMPARM::[<DSC/DSC Instance ID>]-[<Diameter Protocol Parameter Set/Name>]:[CTAG]:::::[P2P_EE_ID=<DiamProtoValidation>],[P2P_HH_ID=<DiamProtoValidation>],[P2P_P_BIT=<DiamProtoValidation>],[UNX_CER=<DiamProtoValidation>],[UNX_CEA=<DiamProtoValidation>];
VFY-DSC-DIAMPARM
VFY-DSC-DIAMPARM::[<DSC/DSC Instance ID>]-[<Diameter Protocol Parameter Set/Name>]:[CTAG];
::[<DSC/DSC Instance ID>]-[<Diameter Protocol Parameter Set/Name>]:<P2P_EE_ID=DiamProtoValidation>,<P2P_HH_ID=DiamProtoValidation>,<P2P_P_BIT=DiamProtoValidation>,<UNX_CER=DiamProtoValidation>,<UNX_CEA=DiamProtoValidation>,<INTERNALID=int>;
AID Description
Name - Position 1
Type: string
Description: Name to uniquely identify the Parameter Set. Leading and trailing whitespaces are trimmed. Valid values: alphanumeric characters, dashes, underscores, spaces, and dots (maximum size of 64).
Attribute Details
P2P_EE_ID - P2P End-to-End ID Validation
Permissions: Writeable
Type: DiamProtoValidation={IGNORE,ENFORCE}
Description: Point to Point End-to-End ID Validation for CE, and DW messages. RFC6733 states that 'The same End-to-End identifier in the request is used in the answer.'. Choose whether to ENFORCE or IGNORE this rule. Valid values: IGNORE (0) or ENFORCE (1). Default value: ENFORCE (1).
P2P_HH_ID - P2P Hop-by-Hop ID Validation
Permissions: Writeable
Type: DiamProtoValidation={IGNORE,ENFORCE}
Description: Point to Point Hop-by-Hop ID Validation for CE, and DW messages. RFC6733 states that 'The same Hop-by-Hop Identifier in the request is used in the answer.'. Choose whether to ENFORCE or IGNORE this rule. Valid values: IGNORE (0) or ENFORCE (1). Default value: ENFORCE (1).
P2P_P_BIT - P2P P-Bit Validation
Permissions: Writeable
Type: DiamProtoValidation={IGNORE,ENFORCE}
Description: Point to Point P-Bit Validation for CE, and DW messages. RFC6733 states that 'The 'P' bit is set to the same value as the one in the request.' and 'The CER and CEA messages MUST NOT be proxied, redirected, or relayed.'. Choose whether to ENFORCE or IGNORE this rule. Valid values: IGNORE (0) or ENFORCE (1). Default value: ENFORCE (1).
UNX_CER - P2P Unexpected CER Validation
Permissions: Writeable
Type: DiamProtoValidation={IGNORE,ENFORCE}
Description: Point to Point Unexpected CER Validation. When this rule is enforced, an error message is sent back when an unexpected CER is received. When ignored, a CEA is sent back. Choose whether to ENFORCE or IGNORE this rule. Valid values: IGNORE (0) or ENFORCE (1). Default value: ENFORCE (1).
UNX_CEA - P2P Unexpected CEA Validation
Permissions: Writeable
Type: DiamProtoValidation={IGNORE,ENFORCE}
Description: Point to Point Unexpected CEA Validation. When this rule is enforced, the unexpected CEA is silently discarded. When ignored, the unexpected CEA is processed. Choose whether to ENFORCE or IGNORE this rule. Valid values: IGNORE (0) or ENFORCE (1). Default value: ENFORCE (1).
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: Parameter set unique internal ID. Reserved for internal usage.
CER Application ID
DLT-DSC-CERAPPIDPARM
DLT-DSC-CERAPPIDPARM::[<DSC/DSC Instance ID>]-[<CER Parameter Set/Name>]-[<CER Application ID/Application ID>-<CER Application ID/Vendor ID>]:[CTAG];
ADD-DSC-CERAPPIDPARM
ADD-DSC-CERAPPIDPARM::[<DSC/DSC Instance ID>]-[<CER Parameter Set/Name>]-[<CER Application ID/Application ID>-<CER Application ID/Vendor ID>]:[CTAG];
VFY-DSC-CERAPPIDPARM
VFY-DSC-CERAPPIDPARM::[<DSC/DSC Instance ID>]-[<CER Parameter Set/Name>]-[<CER Application ID/Application ID>-<CER Application ID/Vendor ID>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<CER Parameter Set/Name>]-[<CER Application ID/Application ID>-<CER Application ID/Vendor ID>]:<INTERNALID=int>;
AID Description
Application ID - Position 1
Type: string
Description: Application ID for transmit in CE messages. Valid values: existing Application ID definition name.
Vendor ID - Position 2
Type: string
Description: Vendor ID - if not Diameter, Vendor-Specific-Application-Id AVP is added to CE. An empty string is assumed to be Diameter which will include the non-vendor specific Auth-Application-Id AVP. Valid values: existing Vendor ID definition name or empty string.
Attribute Details
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: CER Application ID unique internal ID. Reserved for internal usage.
Capacity Parameter Set
DLT-DSC-CAPCTYPARM
DLT-DSC-CAPCTYPARM::[<DSC/DSC Instance ID>]-[<Capacity Parameter Set/Name>]:[CTAG];
ADD-DSC-CAPCTYPARM
ADD-DSC-CAPCTYPARM::[<DSC/DSC Instance ID>]-[<Capacity Parameter Set/Name>]:[CTAG];
CHG-DSC-CAPCTYPARM
CHG-DSC-CAPCTYPARM::[<DSC/DSC Instance ID>]-[<Capacity Parameter Set/Name>]:[CTAG]:::::[QSSECS=<int>],[MSGPERSECCAP=<UnlimitedCap100>],[USAGETHR1=<Percent>],[USAGETHR2=<Percent>],[USAGETHR3=<Percent>],[QSMSGS=<UnlimitedCap100>],[QSKB=<UnlimitedCap70>],[CONGALARM1=<Percent>],[CONGABATE1=<Percent>],[CONGONSET1=<Percent>],[CONGHANDLE1=<string>],[CONGALARM2=<Percent>],[CONGABATE2=<Percent>],[CONGONSET2=<Percent>],[CONGHANDLE2=<string>],[CONGALARM3=<Percent>],[CONGABATE3=<Percent>],[CONGONSET3=<Percent>],[CONGHANDLE3=<string>],[OVLHANDLE1=<string>],[OVLHANDLE2=<string>],[OVLHANDLE3=<string>];
VFY-DSC-CAPCTYPARM
VFY-DSC-CAPCTYPARM::[<DSC/DSC Instance ID>]-[<Capacity Parameter Set/Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Capacity Parameter Set/Name>]:<NAME=string>,<QSSECS=int>,<INTERNALID=int>,<MSGPERSECCAP=UnlimitedCap100>,<USAGETHR1=Percent>,<USAGETHR2=Percent>,<USAGETHR3=Percent>,<QSMSGS=UnlimitedCap100>,<QSKB=UnlimitedCap70>,<CONGALARM1=Percent>,<CONGABATE1=Percent>,<CONGONSET1=Percent>,<CONGHANDLE1=string>,<CONGALARM2=Percent>,<CONGABATE2=Percent>,<CONGONSET2=Percent>,<CONGHANDLE2=string>,<CONGALARM3=Percent>,<CONGABATE3=Percent>,<CONGONSET3=Percent>,<CONGHANDLE3=string>,<OVLHANDLE1=string>,<OVLHANDLE2=string>,<OVLHANDLE3=string>;
AID Description
Name - Position 1
Type: string
Description: Name to uniquely identify the Parameter Set. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64.
Attribute Details
QSSECS - Queue Size in Seconds
Permissions: Writeable
Type: int(Range: [5..60])
Description: Queue Size in Seconds for oldest message in queue (5 to 60). The queue is considered full when the oldest message in the queue is older than the queue size. Other congestion levels occur at fractions of this age. Default value: 10.
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: Parameter set unique internal ID. Reserved for internal usage.
MSGPERSECCAP - Message Per Second Capacity
Permissions: Writeable
Type: UnlimitedCap100={UNLIMITED, 100 to 2147483647}
Description: Message per second capacity is the maximum processing rate for the associated Diameter node (100 to UNLIMITED). Default value: UNLIMITED.
USAGETHR1 - Usage Threshold 1
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Percentage of Message Per Second Capacity used for usage alarms (0 to 100 %). Note that thresholds cannot overlap so threshold 1 must be less than threshold 2 and threshold 2 must be less than threshold 3. Default value: 35 % (if the mate fails, node will be at 70% capacity).
USAGETHR2 - Usage Threshold 2
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Percentage of Message Per Second Capacity used for usage alarms (0 to 100 %). Note that thresholds cannot overlap so threshold 1 must be less than threshold 2 and threshold 2 must be less than threshold 3. Default value: 45 % (if the mate fails, node will be at 90% capacity).
USAGETHR3 - Usage Threshold 3
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Percentage of Message Per Second Capacity used for usage alarms (0 to 100 %). Note that thresholds cannot overlap so threshold 1 must be less than threshold 2 and threshold 2 must be less than threshold 3. Default value: 90 % (node is very close to capacity).
QSMSGS - Queue Size in Messages
Permissions: Writeable
Type: UnlimitedCap100={UNLIMITED, 100 to 2147483647}
Description: Queue size in messages, set to UNLIMITED to disable (100 to UNLIMITED). Note that if flow control limits the number of messages. per second, then messages may be able to take 'Message Queue Size divided by Message per Second' seconds to get through the queue. If the Queue Size in Seconds attribute is lower than this computed value, then this attribute will be irrelevant. Default value: UNLIMITED.
QSKB - Queue Size in KBytes
Permissions: Writeable
Type: UnlimitedCap70={UNLIMITED, 70 to 2147483647}
Description: Queue size in kilo bytes (70 to UNLIMITED). Set to UNLIMITED to disable. Default value: UNLIMITED.
CONGALARM1 - Congestion Alarm 1
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Percentage of queue size to raise level 1 alarm (0 to 100%). Must be less than or equal to Congestion Abatement 1 and less than Congestion Alarm 2. Default value: 30%.
CONGABATE1 - Congestion Abatement 1
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Percentage of queue size to leave congestion level 1 (0 to 100%). Must be less than Congestion Onset 1 and Congestion Abatement 2. Default value: 30%.
CONGONSET1 - Congestion Onset 1
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Percentage of queue size to enter congestion level 1 (0 to 100%). Messages with importance 0 are discarded. Must be less than Congestion Abatement 2. Default value: 40%.
CONGHANDLE1 - Congestion Handling 1
Permissions: Writeable
Type: string
Description: Handling performed on messages of lesser importance at congestion level 1. Supported options include: 1. (empty string, default handling, same as dsc_error) 2. dsc_error MESSAGE (return Result-Code 3002, UNABLE_TO_DELIVER, MESSAGE optional) 3. dsc_error<error code> MESSAGE (return Result-Code of <error code>, MESSAGE optional) 4. dsc_error<vendor id>_<error code> MESSAGE (return Experimental-Result with Vendor-Id of <vendor id> and Experimental-Result-Code of <error code>, MESSAGE optional) 5. dsc_discard (discard requests) 6. dsc_discard_all (discard requests and answers) 7. dsc_table ROUTING_TABLE (use indicated routing table to customize an error answer) 8. dsc_rate_limitRATE (Adjust the output rate to RATE) For a Capacity Parameter Set associated with an ADN Connection, the handling action will be performed to the message if all paths are congested. The handling action configured for the last path is used.
CONGALARM2 - Congestion Alarm 2
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Percentage of queue size to raise level 2 alarm (0 to 100%). Must be less than or equal to Congestion Abatement 2 and less than Congestion Alarm 3. Default value: 40%.
CONGABATE2 - Congestion Abatement 2
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Percentage of queue size to leave congestion level 2 (0 to 100%). Must be less than Congestion Onset 2 and Congestion Abatement 3. Default value: 50%.
CONGONSET2 - Congestion Onset 2
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Percentage of queue size to enter congestion level 2 (0 to 100 %). Messages with importance 1 are discarded. Must be less than Congestion Abatement 3. Default value: 60%.
CONGHANDLE2 - Congestion Handling 2
Permissions: Writeable
Type: string
Description: Handling performed on messages of lesser importance at congestion level 2. Supported options include: 1. (empty string, default handling, same as dsc_error) 2. dsc_error MESSAGE (return Result-Code 3002, UNABLE_TO_DELIVER, MESSAGE optional) 3. dsc_error<error code> MESSAGE (return Result-Code of <error code>, MESSAGE optional) 4. dsc_error<vendor id>_<error code> MESSAGE (return Experimental-Result with Vendor-Id of <vendor id> and Experimental-Result-Code of <error code>, MESSAGE optional) 5. dsc_discard (discard requests) 6. dsc_discard_all (discard requests and answers) 7. dsc_table ROUTING_TABLE (use indicated routing table to customize an error answer) 8. dsc_rate_limitRATE (Adjust the output rate to RATE) For a Capacity Parameter Set associated with an ADN Connection, the handling action will be performed to the message if all paths are congested. The handling action configured for the last path is used.
CONGALARM3 - Congestion Alarm 3
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Percentage of queue size to raise level 3 alarm (0 to 100%). Must be less than or equal to Congestion Abatement 3. Default value: 60%.
CONGABATE3 - Congestion Abatement 3
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Percentage of queue size to leave congestion level 3 (0 to 100%). Must be less than Congestion Onset 3. Default value: 70%.
CONGONSET3 - Congestion Onset 3
Permissions: Writeable
Type: Percent={0 to 100} (Units: %)
Description: Percentage of queue size to enter congestion level 3 (0 to 100%). Messages with an importance of 2 or lower are discarded. Default value: 80%.
CONGHANDLE3 - Congestion Handling 3
Permissions: Writeable
Type: string
Description: Handling performed on messages of lesser importance at congestion level 3. Supported options include: 1. (empty string, default handling, same as dsc_error) 2. dsc_error MESSAGE (return Result-Code 3002, UNABLE_TO_DELIVER, MESSAGE optional) 3. dsc_error<error code> MESSAGE (return Result-Code of <error code>, MESSAGE optional) 4. dsc_error<vendor id>_<error code> MESSAGE (return Experimental-Result with Vendor-Id of <vendor id> and Experimental-Result-Code of <error code>, MESSAGE optional) 5. dsc_discard (discard requests) 6. dsc_discard_all (discard requests and answers) 7. dsc_table ROUTING_TABLE (use indicated routing table to customize an error answer) 8. dsc_rate_limitRATE (Adjust the output rate to RATE) For a Capacity Parameter Set associated with an ADN Connection, the handling action will be performed to the message if all paths are congested. The handling action configured for the last path is used.
OVLHANDLE1 - Overload Handling 1
Permissions: Writeable
Type: string
Description: Handling performed on messages of lesser importance at local overload level 1. Supported options include: 1. (empty string, default handling) * in the Local Overload Parameters, this is treated the same as dsc_error * in ADNConnection or Rate Limiter, the handling is deferred to the Local Overload Parameters 2. dsc_error MESSAGE (return Result-Code 3002, UNABLE_TO_DELIVER, MESSAGE optional) 3. dsc_error<error code> MESSAGE (return Result-Code of <error code>, MESSAGE optional) 4. dsc_error<vendor id>_<error code> MESSAGE (return Experimental-Result with Vendor-Id of <vendor id> and Experimental-Result-Code of <error code>, MESSAGE optional) 5. dsc_discard (discard requests) 6. dsc_discard_all (discard requests and answers) 7. dsc_table ROUTING_TABLE (use indicated routing table to customize an error answer) 8. dsc_rate_limitRATE (Adjust the ADN input rate or Rate Limiter output rate to RATE). For a Capacity Parameter Set associated with an ADN Connection, the handling action will be performed to the message if all paths are congested. The handling action configured for the last path is used.
OVLHANDLE2 - Overload Handling 2
Permissions: Writeable
Type: string
Description: Handling performed on messages of lesser importance at local overload level 2. Supported options include: 1. (empty string, default handling) * in the Local Overload Parameters, this is treated the same as dsc_error * in ADNConnection or Rate Limiter, the handling is deferred to the Local Overload Parameters 2. dsc_error MESSAGE (return Result-Code 3002, UNABLE_TO_DELIVER, MESSAGE optional) 3. dsc_error<error code> MESSAGE (return Result-Code of <error code>, MESSAGE optional) 4. dsc_error<vendor id>_<error code> MESSAGE (return Experimental-Result with Vendor-Id of <vendor id> and Experimental-Result-Code of <error code>, MESSAGE optional) 5. dsc_discard (discard requests) 6. dsc_discard_all (discard requests and answers) 7. dsc_table ROUTING_TABLE (use indicated routing table to customize an error answer) 8. dsc_rate_limitRATE (Adjust the ADN input rate or Rate Limiter output rate to RATE) For a Capacity Parameter Set associated with an ADN Connection, the handling action will be performed to the message if all paths are congested. The handling action configured for the last path is used.
OVLHANDLE3 - Overload Handling 3
Permissions: Writeable
Type: string
Description: Handling performed on messages of lesser importance at local overload level 3. Supported options include: 1. (empty string, default handling) * in the Local Overload Parameters, this is treated the same as dsc_error * in ADNConnection or Rate Limiter, the handling is deferred to the Local Overload Parameters 2. dsc_error MESSAGE (return Result-Code 3002, UNABLE_TO_DELIVER, MESSAGE optional) 3. dsc_error<error code> MESSAGE (return Result-Code of <error code>, MESSAGE optional) 4. dsc_error<vendor id>_<error code> MESSAGE (return Experimental-Result with Vendor-Id of <vendor id> and Experimental-Result-Code of <error code>, MESSAGE optional) 5. dsc_discard (discard requests) 6. dsc_discard_all (discard requests and answers) 7. dsc_table ROUTING_TABLE (use indicated routing table to customize an error answer) 8. dsc_rate_limitRATE (Adjust the ADN input rate or Rate Limiter output rate to RATE) For a Capacity Parameter Set associated with an ADN Connection, the handling action will be performed to the message if all paths are congested. The handling action configured for the last path is used. If this field is a variant of dsc_error, the result code is used to reject messages if the ingress queue is full due to severe local overload.
Security Parameter Set
DLT-DSC-SECPARM
DLT-DSC-SECPARM::[<DSC/DSC Instance ID>]-[<Security Parameter Set/Name>]:[CTAG];
ADD-DSC-SECPARM
ADD-DSC-SECPARM::[<DSC/DSC Instance ID>]-[<Security Parameter Set/Name>]:[CTAG];
CHG-DSC-SECPARM
CHG-DSC-SECPARM::[<DSC/DSC Instance ID>]-[<Security Parameter Set/Name>]:[CTAG]:::::[SECTYPE=<SecurityType>],[FILESET=<string>],[PRIO=<string>];
VFY-DSC-SECPARM
VFY-DSC-SECPARM::[<DSC/DSC Instance ID>]-[<Security Parameter Set/Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Security Parameter Set/Name>]:<SECTYPE=SecurityType>,<FILESET=string>,<PRIO=string>,<INTERNALID=int>;
AID Description
Name - Position 1
Type: string
Description: Name to uniquely identify the Parameter Set. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Attribute Details
SECTYPE - Security Type
Permissions: Writeable
Type: SecurityType={NONE,TLS,FULL TLS DTLS}
Description: Security Type (NONE/TLS/FULL TLS DTLS). Only default and plaintext security parameter sets can be set to NONE. Default value: NONE (default and plaintext) TLS (else).
FILESET - File Set Name
Permissions: Writeable
Type: string
Description: TLS Prefix file names. If the Security Type is NONE, set to empty string. Used in certificate upload. Valid value: empty string and file name string. Default value: empty string (default and plaintext Name) parameter set name (else).
PRIO - Priority String
Permissions: Writeable
Type: string
Description: TLS Priority String. If the Security type is NONE, set to empty string. Leave as 'NORMAL' unless there are errors. See documentation. Valid values: empty string, NORMAL, valid OpenSSL cipher list (separated by :). Default value: empty string (for default and plaintext Name) NORMAL (else). Note that to counter known security vulnerabilities, RC4 and MD5 algorithms have been disabled by default. Furthermore, TLS 1.0 and below have also been disabled by default. For Diameter RFC compliance: Add RC4-SHA to enable TLS_RSA_WITH_RC4_128_SHA Add RC4-MD5 to enable TLS_RSA_WITH_RC4_128_MD5. For compatibility (for example): Add !SHA384 to interwork with a remote peer that erroneously reports support for SHA384 ciphers. Add &TLS10 to allow TLS 1.0
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: Parameter set unique internal ID. Reserved for internal use.
Rate Limiter
VFY-DSC-RATELIMITER
VFY-DSC-RATELIMITER::[<DSC/DSC Instance ID>]-[<Rate Limiter/Name>]:[CTAG];
DLT-DSC-RATELIMITER
DLT-DSC-RATELIMITER::[<DSC/DSC Instance ID>]-[<Rate Limiter/Name>]:[CTAG];
ADD-DSC-RATELIMITER
ADD-DSC-RATELIMITER::[<DSC/DSC Instance ID>]-[<Rate Limiter/Name>]:[CTAG];
CHG-DSC-RATELIMITER
CHG-DSC-RATELIMITER::[<DSC/DSC Instance ID>]-[<Rate Limiter/Name>]:[CTAG]:::::[RATELIMITERCAPPS=<string>];
::[<DSC/DSC Instance ID>]-[<Rate Limiter/Name>]:<NAME=string>,<RATELIMITERCAPPS=string>,<INTERNALID=int>;
AID DESCRIPTION
Name - Position 1
Type: string
Description: Name to uniquely identify the Rate Limiter. Leading and trailing whitespaces are trimmed. Valid values: alphanumeric characters, dashes, underscores, spaces, and dots (maximum size of 64). Cannot start the name with reserved dsc_ or pt_ (case insensitive).
ATTRIBUTE DETAILS
NAME - Name
Permissions: Createable
Type: string
Description: Name to uniquely identify the Rate Limiter. Leading and trailing whitespaces are trimmed. Valid values: alphanumeric characters, dashes, underscores, spaces, and dots (maximum size of 64). Cannot start the name with reserved dsc_ or pt_ (case insensitive).
RATELIMITERCAPPS - Capacity Parameter Set
Permissions: Writeable
Type: string
Description: Capacity Parameter Set associated with this Rate Limiter. Valid values: Existing Capacity Parameter Set. Default value: default.
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: Rate Limiter unique internal ID. Reserved for internal use.
Application ID Definition
DLT-DSC-APPID
DLT-DSC-APPID::[<DSC/DSC Instance ID>]-[<Application ID Definition/Name>]:[CTAG];
ADD-DSC-APPID
ADD-DSC-APPID::[<DSC/DSC Instance ID>]-[<Application ID Definition/Name>]:[CTAG]:::::[APPID=<int>],;
VFY-DSC-APPID
VFY-DSC-APPID::[<DSC/DSC Instance ID>]-[<Application ID Definition/Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Application ID Definition/Name>]:<APPID=int>;
AID Description
Name - Position 1
Type: string
Description: String representation of the numeric Application ID. Leading and trailing whitespaces are trimmed. Valid values: alphanumeric characters, dashes, underscores, spaces, and dots (maximum size of 64). Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Attribute Details
APPID - Application ID
Permissions: Createable
Type: int
Description: An Application ID is a Diameter concept, defined in RFC6733. Application ID values are managed by IANA, see https://www.iana.org/assignments/aaa-parameters/aaa-parameters.txt for more details on specific application id assignments. Valid values: integers.
Vendor ID Definition
DLT-DSC-VENDORID
DLT-DSC-VENDORID::[<DSC/DSC Instance ID>]-[<Vendor ID Definition/Name>]:[CTAG];
ADD-DSC-VENDORID
ADD-DSC-VENDORID::[<DSC/DSC Instance ID>]-[<Vendor ID Definition/Name>]:[CTAG]:::::[VENDORID=<int>],;
VFY-DSC-VENDORID
VFY-DSC-VENDORID::[<DSC/DSC Instance ID>]-[<Vendor ID Definition/Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Vendor ID Definition/Name>]:<VENDORID=int>;
AID Description
Name - Position 1
Type: string
Description: String representation of the numeric Vendor ID. Leading and trailing whitespaces are trimmed. Valid values: alphanumeric characters, dashes, underscores, spaces, and dots (maximum size of 64). Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Attribute Details
VENDORID - Vendor ID
Permissions: Createable
Type: int
Description: A Vendor ID is a Diameter concept, defined in RFC6733. The value 0 is reserved for base Diameter (as defined in RFC6733). Other Vendor ID values are managed by IANA, see https://www.iana.org/assignments/enterprise-numbers for more details on specific vendor id assignments. Valid values: integers.
AVP Definition
DLT-DSC-AVP
DLT-DSC-AVP::[<DSC/DSC Instance ID>]-[<AVP Definition/Name>]:[CTAG];
ADD-DSC-AVP
ADD-DSC-AVP::[<DSC/DSC Instance ID>]-[<AVP Definition/Name>]:[CTAG]:::::[VENDORID=<string>],[AVPCODE=<int>],[AVPTYPE=<AVPType>],[COMMENT=<string>];
CHG-DSC-AVP
CHG-DSC-AVP::[<DSC/DSC Instance ID>]-[<AVP Definition/Name>]:[CTAG]:::::[COMMENT=<string>];
VFY-DSC-AVP
VFY-DSC-AVP::[<DSC/DSC Instance ID>]-[<AVP Definition/Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<AVP Definition/Name>]:<VENDORID=string>,<AVPCODE=int>,<AVPTYPE=AVPType>,<COMMENT=string>;
AID Description
Name - Position 1
Type: string
Description: String representation of the AVP Definition. Leading and trailing whitespaces are trimmed. Valid values: alphanumeric characters, dashes, underscores, spaces, and dots (maximum size of 64). Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Attribute Details
VENDORID - Vendor ID
Permissions: Createable
Type: string
Description: Vendor ID Definition name responsible for the AVP. The combination of Vendor ID and AVP Code uniquely identifies an AVP. Valid values: name of existing Vendor ID Definition.
AVPCODE - AVP Code
Permissions: Createable
Type: int
Description: Code of the AVP. The combination of Vendor ID and AVP Code uniquely identifies an AVP. Valid values: integers.
AVPTYPE - AVP Type
Permissions: Createable
Type: AVPType = {UTF8String,OctetString,Unsigned32,Unsigned64,Integer32,Integer64,Time,Grouped,Enumerated,DiameterIdentity,DiameterURI,IPFilterRule,Address,Unknown,Float32,Float64}
Description: AVP Type defines the validation and encoding format of the AVP values. Important for modification record commands affecting the AVP values. Valid values: UTF8Strings, OctetString, Unsigned32, Unsigned64, Integer32, Integer64, Time, Grouped, Enumerated, DiameterIdentity, DiameterURI, IPFilterRule, Address, Float32, Float64, and Unknown (as per RFC6733). Default value: UTF8String (reference only).
COMMENT - Comment
Permissions: Writeable and Createable
Type: string
Description: AVP Definition optional comment for supplementary information. Often includes the specification reference for the AVP definition. Valid values: free-form string of maximum size 64 characters.
AVP Alias Definition
DLT-DSC-AVPALIAS
DLT-DSC-AVPALIAS::[<DSC/DSC Instance ID>]-[<AVP Alias Definition/Name>]:[CTAG];
ADD-DSC-AVPALIAS
ADD-DSC-AVPALIAS::[<DSC/DSC Instance ID>]-[<AVP Alias Definition/Name>]:[CTAG]:::::[AVPNAME=<string>],[AVPINST=<AVPInst>],[NESTEDAVP=<string>];
VFY-DSC-AVPALIAS
VFY-DSC-AVPALIAS::[<DSC/DSC Instance ID>]-[<AVP Alias Definition/Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<AVP Alias Definition/Name>]:<AVPNAME=string>,<AVPINST=AVPInst>,<NESTEDAVP=string>;
AID Description
Name - Position 1
Type: string
Description: String representation of the AVP Alias definition. Leading and trailing whitespaces are trimmed. Valid values: alphanumeric characters, dashes, underscores, spaces, and dots (maximum size of 64). Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Attribute Details
AVPNAME - AVP Name
Permissions: Createable
Type: string
Description: Associated AVP definition name. Valid values: Existing AVP definition name.
AVPINST - AVP Instance
Permissions: Createable
Type: AVPInst={FIRST,LAST,ANY, 1 to 10}
Description: AVP Instance (FIRST/LAST/ANY/1..10) Location or list of the AVP in the Diameter message or grouped AVP. Default value: FIRST.
NESTEDAVP - Nested AVP Alias
Permissions: Createable
Type: string
Description: Nested AVP Alias. If unnested, set to empty string. Else, set to the associated AVP Alias Definition name of the nested AVP. Valid values: Existing AVP Alias Definition Name or empty string. Default value: empty string. Example: Name: ExpRes-ExpResCo. AVP Name: Experimental-Result. Nested AVP Alias: ExpResCo (Existing AVP Alias Name for Experimental-Result-Code AVP).
Command Code Definitions
DLT-DSC-CMDCODE
DLT-DSC-CMDCODE::[<DSC/DSC Instance ID>]-[<Command Code Definition/Name>]:[CTAG];
ADD-DSC-CMDCODE
ADD-DSC-CMDCODE::[<DSC/DSC Instance ID>]-[<Command Code Definition/Name>]:[CTAG]:::::[CMDCODE=<int>],[IMPORTANCE=<CCImportance>],[COMMENT=<string>];
CHG-DSC-CMDCODE
CHG-DSC-CMDCODE::[<DSC/DSC Instance ID>]-[<Command Code Definition/Name>]:[CTAG]:::::[IMPORTANCE=<CCImportance>],[COMMENT=<string>];
VFY-DSC-CMDCODE
VFY-DSC-CMDCODE::[<DSC/DSC Instance ID>]-[<Command Code Definition/Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Command Code Definition/Name>]:<CMDCODE=int>,<IMPORTANCE=CCImportance>,<COMMENT=string>;
AID Description
Name - Position 1
Type: string
Description: String representation of the Command Code definition. Use abbreviation where possible for cross-referencing. Name will be moved to uppercase as required. Valid values: alphanumeric characters ending with 'R' (maximum size of 10).
Attribute Details
COMMENT - Comment
Permissions: Writeable and Createable
Type: string
Description: Command Code Definition optional comment for supplementary information. When an abbreviation is used in the 'Name' attribute, the full name should be provided. Should also include the corresponding specifications document reference. Valid values: free-form string of maximum size 64 characters.
CMDCODE - Command Code
Permissions: Createable
Type: int
Description: Associated command code. Valid values: 0 to 16777215.
IMPORTANCE - Importance
Permissions: Writeable and Createable
Type: CCImportance={0 to 3}
Description: Command Code Priority (0..3) Default value: 1.
Realm Definition
DLT-DSC-RLM
DLT-DSC-RLM::[<DSC/DSC Instance ID>]-[<Realm Definition/Alias>]:[CTAG];
ADD-DSC-RLM
ADD-DSC-RLM::[<DSC/DSC Instance ID>]-[<Realm Definition/Alias>]:[CTAG]:::::[REALM=<string>],[COMMENT=<string>];
CHG-DSC-RLM
CHG-DSC-RLM::[<DSC/DSC Instance ID>]-[<Realm Definition/Alias>]:[CTAG]:::::[REALM=<string>],[ALIAS=<string>],[COMMENT=<string>];
VFY-DSC-RLM
VFY-DSC-RLM::[<DSC/DSC Instance ID>]-[<Realm Definition/Alias>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<Realm Definition/Alias>]:<REALM=string>,<ALIAS=string>,<COMMENT=string>;
AID Description
Alias - Position 1
Type: string
Description: Alias used to identify the Realm. Used as a short name to identify the realm for ease of provisioning. Valid values: alphanumeric characters, dashes, underscores, spaces, and dots (maximum size of 64). Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Attribute Details
COMMENT - Comment
Permissions: Writeable and Createable
Type: string
Description: Realm Definition optional comment for supplementary information. Valid values: free-form string of maximum size 64 characters.
REALM - Realm
Permissions: Writeable and Createable
Type: string
Description: Realm definition. Valid values: FQDN format with at least one dot (.) character.
ALIAS - Alias
Permissions: Writeable and Createable
Type: string
Description: Alias used to identify the Realm. Used as a short name to identify the realm for ease of provisioning. Valid values: alphanumeric characters, dashes, underscores, spaces, and dots (maximum size of 64). Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Mobile Code Definitions
VFY-DSC-MOBCODES
VFY-DSC-MOBCODES::[<DSC/DSC Instance ID>]:[CTAG];
::[<DSC/DSC Instance ID>]:<MOBCODESEARCHTYPE=SearchType>;
Attribute Details
MOBCODESEARCHTYPE - Search Type
Permissions: Read-only
Type: SearchType={EXACT MATCH,LONGEST FROM RIGHT,LONGEST FROM LEFT}
Description: Search Type (LONGEST FROM LEFT) Mobile Codes represent the IMSI Mobile Code (MCC) and Mobile Network Code (MNC) values. This table defines the MCC MNC values whose MNC values are 3 digits long. It is used to lookup the length of the MNC value (2 or 3 digits ) based on the MCC value. The Diameter Routing Modification command replace-dest-realm-from-imsi performs a lookup of the AVP IMSI in this table. When looking up MCC MNC values, the search type is used to figure out the MCC and MNC digits from the IMSI value. If the search matches an entry in the table, the MNC is 3 digits. If no match is found, the MNC is 2 digits. Populate the table with MCC whose MNC values are all 3 digits. If an MCC value has both 2 digits and 3 digits MNC values then include only the 3 digits MNC values in the table using the format MCCMNC (6 digits). Default value: LONGEST FROM LEFT.
IMSI Mobile Code
VFY-DSC-IMSIMOBCODE
VFY-DSC-IMSIMOBCODE::[<DSC/DSC Instance ID>]-[<IMSI Mobile Code/MCCMNC>]:[CTAG];
DLT-DSC-IMSIMOBCODE
DLT-DSC-IMSIMOBCODE::[<DSC/DSC Instance ID>]-[<IMSI Mobile Code/MCCMNC>]:[CTAG];
ADD-DSC-IMSIMOBCODE
ADD-DSC-IMSIMOBCODE::[<DSC/DSC Instance ID>]-[<IMSI Mobile Code/MCCMNC>]:[CTAG];
::[<DSC/DSC Instance ID>]-[<IMSI Mobile Code/MCCMNC>]:<MCCMNC=string>;
AID Description
MCCMNC - Position 1
Type: string
Description: Mobile Country Code/Mobile Network Code combination A 3 digits MCCMNC value defines and groups all MCC entries that have only 3 digits MNC values. A 6 digits MCCMNC value defines MCC MNC entities that have both 2 and 3 digits MNC values by including the exact 3 digits MNC value. By default, an MCCMNC entry that does not exist in this table is assumed to have 2 digits MNC values. Example: 123456 (MCC is 132 and MNC is 456, other IMSI values that start with 123 have 2 digits MNC). 789 (all IMSI values that start with 789 have 3 digits MNCs). Valid values: 3 digits or 6 digits integer.
Attribute Details
MCCMNC - MCCMNC
Permissions: Createable
Type: string
Description: Mobile Country Code/Mobile Network Code combination A 3 digits MCCMNC value defines and groups all MCC entries that have only 3 digits MNC values. A 6 digits MCCMNC value defines MCC MNC entities that have both 2 and 3 digits MNC values by including the exact 3 digits MNC value. By default, an MCCMNC entry that does not exist in this table is assumed to have 2 digits MNC values. Example: 123456 (MCC is 132 and MNC is 456, other IMSI values that start with 123 have 2 digits MNC). 789 (all IMSI values that start with 789 have 3 digits MNCs). Valid values: 3 digits or 6 digits integer.
Server Pool
DLT-DSC-SERVPOOL
DLT-DSC-SERVPOOL::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]:[CTAG];
ADD-DSC-SERVPOOL
ADD-DSC-SERVPOOL::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]:[CTAG]:::::[SBIND=<PoolSessionBind>],[RTNAME=<string>],[LDBALANCE=<LoadBalancingType>],[LBAVP=<string>];
ADD-DSC-SERVPOOL::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]:[CTAG]:::::[RTNAME=<string>],[LDBALANCE=<LoadBalancingType>],[LBAVP=<string>];
CHG-DSC-SERVPOOL
CHG-DSC-SERVPOOL::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]:[CTAG]:::::[SBIND=<PoolSessionBind>],[RTNAME=<string>],[LDBALANCE=<LoadBalancingType>],[LBAVP=<string>];
SET-DSC-SERVPOOL
SET-DSC-SERVPOOL::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]:[CTAG]:::[ACTIVATE/DEACTIVATE];
VFY-DSC-SERVPOOL
VFY-DSC-SERVPOOL::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]:<NAME=string>,<SBIND=PoolSessionBind>,<RTNAME=string>,<LDBALANCE=LoadBalancingType>,<LBAVP=string>,<STATE=ActInactType>,<INTERNALID=int>;
AID Description
Name - Position 1
Type: string
Description: Name to uniquely identify the Server Pool. The name must be unique within the DSC Node. It is recommended that the name be set to a short and unique value to facilitate logs and alarms correlation. Valid values: alphanumeric characters, dashes, and underscores (maximum size of 32).
Attribute Details
SBIND - Session Binding
Permissions: Writeable and Createable
Type: PoolSessionBind={DISABLED,SESSION,PCRF}
Description: Session Binding (DISABLED/SESSION/PCRF). If set to DISABLED, simple load balancing is used. If set to SESSION, bind is performed to the Diameter Session-Id AVP. If set to PCRF, bind is performed to the EPC IP-CAN session. Default value: DISABLED.
RTNAME - Routing Table Name
Permissions: Writeable and Createable
Type: string
Description: Routing Table name for post-lookup entry point. Valid values: dsc_default or an existing Routing Table name. Default value: dsc_default.
STATE - Status
Permissions: Read-only
Type: ActInactType={ACTIVE,INACTIVE}
Description: Server Pool state (INACTIVE/ACTIVE). Activate the Server Pool to enable this feature.
LDBALANCE - Load Balancing
Permissions: Writeable and Createable
Type: LoadBalancingType={ROUND ROBIN WEIGHT,LEAST LOADED,ROUND ROBIN COST,HASH}
Description: When Round Robin Cost is selected then the lowest cost record is chosen as the routing destination. If more than one record has the same cost then messages are load shared in a round robin manner across the available destinations. Valid costs are values 1 to 99. When Round Robin Weight is selected, the weights represent the ratio of messages delivered to each destination. For example: Candidate A has weight = 10, B = 20 and C = 5. In a group of messages, the first 10 messages are sent to A, then the next 20 to B and the next 5 to C. The process is then restarted at A for the next messages. \n With Hash based the routing candidate is selected by hashing a defined AVP value in the message. When Least Loaded is selected, the weights indicate the relative message capacity of each server (in messages per second). Default Value: ROUND ROBIN WEIGHT.
LBAVP - AVP Alias
Permissions: Writeable and Createable
Type: string
Description: The name of an AVP Alias. This AVP is used by the hashing algorithm to perform traffic load balancing. Valid values: An AVP Alias which has been created in the DSC AVP Alias Definitions tables. If the AVP is not present in the message, then the hop-by-hop header value is used. Default value: session-id AVP.
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: Server Pool internal ID. Reserved for internal use.
Member Diameter ID
DLT-DSC-SPDMID
DLT-DSC-SPDMID::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]-[<Member Diameter ID/Diameter ID>]:[CTAG];
ADD-DSC-SPDMID
ADD-DSC-SPDMID::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]-[<Member Diameter ID/Diameter ID>]:[CTAG];
CHG-DSC-SPDMID
CHG-DSC-SPDMID::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]-[<Member Diameter ID/Diameter ID>]:[CTAG]:::::[COST=<int>],[WEIGHT=<WeightType>];
VFY-DSC-SPDMID
VFY-DSC-SPDMID::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]-[<Member Diameter ID/Diameter ID>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]-[<Member Diameter ID/Diameter ID>]:<DIAMID=string>,<COST=int><WEIGHT=WeightType>,<INTERNALID=int>;
AID Description
Diameter ID - Position 1
Type: string
Description: Diameter ID associated to the Server Pool. Valid values: FQDN format.
Attribute Details
COST - Cost
Permissions: Writeable
Type: int(Range: [1..99])
Description: Cost of the result record (1 to 99). Lowest available record is used for routing. If more than one record have the lowest available cost, loadsharing is performed.
WEIGHT - Weight
Permissions: Writeable
Type: WeightType={0 to 4000000} (Range: [0..4e+06])
Description: Weight of the Diameter ID (0 to 400000). The Diameter ID Weight is used to indicate the relative message capacity of this Diameter ID when load sharing on the server pool. Valid values: 0 to 100 (ROUND ROBIN) 0 to 4000000 (LEAST LOADED). Default value: 10 (ADN) and 0 (non-ADN) (ROUND ROBIN); 2000 (ADN) and 0 (non-ADN) (LEAST LOADED).
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: Member Diameter ID internal ID. Reserved for internal use.
Pool Application ID
DLT-DSC-SPAPPID
DLT-DSC-SPAPPID::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]-[<Pool Application ID/Application ID>]:[CTAG];
ADD-DSC-SPAPPID
ADD-DSC-SPAPPID::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]-[<Pool Application ID/Application ID>]:[CTAG];
VFY-DSC-SPAPPID
VFY-DSC-SPAPPID::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]-[<Pool Application ID/Application ID>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
::[<DSC/DSC Instance ID>]-[<DSC Node/Name>]-[<Server Pool/Name>]-[<Pool Application ID/Application ID>]:<INTERNALID=int>;
AID Description
Application ID - Position 1
Type: string
Description: Application ID associated to the Server Pool. Valid values: Existing Application ID Definition.
Attribute Details
INTERNALID - Internal ID
Permissions: Read-only
Type: int
Description: Pool Application internal ID. Reserved for internal use.
Topology Mapping Table
VFY-DSC-TOPOMTBL
VFY-DSC-TOPOMTBL::[<DSC/DSC Instance ID>]-[<Topology Mapping Table/Table Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];
DLT-DSC-TOPOMTBL
DLT-DSC-TOPOMTBL::[<DSC/DSC Instance ID>]-[<Topology Mapping Table/Table Name>]:[CTAG];
ADD-DSC-TOPOMTBL
ADD-DSC-TOPOMTBL::[<DSC/DSC Instance ID>]-[<Topology Mapping Table/Table Name>]:[CTAG];
::[<DSC/DSC Instance ID>]-[<Topology Mapping Table/Table Name>]:;
AID Description
Table Name - Position 1
Type: string
Description: Table Name to uniquely identify the table. The table name must be unique across all table types. Leading and trailing white spaces are trimmed. Valid values: Alphanumeric, dashes, underscores, spaces, and dots of maximum size 64. Cannot start the name with reserved dsc_ or pt_ (case insensitive).
Topology One to One Public Mapping
DLT-DSC-TMAPONEONE
DLT-DSC-TMAPONEONE::[<DSC/DSC Instance ID>]-[<Topology Mapping Table/Table Name>]-[<Topology One to One Public Mapping/Private Realm>-<Topology One to One Public Mapping/Private DID Host>]:[CTAG];
ADD-DSC-TMAPONEONE
ADD-DSC-TMAPONEONE::[<DSC/DSC Instance ID>]-[<Topology Mapping Table/Table Name>]-[<Topology One to One Public Mapping/Private Realm>-<Topology One to One Public Mapping/Private DID Host>]:[CTAG]:::::[PUBDID=<string>],[PUBREALM=<string>];
CHG-DSC-TMAPONEONE
CHG-DSC-TMAPONEONE::[<DSC/DSC Instance ID>]-[<Topology Mapping Table/Table Name>]-[<Topology One to One Public Mapping/Private Realm>-<Topology One to One Public Mapping/Private DID Host>]:[CTAG]:::::[PRVREALM=<string>],[PRVDID=<string>],[PUBDID=<string>],[PUBREALM=<string>];
VFY-DSC-TMAPONEONE
VFY-DSC-TMAPONEONE::[<DSC/DSC Instance ID>]-[<Topology Mapping Table/Table Name>]-[<Topology One to One Public Mapping/Private Realm>-<Topology One to One Public Mapping/Private DID Host>]:[CTAG];
::[<DSC/DSC Instance ID>]-[<Topology Mapping Table/Table Name>]-[<Topology One to One Public Mapping/Private Realm>-<Topology One to One Public Mapping/Private DID Host>]:<PRVREALM=string>,<PRVDID=string>,<PUBDID=string>,<PUBREALM=string>;
Aid Description
Realm - Position 1
Type: string
Description: Topology Mapping Realm to protect. Add this value to the Private DID Host attribute for the internal protected Diameter ID. Add this value to the Public DID Host attribute for the external Diameter ID. If a FQDN is specified, a Realm Definition will be automatically created if none exists. If a Realm Definition is already defined, the FQDN value will be replaced by the associated alias. Valid values: FQDN format or existing Realm Definition alias.
Private DID Host - Position 2
Type: string
Description: Host of the Diameter node inside the protected realm. Valid values: FQDN format.
Attribute Details
REALM - Realm
Permissions: Writeable and Createable
Type: string
Description: Topology Mapping Realm to protect. Add this value to the Private DID Host attribute for the internal protected Diameter ID. Add this value to the Public DID Host attribute for the external Diameter ID. If a FQDN is specified, a Realm Definition will be automatically created if none exists. If a Realm Definition is already defined, the FQDN value will be replaced by the associated alias. Valid values: FQDN format or existing Realm Definition alias.
PRVDID - Private DID Host
Permissions: Writeable and Createable
Type: string
Description: Host of the Diameter node inside the protected realm. Valid values: FQDN format.
PUBDID - Public DID Host
Permissions: Writeable and Createable
Type: string
Description: Host of the Diameter node to present to the outside realms. Valid values: FQDN format.
Topology One to N Public Mapping
DLT-DSC-TMAPONEMANY
DLT-DSC-TMAPONEMANY::[<DSC/DSC Instance ID>]-[<Topology Mapping Table/Table Name>]-[<Topology One to N Public Mapping/Private Realm>-<Topology One to N Public Mapping/Private DID Host>]:[CTAG];
ADD-DSC-TMAPONEMANY
ADD-DSC-TMAPONEMANY::[<DSC/DSC Instance ID>]-[<Topology Mapping Table/Table Name>]-[<Topology One to N Public Mapping/Private Realm>-<Topology One to N Public Mapping/Private DID Host>]:[CTAG]:::::[PUBPREFIX=<string>],[PUBSUFFIX=<string>],[PUBREALM=<string>];
CHG-DSC-TMAPONEMANY
CHG-DSC-TMAPONEMANY::[<DSC/DSC Instance ID>]-[<Topology Mapping Table/Table Name>]-[<Topology One to N Public Mapping/Private Realm>-<Topology One to N Public Mapping/Private DID Host>]:[CTAG]:::::[PRVREALM=<string>],[PRVDID=<string>],[PUBPREFIX=<string>],[PUBSUFFIX=<string>],[PUBREALM=<string>];
VFY-DSC-TMAPONEMANY
VFY-DSC-TMAPONEMANY::[<DSC/DSC Instance ID>]-[<Topology Mapping Table/Table Name>]-[<Topology One to N Public Mapping/Private Realm>-<Topology One to N Public Mapping/Private DID Host>]:[CTAG];
::[<DSC/DSC Instance ID>]-[<Topology Mapping Table/Table Name>]-[<Topology One to N Public Mapping/Private Realm>-<Topology One to N Public Mapping/Private DID Host>]:<PRVREALM=string>,<PRVDID=string>,<PUBPREFIX=string>,<PUBSUFFIX=string>,<PUBREALM=string>;
Aid Description
Realm - Position 1
Type: string
Description: Topology Mapping Realm to protect. Add this value to the Private DID Host attribute for the internal protected Diameter ID. Add this value to the Public DID Host attribute for the external Diameter ID. If a FQDN is specified, a Realm Definition will be automatically created if none exists. If a Realm Definition is already defined, the FQDN value will be replaced by the associated alias. Valid values: FQDN format or existing Realm Definition alias.
Private DID Host - Position 2
Type: string
Description: Host of the Diameter node inside the protected realm. Valid values: FQDN format.
Attribute Details
REALM - Realm
Permissions: Writeable and Createable
Type: string
Description: Topology Mapping Realm to protect. Add this value to the Private DID Host attribute for the internal protected Diameter ID. Add this value to the Public DID Host attribute for the external Diameter ID. If a FQDN is specified, a Realm Definition will be automatically created if none exists. If a Realm Definition is already defined, the FQDN value will be replaced by the associated alias. Valid values: FQDN format or existing Realm Definition alias.
PRVDID - Private DID Host
Permissions: Writeable and Createable
Type: string
Description: Host of the Diameter node inside the protected realm. Valid values: FQDN format.
PUBPREFIX - Public DID Host (Prefix)
Permissions: Writeable and Createable
Type: string
Description: Host of the Diameter Node to present to the outside realms. Valid values: FQDN format.
PUBSUFFX - Public DID Host (suffix)
Permissions: Writeable and Createable
Type: string
Description: Input format is: <begin> - <end>, where <begin> and <end> are numbers between 1-10000. There can be a difference up to 32 between end and begin. This is the range of suffix values to add to the Public DID for this mapping.
DSC Routing Search Utility
VFY-DSC-SRCHUTIL
VFY-DSC-SRCHUTIL::[<DSC/DSC Instance ID>]:[CTAG];
CHG-DSC-SRCHUTIL
CHG-DSC-SRCHUTIL::[<DSC/DSC Instance ID>]:[CTAG]:::::[NODE_NAME=<string>],[REQUEST_INC_ADN_NAME=<string>],[ANSWER_INC_ADN_NAME=<string>],[TEST_ROUTING_TABLE=<string>];
SET-DSC-SRCHUTIL
SET-DSC-SRCHUTIL::[<DSC/DSC Instance ID>]:[CTAG]:::[CLEAR/SEARCH];
::[<DSC/DSC Instance ID>]:<NODE_NAME=string>,<REQUEST_INC_ADN_NAME=string>,<ANSWER_INC_ADN_NAME=string>,<TEST_ROUTING_TABLE=string>,<OUTPUT_DSC_RESULT=string>,<DIAGNOSTIC_MESSAGE=string>;
Attribute Details
NODE_NAME - DSC Node Name
Permissions: Writeable
Type: string
Description: Name used to logically identify the DSC Node. The attribute is mandatory and is used to identify the DSC Node where the routing search is performed. The Node Name value must be defined on the DSC instance of the Search Utility.
REQUEST_INC_ADN_NAME - Request Incoming ADN Name
Permissions: Writeable
Type: string
Description: Incoming Adjacent Diameter Node Name for Request Message. The attribute is mandatory and is used to identify the Request Message DSC Incoming ADN where the TEST message is received. For Answer Test Message, this represents the incoming ADN of the original Request Message. The ADN DID value must be defined on the input DSC Node and must have at least one connection.
ANSWER_INC_ADN_NAME - Answer Incoming ADN Name
Permissions: Writeable
Type: string
Description: Incoming Adjacent Diameter Node Name for Answer Message. The attribute is mandatory for Answer Message but is not required for REQUEST Message. It is used to identify the Answer Message Incoming ADN where the TEST message is received. The ADN DID value must be defined on the input DSC Node diameter ID and must have at least one connection.
TEST_ROUTING_TABLE - Initial Routing Table Name
Permissions: Writeable
Type: string
Description: Initial Routing Table Name to Test. The Test Message will be routed starting from this routing table. The Initial Routing Table Name must be defined on the search interface instance routing table. If not supplied, it will use the Initial Routing Table Name of the input node for Request message. For Answer message, this will return INVALID INPUT result.
OUTPUT_DSC_RESULT - Result
Permissions: Read-only
Type: string
Description: Routing Test Result of the message (MESSAGE TESTED SUCCESSFULLY, RETURN ERROR, DISCARD MESSAGE, INVALID INPUT, MESSAGE TESTED NOT COMPLETED).
DIAGNOSTIC_MESSAGE - Diagnostic Message
Permissions: Read-only
Type: string
Description: The Diagnostic Message will display the header of the test message for user to confirm the test message content. It will also capture the message path of the test message. If an error is detected in the search criteria, this will alert the user on what is specifically wrong with the data.
DSC Table Record
VFY-DSC-SRCHTBLREC
VFY-DSC-SRCHTBLREC::[<DSC/DSC Instance ID>]:[CTAG];
::[<DSC/DSC Instance ID>]:<SEQNUM=int>,<MATCH_TABLE_TYPE=string>,<MATCH_TABLE_NAME=string>,<TABLE_RECORD=string>,<NEXT_TABLE=string>,<MOD_TABLE=string>;
Attribute Details
SEQNUM - Sequence Number
Permissions: Read-only
Type: int
Description: Routing Search Result Sequence Number to indicate the sequence of the matching table record. The smaller the number, the earlier the test message passes through the matching table record.
MATCH_TABLE_TYPE - Matching Table Type
Permissions: Read-only
Type: string
Description: DSC Search Result Matching Table Type
MATCH_TABLE_NAME - Matching Table Name
Permissions: Read-only
Type: string
Description: DSC Search Result Matching Table Name
TABLE_RECORD - Table Record
Permissions: Read-only
Type: string
Description: DSC Matching Table Record to store the key and content of the matching record.
NEXT_TABLE - Next Table
Permissions: Read-only
Type: string
Description: Next routing table, result table, default routing, or error handling to route the message. The next table cannot be a modification table.
MOD_TABLE - Modification Table
Permissions: Read-only
Type: string
Description: Associated optional Modification Table to be applied to the message. Valid values: empty string and existing Modification Table name.
DSC Candidate Outgoing ADN
VFY-DSC-CANLIST
VFY-DSC-CANLIST::[<DSC/DSC Instance ID>]:[CTAG];
::[<DSC/DSC Instance ID>]:<ORDER=int>,<CAN_OUT_ADN=string>,<CAN_ADN_STATUS=CandidateRouteStatusType>;
Attribute Details
ORDER - Order
Permissions: Read-only
Type: int
Description: the candidate ADN order where the DSC will try to send out the message. The smaller the order number, the early the DSC will try to send the message on that ADN.
CAN_OUT_ADN - Candidate ADN Name
Permissions: Read-only
Type: string
Description: the candidate outgoing ADN Name where the test message will be routed to.
CAN_ADN_STATUS - Candidate Status
Permissions: Read-only
Type: CandidateRouteStatusType={UNAVAILABLE,PREVIOUSLY USED,NO APPLICATION ID,AVAILABLE}
Description: the candidate ADN Status (UNAVAILABLE, PREVIOUSLY USED, NO APPLICATION ID, AVAILABLE). The UNAVAILABLE status ADN will be displayed only if it is from a Result table record and will NOT be seen from other routing mechanisms.