13 Configuring L3-L4 Information for Synthetic Packet Feed

OCNADD supports CLI based configuration for L3-L4 mapping. Feed configuration created from the OCNADD GUI can be updated with L3-L4 mapping configuration using the CLI. Configuration for L3-L4 mapping includes:
  • L3-L4 mapping rule configuration for each synthetic feed.
  • Global L3-L4 mapping configuration to compare and lookup L3-L4 information (applicable for each synthetic feed).

Note:

Option to configure L3-L4 information through the GUI is planned for the subsequent release.

Note:

After performing an update through the CLI, ensure that further updates are not performed through the OCNADD GUI, else, the L3-L4 configuration gets deleted.

Create Configuration

URI: <apiRoot>/ocnadd-configuration/v3/configure

Method: POST

Request Body:

Type: ConsumerConfigDto

Table 13-1 Request Body Parameters

Name Data Type P Cardinality Description
configurationName String M 1 The configuration name provided by third party consumers for the consumer feed. This should be a unique name.
userName String M 1 The user name provided through the OCNADD GUI.
consumerAdapterConfig ConsumerAdapterConfig M 1 The consumer adapter configuration parameters to be configured in the egress adapter for the third party consumer application.
apiVersion ENUM O 1 This field is set by the configuration service based on the API version received in the URI from the GUI for third party feed Create/Update/Delete configuration. The version is set when the configuration service provides a list of configurations to the consumer through GET method (v1, v2).

Type: ConsumerAdapterConfig

Table 13-2 Request Body Parameters

Name Data Type P Cardinality Description
encode_L2_L7_Hex_Dump Boolean M 1

When this parameter is enabled, OCNADD will encode all the incoming data into HTTP2 hex bytes and send it to third party consumer over the TCP connection.

Encoding rule:

a. Encode synthetic Ethernet layer

b. Encode synthetic IP layer

c. Encode synthetic Transport layer

d. Encode Headerlist to HTTP2 Header frame

e. Encode MetadataList to HTTP2 Header frame as custom header when parameter metadataRequired is set to true.

f. Encode SBI Message Payload to HTTP2 Data frame.

targetUri Array of ConsumerEndPoint M 1 up to N This is a mandatory parameter. It provides information about the third party consumer endpoints and their corresponding load factor. The data director sends the 5G traffic feed on these configured endpoints and distributes the load among the endpoints based on the percentage provided as load factor. In case the load factor is not provided then the traffic is equally distributed to all the endpoints. The following example is a sample of the consumer endpoint rules:{ {"targetEndPoint1", "load%"}, {"targetEndPoint2", "load%"} }

If there is only one endpoint, there is no load balancing in the consumer adapter service and total traffic will be sent to the endpoint provided. The GUI disables the selection of lbType.

lbType Enum M 1

User can obtain streaming data distributed to third party application when multiple endpoints are configured for the feed.

When only one endpoint is selected then lbType is disabled in the GUI.

This is a mandatory parameter, and the default value is RoundRobin.

The permitted values are RoundRobin and WeightedLB1.

RoundRobin: Parallel streaming of data towards all third party endpoints. Data is equally distributed to all third party endpoints. Request and Response message to same third party end point can not be assured.

WeightedLB1: Stream data based on the loadsharing type defined corresponding to each third party end point with targetUri. The request and response message will be sent to same third party endpoints.

The percentage of load sharing to third party will be close to the configured load factor defined for consumer endpoint.

The total percentage of load sharing among all the third party end points is 100%.

metadataRequired Boolean O 1 This is an optional parameter, it indicates if the outbound packet from the Data Director should contain the optional metadata. The default value is true. This will be enabled by default. When parameter is enabled:
  • a. Metadata List will be added when a message sent to the third party feed.
    • In case of Synthetic feed, it shall be added in Header Frames as custom headers.
    • In case of HTTP2 feed, it shall be added in JSON payload.

When parameter is disabled:

  • Metadata is skipped for both HTTP2 feed and Synthetic feed.
l2_l4_headerRequired Boolean O 1

This is Layer 2 to Layer 4 information.

When encode_L2_L7_Hex_Dump is set to true, it will be enabled (mandatory), and values must be set.

L2_L4 information is obtained from the metadata list and values which are not available in metadata list, will be obtained from L2L4 info DTO.

l2_l4_info L2L4Info C 1

This is Layer2 to Layer4 information.

When encode_L2_L7_Hex_Dump is set to true, it will be enabled (mandatory), and values must be set.

L2_L4 information is obtained from the metadata list and values which are not available in metadata list, will be obtained from L2L4 info DTO.

l3l4Mapping L3L4MappingDto O 1

This parameter allows to add DD mapping rule for L3 (IP address) and L4 (Port) layer for synthetic packet encoding.

When encode_L2_L7_Hex_Dump is set to true, it can be added by user to get DD mapping applied for Layer 3 and Layer 4 for sourceIP, destinationIP. sourcePort, DestinationPort attributes in synthetic packet encoding.

aggregationRule Array of NFType M 1 This is a mandatory parameter. It provides the list of source NFs from the which the consumer feed require traffic. In case it has SCP and NRF, then data director will aggregate the traffic from SCP and NRF into the consumer feed. The example is given below for the aggregation rules:"aggregationRules": [ "sourceNfType": "SCP", "sourceNfType": "NRF", "sourceNfType": "SEPP", ]
outBoundConnParams OutBoundConnectionParameters M 1 This is a mandatory parameter. It provides the connection parameters for the outbound interface toward the 3rd party application. It contains HTTP/2 or TCP connection type for example, secured or unsecured, cipher suits, ignoreResponseoutboundConnParams: { connType: H2C ciphers: "TLS_RSA_WITH_AES_128_GCM_SHA256" ignoreResponse: true }

