Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
titlevDNS Create Config API Call
linenumberstrue
collapsetrue
curl -v --silent -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{

        "configBody": "{ \"service\": \"tca_policy\", \"location\": \"SampleServiceLocation\", \"uuid\": \"test\", \"policyName\": \"MicroServicevCPE\", \"description\": \"MicroService vCPE Policy\", \"configName\": \"SampleConfigName\", \"templateVersion\": \"OpenSource.version.1\", \"version\": \"1.1.0\", \"priority\": \"1\", \"policyScope\": \"resource=SampleResource,service=SampleService,type=SampleType,closedLoopControlName=ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e\", \"riskType\": \"SampleRiskType\", \"riskLevel\": \"1\", \"guard\": \"False\", \"content\": { \"tca_policy\": { \"domain\": \"measurementsForVfScaling\", \"metricsPerEventName\": [{ \"eventName\": \"Measurement_vGMUX\", \"controlLoopSchemaType\": \"VNF\", \"policyScope\": \"DCAE\", \"policyName\": \"DCAE.Config_tca-hi-lo\", \"policyVersion\": \"v0.0.1\", \"thresholds\": [{ \"closedLoopControlName\": \"ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e\", \"version\": \"1.0.2\", \"fieldPath\": \"$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value\", \"thresholdValue\": 0, \"direction\": \"EQUAL\", \"severity\": \"MAJOR\", \"closedLoopEventStatus\": \"ABATED\" }, { \"closedLoopControlName\": \"ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e\", \"version\": \"1.0.2\", \"fieldPath\": \"$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value\", \"thresholdValue\": 0, \"direction\": \"GREATER\", \"severity\": \"CRITICAL\", \"closedLoopEventStatus\": \"ONSET\" }] }] } } }",
        "policyConfigType": "MicroService",
        "policyName": "com.MicroServicevCPE",
        "onapName": "DCAE"
}' 'http://pdp:8081/pdp/api/createPolicy'

TODO - Update requestParameters

Code Block
titlevDNS - Operational Policy
linenumberstrue
collapsetrue
controlLoop:
  version: 2.0.0
  controlLoopName: ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3
  trigger_policy: unique-policy-id-1-scale-up
  timeout: 1200
  abatement: false
policies:
  - id: unique-policy-id-1-scale-up
    name: Create Scalea outnew theVF VNFModule
    description:
    actor: SO
    recipe: VF scaleOutModule Create
    target:
      type: VNF
    payload:
      # Need to get from
Marco       requestParameters: '{"usePreload":true,"userParams":[{"name":"gtp_bind_addr","value":"vmme_private_ip_0"},{"name":"mmc","value":"001"},{"name":"mme_addr","value":"vmme_private_ip_0"},{"name":"mnc","value":"01"},{"name":"n_prob","value":"50"},{"name":"vnfHostIpAddress","value":"veb_private_ip_0"}]}'
       configurationParameters: '[{"availabilityip-zoneaddr":"$.vnfvf-module-topology.vnfvf-resourcemodule-assignments.availability-zones.availability-zone[0parameters.param[9]","xtzoam-ip-123addr":"$.vnfvf-module-topology.vnfvf-resourcemodule-assignments.availability-zones.availability-zone[0parameters.param[16]","enabled":"$.vf-module-topology.vf-module-parameters.param[23]"}]'
    retry: 0
    timeout: 1200
    success: final_success
    failure: final_failure
    failure_timeout: final_failure_timeout
    failure_retries: final_failure_retries
    failure_exception: final_failure_exception
    failure_guard: final_failure_guard

...

Code Block
titlevDNS Create Operational API Call
linenumberstrue
collapsetrue
curl -v --silent -X PUT --header 'Content-Type: application/json' --header 'Accept: text/html' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
        "policyConfigType": "BRMS_PARAM",
        "policyName": "com.BRMSParamvDNS",
        "policyDescription": "BRMS Param vDNS policy",
        "policyScope": "com",
        "attributes": {
                "MATCHING": {
                "controller" : "amsterdam"
            },
                "RULE": {
                        "templateName": "ClosedLoopControlName",
                        "closedLoopControlName": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
                        "controlLoopYaml": "controlLoop%3A%0D%0A++version%3A+2.0.0%0D%0A++controlLoopName%3A+ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3%0D%0A++trigger_policy%3A+unique-policy-id-1-scale-up%0D%0A++timeout%3A+1200%0D%0A++abatement%3A+false%0D%0Apolicies%3A%0D%0A++-+id%3A+unique-policy-id-1-scale-up%0D%0A++++name%3A+Create+a+new+VF+Module%0D%0A++++description%3A%0D%0A++++actor%3A+SO%0D%0A++++recipe%3A+VF+Module+Create%0D%0A++++target%3A%0D%0A++++++type%3A+VNF%0D%0A++++payload%3A%0D%0A++++++requestParameters%3A+%27%7B%22usePreload%22%3Atrue,%22userParams%22%3A%5B%7B%22name%22%3A%22gtp_bind_addr%22,%22value%22%3A%22vmme_private_ip_0%22%7D,%7B%22name%22%3A%22mmc%22,%22value%22%3A%22001%22%7D,%7B%22name%22%3A%22mme_addr%22,%22value%22%3A%22vmme_private_ip_0%22%7D,%7B%22name%22%3A%22mnc%22,%22value%22%3A%2201%22%7D,%7B%22name%22%3A%22n_prob%22,%22value%22%3A%2250%22%7D,%7B%22name%22%3A%22vnfHostIpAddress%22,%22value%22%3A%22veb_private_ip_0%22%7D%5D%7D%27%0D%0A%22userParams%22%3A%5B%5D%7D%27%0D%0A++++++configurationParameters%3A+%27%5B%7B%22availability-zone%22%3A%22$.vnf-topology.vnf-resource-assignments.availability-zones.availability-zone%5B0%5D%22,%22xtz-123%22%3A%22$.vnf-topology.vnf-resource-assignments.availability-zones.availability-zone%5B0%5D%22%7D%5D%27%0D%0A++++retry%3A+0%0D%0A++++timeout%3A+1200%0D%0A++++success%3A+final_success%0D%0A++++failure%3A+final_failure%0D%0A++++failure_timeout%3A+final_failure_timeout%0D%0A++++failure_retries%3A+final_failure_retries%0D%0A++++failure_exception%3A+final_failure_exception%0D%0A++++failure_guard%3A+final_failure_guard"
                }
        }
}' 'http://pdp:8081/pdp/api/createPolicy'
Code Block
titlevDNS Guard - Min/Max Create API Call
collapsetrue
# PROTOTYPE - development needs to be done first

