Context
The context of shcm-service within the schema tree is shown. Italicised links are to other pages.
node-type choice shcm deployment-config:shcm-service (in shcm-service-config.yaml) diameter-sh origin-realm destination-realm destination-peers list protocol-transport destination-hostname port metric health-check-user-identity diameter-request-timeout-milliseconds cassandra-locking backoff-time-milliseconds backoff-limit hold-time-milliseconds caching service-indications list service-indication cache-strategy cache-parameters cache-validity-time-seconds data-references-subscription-allowed list data-reference cache-strategy cache-parameters cache-validity-time-seconds data-references-subscription-not-allowed list data-reference cache-strategy cache-parameters cache-validity-time-seconds debug-logging-enabled
ShCM service configuration.
This node and its descendants are configured in shcm-service-config.yaml.
Related Constraint
Conditional node ../common depends on this node. The Conditional expression refers to this node as ../shcm-service.
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-realm
The Diameter destination realm.
|
|
Changing this value will require consistent changes to external systems also. Changing this value will converge automatically. |
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).
|
|
Adding or removing entries in this list will require consistent changes to external systems also. Adding or removing entries in this list will converge automatically. |
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.
|
|
Changing this value will require consistent changes to external systems also. Changing this value will converge automatically. |
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.
|
|
Changing this value will require consistent changes to external systems also. Changing this value will converge automatically. |
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.
|
|
Changing this value will require consistent changes to external systems also. Changing this value will converge automatically. |
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.
|
|
Changing this value will require consistent changes to external systems also. Changing this value will converge automatically. |
Type uint32
- Value
-
a number in the range 0 or more
- Default value
-
1
health-check-user-identity
The health check user identity. This should match a test user configured in the HSS.
This node is mandatory.
Type sip-uri-type
- Description
-
The SIP URI type.
- Value
-
a string with length 0 or more matching
sip:.*
diameter-request-timeout-milliseconds
The Diameter request timeout (in milliseconds).
Type uint32
- Value
-
a number in the range 909 to 27273
- Default value
-
5000
backoff-time-milliseconds
The time (in milliseconds) to backoff before re-attempting to obtain the lock in Cassandra.
Type uint32
- Value
-
a number in the range 50 to 5000
- Default value
-
5000
backoff-limit
The limit of times to backoff and re-attempt to obtain a lock in Cassandra.
Type uint32
- Value
-
a number in the range 1 to 10
- Default value
-
5
hold-time-milliseconds
The time (in milliseconds) to hold a lock in Cassandra.
Type uint32
- Value
-
a number in the range 1000 to 30000
- Default value
-
12000
caching
Caching configuration.
Container Structure
service-indications list service-indication cache-strategy cache-parameters cache-validity-time-seconds data-references-subscription-allowed list data-reference cache-strategy cache-parameters cache-validity-time-seconds data-references-subscription-not-allowed list data-reference cache-strategy cache-parameters cache-validity-time-seconds
service-indications list
Service indications.
List Structure
service-indication string cache-strategy cache-strategy-type cache-parameters cache-validity-time-seconds uint32
The key is service-indication.
cache-strategy
Cache strategy.
Related Constraint
Conditional node ../cache-parameters depends on this node. The Conditional expression refers to this node as ../cache-strategy.
Type cache-strategy-type
- Description
-
The type used to define the caching strategy.
- Value
-
one of the following
| Value | Description |
|---|---|
|
Do not use a cache. |
|
Use a simple cache. |
|
Use a subscription cache. |
- Default value
-
'subscription-cache'
cache-parameters
Parameters describing the configuration for this cache.
Conditional
This container is only valid when ../cache-strategy != 'no-cache'.
Container Structure
cache-validity-time-seconds
Cache validity time (in seconds).
This node is mandatory.
Type uint32
- Value
-
a number in the range 1 to 172800
data-references-subscription-allowed list
List of data references for which subscription is permitted, and their caching strategy configuration
List Structure
data-reference enumeration cache-strategy cache-strategy-type cache-parameters cache-validity-time-seconds uint32
The key is data-reference.
data-reference
The data reference.
This node is mandatory.
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
IMS public identity |
|
S-CSCF Name |
|
Initial filter criteria |
|
Service level trace info |
|
IP address secure binding information |
|
Service priority level |
|
Extended priority |
cache-strategy
The cache strategy.
Related Constraint
Conditional node ../cache-parameters depends on this node. The Conditional expression refers to this node as ../cache-strategy.
Type cache-strategy-type
- Description
-
The type used to define the caching strategy.
- Value
-
one of the following
| Value | Description |
|---|---|
|
Do not use a cache. |
|
Use a simple cache. |
|
Use a subscription cache. |
- Default value
-
'subscription-cache'
cache-parameters
Parameters describing the configuration for this cache.
Conditional
This container is only valid when ../cache-strategy != 'no-cache'.
Container Structure
cache-validity-time-seconds
/shcm-service/caching/data-references-subscription-allowed/cache-parameters/cache-validity-time-seconds
Cache validity time (in seconds).
This node is mandatory.
Type uint32
- Value
-
a number in the range 1 to 172800
data-references-subscription-not-allowed list
List of data references for which subscription is not permitted, and their caching strategy configuration.
List Structure
data-reference enumeration cache-strategy enumeration cache-parameters cache-validity-time-seconds uint32
The key is data-reference.
data-reference
The data reference.
This node is mandatory.
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Charging information |
|
MS-ISDN |
|
PSI activation |
|
DSAI |
|
SMS registration info |
|
TADS information |
|
STN SR |
|
UE SRV CC capability |
|
CSRN |
|
Reference location information |
cache-strategy
The cache strategy.
Related Constraint
Conditional node ../cache-parameters depends on this node. The Conditional expression refers to this node as ../cache-strategy.
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Do not use a cache. |
|
Use a simple cache. |
- Default value
-
'simple-cache'
cache-parameters
Parameters describing the configuration for this cache.
Conditional
This container is only valid when ../cache-strategy != 'no-cache'.
Container Structure
cache-validity-time-seconds
/shcm-service/caching/data-references-subscription-not-allowed/cache-parameters/cache-validity-time-seconds
Cache validity time (in seconds).
This node is mandatory.
Type uint32
- Value
-
a number in the range 1 to 172800
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