For Synthetic Feed, "ignoreResponse" will always be true.

TLS secured, and non-secured connection support added for synthetic data generation.

dataStreamOffset Enum [EARLIEST,LATEST] M 1 This is a mandatory parameter for consumer adapter.
  • EARLIEST: Start data stream from beginning or resume data stream from the point of failure.
  • LATEST: Proceed with data stream from the current offset.

Type: ConsumerEndPoint

Table 13-3 Request Body Parameters

Name Data Type P Cardinality Description
targetEndPoint String M 1

The endpoint of 3rd party REST service or TCP server that should receive the 5G feed from OCNADD.

The Data Director sends the feed to this endpoint and also distributes the load based on the load factor.

When multiple destination endpoints are configured:

  • encode_L2_L7_Hex_Dump: True, it will be the REST end point.
  • encode_L2_L7_Hex_Dump: False, it will be the TCP server end point.
loadFactor String O 1

This is a load factor in terms of percentage of data distribution for the target endpoint.

When:

  • lbType = RoundRobin, it does not allow user to add any value.
  • lbType = WeightedLB1, allows user to add load percentage and sum of load factor including all consumer endpoints must be 100%.

Default value: RoundRobin

Type: L2L4Info

Table 13-4 Request Body Parameters

Name Data Type P Cardinality Description
macSrc String M 1

Source MAC address to be used in Layer 2 header.

It should be sent without any format applied to configuration service in feed configuration.

For example: 12:00:00:12:34:45 should be sent as: 120000123445.

macDst String M 1

Destination MAC address to be used in Layer 2 header.

It should be sent without any format applied to configuration service in feed configuration.

For example: 12:00:00:12:34:45 should be send as: 120000123445.

etherType String M 1 Ethernet type in Layer 2 header. This should always be IPv4.
ipSrc String M 1 Source IP address to be used in Layer 3 header.
ipDst String M 1 Destination IP address to be used in Layer 3 header.
srcPort String M 1 Source Port to be used in Layer 4 header.
dstPort String M 1 Destination Port to be used in Layer 4 header.

Type: L3L4MappingDto

Table 13-5 Request Body Parameters

Name Data Type P Cardinality Description
rxRequest L3L4DirectionMappingDto M 1

DD mapping rule for direction type rxRequest(REQUEST_INGRESS).

Consists of mapping rule information for sourceIP, destinationIP, sourcePort, and destinationPort.

txRequest L3L4DirectionMappingDto M 1

DD mapping rule for direction type txRequest(REQUEST_EGRESS).

Consists of mapping rule information for sourceIP, destinationIP, sourcePort, and destinationPort.

rxResponse L3L4DirectionMappingDto M 1

DD mapping rule for direction type rxResponse(RESPONSE_INGRESS).

Consists of mapping rule information for sourceIP, destinationIP, sourcePort, and destinationPort.

txResponse L3L4DirectionMappingDto M 1

DD mapping rule for direction type txResponse(RESPONSE_EGRESS).

Consists of mapping rule information for sourceIP, destinationIP, sourcePort, and, destinationPort.

Type: L3L4AddressMappingsDto

Table 13-6 Request Body Parameters

Name Data Type P Cardinality Description
mappingPriority Enum (MappingPriority) M 1 This defines synthetic packet encoding priority for L3 and L4 layer encoding for IP address and Port.

True:

  • 1st priority: metadata-list
  • 2nd priority: Global DD mapping configuration
  • 3rd priority: Feed configuration

False:

  • 1st priority: Global DD mapping configuration
  • 2nd priority: metadata-list
  • 3rd priority: Feed configuration

Default: True

Possible value: METADATA, DD_MAPPING
mappingReferencePriority Enum (MappingReferencePriority) M 1

This defines reference of mapping priority information.

Default: DD_MAPPING,

Possible value: [DD_MAPPING, DNS]

Note: DNS is not supported in current release. GUI does not allow using the DNS option.

l3l4AttributeRule String M 1 This defines and allows the user to select set of rules which shall be considered for synthetic packet encoding for L3 and L4 fields when Global DD mapping is needed.

GUI prepopulates it with default mapping values during feed configuration and user will be allowed to update it with support condition rules.

Example:

<SupportedL3L4Attributes> AND <SupportedL3L4Attributes> // More than one attributes will always be added with AND, no other type is supported. consumer-fqdn AND producer-fqdn // The value must match and taken from SupportedL3L4Attributes.
address String M 1

The address can be set with either of value (sourceIP, destinationIP, sourcePort, or destinationPort) based on association with parents DTO.

rxRequest->sourceIp = source-ip

rxRequest->destinationIP = destination-ip

rxRequest->sourcePort = source-port

rxRequest->destinationPort = destination-port

It has least priority in L3 and L4 layer synthetic packet encoding.

Type: MappingPriority

Table 13-7 Request Body Parameters

Attribute Name
DD_MAPPING
METADATA
Type: MappingReferencePriority

Table 13-8 Request Body Parameters

Attribute Name
DD_MAPPING

