Context
The context of sentinel-ipsmgw
within the schema tree is shown. Italicised links are to other pages.
node-type choice smo deployment-config:sentinel-ipsmgw (in sentinel-ipsmgw-config.yaml) georedundancy total-sites map-messaging template-smsc-address originating-address ipsmgw-as-msc-address use-msisdn-as-hlr-address suppress-hlr-interaction use-gt-as-calling-party sms-content-size-threshold sri-sm-delivery-not-intended discard-inform-sc force-sm-rp-pri invoke-timeout-milliseconds terminating-domain sip-transport delivery-order charging-options mt-ps-enabled mt-cs-enabled mo-ps-enabled diameter-ro diameter-ro-release realm-choice choice single-realm destination-realm multiple-realms destination-realms list destination-realm charging-function-address peers list origin-realm destination-peers list protocol-transport destination-hostname port metric cdr max-size-bytes max-cdrs max-interval-milliseconds registrar-audit-cdrs-enabled ue-reachability-notifications subscription-expiry-time-seconds correlation-ra-plmnid mcc mnc fallback-settings fallback-timer-milliseconds avoidance-codes-ps-to-cs list avoidance-codes-cs-to-ps list sccp-allowlist list routing-info-cassandra-ttl-seconds ussi reject-all-with-default-message language message debug-logging-enabled
IPSMGW configuration.
This node and its descendants are configured in sentinel-ipsmgw-config.yaml
.
Conditional
This container is only valid when ../smo-virtual-machine-pool/sentinel-ipsmgw-enabled = 'true'
.
Related Constraints
Conditional node ../common
depends on this node. The Conditional expression refers to this node as ../sentinel-ipsmgw
.
../home-network
has a Data Validation Constraint which references this node. The validation expression refers to this node as ../sentinel-ipsmgw
.
Conditional node ../icscf
depends on this node. The Conditional expression refers to this node as ../sentinel-ipsmgw
.
Conditional node ../hlr
depends on this node. The Conditional expression refers to this node as ../sentinel-ipsmgw
.
Conditional node ../home-network
depends on this node. The Conditional expression refers to this node as ../sentinel-ipsmgw
.
georedundancy
Geo-redundancy configuration.
- When present
-
Enables geo-redundancy for IPSMGW.
Container Structure
total-sites
The number of geo-redundant sites.
This node is mandatory.
Type uint32
- Value
-
a number in the range 2 to 32
template-smsc-address
The 'digits' parameter value in this template is replaced by the value of that parameter from the received SMSC address to create a return address to the SMSC.
This node is mandatory.
Type sccp-address-type
- Description
-
A type representing an SCCP address in string form. The basic form of an SCCP address is:
type=<variant>,ri=<address type>,<parameter>=<value>,…
where
<variant>
isA7
for ANSI-variant SCCP orC7
for ITU-variant SCCP, and<address type>
is one ofgt
orpcssn
(for an address specified by Global Title (GT), or Point Code (PC) and Subsystem Number (SSN), respectively).The
<parameter>
options are:-
Point code:
pc=<point code in network-cluster-member (ANSI) or integer (ITU) format>
-
Subsystem number:
ssn=<subsystem number 0-255>
-
Global title address digits:
digits=<address digits, one or more 0-9>
-
Nature of address:
nature=<nature>
where<nature>
isunknown
,international
,national
, orsubscriber
-
Numbering plan:
numbering=<numbering>
where<numbering>
isunknown
,isdn
,generic
,data
,telex
,maritime-mobile
,land-mobile
,isdn-mobile
, orprivate
-
Global title translation type:
tt=<integer 0-255>
-
National indicator:
national=<true or false>
.parameter
names are separated from their values by an equals sign, and all<parameter>=<value>
pairs are separated by commas. Do not include any whitespace anywhere in the address.Only the
ssn
andnational
parameters are mandatory; the others are optional, depending on the details of the address - see below.Note carefully the following:
-
For ANSI addresses, ALWAYS specify
national=true
, unless using ITU-format addresses in an ANSI-variant network. -
For ITU addresses, ALWAYS specify
national=false
. -
All SCCP addresses across the deployment’s configuration must use the same variant (
A7
orC7
). -
Be sure to update the SGC’s SCCP variant in
sgc-config.yaml
to match the variant of the addresses.
For PC/SSN addresses (with
ri=pcssn
), you need to specify the point code and SSN. For GT addresses (withri=gt
), you must specify the global title digits and SSN in addition to the fields listed below (choose one option).There are two options for ANSI GT addresses:
-
translation type only
-
numbering plan and translation type.
There are four options for ITU GT addresses:
-
nature of address only
-
translation type only
-
numbering plan and translation type
-
nature of address with either or both of numbering plan and translation type.
Some valid ANSI address examples are:
-
type=A7,ri=pcssn,pc=0-0-5,ssn=147,national=true
-
type=A7,ri=gt,ssn=146,tt=8,digits=12012223333,national=true
Some valid ITU address examples are:
-
type=C7,ri=pcssn,pc=1434,ssn=147,national=false
-
type=C7,ri=gt,ssn=146,nature=INTERNATIONAL,numbering=ISDN,tt=0, digits=123456,national=false
-
type=C7,ri=gt,ssn=148,numbering=ISDN,tt=0,digits=0778899,national=false
-
- Value
-
a string with length 0 or more matching
(.,)*type=(A|C)7.
and matching(.,)*ri=(gt|pcssn).
and matching(.,)*ssn=[0-2]?[0-9]?[0-9].
and matching.=.(,.=.)*
originating-address
The SCCP address used as the calling party address in SS7 messages initiated by the IP-SM-GW.
![]() |
A restart is required for changes to this value to take effect. |
This node is mandatory.
Type sccp-address-type
- Description
-
A type representing an SCCP address in string form. The basic form of an SCCP address is:
type=<variant>,ri=<address type>,<parameter>=<value>,…
where
<variant>
isA7
for ANSI-variant SCCP orC7
for ITU-variant SCCP, and<address type>
is one ofgt
orpcssn
(for an address specified by Global Title (GT), or Point Code (PC) and Subsystem Number (SSN), respectively).The
<parameter>
options are:-
Point code:
pc=<point code in network-cluster-member (ANSI) or integer (ITU) format>
-
Subsystem number:
ssn=<subsystem number 0-255>
-
Global title address digits:
digits=<address digits, one or more 0-9>
-
Nature of address:
nature=<nature>
where<nature>
isunknown
,international
,national
, orsubscriber
-
Numbering plan:
numbering=<numbering>
where<numbering>
isunknown
,isdn
,generic
,data
,telex
,maritime-mobile
,land-mobile
,isdn-mobile
, orprivate
-
Global title translation type:
tt=<integer 0-255>
-
National indicator:
national=<true or false>
.parameter
names are separated from their values by an equals sign, and all<parameter>=<value>
pairs are separated by commas. Do not include any whitespace anywhere in the address.Only the
ssn
andnational
parameters are mandatory; the others are optional, depending on the details of the address - see below.Note carefully the following:
-
For ANSI addresses, ALWAYS specify
national=true
, unless using ITU-format addresses in an ANSI-variant network. -
For ITU addresses, ALWAYS specify
national=false
. -
All SCCP addresses across the deployment’s configuration must use the same variant (
A7
orC7
). -
Be sure to update the SGC’s SCCP variant in
sgc-config.yaml
to match the variant of the addresses.
For PC/SSN addresses (with
ri=pcssn
), you need to specify the point code and SSN. For GT addresses (withri=gt
), you must specify the global title digits and SSN in addition to the fields listed below (choose one option).There are two options for ANSI GT addresses:
-
translation type only
-
numbering plan and translation type.
There are four options for ITU GT addresses:
-
nature of address only
-
translation type only
-
numbering plan and translation type
-
nature of address with either or both of numbering plan and translation type.
Some valid ANSI address examples are:
-
type=A7,ri=pcssn,pc=0-0-5,ssn=147,national=true
-
type=A7,ri=gt,ssn=146,tt=8,digits=12012223333,national=true
Some valid ITU address examples are:
-
type=C7,ri=pcssn,pc=1434,ssn=147,national=false
-
type=C7,ri=gt,ssn=146,nature=INTERNATIONAL,numbering=ISDN,tt=0, digits=123456,national=false
-
type=C7,ri=gt,ssn=148,numbering=ISDN,tt=0,digits=0778899,national=false
-
- Value
-
a string with length 0 or more matching
(.,)*type=(A|C)7.
and matching(.,)*ri=(gt|pcssn).
and matching(.,)*ssn=[0-2]?[0-9]?[0-9].
and matching.=.(,.=.)*
ipsmgw-as-msc-address
The ipsmgw-as-msc-address is the address that the IP-SM-GW will return to the GMSC during the SendRoutingInformation phase of the MT message procedure, so that subsequent messages will be delivered to the IP-SM-GW. TCAP messages with this address should be routeable to an IP-SM-GW node.
This node is mandatory.
Type ss7-address-string-type
- Description
-
The SS7 address string type.
- Value
-
a string with length 0 or more matching
(.,)*address=.
and matching.=.(,.=.)*
use-msisdn-as-hlr-address
Indicates if 'hlr/hlr-address' should be used as the actual HLR address, or have its digits replaced with the MSISDN of the subscriber.
This node is mandatory.
Type boolean
- Value
-
'true' or 'false'
suppress-hlr-interaction
If true, no MAP messages will be sent to the HLR. Useful in LTE-only networks. Can only be set to true when 'delivery-order' is 'PS_ONLY'
This node is mandatory.
Data Validation Constraint
|
|
Validation Error: |
'suppress-hlr-interaction' can only be 'true' when 'delivery-order' is set to 'PS_ONLY' |
Type boolean
- Value
-
'true' or 'false'
use-gt-as-calling-party
When accepting an OpenRequest, the SCCP responder address in the
OpenAccept will, by default, be set to the value of the SCCP called
party in the OpenRequest. If UseGtAsCallingParty
is set to true,
and if the received sccp-called-party contains a global title, then
the global title will be used.
This node is mandatory.
Type boolean
- Value
-
'true' or 'false'
sms-content-size-threshold
If the length of the message content falls within the configured maximum then send the ForwardSM as part of the TC-BEGIN. As a special case a configured max size of 0 disables this functionality regardless of the actual content length.
This node is mandatory.
Type uint32
- Value
-
a number in the range 0 or more
sri-sm-delivery-not-intended
If true, specify the SmDeliveryNotIntended flag when performing an SRI for SM IMSI-only query (i.e. during SMMA callflows).
This node is mandatory.
Type boolean
- Value
-
'true' or 'false'
discard-inform-sc
If true, discard outbound InformSC components from requests sent to the HLR.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
true
force-sm-rp-pri
If true, force Sm_RP_PRI to be set to true in SendRoutingInfoForSM requests sent to the HLR.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
true
invoke-timeout-milliseconds
Timeout (in milliseconds) when invoking MAP operations.
Type uint32
- Value
-
a number in the range 0 or more
- Default value
-
4500
terminating-domain
Domain defined by the operator to compose SIP URIs from the MSISDN.
This node is mandatory.
Type domain-name
- Description
-
The domain-name type represents a DNS domain name. The name SHOULD be fully qualified whenever possible.
See RFC 6991 for full details.
- Value
-
a string with length 1 to 253 matching
((([a-zA-Z0-9_]([a-zA-Z0-9\-]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\.
sip-transport
The SIP transport to use for IPSMGW’s own SIP URI in outbound requests.
Type enumeration
- Value
-
one of the following
Value | Description |
---|---|
|
TCP. |
|
UDP. |
- Default value
-
'udp'
delivery-order
The delivery order for mobile-terminating messages.
This node is mandatory.
Related Constraint
../map-messaging/suppress-hlr-interaction
has a Data Validation Constraint which references this node. The validation expression refers to this node as ../../delivery-order
.
Type enumeration
- Value
-
one of the following
Value | Description |
---|---|
|
Try IMS network first, then circuit-switched network second. |
|
Try circuit-switched network first, then IMS network second. |
|
Only try delivery over the IMS network. |
|
Only try delivery over the circuit-switched network. |
charging-options
Message charging options.
Container Structure
mt-ps-enabled mt-cs-enabled mo-ps-enabled diameter-ro diameter-ro-release realm-choice choice single-realm destination-realm multiple-realms destination-realms list destination-realm charging-function-address peers list origin-realm destination-peers list protocol-transport destination-hostname port metric cdr max-size-bytes max-cdrs max-interval-milliseconds registrar-audit-cdrs-enabled
mt-ps-enabled
Whether charging is enabled for mobile-terminating PS messages.
This node is mandatory.
Related Constraint
Conditional node ../diameter-ro
depends on this node. The Conditional expression refers to this node as ../mt-ps-enabled
.
Type boolean
- Value
-
'true' or 'false'
mt-cs-enabled
Whether charging is enabled for mobile-terminating CS messages.
This node is mandatory.
Related Constraint
Conditional node ../diameter-ro
depends on this node. The Conditional expression refers to this node as ../mt-cs-enabled
.
Type boolean
- Value
-
'true' or 'false'
mo-ps-enabled
Whether charging is enabled for mobile-originating PS messages.
This node is mandatory.
Related Constraint
Conditional node ../diameter-ro
depends on this node. The Conditional expression refers to this node as ../mo-ps-enabled
.
Type boolean
- Value
-
'true' or 'false'
diameter-ro
Diameter Ro configuration.
Conditional
This container is only valid when ../mt-ps-enabled = 'true' or ../mt-cs-enabled = 'true' or ../mo-ps-enabled = 'true'
.
Related Constraint
Conditional node ../../../smo-virtual-machine-pool/virtual-machines/per-node-diameter-ro
depends on this node. The Conditional expression refers to this node as ../../../sentinel-ipsmgw/charging-options/diameter-ro
.
diameter-ro-release
The Diameter Ro release to use.
Type enumeration
- Value
-
one of the following
Value | Description |
---|---|
|
Release V8d0 |
|
Release V960 |
|
Release Va00 |
|
Release Vb80 |
|
Release Vcb0 |
- Default value
-
'Vcb0'
realm-choice choice
Whether to use a single realm or multiple realms.
A Choice between one of the following:
destination-realm
The Diameter destination realm.
This node is mandatory.
Type domain-name
- Description
-
The domain-name type represents a DNS domain name. The name SHOULD be fully qualified whenever possible.
See RFC 6991 for full details.
- Value
-
a string with length 1 to 253 matching
((([a-zA-Z0-9_]([a-zA-Z0-9\-]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\.
destination-realms list
List of Diameter destination realms.
Must contain at least 1 element.
List Structure
destination-realm domain-name charging-function-address string peers list string
The key is destination-realm
.
destination-realm
The destination realm.
This node is mandatory.
Type domain-name
- Description
-
The domain-name type represents a DNS domain name. The name SHOULD be fully qualified whenever possible.
See RFC 6991 for full details.
- Value
-
a string with length 1 to 253 matching
((([a-zA-Z0-9_]([a-zA-Z0-9\-]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\.
charging-function-address
The value that must appear in a P-Charging-Function-Addresses header in order to select this destination realm. If omitted, this will be the same as the destination-realm value.
Type string
- Value
-
a string
peers list
List of Diameter peers for the realm.
Must contain at least 1 element.
Type List of string
- Values
-
a string
origin-realm
The Diameter origin realm.
![]() |
A restart is required for changes to this value to take effect. |
This node is mandatory.
Type domain-name
- Description
-
The domain-name type represents a DNS domain name. The name SHOULD be fully qualified whenever possible.
See RFC 6991 for full details.
- Value
-
a string with length 1 to 253 matching
((([a-zA-Z0-9_]([a-zA-Z0-9\-]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\.
destination-peers list
Diameter destination peer(s).
Must contain at least 1 element.
List Structure
protocol-transport enumeration destination-hostname domain-name port port-number metric uint32
The key is destination-hostname
.
protocol-transport
The combined Diameter protocol and transport.
Type enumeration
- Value
-
one of the following
Value | Description |
---|---|
|
The Authentication, Authorization and Accounting (AAA) protocol over tcp |
|
The Authentication, Authorization and Accounting with Secure Transport (AAAS) protocol over tcp. IMPORTANT: this protocol is currently not supported. |
|
The Authentication, Authorization and Accounting (AAA) protocol over Stream Control Transmission Protocol (SCTP) transport. Will automatically be configured multi-homed if multiple signaling interfaces are provisioned. |
- Default value
-
'aaa'
destination-hostname
The destination hostname.
This node is mandatory.
Type domain-name
- Description
-
The domain-name type represents a DNS domain name. The name SHOULD be fully qualified whenever possible.
See RFC 6991 for full details.
- Value
-
a string with length 1 to 253 matching
((([a-zA-Z0-9_]([a-zA-Z0-9\-]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\.
port
The destination port number.
Type port-number
- Description
-
The port-number type represents a 16-bit port number of an Internet transport-layer protocol such as UDP, TCP, DCCP, or SCTP.
See RFC 6991 for full details.
- Value
-
a number in the range 0 or more
- Default value
-
3868
metric
The metric to use for this peer. Peers with lower metrics take priority over peers with higher metrics. If all peers have the same metric, traffic is round-robin load balanced over all peers.
Type uint32
- Value
-
a number in the range 0 or more
- Default value
-
1
max-size-bytes
Approximate maximum size in bytes before a new CDR file is started. After a CDR is written, the total file size is compared to MaxSize. If the current file size is larger, it is completed. If set to 0, no size-based rollover is done.
Type uint64
- Value
-
a number in the range 0 or more
- Default value
-
100000000
max-cdrs
Number of records to be written to a CDR file before a new file is started. If set to 0, no record-based rollover is done.
Type uint32
- Value
-
a number in the range 0 or more
- Default value
-
0
max-interval-milliseconds
The length of time (in milliseconds) before time-based file rollover. If a CDR file is used for more than max-interval-milliseconds without being rolled over due to record- or size-based limits, it is completed anyway. If set to 0, no time-based rollover is done.
Type uint32
- Value
-
a number in the range 0, 1000 or more
- Default value
-
0
registrar-audit-cdrs-enabled
'true' enables the creation of Registrar audit CDRs, 'false' disables.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
false
ue-reachability-notifications
Settings regarding UE reachability subscriptions.
- When present
-
Enables UE reachability notifications.
Container Structure
subscription-expiry-time-seconds
The UE reachability subscription expiry time (in seconds).
This node is mandatory.
Type uint32
- Value
-
a number in the range 0 or more
correlation-ra-plmnid
The PLMNID used by the correlation RA to generate MT correlation IMSIs when the routing info for the terminating subscriber cannot be determined. Must match one of the PLMNIDs defined in the home network configuration.
mnc
The Mobile Network Code (MNC).
This node is mandatory.
Type leafref
- Value
-
one of /home-network/home-plmn-ids[mcc = current()/../mcc/mncs]
fallback-timer-milliseconds
Timeout (in milliseconds) before attempting message delivery fallback.
Type uint32
- Value
-
a number in the range 0 or more
- Default value
-
5000
avoidance-codes-ps-to-cs list
List of error codes which will prevent fallback from PS to CS.
Type List of uint32
- Values
-
a number in the range 0 or more
avoidance-codes-cs-to-ps list
List of error codes which will prevent fallback from CS to PS.
Type List of uint32
- Values
-
a number in the range 0 or more
sccp-allowlist list
List of allowed GT prefixes. If non-empty, then requests from any GT originating addresses not on the list will be rejected. If empty, then all requests will be allowed. Requests from non-GT addresses are always allowed.
Type List of string
- Values
-
a string
routing-info-cassandra-ttl-seconds
Timeout (in seconds) that routing info is stored in Cassandra.
Type uint32
- Value
-
a number in the range 0 or more
- Default value
-
120
reject-all-with-default-message
Should all USSI messages be rejected with a default message.
- When present
-
Reject all USSI messages with a default message
language
The language that will be set in the USSI response message.
This node is mandatory.
Type string
- Value
-
a string with length 2 matching
[a-zA-Z]*
message
The text that will be set in the USSI response message.
This node is mandatory.
Type string
- Value
-
a string
debug-logging-enabled
Enable extensive logging for verification and issue diagnosis during acceptance testing. Must not be enabled in production.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
false