Context
The context of remote within the schema tree is shown. Italicised links are to other pages.
deployment-config:sgc (in sgc-config.yaml) m3ua remote peers list id remote-ips list node-index ips list port state-maintenance-role conn-type is-ipsp asp-id application-servers list as-id daud-on-asp-ac application-servers list id traffic-maintenance-role routing-context routes default-priority dpc-ids list id priority precond-ssns list dpcs list id dpc network-appearance muss mss pudt cpcs list dpc ssns list
Remote M3UA configuration.
peers list
Connection configuration.
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
List Structure
id string remote-ips list node-index int16 ips list ipv4-address-no-zone port port-number state-maintenance-role enumeration conn-type enumeration is-ipsp boolean asp-id uint32 application-servers list as-id string daud-on-asp-ac boolean
The key is id.
remote-ips list
Remote IP configuration to connect this SGC cluster to this remote peer.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
Must contain at least 1 element.
node-index
The index of the SMO node that hosts the SGC that will be connected to this IP set. '1' is the first SMO node, '2' is the second, and so on. '-1' indicates that all SGC nodes in the cluster will use this remote IP set.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
Type int16
- Value
-
a number in the range -1, 1 or more
ips list
The remote IP address(es) that belong to this IP set.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
Must contain at least 1 element.
Type List of ipv4-address-no-zone
- Description
-
An IPv4 address without a zone index.
See RFC 6991 for full details.
- Values
-
a string with length 0 or more matching
[0-9\.]*
port
The remote port for this M3UA association.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
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
-
2905
state-maintenance-role
The role to perform in M3UA state maintenance.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
The SGC takes an active role in M3UA state maintenance. |
|
The SGC takes a passive role in M3UA state maintenance. |
- Default value
-
'active'
conn-type
The connection type to establish: client or server.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
The SGC connects to the remote peer. |
|
The SGC waits for a connection from the remote peer. |
- Default value
-
'client'
application-servers list
The application servers to which this connection belongs.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
Must contain at least 1 element.
daud-on-asp-ac
Send DAUD when the ASP goes ACTIVE in this AS.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
Type boolean
- Value
-
'true' or 'false'
- Default value
-
true
application-servers list
Application server configuration.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
List Structure
id string traffic-maintenance-role enumeration routing-context uint32 routes default-priority uint8 dpc-ids list id string priority uint8 precond-ssns list uint8
The key is id.
id
Uniquely identifies this list entry.
Not referred to anywhere else in the configuration. Any unique value is permitted.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
This node is mandatory.
Type string
- Value
-
a string
traffic-maintenance-role
The traffic-maintenance role to assume in this application server.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Assume an active traffic-maintenance role. |
|
Assume a passive traffic-maintenance role. |
- Default value
-
'active'
routing-context
The routing context of this application server. No value specified means null.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
Type uint32
- Value
-
a number in the range 0 or more
default-priority
The default priority to apply to any routes in this application server where a specific priority has not been configured.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
This node is mandatory.
Type uint8
- Value
-
a number in the range 0 or more
dpc-ids list
A list of DPCs that may be accessible from this application server.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
Must contain at least 1 element.
priority
This DPC’s priority. Overrides any value configured in
../default-priority
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
Type uint8
- Value
-
a number in the range 0 or more
precond-ssns list
This application server will not become active until there is at least one connected TCAP stack for each SSN specified here.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
Type List of uint8
- Values
-
a number in the range 0 or more
dpc
The destination point code.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
This node is mandatory.
Type ss7-point-code-type
- Description
-
A type representing an SS7 point code. When ANSI variant is in use, specify this in network-cluster-member format, such as 1-2-3, where each element is between 0 and 255. When ITU variant is in use, specify this as an integer between 0 and 16383. Note that for ITU you will need to quote the integer, as this field takes a string rather than an integer.
- Value
-
a string with length 0 or more matching
(([0-2]?[0-9]?[0-9]-){2}[0-2]?[0-9]?[0-9])|([0-1]?[0-9]{1,4})
network-appearance
The network appearance.
Absent means null. 0 and null have different meanings in the network.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
Type uint8
- Value
-
a number in the range 0 or more
pudt
The preferred unitdata message type.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Use UDT messages where possible. |
|
Use XUDT messages even if the data would fit within a UDT message. |
- Default value
-
'UDT'
dpc
The destination point code to inform if the monitored SSN changes state.
|
|
See 'Reconfiguring the SGC' in 'Rhino VoLTE TAS Configuration and Management Guide' for how to activate changes to this value. |
This node is mandatory.
Type ss7-point-code-type
- Description
-
A type representing an SS7 point code. When ANSI variant is in use, specify this in network-cluster-member format, such as 1-2-3, where each element is between 0 and 255. When ITU variant is in use, specify this as an integer between 0 and 16383. Note that for ITU you will need to quote the integer, as this field takes a string rather than an integer.
- Value
-
a string with length 0 or more matching
(([0-2]?[0-9]?[0-9]-){2}[0-2]?[0-9]?[0-9])|([0-1]?[0-9]{1,4})