Type: L3L4DirectionMappingsDto

Table 13-9 Request Body Parameters

Name Data Type P Cardinality Description
sourceIP L3L4AddressMappingsDto M 1

DD mapping rule for source IP address with L3 and L4 rules.

It shall be configured for each direction type (rxRequest, txRequest, rxResponse, txResponse) based on associated parent DTO.

destinationIP L3L4AddressMappingsDto M 1

DD mapping rule for destination IP address with L3 and L4 rules.

It shall be configured for each direction type (rxRequest, txRequest, rxResponse, txResponse) based on associated parent DTO.

sourcePort L3L4AddressMappingsDto M 1

DD mapping rule for sourcePort address with L3 and L4 rules.

It shall be configured for each direction type (rxRequest, txRequest, rxResponse, txResponse) based on associated parent DTO.

destinationPort L3L4AddressMappingsDto M 1

DD mapping rule for destinationPort address with L3 and L4 rules.

It shall be configured for each direction type (rxRequest, txRequest, rxResponse, txResponse) based on associated parent DTO.

Type: NFType

Table 13-10 Request Body Parameters

Name Data Type P Cardinality Description
sourceNfType String M 1

This is an identifier for the source feed. The allowed values are SCP, NRF, SEPP and Third Party.

For example:

"sourceNfType": "SCP"

Supported NF Type: SCP, NRF, SEPP

Type: OutBoundConnectionParameters

Table 13-11 Request Body Parameters

Name Data Type P Cardinality Description
connType

ENUM <HTTP2, H2C,

TCP_SECURED,

TCP>

M 1

Connection type to indicate if it is a secured connection or unsecured connection.

HTTP2: Secured HTTP2 connection with default TLS 1.2

H2C: HTTP2 in clear text (non secured)

TCP: Non secured TCP connection.

TCP_SECURED: Secured TCP connection with default TLS 1.2.

ciphers List<String> C 1 List of cipher and keys. It is applicable when the Conn Type is Secured.
ignoreResponse Boolean M 1 To indicate if the response should be processed or ignored by the consumer adapter. Default is True.

Table 13-12 Supported Response Codes

Response Code Description
201 Created

The configuration service processes the filter request, creates the filter subscription, and returns the common Location header of the filter API.

The URI in the Location header can be used to update or delete the filter configuration.

{ apiRoot}/ocnadd-configuration/v1/filter

204 No Content The response to update and delete the filter configuration request against an existing list of Filters or Filter Names respectively.
400 Bad Request The response to a POST request if the create subscription request does not contain valid data.
403 Forbidden This response is returned if create/update/delete is not allowed for the filter configuration.
404 Not Found This response shall be returned if existing Filter Name cannot be found on the OCNADD.
500 Internal Server Error The response body contains the error reason for the request message. This shall be sent in case of an internal processing error of the configuration service.

Example

cURL Command

