SDN-C Context Builder Application

Configuration

Configuration of the SDN-C Context Builder is done via config/application.properties (TODO: to be updated when SDNC Context Builder can be installed by OOM)

SDNC Connection

# SDNC REST Client Configuration
sdnc.serviceName=<IP address for connecting to SDNC>
sdnc.servicePort=<Port for connecting to SDNC>
sdnc.httpProtocol=http
sdnc.user=<username for connecting to SDNC>
sdnc.password=<obfuscated password for connecting to SDNC>
sdnc.connectionTimeout=5000
sdnc.readTimeout=1000
sdnc.genericResourcePath=/restconf/config/GENERIC-RESOURCE-API:services/service/{0}

Provide basic authorization

  # HTTP Basic Authorization credentials for Rest Service API
  sdncCtxBuilder.userId=<username for basic authorization>
  sdncCtxBuilder.password=<password for basic authorization>

Interfaces/API

The SDN-C Context builder supports the use of the GENERIC-RESPONSE-API and VNF-API on the SDN-C

URI example using GENERIC-RESPONSE-API

SDC Context Builder URI example for vFW

http://10.147.113.136:8080/sdnccontextbuilder/v1/service/context?serviceInstanceId=68352304-7bba-4609-8551-0d0b819376c3

JSON response example

SDC Context Builder JSON response example

{
    "service": {
        "name": "vcpe_svc_vcpesvc_rescust_0822a_201808262153",
        "invariantUUID": "3a4e6986-5c5e-434e-b0be-8d718107fa83",
        "uuid": "7d518257-49bd-40ac-8d17-017a726ec12a",
        "dataQuality": {
            "status": "ok"
        },
        "attributeList": []
    },
    "dataQuality": {
        "status": "ok"
    },
    "attributeList": [],
    "vfList": [
        {
            "name": "zRegionOne06",
            "type": "vcpesvc_rescust_0822a/vcpevsp_vgw_0822a 0",
            "invariantUUID": "71370375-e1b4-4ad2-9832-1b7877428c81",
            "uuid": "7dd31559-9fc6-4b0d-bbe3-7ba641bf8a9b",
            "dataQuality": {
                "status": "ok"
            },
            "attributeList": [],
            "vfModuleList": [
                {
                    "name": "zRegionOne06_base_vcpe_vgw_0",
                    "invariantUUID": "7e91451d-e320-4755-a1a8-fcf140b86779",
                    "uuid": "1908874e-cfae-4ee1-93b9-f4ba46b460ff",
                    "maxInstances": 0,
                    "minInstances": 0,
                    "dataQuality": {
                        "status": "ok"
                    },
                    "attributeList": [],
                    "vmList": [
                        {
                            "name": "zRegionOne06001",
                            "nfNamingCode": "vgw",
                            "dataQuality": {
                                "status": "ok"
                            },
                            "attributeList": []
                        }
                    ],
                    "networkList": []
                }
            ],
            "vnfcList": []
        }
    ]
}

URI example using VNF-API

SDC Context Builder JSON response example for non vFW

http://10.147.113.136:8080/sdnccontextbuilder/v1/service/context?serviceInstanceId=7d518257-49bd-40ac-8d17-017a726ec12a

JSON response example

Response example

{
    "service": {
        "name": "vFW service instance",
        "uuid": "7d518257-49bd-40ac-8d17-017a726ec12a",
        "dataQuality": {
            "status": "ok"
        },
        "attributeList": []
    },
    "dataQuality": {
        "status": "ok"
    },
    "attributeList": [],
    "vfList": [
        {
            "name": "zdyh3bsflb0001v_01",
            "type": "vShaken_DNS_ns592n/vSHAKEN_IST_09042018 0",
            "invariantUUID": "null",
            "uuid": "null",
            "dataQuality": {
                "status": "ok"
            },
            "attributeList": [],
            "vfModuleList": [
                {
                    "uuid": "2c3f8902-f278-4ee3-93cf-9d2364cbafca",
                    "maxInstances": 1,
                    "minInstances": 0,
                    "dataQuality": {
                        "status": "ok"
                    },
                    "attributeList": [],
                    "vmList": [],
                    "networkList": []
                }
            ],
            "vnfcList": [
                {
                    "name": "dyh3bsflb0001vm001",
                    "invariantUUID": "null",
                    "uuid": "null",
                    "type": "alb",
                    "dataQuality": {
                        "status": "ok"
                    },
                    "attributeList": []
                },
                {
                    "name": "dyh3bsflb0001vm002",
                    "invariantUUID": "null",
                    "uuid": "null",
                    "type": "alb",
                    "dataQuality": {
                        "status": "ok"
                    },
                    "attributeList": []
                }
            ]
        }
    ]
}

Error Code

Error Code	Description	Resolution
400	missing AppId from the header	Provide AppId in the header and re-send the request
401	missing basic auth from the header	Provide basic authorization in the header and re-send the request