curl -v --silent -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
        "policyClass": "Decision",
        "policyName": "com.vDNS.MinMax",
        "policyDescription": "Ensure number of instances within a range",
        "ecompNameonapName": "PDPD",
        "ruleProvider": "GUARD_MIN_YAMLMAX",
        "attributes": {
                "MATCHING": {
                        "actor": "SO",
                        "recipe": "scaleOut",
                        "targets": ".*",
                        "clname": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
                        "min": "1",
                        "max": "5",
                        "guardActiveStart": "00:00:01-05:00",
                        "guardActiveEnd": "00:00:00-05:00"
                }
        }
}' 'http://pdp:8081/pdp/api/createPolicy'


Code Block
titlevDNS Guard - Frequency Limiter Create API Call
collapsetrue
# DRAFT - this needs to be tested first
curl -v --silent -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
        "policyClass": "Decision",
        "policyName": "com.vDNS.Frequency",
        "policyDescription": "Limit vDNS Scale Up over time period",
        "ecompNameonapName": "PDPD",
        "ruleProvider": "GUARD_YAML",
        "attributes": {
                "MATCHING": {
                        "actor": "SO",
                        "recipe": "scaleOut",
                        "targets": ".*",
                        "clname": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
                        "limit": "1",
                        "timeWindow": "10",
                        "timeUnits": "minute",
                        "guardActiveStart": "00:00:01-05:00",
                        "guardActiveEnd": "00:00:00-05:00"
                }
        }
}' 'http://pdp:8081/pdp/api/createPolicy'

...

Code Block
titlevDNS - A&AI vserver named query
linenumberstrue
collapsetrue
#PLD find the vserver version 


https://{aai}/aai/search/named-query

{
  "query-parameters": {
    "named-query": {
      "named-query-uuid": "4ff56a54-9e3f-46b7-a337-07a1d3c6b469"
    }
  },
  "instance-filters": {
    "instance-filter": [
      {
        "vserver": {
          "vserver-name": "vserver-71c978fb-29b8-437d-80e6-acf3a3a91e69"
        }
      }
    ]
  }
}

TODO -  Update with output containing valid VF Modules (other than "dummy")