curl -v --location --request POST 'http://172.16.19.9:31796/ocnadd-configuration/v3/configure' \
--header 'Content-Type: application/json' \
--data-raw '{
    /*Name of Feed, must follow lower case and only - is allowed for name seperation*/
    "configurationName": "app1",
    /*user role for UI purpose*/
    "userName": "admin",
    "filterconfig": null,
    /*Feed configuration for Egress Adapter*/
    "consumerAdapterConfig": {
        /*Data aggergation rule, to include data from source while sending to 3rd party, supported value: SCP, NRF, SEPP*/
        "aggregationRules": [
            {
                "sourceNfType": "SCP"
            }
        ],
        "outboundConnParams": {
            /* Connection type to connection with 3rd party app, supported value: TCP_SECURED and TCP for non-secured*/
            "connType": "TCP_SECURED",
            /* Cipher type when oracle supported ciphers are not in 3rd party app*/
            "ciphers": [
                "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"
            ]
        },
        "targetUri": [
            {
                /* Tcp service 3rd party app endpoints, min=1 and max=2 endpoints are supported*/
                "targetEndPoint": "ocnaddthirdpartyconsumer1:18990",
                /* Load factor in case of weighted load balancing feature is required*/
                "loadFactor": "10"
            },
            {
                /* Tcp service 3rd party app endpoints, min=1 and max=2 endpoints are supported*/
                "targetEndPoint": "ocnaddthirdpartyconsumer2:18990",
                /* Load factor in case of weighted load balancing feature is required*/
                "loadFactor": "90"
            }
        ],
        /* To choose, metadata should be added in HTTP2 HEADERS frame as custom header or not*/
        "metadataRequired": true,
        /* Must be set to true, when synthetic data is required*/
        "encode_L2_L7_Hex_Dump": true,
        /* Default; L2 l4 layer information, All attributes value must be set*/
        "l2_l4_info": {
            /* Source MAC address for Ethernet Header*/
            "macSrc": "000000000000",
            /* Destination MAC address for Ethernet Header*/
            "macDst": "000000000000",
            /* Should not be change, only IPv4 is supported*/
            "etherType": "0800",
            /* Source IP address to be added in IP header for synthetic packet when it is not present in metadata and L3L4 mapping is not configured*/
            "ipSrc": "10.10.10.100",
            /* Destination IP address to be added in IP header for synthetic packet when it is not present in metadata and L3L4 mapping is not configured*/
            "ipDst": "10.100.100.101",
            /* Source Port to be added in TCP header for synthetic packet when it is not present in metadata and L3L4 mapping is not configured*/
            "srcPort": "8080",
            /* Destination Port to be added in TCP header for synthetic packet when it is not present in metadata and L3L4 mapping is not configured*/
            "dstPort": "8080"
        },
        /* Start of L3L4 mapping configuration for a feed*/
        "l3l4Mapping": {
            /* Mappning rule configuration for direction type RxRequest*/
            "rxRequest": {
                /* Source IP l3l4 mapping configuration*/
                "sourceIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "DD_MAPPING",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "consumer-fqdn AND api-name",
                    /* Least priority address*/
                    "address": "10.20.30.10"
                },
                /* Destination IP l3l4 mapping configuration*/
                "destinationIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "DD_MAPPING",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND message-direction",
                    /* Least priority address*/
                    "address": "10.20.40.10"
                },
                /* Source Port l3l4 mapping configuration*/
                "sourcePort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "DD_MAPPING",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND consumer-fqdn",
                    /* Least priority address*/
                    "address": "3010"
                },
                /* Destination Port l3l4 mapping configuration*/
                "destinationPort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "DD_MAPPING",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn",
                    /* Least priority address*/
                    "address": "4010"
                }
            },
            /* Mappning rule configuration for direction type TxRequest*/
            "txRequest": {
                /* Source IP l3l4 mapping configuration*/
                "sourceIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND message-direction",
                    /* Least priority address*/
                    "address": "10.20.40.20"
                },
                /* Destination IP l3l4 mapping configuration*/
                "destinationIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "producer-fqdn",
                    /* Least priority address*/
                    "address": "10.20.50.10"
                },
                /* Source Port l3l4 mapping configuration*/
                "sourcePort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND producer-fqdn",
                    /* Least priority address*/
                    "address": "4020"
                },
                /* Destination Port l3l4 mapping configuration*/
                "destinationPort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "producer-fqdn",
                    /* Least priority address*/
                    "address": "5010"
                }
            },
            /* Mappning rule configuration for direction type RxResponse*/
            "rxResponse": {
                /* Source IP l3l4 mapping configuration*/
                "sourceIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "producer-fqdn",
                    /* Least priority address*/
                    "address": "10.20.50.10"
                },
                /* Destination IP l3l4 mapping configuration*/
                "destinationIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND message-direction",
                    /* Least priority address*/
                    "address": "10.20.40.20"
                },
                /* Source Port l3l4 mapping configuration*/
                "sourcePort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "producer-fqdn",
                    /* Least priority address*/
                    "address": "5010"
                },
                /* Destination Port l3l4 mapping configuration*/
                "destinationPort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND producer-fqdn",
                    /* Least priority address*/
                    "address": "4020"
                }
            },
            /* Mappning rule configuration for direction type TxResponse*/
            "txResponse": {
                /* Source IP l3l4 mapping configuration*/
                "sourceIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND message-direction",
                    /* Least priority address*/
                    "address": "10.20.40.10"
                },
                /* Destination IP l3l4 mapping configuration*/
                "destinationIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "consumer-fqdn AND producer-fqdn",
                    /* Least priority address*/
                    "address": "10.20.30.10"
                },
                /* Source Port l3l4 mapping configuration*/
                "sourcePort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn",
                    /* Least priority address*/
                    "address": "4010"
                },
                /* Destination Port l3l4 mapping configuration*/
                "destinationPort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND consumer-fqdn",
                    /* Least priority address*/
                    "address": "3010"
                }
            }
        },
        /* Type of load distribution, supported, RoundRobin, WeightedLB1*/
        "lbType": "RoundRobin",
        "filterNames": null
    },
    /* Do not change*/
    "apiVersion": "v3"
}'

Get Feed Configuration

URI:<apiRoot>/ocnadd-configuration/v3/consumers/configurations/<app-name>

Method: GET

Example

cURL Command

curl -v --location --request GET 'http://172.16.19.9:32697/ocnadd-configuration/v3/consumers/configurations/app2'

Response:


{
    "configurationName": "app2",
    "userName": "admin",
    "consumerAdapterConfig": {
        "aggregationRules": [
            {
                "sourceNfType": "SCP"
            }
        ],
        "targetUri": [
            {
                "targetEndPoint": "ocnaddthirdpartyconsumer:18990",
                "loadFactor": "10"
            }
        ],
        "sequencingRequired": false,
        "metadataRequired": true,
        "outboundConnParams": {
            "ciphers": [
                "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"
            ],
            "ignoreResponse": false,
            "connType": "TCP_SECURED"
        },
        "dataStreamOffset": "LATEST",
        "encode_L2_L7_Hex_Dump": true,
        "l2_l4_headerRequired": true,
        "l2_l4_info": {
            "macSrc": "000000000000",
            "macDst": "000000000000",
            "etherType": "0800",
            "ipSrc": "10.10.10.100",
            "ipDst": "10.100.100.101",
            "srcPort": "8080",
            "dstPort": "8080"
        },
        "l3l4Mapping": null,
        "lbType": "RoundRobin",
        "filterNames": []
    },
    "apiVersion": "v3"
}

Get Default L3L4 Mapping Rule Configuration

URI:<apiRoot>/ocnadd-configuration/v1/defaultl3l4feedmapping/configuration'

Method: GET

Example

cURL Command

curl -v --location --request GET 'http://172.16.19.9:32697/ocnadd-configuration/v1/defaultl3l4feedmapping/configuration'

