Context
The context of naf-filter within the schema tree is shown. Italicised links are to other pages.
node-type choice mag deployment-config:naf-filter (in naf-filter-config.yaml) service-type service-id naf-group force-auth-on-paths list cassandra-connectivity reconnection-policy reconnection-interval-seconds reconnection-initial-delay-seconds reconnection-max-delay-seconds socket-connect-timeout-milliseconds socket-read-timeout-milliseconds socket-keepalive socket-reuse-address socket-linger-seconds socket-tcp-nodelay socket-receive-buffer-size-bytes socket-send-buffer-size-bytes lb-recipe lb-latency-aware-exclusion-threshold lb-latency-aware-scale use-ssl nonce-options reuse-count lifetime-milliseconds cache-capacity storage-mechanism nonce-cassandra-keyspace debug-logging-enabled intercept-tomcat-errors http-version
The Network Address Function (NAF) filter configuration.
This node and its descendants are configured in naf-filter-config.yaml.
Related Constraints
Conditional node ../number-analysis depends on this node. The Conditional expression refers to this node as ../naf-filter.
../home-network has a Data Validation Constraint which references this node. The validation expression refers to this node as ../naf-filter.
Conditional node ../common depends on this node. The Conditional expression refers to this node as ../naf-filter.
Conditional node ../home-network depends on this node. The Conditional expression refers to this node as ../naf-filter.
service-type
Identifies the type of service the NAF filter is providing. Recognised values for this setting are defined in Annex B of 3GPP TS 29.109. Affects which settings are selected from the GUSS.
Type uint8
- Value
-
a number in the range 0 or more
- Default value
-
0
service-id
An operator specific identifier that uniquely identifies the service the NAF filter is providing within the network. Affects which settings are selected from the GUSS.
Type uint16
- Value
-
a number in the range 0 or more
- Default value
-
0
naf-group
Identifies the group that the NAF filter belongs to. Affects which settings are selected from the GUSS.
Type string
- Value
-
a string
- Default value
-
''
force-auth-on-paths list
A list of URL path prefixes for which authentication should always be enforced, even for requests from trusted entities.
Type List of string
- Values
-
a string
cassandra-connectivity
Cassandra connectivity configuration for the NAF filter
Container Structure
reconnection-policy reconnection-interval-seconds reconnection-initial-delay-seconds reconnection-max-delay-seconds socket-connect-timeout-milliseconds socket-read-timeout-milliseconds socket-keepalive socket-reuse-address socket-linger-seconds socket-tcp-nodelay socket-receive-buffer-size-bytes socket-send-buffer-size-bytes lb-recipe lb-latency-aware-exclusion-threshold lb-latency-aware-scale use-ssl
reconnection-policy
The reconnection policy: 'constant' or 'exponential'.
Related Constraints
Conditional node ../reconnection-initial-delay-seconds depends on this node. The Conditional expression refers to this node as ../reconnection-policy.
Conditional node ../reconnection-max-delay-seconds depends on this node. The Conditional expression refers to this node as ../reconnection-policy.
Conditional node ../reconnection-interval-seconds depends on this node. The Conditional expression refers to this node as ../reconnection-policy.
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
The time between reconnect attempts is constant. |
|
The time between reconnect attempts increases exponentially to an upper limit. |
- Default value
-
'constant'
reconnection-interval-seconds
The reconnection interval (in seconds) to be used when the reconnection policy is set to 'constant'.
Conditional
This leaf is only valid when ../reconnection-policy = 'constant'.
Type uint32
- Value
-
a number in the range 5 to 60
- Default value
-
10
reconnection-initial-delay-seconds
The initial reconnection delay (in seconds) to be used when the reconnection policy is set to 'exponential'.
Conditional
This leaf is only valid when ../reconnection-policy = 'exponential'.
Type uint32
- Value
-
a number in the range 1 to 24
- Default value
-
1
reconnection-max-delay-seconds
The longest permitted interval (in seconds) between reconnect attempts when the reconnection policy is set to 'exponential'.
Conditional
This leaf is only valid when ../reconnection-policy = 'exponential'.
Type uint32
- Value
-
a number in the range 16 to 128
- Default value
-
32
socket-connect-timeout-milliseconds
The socket connection timeout (in milliseconds).
Type uint32
- Value
-
a number in the range 0 or more
- Default value
-
4000
socket-read-timeout-milliseconds
The socket read timeout (in milliseconds).
Type uint32
- Value
-
a number in the range 0 or more
- Default value
-
4000
socket-keepalive
The socket 'keepalive' option value. 'true' will enable the sending of keepalive messages. 'false' disables the sending of these messages. A value of 'not-set' indicates that the operating system default should be used.
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Enable the 'keepalive' socket option. |
|
Disable the 'keepalive' socket option. |
|
Use the operating system default value for the 'keepalive' socket option. |
- Default value
-
'not-set'
socket-reuse-address
The socket 'reuse-address' option value. 'true' enables this option which allows reuse of the local address provided that there is no active socket already bound to the address. 'false' disables this option. A value of 'not-set' indicates that the operating system default should be used.
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Enable the 'reuse-address' socket option. |
|
Disable the 'reuse-address' socket option. |
|
Use the operating system default value for 'reuse-address'. |
- Default value
-
'not-set'
socket-linger-seconds
If set to a value greater than '0' activates the 'linger' socket option. When activated, a close or shutdown of a socket will not return until all queued messages have been sent or the timeout (in seconds) has expired.
Setting this to '0' disables the 'linger' socket option.
A value of '-1' uses the operating system default.
Type int32
- Value
-
a number in the range -1 or more
- Default value
-
-1
socket-tcp-nodelay
A value of 'true' disables Nagle’s algorithm. All messages will be sent immediately. A value of 'false' enables Nagle’s algorithm. When Nagle’s algorithm is enabled the operating system may temporarily queue outbound data pending the arrival of further data to the same destination. This can reduce network overhead when many small TCP messages are generated by an application. A transmission delay of up to 500ms may occur as a result.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
true
socket-receive-buffer-size-bytes
The socket receive buffer size (in bytes). A value of '-1' uses the operating system default.
Type int32
- Value
-
a number in the range -1 or more
- Default value
-
-1
socket-send-buffer-size-bytes
The socket send buffer size (in bytes). A value of '-1' uses the operating system default.
Type int32
- Value
-
a number in the range -1 or more
- Default value
-
-1
lb-recipe
The load balancing recipe.
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Use round robin load balancing. |
|
Use data center (DC) aware round robin load balancing. |
|
Use latency aware round robin load balancing. |
|
Use latency and data center (DC) aware round robin load balancing. |
|
Use the default load balancing mechanism. |
- Default value
-
'use-default'
lb-latency-aware-exclusion-threshold
The load balancing latency aware exclusion threshold.
Type decimal64
- Value
-
a number with up to 1 decimal digits in the range 0.0, 1.0 or more
- Default value
-
0.0
lb-latency-aware-scale
The load balancing latency aware scale.
Type decimal64
- Value
-
a number with up to 1 decimal digits in the range 0.0 or more
- Default value
-
0.0
use-ssl
The SSL implementation to use. 'none' means do not use SSL.
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Use the JDK’s SSL implementation. |
|
Use Netty’s SSL implementation. |
|
Do not use SSL. |
- Default value
-
'none'
reuse-count
The maximum number of times a nonce can be reused by incrementing the nonce count.
Type uint32
- Value
-
a number in the range 0 or more
- Default value
-
100
lifetime-milliseconds
The time that a nonce remains valid for after being generated (in milliseconds).
Type uint32
- Value
-
a number in the range 0 or more
- Default value
-
180000
cache-capacity
The capacity of the nonce cache. This setting is only relevant when using the local storage mechanism.
Type uint32
- Value
-
a number in the range 1 or more
- Default value
-
100000
storage-mechanism
The storage mechanism to use for the nonce cache.
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Use Cassandra storage. |
|
Use local storage. |
- Default value
-
'local'
nonce-cassandra-keyspace
The Cassandra keyspace for the nonce cache. This setting is only relevant when using the Cassandra storage mechanism.
Type string
- Value
-
a string
- Default value
-
'opencloud_nonce_info'
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
intercept-tomcat-errors
Let NGINX intercept Tomcat errors and replace them with default errors. Use only on advice of your Customer Care representative.
|
Metaswitch support should be contacted for advice on how changes to this value can be made to take effect. |
Type boolean
- Value
-
'true' or 'false'
- Default value
-
false
http-version
HTTP version to use on the Ub (BSF) and Ua/Ut (NAF) interfaces.
|
|
Metaswitch support should be contacted for advice on how changes to this value can be made to take effect. |
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Use HTTP version 1.0. |
|
Use HTTP version 1.1. |
- Default value
-
'1.1'