Code Block
titlevDNS - A&AI vserver named query response
linenumberstrue
collapsetrue
{
    "inventory-response-item": [
        {
            "vserver": {
                "vserver-id": "6ed3642c143473ac-f7a11b32-4a7c47bc-9290aa07-3d51fe1531eb10a680d2bbbb",
                "vserver-name": "zdfw1lb01lb02vlb-ms-0706-1",
                "vserver-name2": "zdfw1lb01lb02vlb-ms-0706-1",
                "prov-status": "ACTIVE",
                "vserver-selflink": "http://10ecompctl1.12research.25att.2com:8774/v2.1/41d6d38489bd40b09ea8a6b6b852dcbd3f2aaef74ecb4b19b35e26d0849fe9a2/servers/6ed3642c143473ac-f7a11b32-4a7c47bc-9290aa07-3d51fe1531eb10a680d2bbbb",
         "       "in-maint": false,
                "is-closed-loop-disabled": false,
                "resource-version": "15106064035221531949079952"
        },    },
  "extra-properties": {         "extra-propertyproperties": []{},
      },       "inventory-response-items": {
                "inventory-response-item": [
                    {
                        "model-name": "vLoadBalancervLoadBalancerMS",
                        "generic-vnf": {
                            "vnf-id": "db373a8df524b92a-f7beb5bd-4d024c9d-8ac89c92-6ca4c305d1442ef672bc070f",
              "vnf-name": "Vfmodule_vLB1113",               "vnf-typename": "vLoadBalancer-1106/vLoadBalancer 0vLoadBalancerMS-Vnf-0706-1",
              "service-id": "66f157fc-4148-4880-95f5-e120677e98d1",               "provvnf-statustype": "PREPROVvLoadBalancerMS/vLoadBalancerMS 0",
              "in-maint": false,             "service-id":  "is50e1b0be-e0c9-closed48e2-loop9f42-disabled15279a783ee8": false,
              "resource-version": "1510604011851",
              "modelprov-invariant-idstatus": "cee050ed-92a5-494f-ab04-234307a846dcPROV",
               "model-version-id": "fd65becc-6b2c-4fe8-ace9-cc29db9a3da2"             }"orchestration-status": "Active",
            "extra-properties": {               "extraipv4-oam-propertyaddress": ["10.0.150.1",
                {            "in-maint": false,
      "property-name": "model-ver.model-version-id",                     "property-value": "fd65beccis-6b2cclosed-4fe8loop-ace9-cc29db9a3da2"disabled": false,
                },            "resource-version": "1533141664663",
         {                   "propertymodel-invariant-nameid": "model-ver.model-name32f7ec6a-1c54-4c06-a548-fe84832e3c40",
                  "property-value          "model-version-id": "vLoadBalancer"2db7689c-a979-4418-b71f-6a45a32f4791",
                },            "model-customization-id": "f3af2f41-8ea2-4f3c-8d85-aaede9699a71",
         {                   "propertynf-nametype": "model.modelnf-type",
                  "property-value": "resource"            "nf-function": "nf-function",
    },                 {         "nf-role": "nf-role",
         "property-name": "model.model-invariant-id",                   "propertynf-naming-valuecode": "cee050ed-92a5-494f-ab04-234307a846dc""
                        },
                {        "extra-properties": {
         "property-name": "model-ver.model-version",                   "extra-property-value": "1.0"[
                }               ] {
           },             "inventory-response-items": {               "inventory-response-item": ["property-name": "model-ver.model-version-id",
                 {                   "modelproperty-namevalue": "vLoadBalancer-1106",2db7689c-a979-4418-b71f-6a45a32f4791"
                   "service-instance": {            },
        "service-instance-id": "3b12f31f-8f2d-4f5c-b875-61ff1194b941",                     "service-instance-name": "vLoadBalancer-1113", {
                   "resource-version": "1510603936425",                     "modelproperty-invariant-idname": "1321d60dmodel-f7ff-4300-96c2-6bf0b3268b7a",ver.model-name",
                        "model-version-id            "property-value": "732d4692-4b97-46f9-a996-0b3339e88c50vLoadBalancerMS"
                  },                   "extra-properties": {},
                    "extra-property": [           {
           {                         "property-name": "model-ver.model-version-idtype",
                                    "property-value": "732d4692-4b97-46f9-a996-0b3339e88c50resource"
                      },          },
                  {              {
          "property-name": "model-ver.model-name",                         "property-valuename": "vLoadBalancer-1106"model.model-invariant-id",
                      },              "property-value": "32f7ec6a-1c54-4c06-a548-fe84832e3c40"
       {                         "property-name": "model.model-type"},
                        "property-value": "service"        {
              },                       {
 "property-name": "model-ver.model-version",
                      "property-name": "model.model-invariant-id",                         "property-value": "1321d60d-f7ff-4300-96c2-6bf0b3268b7a1.0"
                      },          }
            {                ]
        "property-name": "model-ver.model-version",               },
         "property-value": "1.0"              "inventory-response-items": {
       }                     ]
"inventory-response-item": [
                 }               {
 },                 {
                  "model-name": "Vloadbalancer..base_vlb..module-0vLoadBalancerMS",
                  "vf-module": {                     "vfservice-module-idinstance": "e6b3e3eb-34e1-4c00-b8c1-2a4fbe479b12",{
                    "vf-module-name": "Vfmodule_vLB1113-1",
                    "heatservice-stackinstance-id": "Vfmodule_vLB1113-1/3dd6d900-772f-4fcc-a0cb-e250ab2bb4db",
f242d516-7c96-4b02-a74d-4363b4267459",
                   "orchestration-status": "active",                     "isservice-baseinstance-vf-modulename": true,"vLoadBalancerMS-Service-0706-1",
                    "resource-version": "1510604612557",                     "modelenvironment-invariant-idcontext": "6d760188-9a24-451a-b05b-e08b86cb94f2General_Revenue-Bearing",
                    "model-version-id": "93facad9-55f2-4fe0-9574-814c2bc2d071"                     }"workload-context": "Production",
                  "extra-properties": {                     "extramodel-invariant-propertyid": ["2d4e2c32-2ffb-494a-9677-073a08f637dd",
                      {                         "property-name"model-version-id": "model-ver.model-version-id4dd37f02-7da5-451c-ba76-032a5b465c65",
                        "property-value": "93facad9-55f2-4fe0-9574-814c2bc2d071"                "resource-version": "1530889799597",
          },                       {       "orchestration-status": "Active"
                "property-name": "model-ver.model-name",                    },
      "property-value": "Vloadbalancer..base_vlb..module-0"                       },      "extra-properties": {
               {                         "extra-property-name": "model.model-type",[
                        "property-value": "resource"                   {
   },                       {                         "property-name": "model-ver.model-invariantversion-id",
                        "property-value": "6d760188-9a24-451a-b05b-e08b86cb94f2"                       },
"property-value": "4dd37f02-7da5-451c-ba76-032a5b465c65"
                     {                       },
 "property-name": "model-ver.model-version",                         "property-value": "1"                {
      }                     ]                   }  "property-name": "model-ver.model-name",
             },                 {                   "modelproperty-namevalue": "Vloadbalancer..dnsscaling..module-1",vLoadBalancerMS"
                     "vf-module": {                     "vf-module-id": "dummy_db373a8d-f7be-4d02-8ac8-6ca4c305d144", },
                           "vf-module-name": "dummy_db373a8d-f7be-4d02-8ac8-6ca4c305d144",                {
    "is-base-vf-module": false,                     "resource-version": "1510610079687",                     "modelproperty-invariant-idname": "356a1cff-71f2-4086-9980-a2927ce11c1c",
        model.model-type",
           "model-version-id": "6b93d804-cfc8-4be3-92cc-9336d135859a"                   },                   "extraproperty-propertiesvalue": {
                    "extra-property": ["service"
                      {                         "property-name": "model-ver.model-version-id"},
                        "property-value": "6b93d804-cfc8-4be3-92cc-9336d135859a"                   {
   },                       {                         "property-name": "model-ver.model-invariant-nameid",
                        "property-value": "Vloadbalancer..dnsscaling..module-1"                       },
"property-value": "2d4e2c32-2ffb-494a-9677-073a08f637dd"
                     {                         "property-name": "model.model-type"},
                        "property-value": "resource"                      {
},                       {                         "property-name": "model-ver.model-invariant-idversion",
                                                "property-value": "356a1cff-71f2-4086-9980-a2927ce11c1c"1.0"
                        },                    }
  {                         "property-name": "model-ver.model-version",            ]
            "property-value": "1"                       }
                    ]            },
                }                {
},                 {                   "model-name": "VloadbalancerVloadbalancerms..dnsscaling..module-1",
                                    "vf-module": {
                                        "vf-module-id": "my_module_db373a8d-f7be-4d02-8ac8-6ca4c305d144c0831ca7-0a20-4f03-a183-1135381b8707",
                    "vf-module-name": "my_module_1",                     "is-base-vf-module-name": false"vLoadBalancerMS-Vnf-0706-1_2",
                    "resource-version": "1510610079687",                     "modelheat-invariantstack-id": "356a1cff-71f2-4086-9980-a2927ce11c1cvLoadBalancerMS-Vnf-0706-1_2/122b563a-2c56-4804-aa81-970ba7741b55",
                    "model-version-id": "6b93d804-cfc8-4be3-92cc-9336d135859a"                       }"orchestration-status": "active",
                  "extra-properties": {                     "extra-propertyis-base-vf-module": [false,
                      {                         "propertyresource-nameversion": "model-ver.model-version-id1531510457103",
                        "property-value": "6b93d804-cfc8-4be3-92cc-9336d135859a"                "model-invariant-id": "285adb8d-b6b4-41f6-8f28-48f86ad4fa3b",
        },                       {         "model-version-id": "3db507c6-bec6-47a3-9ac3-5978d3f03882",
              "property-name": "model-ver.model-name",                         "propertymodel-customization-valueid": "Vloadbalancer..dnsscaling..module-1"1726b74e-8831-4b0a-a1f3-c254cc2e8fef",
                      },                  "module-index": 0
   {                         "property-name": "model.model-type",       },
                 "property-value": "resource"                  "extra-properties": {
   },                       {                         "property-name": "model.model-invariant-id","extra-property": [
                        "property-value": "356a1cff-71f2-4086-9980-a2927ce11c1c"                   {
   },                       {                         "property-name": "model-ver.model-version-id",
                            "property-value": "1"                    "property-value": "3db507c6-bec6-47a3-9ac3-5978d3f03882"
    }                     ]                   },
                },                 {           {
       "model-name": "Vloadbalancer..dnsscaling..module-1",
                  "vf-module": {                     "vfproperty-module-idname": "my_module_db373a8d-f7be-4d02-8ac8-6ca4c305d144",model-ver.model-name",
                         "vf-module-name": "my_module_2",                       "is-base-vf-module": false,property-value": "Vloadbalancerms..dnsscaling..module-1"
                     "resource-version": "1510610079687",                     "model-invariant-id": "356a1cff-71f2-4086-9980-a2927ce11c1c" },
                    "model-version-id": "6b93d804-cfc8-4be3-92cc-9336d135859a"                        {
       },                   "extra-properties": {                     "extraproperty-propertyname": ["model.model-type",
                       {                         "property-namevalue": "model-ver.model-version-id",resource"
                        "property-value": "6b93d804-cfc8-4be3-92cc-9336d135859a"                       },
                      {                      {
  "property-name": "model-ver.model-name",                         "property-value": "Vloadbalancer..dnsscaling..module-1"                       },"property-name": "model.model-invariant-id",
                       {                         "property-namevalue": "model.model-type",285adb8d-b6b4-41f6-8f28-48f86ad4fa3b"
                        "property-value": "resource"
                      },
                      {                      {
  "property-name": "model.model-invariant-id",                         "property-value": "356a1cff-71f2-4086-9980-a2927ce11c1c"                   "property-name": "model-ver.model-version",
  },                       {                         "property-namevalue": "model-ver.model-version",1"
                                   "property-value": "1"        }
              }                     ]     ]
             }                 }      }
        ]             }           },
          {             "tenant": {        {
      "tenant-id": "41d6d38489bd40b09ea8a6b6b852dcbd",               "tenant-name": "Integration-SB-00",               "resourcemodel-versionname": "1509587770200"Vloadbalancerms..dnsscaling..module-1",
            },             "extra-properties": {
              "extravf-propertymodule": []{
            },             "inventory-response-items": {              "vf-module-id": "inventory-response-item": [50e6e588-fe87-4663-aa10-51964f51a67d",
                     {                   "cloudvf-module-regionname": {"vLoadBalancerMS-Vnf-0706-1_4",
                    "cloud-owner": "CloudOwner",                     "cloudheat-regionstack-id": "RegionOnevLoadBalancerMS-Vnf-0706-1_4/ec246cff-38e3-4c89-99bf-21bc925b073c",
                    "cloud-region-version": "v1",                     "resourceorchestration-versionstatus": "1509587770092active",
                  },                      "extra-propertiesis-base-vf-module": false,
{                       "extra-property": []                "resource-version": "1531925572435",
 }                 }               ]       "model-invariant-id": "285adb8d-b6b4-41f6-8f28-48f86ad4fa3b",
    }           }         ]       }     }   ]
}

SO API Interaction

Code Block
titlevDNS - SO Request (TODO - Update)
linenumberstrue
collapsetrue
https://{so}/serviceInstantiation/v7/3b12f31f-8f2d-4f5c-b875-61ff1194b941/vnfs/db373a8d-f7be-4d02-8ac8-6ca4c305d144/vfModules/scaleOut

{
  "requestDetails": { "model-version-id": "3db507c6-bec6-47a3-9ac3-5978d3f03882",
                        "modelInfo": {       "modelType": "vfModule",       "modelInvariantIdmodel-customization-id": "356a1cff1726b74e-71f28831-40864b0a-9980a1f3-a2927ce11c1cc254cc2e8fef",
      "modelVersionId": "6b93d804-cfc8-4be3-92cc-9336d135859a",          "modelName": "Vloadbalancer..dnsscaling..module-1",       "modelVersion": "1"     },     "cloudConfiguration": {       "lcpCloudRegionIdmodule-index": "RegionOne",2
        "tenantId": "41d6d38489bd40b09ea8a6b6b852dcbd"     },     "requestInfo": {       "instanceName": "my_module_3",       "source": "POLICY" },
      "suppressRollback": false,       "requestorId": "policy"     },     "relatedInstanceList": [       {   "extra-properties": {
    "relatedInstance": {           "instanceId": "e6e99b38-7e3c-49ad-ad90-617c6c710a02",           "instanceName": "my_module_3_vol",           "modelInfoextra-property": {[
            "modelType": "volumeGroup"           }         }       },    {
  {         "relatedInstance": {           "instanceId": "3b12f31f-8f2d-4f5c-b875-61ff1194b941",           "modelInfo": {             "modelTypeproperty-name": "servicemodel-ver.model-version-id",
             "modelInvariantId": "1321d60d-f7ff-4300-96c2-6bf0b3268b7a",                                   "modelVersionIdproperty-value": "732d46923db507c6-4b97bec6-46f947a3-a9969ac3-0b3339e88c50",5978d3f03882"
                  "modelName": "vLoadBalancer-1106",             "modelVersion": "1.0"           },
                }        },       {         "relatedInstance": {   {
       "instanceId": "db373a8d-f7be-4d02-8ac8-6ca4c305d144",             "modelInfo": {             "modelType": "vnf",             "modelInvariantIdproperty-name": "cee050edmodel-92a5-494f-ab04-234307a846dc",ver.model-name",
                "modelVersionId": "fd65becc-6b2c-4fe8-ace9-cc29db9a3da2",                  "modelName": "vLoadBalancer",             "modelVersionproperty-value": "1.0",Vloadbalancerms..dnsscaling..module-1"
                      "modelCustomizationName": "vLoadBalancer 0"           }         },
      }     ],     "requestParameters": {                            {
                                                "property-name": "model.model-type",
                                                "property-value": "resource"
                                            },
                                            {
                                               "property-name": "model.model-invariant-id",
                                                "property-value": "285adb8d-b6b4-41f6-8f28-48f86ad4fa3b"
                                            },
                                            {
                                                "property-name": "model-ver.model-version",
                                                "property-value": "1"
                                            }
                                        ]
                                    }
                                },
                                {
                                    "model-name": "Vloadbalancerms..dnsscaling..module-1",
                                    "vf-module": {
                                        "vf-module-id": "8853e587-07d9-4081-9f90-61af87cd34bf",
                                        "vf-module-name": "vLoadBalancerMS-Vnf-0706-1_3",
                                        "heat-stack-id": "vLoadBalancerMS-Vnf-0706-1_3/10d56b1b-1d3e-4677-a31f-3449e1e3c457",
                                        "orchestration-status": "active",
                                        "is-base-vf-module": false,
                                        "resource-version": "1531840660936",
                                        "model-invariant-id": "285adb8d-b6b4-41f6-8f28-48f86ad4fa3b",
                                        "model-version-id": "3db507c6-bec6-47a3-9ac3-5978d3f03882",
                                        "model-customization-id": "1726b74e-8831-4b0a-a1f3-c254cc2e8fef",
                                        "module-index": 1
                                    },
                                    "extra-properties": {
                                        "extra-property": [
                                            {
                                                "property-name": "model-ver.model-version-id",
                                                "property-value": "3db507c6-bec6-47a3-9ac3-5978d3f03882"
                                            },
                                            {
                                                "property-name": "model-ver.model-name",
                                                "property-value": "Vloadbalancerms..dnsscaling..module-1"
                                            },
                                            {
                                                "property-name": "model.model-type",
                                                "property-value": "resource"
                                            },
                                            {
                                                "property-name": "model.model-invariant-id",
                                                "property-value": "285adb8d-b6b4-41f6-8f28-48f86ad4fa3b"
                                            },
                                            {
                                                "property-name": "model-ver.model-version",
                                                "property-value": "1"
                                            }
                                        ]
                                    }
                                },
                                {
                                    "model-name": "Vloadbalancerms..dnsscaling..module-1",
                                    "vf-module": {
                                        "vf-module-id": "51dbbf67-6e25-4d0c-8c18-ba7f21b8cfb3",
                                        "vf-module-name": "vLoadBalancerMS-Vnf-0706-1_6",
                                        "heat-stack-id": "vLoadBalancerMS-Vnf-0706-1_6/8486eafa-d860-4c17-a1bf-a1c436290806",
                                        "orchestration-status": "active",
                                        "is-base-vf-module": false,
                                        "resource-version": "1532638352675",
                                        "model-invariant-id": "285adb8d-b6b4-41f6-8f28-48f86ad4fa3b",
                                        "model-version-id": "3db507c6-bec6-47a3-9ac3-5978d3f03882",
                                        "model-customization-id": "1726b74e-8831-4b0a-a1f3-c254cc2e8fef",
                                        "module-index": 4
                                    },
                                    "extra-properties": {
                                        "extra-property": [
                                            {
                                                "property-name": "model-ver.model-version-id",
                                                "property-value": "3db507c6-bec6-47a3-9ac3-5978d3f03882"
                                            },
                                            {
                                                "property-name": "model-ver.model-name",
                                                "property-value": "Vloadbalancerms..dnsscaling..module-1"
                                            },
                                            {
                                                "property-name": "model.model-type",
                                                "property-value": "resource"
                                            },
                                            {
                                                "property-name": "model.model-invariant-id",
                                                "property-value": "285adb8d-b6b4-41f6-8f28-48f86ad4fa3b"
                                            },
                                            {
                                                "property-name": "model-ver.model-version",
                                                "property-value": "1"
                                            }
                                        ]
                                    }
                                },
                                {
                                    "model-name": "Vloadbalancerms..dnsscaling..module-1",
                                    "vf-module": {
                                        "vf-module-id": "c6256fd8-dfa7-49fd-a320-4be08bb3a49d",
                                        "vf-module-name": "vLoadBalancerMS-Vnf-0706-1_7",
                                        "heat-stack-id": "vLoadBalancerMS-Vnf-0706-1_7/8a587bc3-96b1-4ba7-9f4a-d40f669d08de",
                                        "orchestration-status": "active",
                                        "is-base-vf-module": false,
                                        "resource-version": "1532702700715",
                                        "model-invariant-id": "285adb8d-b6b4-41f6-8f28-48f86ad4fa3b",
                                        "model-version-id": "3db507c6-bec6-47a3-9ac3-5978d3f03882",
                                        "model-customization-id": "1726b74e-8831-4b0a-a1f3-c254cc2e8fef",
                                        "module-index": 5
                                    },
                                    "extra-properties": {
                                        "extra-property": [
                                            {
                                                "property-name": "model-ver.model-version-id",
                                                "property-value": "3db507c6-bec6-47a3-9ac3-5978d3f03882"
                                            },
                                            {
                                                "property-name": "model-ver.model-name",
                                                "property-value": "Vloadbalancerms..dnsscaling..module-1"
                                            },
                                            {
                                                "property-name": "model.model-type",
                                                "property-value": "resource"
                                            },
                                            {
                                                "property-name": "model.model-invariant-id",
                                                "property-value": "285adb8d-b6b4-41f6-8f28-48f86ad4fa3b"
                                            },
                                            {
                                                "property-name": "model-ver.model-version",
                                                "property-value": "1"
                                            }
                                        ]
                                    }
                                },
                                {
                                    "model-name": "Vloadbalancerms..dnsscaling..module-1",
                                    "vf-module": {
                                        "vf-module-id": "dummy_f524b92a-b5bd-4c9d-9c92-2ef672bc070f",
                                        "vf-module-name": "vLoadBalancerMS-Vnf-0706-1_0",
                                        "is-base-vf-module": false,
                                        "resource-version": "1537212348939",
                                        "model-invariant-id": "285adb8d-b6b4-41f6-8f28-48f86ad4fa3b",
                                        "model-version-id": "3db507c6-bec6-47a3-9ac3-5978d3f03882",
                                        "model-customization-id": "1726b74e-8831-4b0a-a1f3-c254cc2e8fef"
                                    },
                                    "extra-properties": {
                                        "extra-property": [
                                            {
                                                "property-name": "model-ver.model-version-id",
                                                "property-value": "3db507c6-bec6-47a3-9ac3-5978d3f03882"
                                            },
                                            {
                                                "property-name": "model-ver.model-name",
                                                "property-value": "Vloadbalancerms..dnsscaling..module-1"
                                            },
                                            {
                                                "property-name": "model.model-type",
                                                "property-value": "resource"
                                            },
                                            {
                                                "property-name": "model.model-invariant-id",
                                                "property-value": "285adb8d-b6b4-41f6-8f28-48f86ad4fa3b"
                                            },
                                            {
                                                "property-name": "model-ver.model-version",
                                                "property-value": "1"
                                            }
                                        ]
                                    }
                                },
                                {
                                    "model-name": "Vloadbalancerms..dnsscaling..module-1",
                                    "vf-module": {
                                        "vf-module-id": "aa9294f3-8cd6-483c-8165-8e303b7022a4",
                                        "vf-module-name": "vLoadBalancerMS-Vnf-0706-1_5",
                                        "heat-stack-id": "vLoadBalancerMS-Vnf-0706-1_5/39e7f1bd-1746-4370-aec5-1ff83a28a9a9",
                                        "orchestration-status": "active",
                                        "is-base-vf-module": false,
                                        "resource-version": "1532616866686",
                                        "model-invariant-id": "285adb8d-b6b4-41f6-8f28-48f86ad4fa3b",
                                        "model-version-id": "3db507c6-bec6-47a3-9ac3-5978d3f03882",
                                        "model-customization-id": "1726b74e-8831-4b0a-a1f3-c254cc2e8fef",
                                        "module-index": 3
                                    },
                                    "extra-properties": {
                                        "extra-property": [
                                            {
                                                "property-name": "model-ver.model-version-id",
                                                "property-value": "3db507c6-bec6-47a3-9ac3-5978d3f03882"
                                            },
                                            {
                                                "property-name": "model-ver.model-name",
                                                "property-value": "Vloadbalancerms..dnsscaling..module-1"
                                            },
                                            {
                                                "property-name": "model.model-type",
                                                "property-value": "resource"
                                            },
                                            {
                                                "property-name": "model.model-invariant-id",
                                                "property-value": "285adb8d-b6b4-41f6-8f28-48f86ad4fa3b"
                                            },
                                            {
                                                "property-name": "model-ver.model-version",
                                                "property-value": "1"
                                            }
                                        ]
                                    }
                                },
                                {
                                    "model-name": "Vloadbalancerms..base_vlb..module-0",
                                    "vf-module": {
                                        "vf-module-id": "155949a5-8494-45c8-84db-3675dcc5a64f",
                                        "vf-module-name": "Vfmodule_vLBMS-0706-1",
                                        "heat-stack-id": "Vfmodule_vLBMS-0706-1/76c42b6b-09b0-434b-85a7-2b226eb3d31c",
                                        "orchestration-status": "active",
                                        "is-base-vf-module": true,
                                        "resource-version": "1530890184655",
                                        "model-invariant-id": "f96252ec-2729-45c7-ae73-a4e4bf495838",
                                       "model-version-id": "75122eb8-1482-4c68-b7cf-dd8458f58ba5",
                                        "model-customization-id": "f979a817-584e-4857-b585-c8f409eccbdd",
                                        "module-index": 0
                                    },
                                    "extra-properties": {
                                        "extra-property": [
                                            {
                                                "property-name": "model-ver.model-version-id",
                                                "property-value": "75122eb8-1482-4c68-b7cf-dd8458f58ba5"
                                            },
                                            {
                                                "property-name": "model-ver.model-name",
                                                "property-value": "Vloadbalancerms..base_vlb..module-0"
                                            },
                                            {
                                                "property-name": "model.model-type",
                                                "property-value": "resource"
                                            },
                                           {
                                                "property-name": "model.model-invariant-id",
                                                "property-value": "f96252ec-2729-45c7-ae73-a4e4bf495838"
                                            },
                                            {
                                                "property-name": "model-ver.model-version",
                                                "property-value": "1"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "tenant": {
                            "tenant-id": "3f2aaef74ecb4b19b35e26d0849fe9a2",
                            "tenant-name": "ONAP-demo-test",
                            "resource-version": "1529419258510"
                        },
                        "extra-properties": {},
                        "inventory-response-items": {
                            "inventory-response-item": [
                                {
                                    "cloud-region": {
                                        "cloud-owner": "CloudOwner",
                                        "cloud-region-id": "RegionOne",
                                        "cloud-type": "openstack",
                                        "owner-defined-type": "owner type",
                                        "cloud-region-version": "v2.5",
                                        "cloud-zone": "zone-1",
                                        "sriov-automation": false,
                                        "resource-version": "1529419258443"
                                    },
                                    "extra-properties": {}
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ]
}



SO API Interaction

Code Block
titlevDNS - SO Request
linenumberstrue
collapsetrue
https://{so}/serviceInstantiation/v7/3b12f31f-8f2d-4f5c-b875-61ff1194b941/vnfs/db373a8d-f7be-4d02-8ac8-6ca4c305d144/vfModules/scaleOut

{
  "requestDetails": {
    "modelInfo": {
      "modelType": "vfModule",
      "modelInvariantId": "356a1cff-71f2-4086-9980-a2927ce11c1c",
      "modelVersionId": "6b93d804-cfc8-4be3-92cc-9336d135859a",
      "modelName": "Vloadbalancer..dnsscaling..module-1",
      "modelVersion": "1"
    },
    "cloudConfiguration": {
      "lcpCloudRegionId": "RegionOne",
      "tenantId": "41d6d38489bd40b09ea8a6b6b852dcbd"
    },
    "requestInfo": {
      "instanceName": "my_module_3",
      "source": "POLICY",
      "suppressRollback": false,
      "requestorId": "policy"
    },
    "relatedInstanceList": [
      {
        "relatedInstance": {
          "instanceId": "3b12f31f-8f2d-4f5c-b875-61ff1194b941",
          "modelInfo": {
            "usePreloadmodelType": true"service",
      "userParams": [       "modelInvariantId": "1321d60d-f7ff-4300-96c2-6bf0b3268b7a",
 {           "namemodelVersionId": "gtp_bind_addr732d4692-4b97-46f9-a996-0b3339e88c50",
            "valuemodelName": "vmme_private_ip_0"vLoadBalancer-1106",
        },    "modelVersion": "1.0"
   {       }
   "name": "mmc",      }
    "value": "001" },
      {
},        "relatedInstance": {
          "nameinstanceId": "mme_addrdb373a8d-f7be-4d02-8ac8-6ca4c305d144",
          "valuemodelInfo": "vmme_private_ip_0"{
        },       "modelType": "vnf",
 {           "namemodelInvariantId": "mnccee050ed-92a5-494f-ab04-234307a846dc",
            "valuemodelVersionId": "01"fd65becc-6b2c-4fe8-ace9-cc29db9a3da2",
        },    "modelName": "vLoadBalancer",
   {
          "namemodelVersion": "n_prob1.0",
            "valuemodelCustomizationName": "50vLoadBalancer 0"
          },
        {}
      }
   "name": "vnfHostIpAddress",
      ],
    "valuerequestParameters": "veb_private_ip_0"{
      "usePreload": true,
}      "userParams": []
    },
    "configurationParameters": [
      {
        "availability-zone": "$.vnf-topology.vnf-resource-assignments.availability-zones.availability-zone[0]",
        "xtz-123": "$.vnf-topology.vnf-resource-assignments.availability-zones.availability-zone[0]"
      }
    ]
  }
}
Code Block
titlevDNS - SO Response ACCEPTED (TODO - Update)
linenumberstrue
collapsetrue
{
	"requestReferences": {
		"requestId": "60533ee3-814d-4949-be93-e6b26aace580"
	},
	"request": {
		"requestId":"d5bc27f2-1d5c-405d-a985-3e3f544c1582",
		"requestStatus": {
			"percentProgress": 0,
			"requestState": "COMPLETEIN_PROGRESS",
			"wasRolledBack": false
		}
	},
	"httpResponseCode": 0
}
Code Block
titlevDNS - SO Request Status Query (if not complete)
linenumberstrue
collapsetrue
https://{so}/orchestrationRequests/v5/60533ee3-814d-4949-be93-e6b26aace580
Code Block
titlevDNS - SO Response SUCCESS (TODO - Add)
linenumberstrue
collapsetrue
TODO - this is new work{
	"requestReferences": {
		"requestId": "60533ee3-814d-4949-be93-e6b26aace580"
	},
	"request": {
		"requestId":"d5bc27f2-1d5c-405d-a985-3e3f544c1582",
		"requestStatus": {
			"percentProgress": 100,
			"requestState": "COMPLETE",
			"wasRolledBack": false
		}
	},
	"httpResponseCode": 0
}




vFirewall

Policy Creation

Code Block
titlevFirewall - TCA Configuration Policy Payload
linenumberstrue
collapsetrue
tca_policy: "{
  "domain": "measurementsForVfScaling",
  "metricsPerEventName": [
    {
      "eventName": "vFirewallBroadcastPackets",
      "controlLoopSchemaType": "VNF",
      "policyScope": "DCAE",
      "policyName": "DCAE.Config_tca-hi-lo",
      "policyVersion": "v0.0.1",
 
      "thresholds": [
        {
          "closedLoopControlName": "ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a",
          "version": "1.0.2",
          "fieldPath": "$.event.measurementsForVfScalingFields.vNicUsageArray[*].receivedTotalPacketsDelta",
          "thresholdValue": 300,
          "direction": "LESS_OR_EQUAL",
          "severity": "MAJOR",
          "closedLoopEventStatus": "ONSET"
        },
        {
          "closedLoopControlName": "ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a",
          "version": "1.0.2",
          "fieldPath": "$.event.measurementsForVfScalingFields.vNicUsageArray[*].receivedTotalPacketsDelta",
          "thresholdValue": 700,
          "direction": "GREATER_OR_EQUAL",
          "severity": "CRITICAL",
          "closedLoopEventStatus": "ONSET"
        }
      ]
    }
  ]
 
}"

...

Code Block
languagetext
titleCCVPN - Query 'input-parameters' for 'service-instance'
collapsetrue
URL: https://<AAI host>:<AAI port>/aai/v14/business/customers/customer/{global-custoner-id}/service-subscriptions/service-subscription/{service-type}/service-instances?service-instance-id={serviceId}
Method: GET
Request Body:
{
}
Response Body:
{
    "service-instance-id": "{service-instance-id}",
    "service-instance-name" : "instance name",
    "service-type": "some type",
    "service-role": "some role",
    "model-invariant-id": "model id",
    "model-version-id": "model version",
    "input-parameters:"request parameters",  // ... This is the service instance recreation input looked up by CL.
    "resource-version": "some version"
}
 
 
Example of response body:
{
    "service-instance-id": "176d9eba-1662-4289-8396-0097b50fd485",
    "service-type": "E2E Service",
    "service-role": "E2E Service",
    "model-invariant-id": "c22a9483-d2b6-49cc-b1f7-ef34c93572a1",
    "model-version-id": "71d0e396-e246-4c23-aa57-6da2043d6209",
    "input-parameters:".....;",             // ... This is the service instance recreation input looked up by CL.
    "resource-version": "1528975017336"
    "relationship-list": {
         "relationship": [
            {
            "related-to": "pnf",
            "related-link": "/aai/v11/network/pnfs/pnf/MME-0001",
            "relationship-data": [
                    {    
                    "relationship-key": "pnf.pnf-id",      
                    "relationship-value": "176d9eba-1662-4289-8396-0097b50fd466"
                    }
                ],
            "related-to-property": [
                    {
                    "property-key": "pnf.pnf-name",      
                    "property-value": "MME-0001"
                    }
                ]
            } 
        ]
    }
}


SO API Interaction





requestParameters: '{}'