Response:

{
    "rxRequest": {
        "sourceIP": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "consumer-fqdn",
            "address": ""
        },
        "destinationIP": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "feed-source-nf-fqdn AND message-direction",
            "address": ""
        },
        "sourcePort": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "feed-source-nf-fqdn",
            "address": ""
        },
        "destinationPort": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "feed-source-nf-fqdn",
            "address": ""
        }
    },
    "txRequest": {
        "sourceIP": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "feed-source-nf-fqdn AND message-direction",
            "address": ""
        },
        "destinationIP": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "producer-fqdn",
            "address": ""
        },
        "sourcePort": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "producer-fqdn",
            "address": ""
        },
        "destinationPort": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "producer-fqdn",
            "address": ""
        }
    },
    "rxResponse": {
        "sourceIP": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "producer-fqdn",
            "address": ""
        },
        "destinationIP": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "feed-source-nf-fqdn AND message-direction",
            "address": ""
        },
        "sourcePort": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "producer-fqdn",
            "address": ""
        },
        "destinationPort": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "producer-fqdn",
            "address": ""
        }
    },
    "txResponse": {
        "sourceIP": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "feed-source-nf-fqdn AND message-direction",
            "address": ""
        },
        "destinationIP": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "consumer-fqdn",
            "address": ""
        },
        "sourcePort": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "feed-source-nf-fqdn",
            "address": ""
        },
        "destinationPort": {
            "mappingPriority": "METADATA",
            "mappingReferencePriority": "DD_MAPPING",
            "l3l4AttributeRule": "feed-source-nf-fqdn",
            "address": ""
        }
    }
}

Update Configuration

URI:<apiRoot>/ocnadd-configuration/v3/configure

Method: PUT

Request Body:

Type: Table 13-1

Table 13-13 Supported Response Codes

Response Code Description
201 Created

The configuration service shall process the filter request and create the filter subscription and return the common Location header of filter API.

The URI in the Location header can be used to update/delete the filter configuration.

{ apiRoot}/ocnadd-configuration/v1/filter

204 No Content The response to update and delete the filter configuration request against an existing list of Filters or Filter Names respectively.
400 Bad Request The response to a POST request if the create subscription request does not contain valid data.
403 Forbidden This response is returned if create/update/delete is not allowed for the filter configuration.
404 Not Found This response shall be returned if existing filterName could not be found on the data director.
500 Internal Server Error The response body contains the error reason for the request message. This shall be sent in case of an internal processing error of the configuration service.

Example

cURL Command

curl -v --location --request PUT 'http://172.16.19.9:31796/ocnadd-configuration/v3/configure/app1' \
--header 'Content-Type: application/json' \
--data-raw '{
    /*Name of Feed, must follow lower case and only - is allowed for name seperation*/
    "configurationName": "app1",
    /*user role for UI purpose*/
    "userName": "admin",
    "filterconfig": null,
    /*Feed configuration for Egress Adapter*/
    "consumerAdapterConfig": {
        /*Data aggergation rule, to include data from source while sending to 3rd party, supported value: SCP, NRF, SEPP*/
        "aggregationRules": [
            {
                "sourceNfType": "SCP"
            }
        ],
        "outboundConnParams": {
            /* Connection type to connection with 3rd party app, supported value: TCP_SECURED and TCP for non-secured*/
            "connType": "TCP_SECURED",
            /* Cipher type when oracle supported ciphers are not in 3rd party app*/
            "ciphers": [
                "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"
            ]
        },
        "targetUri": [
            {
                /* Tcp service 3rd party app endpoints, min=1 and max=2 endpoints are supported*/
                "targetEndPoint": "ocnaddthirdpartyconsumer1:18990",
                /* Load factor in case of weighted load balancing feature is required*/
                "loadFactor": "10"
            },
            {
                /* Tcp service 3rd party app endpoints, min=1 and max=2 endpoints are supported*/
                "targetEndPoint": "ocnaddthirdpartyconsumer2:18990",
                /* Load factor in case of weighted load balancing feature is required*/
                "loadFactor": "90"
            }
        ],
        /* To choose, metadata should be added in HTTP2 HEADERS frame as custom header or not*/
        "metadataRequired": true,
        /* Must be set to true, when synthetic data is required*/
        "encode_L2_L7_Hex_Dump": true,
        /* Default; L2 l4 layer information, All attributes value must be set*/
        "l2_l4_info": {
            /* Source MAC address for Ethernet Header*/
            "macSrc": "000000000000",
            /* Destination MAC address for Ethernet Header*/
            "macDst": "000000000000",
            /* Should not be change, only IPv4 is supported*/
            "etherType": "0800",
            /* Source IP address to be added in IP header for synthetic packet when it is not present in metadata and L3L4 mapping is not configured*/
            "ipSrc": "10.10.10.100",
            /* Destination IP address to be added in IP header for synthetic packet when it is not present in metadata and L3L4 mapping is not configured*/
            "ipDst": "10.100.100.101",
            /* Source Port to be added in TCP header for synthetic packet when it is not present in metadata and L3L4 mapping is not configured*/
            "srcPort": "8080",
            /* Destination Port to be added in TCP header for synthetic packet when it is not present in metadata and L3L4 mapping is not configured*/
            "dstPort": "8080"
        },
        /* Start of L3L4 mapping configuration for a feed*/
        "l3l4Mapping": {
            /* Mappning rule configuration for direction type RxRequest*/
            "rxRequest": {
                /* Source IP l3l4 mapping configuration*/
                "sourceIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "DD_MAPPING",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "consumer-fqdn AND api-name",
                    /* Least priority address*/
                    "address": "10.20.30.10"
                },
                /* Destination IP l3l4 mapping configuration*/
                "destinationIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "DD_MAPPING",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND message-direction",
                    /* Least priority address*/
                    "address": "10.20.40.10"
                },
                /* Source Port l3l4 mapping configuration*/
                "sourcePort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "DD_MAPPING",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND consumer-fqdn",
                    /* Least priority address*/
                    "address": "3010"
                },
                /* Destination Port l3l4 mapping configuration*/
                "destinationPort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn",
                    /* Least priority address*/
                    "address": "4010"
                }
            },
            /* Mappning rule configuration for direction type TxRequest*/
            "txRequest": {
                /* Source IP l3l4 mapping configuration*/
                "sourceIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND message-direction",
                    /* Least priority address*/
                    "address": "10.20.40.20"
                },
                /* Destination IP l3l4 mapping configuration*/
                "destinationIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "producer-fqdn",
                    /* Least priority address*/
                    "address": "10.20.50.10"
                },
                /* Source Port l3l4 mapping configuration*/
                "sourcePort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND producer-fqdn",
                    /* Least priority address*/
                    "address": "4020"
                },
                /* Destination Port l3l4 mapping configuration*/
                "destinationPort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "producer-fqdn",
                    /* Least priority address*/
                    "address": "5010"
                }
            },
            /* Mappning rule configuration for direction type RxResponse*/
            "rxResponse": {
                /* Source IP l3l4 mapping configuration*/
                "sourceIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "producer-fqdn",
                    /* Least priority address*/
                    "address": "10.20.50.10"
                },
                /* Destination IP l3l4 mapping configuration*/
                "destinationIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND message-direction",
                    /* Least priority address*/
                    "address": "10.20.40.20"
                },
                /* Source Port l3l4 mapping configuration*/
                "sourcePort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "producer-fqdn",
                    /* Least priority address*/
                    "address": "5010"
                },
                /* Destination Port l3l4 mapping configuration*/
                "destinationPort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND producer-fqdn",
                    /* Least priority address*/
                    "address": "4020"
                }
            },
            /* Mappning rule configuration for direction type TxResponse*/
            "txResponse": {
                /* Source IP l3l4 mapping configuration*/
                "sourceIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND message-direction",
                    /* Least priority address*/
                    "address": "10.20.40.10"
                },
                /* Destination IP l3l4 mapping configuration*/
                "destinationIP": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "consumer-fqdn AND producer-fqdn",
                    /* Least priority address*/
                    "address": "10.20.30.10"
                },
                /* Source Port l3l4 mapping configuration*/
                "sourcePort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn",
                    /* Least priority address*/
                    "address": "4010"
                },
                /* Destination Port l3l4 mapping configuration*/
                "destinationPort": {
                    /* Set the mapping priorty, supporte value DD_MAPPING, METADATA*/
                    "mappingPriority": "METADATA",
                    /* Should not be change*/
                    "mappingReferencePriority": "DD_MAPPING",
                    /* Set supported l3l4 mapping rule, Max 2 attribute supported with 'AND' only*/
                    "l3l4AttributeRule": "feed-source-nf-fqdn AND consumer-fqdn",
                    /* Least priority address*/
                    "address": "3010"
                }
            }
        },
        /* Type of load distribution, supported, RoundRobin, WeightedLB1*/
        "lbType": "RoundRobin",
        "filterNames": null
    },
    /* Do not change*/
    "apiVersion": "v3"
}'

Delete Configuration

URI:<apiRoot>/ocnadd-configuration/v3/configure

Method: DELETE

Example

cURL Command

curl -v --location --request DELETE 'http://172.16.19.9:31796/ocnadd-configuration/v3/configure/app1' 

Global L3L4 Map Configuration

Create Configuration

URI:<apiRoot>/ocnadd-configuration/v1/l3l4mapping

Method: POST

Request Body:

Type: OcnaddL3L4DDMappingConfigDto

Table 13-14 Request Body Parameters

Name Data Type P Cardinality Description
l3l4DDMappingConfig List <L3L4DDMappingDto> M 1 up to N Defines and allows the user to add list of rules for L3 and L4 layer global mapping for synthetic packet encoding.

Type: L3L4DDMappingDto

Table 13-15 Request Body Parameters

Name Data Type P Cardinality Description
l3l4Attributes       Defines and allows the user to add list of supported attributes and values to create L3 and L4 global mapping rule.
ip String M 1 The IP address to be used in L2 layer synthetic packet encoding.
port String M 1 The port number to be used in L3 layer synthetic packet encoding.

Type: L3L4AttributesDto

Table 13-16 Request Body Parameters

Name Data Type P Cardinality Description
l3l4Attribute Enum (SupportedL3L4Attributes) M 1 Defines and allows the user to select supported attributes to create L3 and L4 global mapping rule.
attributeValue String M 1 Values for selected attributes above.

Type: SupportedL3L4Attributes

Table 13-17 Request Body Parameters

Name
consumer-fqdn
producer-fqdn
api-name
feed-source-nf-fqdn
message-direction

Table 13-18 Supported Response Codes

Response Code Description
201 Created

The configuration service shall process the filter request and create the filter subscription and return the common Location header of filter API.

The URI in the Location header can be used to update/delete the filter configuration.

{ apiRoot}/ocnadd-configuration/v1/filter

204 No Content The response to update and delete the filter configuration request against an existing list of Filters or Filter Names respectively.
400 Bad Request The response to a POST request if the create subscription request does not contain valid data.
403 Forbidden This response is returned if create/update/delete is not allowed for the filter configuration.
404 Not Found This response shall be returned if existing filterName could not be found on the data director.
500 Internal Server Error The response body contains the error reason for the request message. This shall be sent in case of an internal processing error of the configuration service.

Example

cURL Command

curl -v --location --request POST 'http://172.16.19.9:31796/ocnadd-configuration/v1/l3l4mapping' \
--header 'Content-Type: application/json' \
--data-raw '

{
    "l3l4DDMappingConfig": [
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /*1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "consumer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm12.oracle.com"
                },
                /*2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "api-name",
                    /*Attribute Value*/
                    "attributeValue": "nudm-uecm"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.10.10",
            /*PORT mapping*/
            "port": "1010"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "consumer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm12.oracle.com"
                },
                /* 2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "producer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm1svc.scpsvc.svc.cluster.local"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.10.10",
            /*PORT mapping*/
            "port": "1010"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "consumer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm12.oracle.com"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.19.19",
            /*PORT mapping*/
            "port": "1919"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "producer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm1svc.scpsvc.svc.cluster.local"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.13.13",
            /*PORT mapping*/
            "port": "1313"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "producer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm1svc.scpsvc.svc.cluster.local"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.15.15",
            /*PORT mapping*/
            "port": "1515"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "<scprel>-scp-worker.scp.svc.cluster.local"
                },
                /* 2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "message-direction",
                    /*Attribute Value*/
                    "attributeValue": "RxRequest"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.11.11",
            /*PORT mapping*/
            "port": "1111"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "ocscp-scp1.oracle.com"
                },
                /* 2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "message-direction",
                    /*Attribute Value*/
                    "attributeValue": "TxResponse"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.11.11",
            /*PORT mapping*/
            "port": "1111"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "ocscp-scp1.oracle.com"
                },
                /* 2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "message-direction",
                    /*Attribute Value*/
                    "attributeValue": "TxRequest"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.14.14",
            /*PORT mapping*/
            "port": "1414"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "ocscp-scp1.oracle.com"
                },
                /* 2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "message-direction",
                    /*Attribute Value*/
                    "attributeValue": "RxResponse"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.14.14",
            /*PORT mapping*/
            "port": "1414"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "<scprel>-scp-worker.scp.svc.cluster.local"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.16.16",
            /*PORT mapping*/
            "port": "1616"
        },
        {
            /*List of Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "<scprel>-scp-worker.scp.svc.cluster.local"
                },
                /* 2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "consumer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm12.oracle.com"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.17.17",
            /*PORT mapping*/
            "port": "1717"
        },
        {
            /*List of Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "<scprel>-scp-worker.scp.svc.cluster.local"
                },
                /* 2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "producer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm1svc.scpsvc.svc.cluster.local"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.18.18",
            /*PORT mapping*/
            "port": "1818"
        }
    ]
}'

Get Configuration

URI:<apiRoot>/ocnadd-configuration/v1/l3l4mapping

Method: GET

Request Body:

Type: Table 13-14

Example

cURL Command

curl -v --location --request GET 'http://172.16.19.9:31796/ocnadd-configuration/v1/l3l4mapping' 

Response:

{
    "l3l4DDMappingConfig": [
        {
            "l3l4Attributes": [
                {
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    "attributeValue": "<scprel>-scp-worker.scp.svc.cluster.local"
                },
                {
                    "l3l4Attribute": "consumer-fqdn",
                    "attributeValue": "udm12.oracle.com"
                }
            ],
            "ip": "10.10.17.17",
            "port": "1717"
        },
        {
            "l3l4Attributes": [
                {
                    "l3l4Attribute": "consumer-fqdn",
                    "attributeValue": "udm12.oracle.com"
                },
                {
                    "l3l4Attribute": "producer-fqdn",
                    "attributeValue": "udm1svc.scpsvc.svc.cluster.local"
                }
            ],
            "ip": "10.10.10.10",
            "port": "1010"
        },
        {
            "l3l4Attributes": [
                {
                    "l3l4Attribute": "consumer-fqdn",
                    "attributeValue": "udm12.oracle.com"
                },
                {
                    "l3l4Attribute": "api-name",
                    "attributeValue": "nudm-uecm"
                }
            ],
            "ip": "10.10.10.10",
            "port": "1010"
        },
        {
            "l3l4Attributes": [
                {
                    "l3l4Attribute": "consumer-fqdn",
                    "attributeValue": "udm12.oracle.com"
                }
            ],
            "ip": "10.10.19.19",
            "port": "1919"
        },
        {
            "l3l4Attributes": [
                {
                    "l3l4Attribute": "message-direction",
                    "attributeValue": "TxResponse"
                },
                {
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    "attributeValue": "ocscp-scp1.oracle.com"
                }
            ],
            "ip": "10.10.11.11",
            "port": "1111"
        },
        {
            "l3l4Attributes": [
                {
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    "attributeValue": "ocscp-scp1.oracle.com"
                },
                {
                    "l3l4Attribute": "message-direction",
                    "attributeValue": "RxResponse"
                }
            ],
            "ip": "10.10.14.14",
            "port": "1414"
        },
        {
            "l3l4Attributes": [
                {
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    "attributeValue": "<scprel>-scp-worker.scp.svc.cluster.local"
                },
                {
                    "l3l4Attribute": "producer-fqdn",
                    "attributeValue": "udm1svc.scpsvc.svc.cluster.local"
                }
            ],
            "ip": "10.10.18.18",
            "port": "1818"
        },
        {
            "l3l4Attributes": [
                {
                    "l3l4Attribute": "message-direction",
                    "attributeValue": "RxRequest"
                },
                {
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    "attributeValue": "<scprel>-scp-worker.scp.svc.cluster.local"
                }
            ],
            "ip": "10.10.11.11",
            "port": "1111"
        },
        {
            "l3l4Attributes": [
                {
                    "l3l4Attribute": "producer-fqdn",
                    "attributeValue": "udm1svc.scpsvc.svc.cluster.local"
                }
            ],
            "ip": "10.10.13.13",
            "port": "1313"
        },
        {
            "l3l4Attributes": [
                {
                    "l3l4Attribute": "producer-fqdn",
                    "attributeValue": "udm1svc.scpsvc.svc.cluster.local"
                }
            ],
            "ip": "10.10.15.15",
            "port": "1515"
        },
        {
            "l3l4Attributes": [
                {
                    "l3l4Attribute": "message-direction",
                    "attributeValue": "TxRequest"
                },
                {
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    "attributeValue": "ocscp-scp1.oracle.com"
                }
            ],
            "ip": "10.10.14.14",
            "port": "1414"
        },
        {
            "l3l4Attributes": [
                {
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    "attributeValue": "<scprel>-scp-worker.scp.svc.cluster.local"
                }
            ],
            "ip": "10.10.16.16",
            "port": "1616"
        }
    ]
}

Update Configuration

URI:<apiRoot>/ocnadd-configuration/v1/l3l4mapping

Method: PUT

Request Body:

Type: Table 13-14

Example

cURL Command

curl -v --location --request PUT 'http://172.16.19.9:31796/ocnadd-configuration/v1/l3l4mapping' \
--header 'Content-Type: application/json' \
--data-raw '

{
    "l3l4DDMappingConfig": [
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /*1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "consumer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm12.oracle.com"
                },
                /*2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "api-name",
                    /*Attribute Value*/
                    "attributeValue": "nudm-uecm"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.10.10",
            /*PORT mapping*/
            "port": "1010"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "consumer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm12.oracle.com"
                },
                /* 2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "producer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm1svc.scpsvc.svc.cluster.local"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.10.10",
            /*PORT mapping*/
            "port": "1010"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "consumer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm12.oracle.com"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.19.19",
            /*PORT mapping*/
            "port": "1919"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "producer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm1svc.scpsvc.svc.cluster.local"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.13.13",
            /*PORT mapping*/
            "port": "1313"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "producer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm1svc.scpsvc.svc.cluster.local"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.15.15",
            /*PORT mapping*/
            "port": "1515"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "<scprel>-scp-worker.scp.svc.cluster.local"
                },
                /* 2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "message-direction",
                    /*Attribute Value*/
                    "attributeValue": "RxRequest"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.11.11",
            /*PORT mapping*/
            "port": "1111"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "ocscp-scp1.oracle.com"
                },
                /* 2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "message-direction",
                    /*Attribute Value*/
                    "attributeValue": "TxResponse"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.11.11",
            /*PORT mapping*/
            "port": "1111"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "ocscp-scp1.oracle.com"
                },
                /* 2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "message-direction",
                    /*Attribute Value*/
                    "attributeValue": "TxRequest"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.14.14",
            /*PORT mapping*/
            "port": "1414"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "ocscp-scp1.oracle.com"
                },
                /* 2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "message-direction",
                    /*Attribute Value*/
                    "attributeValue": "RxResponse"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.14.14",
            /*PORT mapping*/
            "port": "1414"
        },
        {
            /*List of L3l4 Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "<scprel>-scp-worker.scp.svc.cluster.local"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.16.16",
            /*PORT mapping*/
            "port": "1616"
        },
        {
            /*List of Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "<scprel>-scp-worker.scp.svc.cluster.local"
                },
                /* 2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "consumer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm12.oracle.com"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.17.19",
            /*PORT mapping*/
            "port": "1717"
        },
        {
            /*List of Attributes with its value for row*/
            "l3l4Attributes": [
                /* 1st Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "feed-source-nf-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "<scprel>-scp-worker.scp.svc.cluster.local"
                },
                /* 2nd Attribute Name and Value pair*/
                {
                    /*Attribute Name, from supported Attributes list*/
                    "l3l4Attribute": "producer-fqdn",
                    /*Attribute Value*/
                    "attributeValue": "udm1svc.scpsvc.svc.cluster.local"
                }
            ],
            /*IP Address mapping*/
            "ip": "10.10.18.18",
            /*PORT mapping*/
            "port": "1818"
        }
    ]
}'

Delete Configuration

URI:<apiRoot>/ocnadd-configuration/v1/l3l4mapping

Method: DELETE

Example

cURL Command

curl -v --location --request DELETE 'http://172.16.19.9:31796/ocnadd-configuration/v1/l3l4mapping'