Content Comparison

Table of Contents

Test Case Id	Description	Pre-conditions	Test Steps	Expected Results
1	Perform healthcheck for the Policy components using Healthcheck API Drools PDP XACML PDP PAP BRMSGateway	Policy docker image ready and policy components (Drools, XACML, PAP, BRMS Gateway) should be up and running Server and authentication details should be configured at $POLICY_HOME/config/feature-healthcheck.properties	API – healthcheck Method - GET Endpoint: http://<host>:8081/healthcheck	All the policy components should return health status as “true”
2	~~Import/Load Use case template for the following use cases (VoLTE, vCPE, vFW, vDNS)~~	~~Policy components should be up and running~~	~~API – policyEngineImport~~ ~~Method – POST~~ ~~Endpoint:~~ ~~https://<host>:8081/pdp/policyEngineImport~~	~~Policy service models should be imported for the specified use cases. We should be able to create policy from here.~~
3	Create config Policy for the following use cases ~~VoLTE~~ vFW vDNS vCPE	Policy components up and running	API – CreateConfig Method – PUT Endpoint: https://<host>:8081/Pdp/createPolicy	Config Policy should be created in Policy Engine (PAP)
4	Push Config policy to the PDP Engines for the following use cases ~~VoLTE~~ vFW vDNS vCPE	Policy components up and running	API - pushPolicy Method - PUT Endpoint: https:// <host>:8081/Pdp/pushPolicy	Config Policy should be pushed to the PDP group
5	Create Operational policy for the following use cases VoLTE vFW vDNS vCPE	Policy components up and running	API - createPolicy Method – PUT Endpoint: https://<host>:8081/Pdp/createPolicy	Operational Policy should be created in Policy Engine (PAP)
6	Push operational Policy to the PDP Engines for each use case VoLTE vFW vDNS vCPE	Policy components up and running	API - pushPolicy Method - PUT Endpoint: https:// <host>:8081/Pdp/pushPolicy	Operational Policy should be pushed to the PDP group
7	Retrieve the configs for the following use cases VoLTE vFW vDNS vCPE	Policy components up and running	API – getConfig Method – POST Endpoint: https://<host>:8081/Pdp/getConfig	Both Config and Operational Policies configured for each use case should be retrieved successfully
8	~~Simulate DCAE Control loop event for each use case with higher or lower threshold values~~ ~~VoLTE~~ ~~vFW~~ ~~vDNS~~ ~~vCPE~~	~~Policy components up and running~~ ~~Simulator should be available~~	~~Invoke the Simulator API to trigger a DCAE control loop event~~	~~DCAE event should be triggered to Policy for each use case depending on the threshold configured~~
9	~~Simulate A&AI Response for Use Case vFW~~
10	~~Simulate APPC Response for Use Case vFW~~	~~Policy components up and running~~ ~~Simulator should be available~~	~~Invoke APPC simulator API with Policy data or Trigger a DCAE control loop event for vFW/vCPE~~	~~Valid Response from AppC Simulator API~~
11	~~Simulate A&AI Response for Use Case vCPE~~
12	~~Simulate APPC Response for Use Case vCPE~~
13	~~Simulate A&AI Response for Use Case VOLTE~~
14	~~Simulate VF-C Response for Use Case VOLTE~~	~~Policy components up and running~~ ~~Simulator should be available~~	~~Invoke VF-C simulator API with Policy data or Trigger a DCAE control loop event for VOLTE~~	~~Valid Response from VF-C Simulator API~~
15	~~Simulate SO Response for VDNS~~	~~Policy components up and running~~ ~~Simulator should be available~~	~~Invoke SO simulator API with Policy data or Trigger a DCAE control loop event for vDNS~~	~~Valid Response from SO Simulator API~~
16	~~Simulate A&AI Response for VDNS~~	~~Policy components up and running~~ ~~Simulator should be available~~	~~Invoke A&AI simulator API with Policy data or Trigger a DCAE control loop event for vDNS~~	~~Valid Response from A&AI Simulator API~~

...

Code Block

title	vFirewall - Operational Policy
linenumbers	true
collapse	true

controlLoop:
  version: 2.0.0
  controlLoopName: ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a
  services:
    - serviceInvariantUUID: 5cfe6f4a-41bc-4247-8674-ebd4b98e35cc
      serviceUUID: 0f40bba5-986e-4b3c-803f-ddd1b7b25f24
      serviceName: 57e66ea7-0ed6-45c7-970f
  trigger_policy: unique-policy-id-1-modifyConfig
  timeout: 1200
  abatement: false

policies:
  - id: unique-policy-id-1-modifyConfig
    name: modify packet gen config
    description:
    actor: APPC
    recipe: ModifyConfig
    target:
      # TBD - Cannot be known until instantiation is done
      resourceID: Eace933104d443b496b8.nodes.heat.vpg
	  type: VNF	
    retry: 0
    timeout: 300
    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

title	DCAE Control Loop Event (TCA) - vFirewall
linenumbers	true
collapse	true

{
	"closedLoopEventClient": "DCAE_INSTANCE_ID.dcae-tca",
	"policyVersion": "1.0.0.5",
	"policyName": "vFirewall",
	"policyScope": "resource=SampleResource,service=SampleService,type=SampleType,closedLoopControlName=SampleClosedLoop",
	"target_type": "VNF",
	"AAI": {
		"generic-vnf.vnf-idname": "zdfw1fwl01fwl02"
	},
	"closedLoopAlarmStart": 1484855291527925,
	"closedLoopEventStatus": "ONSET",
	"closedLoopControlName": "ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a",
	"version": "1.0.2",
	"target": "generic-vnf.vnf-idname",
	"requestID": "8c1b8bd8-06f7-493f-8ed7-daaa4cc481bc",
	"from": "DCAE"
}

Code Block

title	AAI namedvnf-name query request
linenumbers	true
collapse	true

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

{ 
	"query-parameters/v11/network/generic-vnfs/generic-vnf?vnf-name=zdfw1fwl01fwl02

Code Block

title	AAI named-query response
linenumbers	true
collapse	true

*TODO

Code Block

title	APPC request
linenumbers	true
collapse	true

{
  	"CommonHeader": {
     		    "named-queryTimeStamp": {1500997725298,
  		  "APIver": "1.01",
  		     "named-query-uuid"RequestID": "a93ac487664be3d2-409c6c12-4e8c4f4b-9e5fa3e7-334ae8f99087c349acced200",
  		  "RequestTrack": [],
  }		  "Flags": []
  	},
  	"Action": "ModifyConfig",
  	"instance-filtersPayload": {
    	"instance-filtergeneric-vnf.vnf-id":[ {"fw0001vm001fw001",
    	"pg-streams": {
      		"genericpg-vnfstream": [
			{
          		"id": "fw_udp1",
      "vnf-id    		"is-enabled": "zdfw1fwl01fwl02true"
        	},
   }     	{
      } ]   		"id": "fw_udp2",
 } }

Code Block

title	AAI named-query response
linenumbers	true
collapse	true

Below is a sample response format. Field values are just examples. Will update to real values for vFW later.


{ 		"is-enabled": "true"
        	},
       "inventory-response-item": [ 	{
        { 		"id": "fw_udp3",
          		"modelis-nameenabled": "service-instancetrue",
        	},
   "generic-vnf": {    	{
            		"vnf-id": "de7cc3ab-0212-47df-9e64-da1c79234debfw_udp4",
                "vnf-name		"is-enabled": "ZRDM2MMEX39true",
        	},
       "vnf-type": "vMME Svc Jul 14/vMME VF Jul 14 1", 	{
          		"id": "fw_udp5",
           		"serviceis-idenabled": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",true"
        	}]
    	}
  "orchestration-status": "active",
 	}
}

Code Block

title	APPC response
linenumbers	true
collapse	true

ACCEPT response

{
    "Status": {
        "in-maintValue": false"ACCEPTED",
        "Code": "100"
    },
    "is-closed-loop-disabled": false,Payload": {
                "resource-version"pg-streams": "1503082370097",
                "model-invariant-id": "82194af1-3c2c-485a-8f44-420e22a9eaa4",
                "model-version-id": "46b92144-923a-4d20-b85a-3cbd847668a9"
            },
            "extra-properties": {},
            "inventory-response-items": {
                "inventory-response-item": [
                    {
                        "model-name": "service-instance",
                        "service-instance": {
                            "service-instance-id": "37b8cdb7-94eb-468f-a0c2-4e3c3546578e",
                            "service-instance-name": "Changed Service Instance NAME",
                            "model-invariant-id": "82194af1-3c2c-485a-8f44-420e22a9eaa4",
                            "model-version-id": "46b92144-923a-4d20-b85a-3cbd847668a9",
                            "resource-version": "1503082993532",
                            "orchestration-status": "Active"
                        },
                        "extra-properties": {},
                        "inventory-response-items": {
                            "inventory-response-item": [
                                {
                                    "model-name": "pnf",
                                    "generic-vnf": {
                                        "vnf-id": "jimmy-test",
                                        "vnf-name": "jimmy-test-vnf",
                                        "vnf-type": "vMME Svc Jul 14/vMME VF Jul 14 1",
                                        "service-id": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",
                                        "orchestration-status": "active",
                                        "in-maint": false,
                                        "is-closed-loop-disabled": false,
                                        "resource-version": "1504013830207",
                                        "model-invariant-id": "862b25a1-262a-4961-bdaa-cdc55d69785a",
                                        "model-version-id": "e9f1fa7d-c839-418a-9601-03dc0d2ad687"
                                    },
                                    "extra-properties": {}
                                },
                                {
                                    "model-name": "service-instance",
                                    "generic-vnf": {
                                        "vnf-id": "jimmy-test-vnf2",
                                        "vnf-name": "jimmy-test-vnf2-named",
                                        "vnf-type": "vMME Svc Jul 14/vMME VF Jul 14 1",
                                        "service-id": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",
                                        "orchestration-status": "active",
                                        "in-maint": false,
                                        "is-closed-loop-disabled": false,
                                        "resource-version": "1504014833841",
                                        "model-invariant-id": "82194af1-3c2c-485a-8f44-420e22a9eaa4",
                                        "model-version-id": "46b92144-923a-4d20-b85a-3cbd847668a9"
                                    },
                                    "extra-properties": {}
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ]
}

Code Block

title	APPC request
linenumbers	true
collapse	true

{
  	"CommonHeader": {
  		  "TimeStamp": 1500997725298,
  		  "APIver": "1.01",
  		  "RequestID": "664be3d2-6c12-4f4b-a3e7-c349acced200",
  		  "RequestTrack": [],
  		  "Flags": []
  	},
  	"Action": "ModifyConfig",
  	"Payload": {
    	"generic-vnf.vnf-id": "fw0001vm001fw001",
    	"pg-streams": {
      		"pg-stream": [
			{
          		"id": "fw_udp1",
          		"is-enabled": "true"
        	},
        	{
          		"id": "fw_udp2",
          		"is-enabled": "true"
        	},
        	{
         		"id": "fw_udp3",
          		"is-enabled": "true"
        	},
        	{
          		"id": "fw_udp4",
          		"is-enabled": "true"
        	},
        	{
          		"id": "fw_udp5",
          		"is-enabled": "true"
        	}]
    	}
  	}
}

Code Block

title	APPC response
linenumbers	true
collapse	true

ACCEPT response

{
    "Status": {
        "Value": "ACCEPTED",
        "Code": "100"
    },
    "Payload": {
        "pg-streams": "{\\\"pg-streams\\\": {\\\"pg-stream\\\":[{\\\"id\\\":\\\"fw_udp1\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp2\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp3\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp4\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp5\\\", \\\"is-enabled\\\":\\\"true\\\"}]}}",
        "generic-vnf.vnf-id": "fw0001vm001fw001"
    },
    "CommonHeader": {
        "TimeStamp": "1493841850199",
        "APIver": "1.01",
        "RequestID": "664be3d2-6c12-4f4b-a3e7-c349acced200",
        "SubrequestID": null,
        "OriginatorID": null
    }
}


SUCCESS response



{
    "Status": {
        "Value": "SUCCESS",
        "Code": "400"
    },
    "Payload": {
        "pg-streams": "{\\\"pg-streams\\\": {\\\"pg-stream\\\":[{\\\"id\\\":\\\"fw_udp1\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp2\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp3\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp4\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp5\\\", \\\"is-enabled\\\":\\\"true\\\"}]}}",
        "generic-vnf.vnf-id": "fw0001vm001fw001"
    },
    "CommonHeader": {
        "TimeStamp": "1493841850199",
        "APIver": "1.01",
        "RequestID": "664be3d2-6c12-4f4b-a3e7-c349acced200",
        "SubrequestID": null,
        "OriginatorID": null
    }
}

...

Code Block

title	vDNS - TCA Configuration Policy Payload
linenumbers	true
collapse	true

tca_policy: "{
  "domain": "measurementsForVfScaling",
  "metricsPerEventName": [
    {
      "eventName": "vLoadBalancer",
      "controlLoopSchemaType": "VM",
      "policyScope": "DCAE",
      "policyName": "DCAE.Config_tca-hi-lo",
      "policyVersion": "v0.0.1",
      "thresholds": [
        {
          "closedLoopControlName": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
          "version": "1.0.2",
          "fieldPath": "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated",
          "thresholdValue": 300,
          "direction": "GREATER_OR_EQUAL",
          "severity": "MAJOR",
          "closedLoopEventStatus": "ONSET"
        },
        {
          "closedLoopControlName": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
          "version": "1.0.2",
          "fieldPath": "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated",
          "thresholdValue": 300,
          "direction": "GREATER_OR_EQUAL",
          "severity": "CRITICAL",
          "closedLoopEventStatus": "ONSET"
        }
      ]
    }
    
  ]
 
}"

Code Block

title	vDNS - Operational Policy
linenumbers	true
collapse	true

controlLoop:
  version: 2.0.0
  controlLoopName: ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3
  services: 
    - serviceName: d4738992-6497-4dca-9db9
      serviceInvariantUUID: dc112d6e-7e73-4777-9c6f-1a7fb5fd1b6f
      serviceUUID: 2eea06c6-e1d3-4c3a-b9c4-478c506eeedf
  trigger_policy: unique-policy-id-1-scale-up
  timeout: 1200

policies:
  - id: unique-policy-id-1-scale-up
    name: Create a new VF Module
    description:
    actor: SO
    recipe: VF Module Create
    target:
      type: VNF
    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

title	DCAE Control Loop Event (TCA) - vDNS
linenumbers	true
collapse	true

{
                "closedLoopEventClient": "DCAE_INSTANCE_ID.dcae-tca",
                "policyVersion": "1.0.0.5"{\\\"pg-streams\\\": {\\\"pg-stream\\\":[{\\\"id\\\":\\\"fw_udp1\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp2\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp3\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp4\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp5\\\", \\\"is-enabled\\\":\\\"true\\\"}]}}",
        "generic-vnf.vnf-id": "fw0001vm001fw001"
    },
    "CommonHeader": {
        "TimeStamp": "1493841850199",
                "policyName"APIver": "vLoadBalancer1.01",
       
        "policyScopeRequestID": "resource=SampleResource,service=SampleService,type=SampleType,closedLoopControlName=SampleClosedLoop",
  664be3d2-6c12-4f4b-a3e7-c349acced200",
             "target_type"SubrequestID": "VM"null,
        "OriginatorID": null
    }
}
"AAI":
{
SUCCESS response



{
    "Status": {
        "vserver.vserver-nameValue": "dfw1lb01lb01SUCCESS",
           "Code": "400"
    },
    "Payload": {
        "pg-streams": "{\\\"pg-streams\\\": "closedLoopAlarmStart": 1484677482204798,
                "closedLoopEventStatus": "ONSET",
                "closedLoopControlName": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
                "version": "1.0.2",
                "target": "vserver.vserver-name",
                "requestID": "97964e10-686e-4790-8c45-bdfa61df770f",
                "from": "DCAE"
}

Code Block

title	AAI named-query request
linenumbers	true
collapse	true

{
	"query-parameters": {
    	"named-query": {{\\\"pg-stream\\\":[{\\\"id\\\":\\\"fw_udp1\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp2\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp3\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp4\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp5\\\", \\\"is-enabled\\\":\\\"true\\\"}]}}",
         	"namedgeneric-queryvnf.vnf-uuidid": "4ff56a54-9e3f-46b7-a337-07a1d3c6b469fw0001vm001fw001"
        }
    },
    "instance-filtersCommonHeader": {
    	"instance-filter": [{         	"vserver"TimeStamp": {"1493841850199",
            	"vserver-name"APIver": "dfw1lb01lb011.01",
            }
        }]"RequestID": "664be3d2-6c12-4f4b-a3e7-c349acced200",
     } }

Code Block

title	AAI named-query response
linenumbers	true
collapse	true

{     "inventory-response-item"SubrequestID": [
  null,
     {   "OriginatorID": null
    }
}

vDNS Use Case

Code Block

title	vDNS - TCA Configuration Policy Payload
linenumbers	true
collapse	true

tca_policy: "{
 "extra-propertiesdomain": {}"measurementsForVfScaling",
            "inventory-response-items"metricsPerEventName": [{
               "eventName": "inventory-response-item": [vLoadBalancer",
              "controlLoopSchemaType": "VM",
      {        "policyScope": "DCAE",
              "policyName": "extra-properties": {DCAE.Config_tca-hi-lo",
              "policyVersion": "v0.0.1",
              "extra-propertythresholds": [{
                       "closedLoopControlName": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
        {             "version": "1.0.2",
                      "property-namefieldPath": "model.model-name$.event.measurementsForVfScalingFields.vNicUsageArray[*].receivedTotalPacketsDelta",
                                    "property-value": "c15ce9e1-e914-4c8f-b8bb""thresholdValue": 300,
                     "direction": "GREATER_OR_EQUAL",
         },            "severity": "CRITICAL",
                   {  "closedLoopEventStatus": "ONSET"
              }]
       }]
}"

Code Block

title	vDNS - Operational Policy
linenumbers	true
collapse	true

controlLoop:
  version: 2.0.0
  controlLoopName: ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3
  "property-name": "model.model-type",trigger_policy: unique-policy-id-1-scale-up
  timeout: 1200
  abatement: false
policies:
  - id: unique-policy-id-1-scale-up
    name: Create a new VF Module
    description:
    actor: SO
 "property-value": "resource"  recipe: VF Module Create
    target:
      type: VNF
    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

title	DCAE Control Loop Event (TCA) - vDNS
linenumbers	true
collapse	true

{
                   "closedLoopEventClient": "DCAE_INSTANCE_ID.dcae-tca",
                "property-namepolicyVersion": "model.model-version1.0.0.5",
                "policyName": "vLoadBalancer",
                  "property-valuepolicyScope": "1"resource=SampleResource,service=SampleService,type=SampleType,closedLoopControlName=SampleClosedLoop",
                "target_type": "VM",
                },
"AAI": {
                    "vserver.vserver-name": "dfw1lb01lb01"
         {       },
                "closedLoopAlarmStart": 1484677482204798,
                "property-nameclosedLoopEventStatus": "model.model-idONSET",
                   "closedLoopControlName": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
                "property-valueversion": "033a32ed-aa65-4764-a736-36f2942f1aa0"1.0.2",
                "target": "vserver.vserver-name",
                 }"requestID": "97964e10-686e-4790-8c45-bdfa61df770f",
                "from": "DCAE"
}

Code Block

title	AAI named-query request
linenumbers	true
collapse	true

{
	"query-parameters": {
    	"named-query": {
     {   	"named-query-uuid": "4ff56a54-9e3f-46b7-a337-07a1d3c6b469"
        }
    },
    "instance-filters": {
    	"instance-filter": [{
        	"property-namevserver": "model.model-name-version-id",{
            	"vserver-name": "dfw1lb01lb01"
            }
        }]
     "property-value": "d4d072dc-4e21-4a03-9524-628985819a8e"
}
}

Code Block

title	AAI named-query response
linenumbers	true
collapse	true

{
    "inventory-response-item": [
        {
            "vserver": {
        }        "vserver-id": "6ed3642c-f7a1-4a7c-9290-3d51fe1531eb",
                "vserver-name": "zdfw1lb01lb02",
 ]               "vserver-name2": "zdfw1lb01lb02",
           },     "prov-status": "ACTIVE",
                  "generic-vnf": {
           "vserver-selflink": "http://10.12.25.2:8774/v2.1/41d6d38489bd40b09ea8a6b6b852dcbd/servers/6ed3642c-f7a1-4a7c-9290-3d51fe1531eb",
                "in-maint": false,

                           "is-closed-loop-disabled": false,

                           "orchestration-status"resource-version": "Created1510606403522",
            },
               "modelextra-invariant-idproperties": "033a32ed-aa65-4764-a736-36f2942f1aa0",
 {},
                          "model-version-id": "1.0",
         "inventory-response-items": {
                  "resourceinventory-response-versionitem": "1485542422",[
                            "service-id": "b3f70641-bdb9-4030-825e-6abb73a1f929",    {
                        "vnfmodel-idname": "594e2fe0-48b8-41ff-82e2-3d4bab69b192vLoadBalancer",
                            "generic-vnf-name": "Vnf_Ete_Named90e1ab3-dcd5-4877-9edb-eadfc84e32c8",{
                            "vnf-typeid": "8330e932db373a8d-2a23f7be-49434d02-8606/c15ce9e1-e914-4c8f-b8bb 1"8ac8-6ca4c305d144",
                        },    "vnf-name": "Vfmodule_vLB1113",
                   "inventory-response-items": {        "vnf-type": "vLoadBalancer-1106/vLoadBalancer 0",
                  "inventory-response-item": [                     "service-id": "66f157fc-4148-4880-95f5-e120677e98d1",
           {                 "prov-status": "PREPROV",
                  "extra-properties": {           "orchestration-status": "Created",
                            "extrain-propertymaint": [false,
                            "is-closed-loop-disabled": false,
              {                    "resource-version": "1510604011851",
                            "propertymodel-invariant-nameid": "model.model-namecee050ed-92a5-494f-ab04-234307a846dc",
                                     "model-version-id": "fd65becc-6b2c-4fe8-ace9-cc29db9a3da2",
          "property-value": "8330e932-2a23-4943-8606"                    "model-customization-id": "1983c783-444f-4e79-af3a-85e5d49628f3",
                        },    "nf-type": "",
                            "nf-function": "",
         {                   "nf-role": "",
                            "propertynf-naming-namecode": "model.model-type",
                        },
                        "propertyextra-valueproperties": "service"{
                            "extra-property": [
              },                  {
                          {          "property-name": "model-ver.model-version-id",
                                     "property-namevalue": "model.model-version",fd65becc-6b2c-4fe8-ace9-cc29db9a3da2"
                                },
                    "property-value": "1"           {
                                 },   "property-name": "model-ver.model-name",
                                    "property-value": "vLoadBalancer"
  {                              },
                  "property-name": "model.model-id",              {
                                    "property-valuename": "4fcbc1c0-7793-46d8-8aa1-fa1c2ed9ec7b"model.model-type",
                                    "property-value": "resource"
       },                         },
                    {            {
                                    "property-name": "model.model-nameinvariant-version-id",
                                                "property-value": "5c996219cee050ed-b2e292a5-4c76494f-9b43ab04-7e8672a33c1d234307a846dc"
                                            }},
                                {
       ]                                     }"property-name": "model-ver.model-version",
                                    "serviceproperty-instancevalue": {"1.0"
                                        "model-invariant-id": "4fcbc1c0-7793-46d8-8aa1-fa1c2ed9ec7b",     }
                            ]
       "model-version-id": "1.0",                },
                        "resourceinventory-response-versionitems": "1485542400",{
                            "inventory-response-item": [
                  "service-instance-id": "cf8426a6-0b53-4e3d-bfa6-4b2f4d5913a5",              {
                                    "servicemodel-instance-name": "Service_Ete_Named90e1ab3-dcd5-4877-9edb-eadfc84e32c8"vLoadBalancer-1106",
                                    }
"service-instance": {
                               },         "service-instance-id": "3b12f31f-8f2d-4f5c-b875-61ff1194b941",
                      {                       "service-instance-name": "vLoadBalancer-1113",
             "extra-properties": {                          "model-invariant-id": "1321d60d-f7ff-4300-96c2-6bf0b3268b7a",
             "extra-property": [                          "model-version-id": "732d4692-4b97-46f9-a996-0b3339e88c50",
                 {                       "resource-version": "1510603936425"
                        "property-name": "model.model-name",            },
                                    "propertyextra-valueproperties": "C15ce9e1E9144c8fB8bb..base_vlb..module-0"{
                                        "extra-property": [
  },                                             {
                                                "property-name": "model-ver.model-typeversion-id",
                                                "property-value": "resource732d4692-4b97-46f9-a996-0b3339e88c50"
                                            },
                                            {
                                                "property-name": "model-ver.model-versionname",
                                                "property-value": "1vLoadBalancer-1106"
                                            },
                                            {
                                                "property-name": "model.model-idtype",
                                                "property-value": "79ee24cd-fc9a-4f14-afae-5e1dd2ab2941-value": "service"
                                            },
                                            {
                                                "property-name": "model.model-nameinvariant-version-id",
                                                "property-value": "5484cabb1321d60d-1a0df7ff-4f294300-a61696c2-094a3f643d736bf0b3268b7a"
                                            }
,
                                       ]     {
                               },                                     "model"property-name": "C15ce9e1E9144c8fB8bb..base_vlb..module-0model-ver.model-version",
                                    "vf-module": {           "property-value": "1.0"
                            "heat-stack-id": "Vfmodule_Ete_Named90e1ab3-dcd5-4877-9edb-eadfc84e32c8/5845f37b-6cda-4e91-8ca3-f5572d226488",                              }
          "is-base-vf-module": true,                             ]
           "orchestration-status": "active",                         }
                  "model-invariant-id": "79ee24cd-fc9a-4f14-afae-5e1dd2ab2941",             },
                           "model-version-id": "1",    {
                                    "resourcemodel-versionname": "1485542667Vloadbalancer..base_vlb..module-0",
                                        "vf-module-id": "b0eff878-e2e1-4947-9597-39afdd0f51dd",{
                                        "vf-module-nameid": "Vfmodule_Ete_Named90e1ab3-dcd5-4877-9edb-eadfc84e32c8"e6b3e3eb-34e1-4c00-b8c1-2a4fbe479b12",
                                    }    "vf-module-name": "Vfmodule_vLB1113-1",
                           },                            "heat-stack-id": "Vfmodule_vLB1113-1/3dd6d900-772f-4fcc-a0cb-e250ab2bb4db",
    {                                     "extraorchestration-propertiesstatus": {"active",
                                        "extra-propertyis-base-vf-module": [true,
                                        "resource-version": "1510604612557",
  {
                                                "property-name"model-invariant-id": "model.model-name6d760188-9a24-451a-b05b-e08b86cb94f2",
                                                "property-value"model-version-id": "C15ce9e1E9144c8fB8bb..dnsscaling..module-1"93facad9-55f2-4fe0-9574-814c2bc2d071",
                                            },
                          "model-customization-id": "93fd5bd4-8051-4074-8530-c0c504604df5",
                 {                       "module-index": 0
                        "property-name": "model.model-type",            },
                                    "propertyextra-valueproperties": "resource"{
                                            },"extra-property": [
                                            {
                                                "property-name": "model-ver.model-version-id",
                                                "property-value": "193facad9-55f2-4fe0-9574-814c2bc2d071"
                                            },
                                            {
                                                "property-name": "model-ver.model-idname",
                                                "property-value": "f32568ec-2f1c-458a-864b-0593d53d141aVloadbalancer..base_vlb..module-0"
                                            },
                                            {
                                                "property-name": "model.model-name-version-idtype",
                                                "property-value": "69615025-879d-4f0d-afe3-b7d1a7eeed1fresource"
                                            },
                                            {
               ]                                 "property-name": "model.model-invariant-id",
                           },                     "property-value": "6d760188-9a24-451a-b05b-e08b86cb94f2"
              "vf-module": {                             },
           "is-base-vf-module": false,                                {
        "model-invariant-id": "f32568ec-2f1c-458a-864b-0593d53d141a",                                         "modelproperty-version-idname": "1.0model-ver.model-version",
                                        "resource-version        "property-value": "14855617521",
                                          "vf-module-id": "dummy", }
                                       "vf-module-name": "dummy" ]
                                    }
                                },
                                {
                                    "extramodel-propertiesname": {
 "Vloadbalancer..dnsscaling..module-1",
                                      "extravf-propertymodule": [{
                                        "vf-module-id": "dummy_db373a8d-f7be-4d02-8ac8-6ca4c305d144",
  {                                      "vf-module-name": "dummy_db373a8d-f7be-4d02-8ac8-6ca4c305d144",
         "property-name": "model.model-name",                              "is-base-vf-module": false,
                  "property-value": "C15ce9e1E9144c8fB8bb..dnsscaling..module-1"                      "resource-version": "1510610079687",
                         },               "model-invariant-id": "356a1cff-71f2-4086-9980-a2927ce11c1c",
                            {            "model-version-id": "6b93d804-cfc8-4be3-92cc-9336d135859a"
                                   "property-name": "model.model-type",
       },
                                         "propertyextra-valueproperties": "resource"{
                                        "extra-property": [
  },                                             {
                                                "property-name": "model-ver.model-version-id",
                                                "property-value": "16b93d804-cfc8-4be3-92cc-9336d135859a"
                                            },
                                            {
                                                "property-name": "model-ver.model-idname",
                                                "property-value": "f32568ec-2f1c-458a-864b-0593d53d141aVloadbalancer..dnsscaling..module-1"
                                            },
                                            {
                                                "property-name": "model.model-name-version-idtype",
                                                "property-value": "69615025-879d-4f0d-afe3-b7d1a7eeed1fresource"
                                            },
                                            {
            ]                                    "property-name": "model.model-invariant-id",
             },                                     "vfproperty-modulevalue": {"356a1cff-71f2-4086-9980-a2927ce11c1c"
                                        "heat-stack-id": "vDNS_Ete_Named90e1ab3-dcd5-4877-9edb-eadfc84e32c8/f447ce51-14dd-4dcd-9957-68a047c79673",   },
                                     "is-base-vf-module": false,      {
                                  "orchestration-status": "active",             "property-name": "model-ver.model-version",
                          "model-invariant-id": "f32568ec-2f1c-458a-864b-0593d53d141a",                     "property-value": "1"
                  "model-version-id": "1.0",                         }
               "resource-version": "1485562712",                        ]
                "vf-module-id": "8cd79e44-1fae-48c1-a160-609f90b46749",                   }
                     "vf-module-name": "vDNS_Ete_Named90e1ab3-dcd5-4877-9edb-eadfc84e32c8"          }
                          }  ]
                        }
     }               },
             ]       {
                 }       "tenant": {
            },                "tenant-id": "41d6d38489bd40b09ea8a6b6b852dcbd",
   {                         "extratenant-propertiesname": {}"Integration-SB-00",
                            "inventoryresource-response-itemsversion": {"1509587770200"
                            "inventory-response-item": [},
                        "extra-properties": {},
       {                 "inventory-response-items": {
                  "cloud-region": {          "inventory-response-item": [
                             "cloud-owner": "Rackspace",  {
                                      "cloud-region-id": "DFW",{
                                        "cloud-region-versionowner": "v1CloudOwner",
                                        "cloud-typeregion-id": "SharedNodeRegionOne",
                                        "cloud-zonetype": "CloudZoneSharedNode",
                                        "owner-defined-type": "OwnerType",
                                        "resourcecloud-region-version": "1485465545v1",
                                    }    "cloud-zone": "CloudZone",
                                        "extrasriov-propertiesautomation": {}false,
                                    }    "resource-version": "1509587770092"
                       ]             },
           },                         "tenantextra-properties": {}
                            "resource-version": "1485465545",
    }
                           "tenant-id": "1015548", ]
                        }
   "tenant-name": "1015548"                }
        }        ]
            }
        }
    ]
}

Code Block

title	SO request
linenumbers	true
collapse	true

NOTE: Robot ]must add preload for dummy module for this to work.
{

 }, "requestDetails": {

         "vservermodelInfo": {

      "modelType": "vfModule",

      "in-maintmodelInvariantId": false"356a1cff-71f2-4086-9980-a2927ce11c1c",

               "is-closed-loop-disabled": false"modelVersionId": "6b93d804-cfc8-4be3-92cc-9336d135859a",

      "modelName": "Vloadbalancer..dnsscaling..module-1",

      "prov-statusmodelVersion": "ACTIVE1",

         },

    "resource-versioncloudConfiguration": "1485546436",{

      "lcpCloudRegionId": "RegionOne",

      "vserver-idtenantId": "70f081eb-2a87-4c81-9296-4b93d7d145c6",
 41d6d38489bd40b09ea8a6b6b852dcbd"

    },

    "requestInfo": {

      "vserver-nameinstanceName": "vlb-lb-32c8vDNS_vLB1113-1",

      "source": "POLICY",

      "vserver-name2suppressRollback": "vlb-lb-32c8"false,

      "requestorId": "policy"

    },

"vserver-selflink": "https://dfw.servers.api.rackspacecloud.com/v2/1015548/servers/70f081eb-2a87-4c81-9296-4b93d7d145c6"    "relatedInstanceList": [

      {

   }     "relatedInstance": {

 }     ] }

Code Block

title	SO request
linenumbers	true
collapse	true

{   "requestDetailsinstanceId": {"3b12f31f-8f2d-4f5c-b875-61ff1194b941",

          "modelInfo": {

            "modelType": "service",

 “modelType”: “vfModule”,           “modelInvariantId”"modelInvariantId": “ff5256d2"1321d60d-5a33f7ff-55df4300-13ab96c2-12abad84e7ff”6bf0b3268b7a",

            “modelNameVersionId”"modelVersionId": “fe6478e5"732d4692-ea334b97-334646f9-ac12a996-ab121484a3fe”0b3339e88c50",

            “modelName”"modelName": “vSAMP12..base..module-0”"vLoadBalancer-1106",

            "modelVersion": "1.0"

     },     }

“cloudConfiguration”: {       }

  “lcpCloudRegionId”: “mdt1”,   },

      “tenantId”:{
“88a6ca3ee0394ade9403f075db23167e”
      },       "requestInforelatedInstance": {

          “instanceName”"instanceId": “MSOTEST103a-vSAMP12_base_module-0”"db373a8d-f7be-4d02-8ac8-6ca4c305d144",

         “source”: “VID”,
          “suppressRollback”: true
      },
      "relatedInstanceList": [ "modelInfo": {

            {
"modelType": "vnf",

          “relatedInstance”: { "modelInvariantId": "cee050ed-92a5-494f-ab04-234307a846dc",

            “instanceId”: “{serviceInstanceId}”"modelVersionId": "fd65becc-6b2c-4fe8-ace9-cc29db9a3da2",

            "modelName":  “modelInfo”: {"vLoadBalancer",

            "modelVersion": "1.0",

         “modelType”: “service”,  "modelCustomizationName": "vLoadBalancer 0"

          }

 “modelInvariantId”: “ff3514e3-5a33-55df-13ab-12abad84e7ff”,      }

      }

   “modelNameVersionId”: “fe6985cd-ea33-3346-ac12-ab121484a3fe” ],

    "requestParameters": {}

  }

}

Code Block

title	SO Response
linenumbers	true
collapse	true

SUCCESS:
{
	"requestReferences":  {
 “modelName”: “{parent service model name}”	"instanceId": "ff305d54-75b4-ff1b-bdb2-eb6b9e5460ff",
    	"requestId": "e4f95e0c-a013-4530-8e59-c5c5f9e539b6"
  	},
  	"httpResponseCode": 200
}

VOLTE Use Case

Code Block

title	VOLTE - Operational Policy
linenumbers	true
collapse	true

controlLoop:
  "modelVersion"version: "12.0.0"
  controlLoopName: ControlLoop-VOLTE-2179b738-fd36-4843-a71a-a8c24c70c55b
  trigger_policy: unique-policy-id-1-restart
  timeout: 3600
  abatement: }false

policies:
  - id: unique-policy-id-1-restart
    name: }Restart the VM
    description:
  },  actor: VFC
      {recipe: Restart
    target:
      “relatedInstance”type: {VM
    retry: 3
    timeout: 1200
   “instanceId” success: “{vnfInstanceId}”,final_success
    failure: final_failure
    failure_timeout: final_failure_timeout
   "modelInfo" failure_retries: {final_failure_retries
    failure_exception: final_failure_exception
    failure_guard: final_failure_guard

Code Block

title	DCAE Control Loop Event (HOLMES) - VOLTE
linenumbers	true
collapse	true

{
	"closedLoopEventClient": "DCAE.HolmesInstance",
    “modelType”"policyVersion": “vnf”"1.0.0.5",
    "policyName": "vVOLTE",
            “modelInvariantId”: “ff5256d1-5a33-55df-13ab-12abad84e7ff”"policyScope": "resource=volte,service=VolteSErvice,type=SampleType,closedLoopControlName=CL-VOLTE-SIG-d925ed73-8231-4d02-9545-db4e101f88f8",
    "target_type": "VM",
    "AAI": {
		"vserver.vserver-name": "dfw1lb01lb01",
 		"service-instance.service-instance-id" :  “modelNameVersionId”: “fe6478e4-ea33-3346-ac12-ab121484a3fe”,
 "TBD",
		"generic-vnf.vnf-id" : "TBD",
		"generic-vnf.vnf-name" : "TBD"
    },
    "closedLoopAlarmStart": 1484677482204798,
     “modelName”"closedLoopEventStatus": “vSAMP12”"ONSET",
      "closedLoopControlName": "ControlLoop-VOLTE-2179b738-fd36-4843-a71a-a8c24c70c55b",
    "version": "1.0.2",
     "modelVersiontarget": "1vserver.0vserver-name",
    "requestID": "97964e10-686e-4790-8c45-bdfa61df770f",
    "from": "DCAE"
}

Code Block

title	A&AI Call
linenumbers	true
collapse	true

This call is a simple GET in “modelCustomizationName”:order “vSAMP12to 1”
               }
            }
         }
      ],
      “requestParameters”: {
          “userParams”: []
      }
  }
}

Code Block

title	SO Response
linenumbers	true
collapse	true

SUCCESS:
{
	"requestReferences": {
    	"instanceId": "ff305d54-75b4-ff1b-bdb2-eb6b9e5460ff",
    	"requestId": "e4f95e0c-a013-4530-8e59-c5c5f9e539b6"
  	},
  	"httpResponseCode": 200
}

VOLTE Use Case

Code Block

title	VOLTE - Operational Policy
linenumbers	true
collapse	true

controlLoop:
  version: 2.0.0
  controlLoopName: ControlLoop-VOLTE-2179b738-fd36-4843-a71a-a8c24c70c55b
  trigger_policy: unique-policy-id-1-restart
  timeout: 3600

policies:
  - id: unique-policy-id-1-restart
    name: Restart the VM
    description:
    actor: VFC
    recipe: Restart
    target:
      type: VM
    retry: 3
    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

title	DCAE Control Loop Event (HOLMES) - VOLTE
linenumbers	true
collapse	true

{
	"closedLoopEventClient": "DCAE.HolmesInstance",
    "policyVersion": "1.0.0.5",
    "policyName": "vVOLTE",
    "policyScope": "resource=volte,service=VolteSErvice,type=SampleType,closedLoopControlName=CL-VOLTE-SIG-d925ed73-8231-4d02-9545-db4e101f88f8",
    "target_type": "VM",
    "AAI": {
		"vserver.vserver-name": "dfw1lb01lb01",
 		retrieve "is-closed-loop-diable" flag.

Code Block

title	A&AI Response
linenumbers	true
collapse	true

Below is a sample GET response format. Field values are just examples. Will update to real values later.

{
   "vnf-id": "5e49ca06-2972-4532-9ed4-6d071588d792",
   "vnf-name": "USUCP0PCOIL0110UJRT01",
   "vnf-type": "RT",
   "service-id": "d7bb0a21-66f2-4e6d-87d9-9ef3ced63ae4",
   "equipment-role": "UCPE",
   "orchestration-status": "created",
   "management-option": "ATT",
   "ipv4-oam-address": "32.40.68.35",
   "ipv4-loopback0-address": "32.40.64.57",
   "nm-lan-v6-address": "2001:1890:e00e:fffe::1345",
   "management-v6-address": "2001:1890:e00e:fffd::36",
   "in-maint": false,
   "is-closed-loop-disabled": false,
   "resource-version": "1493389458092",
   "relationship-list": {"relationship": [
		{
         	"related-to": "service-instance",
         	"related-link": "https://aai-int1.test.att.com:8443/aai/v9/business/customers/customer/1610_Func_Global_20160817084727/service-subscriptions/service-subscription/uCPE-VMS/service-instances/service-instance/USUCP0PCOIL0110UJZZ01",
         	"relationship-data": [
         	{
               "relationship-key": "customer.global-customer-id",
               "relationship-value": "1610_Func_Global_20160817084727"
            },
            {
               "relationship-key": "service-subscription.service-type",
               "relationship-value": "uCPE-VMS"
            },
            {
               "relationship-key": "service-instance.service-instance-id" : "TBD",
		"generic-vnf.vnf-id" : "TBD", 		"generic-vnf.vnf-name" : "TBD"     },     "closedLoopAlarmStartrelationship-value": 1484677482204798, "USUCP0PCOIL0110UJZZ01"
        "closedLoopEventStatus": "ONSET",   }
 "closedLoopControlName": "ControlLoop-VOLTE-2179b738-fd36-4843-a71a-a8c24c70c55b",       "version": "1.0.2" 	],
    "target": "vserver.vserver-name",    "related-to-property": [{"requestIDproperty-key": "97964e10service-686einstance.service-4790instance-8c45-bdfa61df770f",name"}]
    "from": "DCAE" }

Code Block

title	A&AI Call
linenumbers	true
collapse	true

This call is a simple GET in order to retrieve "is-closed-loop-diable" flag.

Code Block

title	A&AI Response
linenumbers	true
collapse	true

Below is a sample GET response format. Field values are just examples. Will update to real values later.

{
   "vnf-id": "5e49ca06-2972-4532-9ed4-6d071588d792",
   "vnf-name": "USUCP0PCOIL0110UJRT01",
   "vnf-type": "RT",
   "service-id": "d7bb0a21-66f2-4e6d-87d9-9ef3ced63ae4",
   "equipment-role": "UCPE",
   "orchestration-status": "created",
   "management-option": "ATT",
   "ipv4-oam-address": "32.40.68.35",
   "ipv4-loopback0-address": "32.40.64.57",
   "nm-lan-v6-address": "2001:1890:e00e:fffe::1345",
   "management-v6-address": "2001:1890:e00e:fffd::36",
   "in-maint": false,
   "is-closed-loop-disabled": false,
   "resource-version": "1493389458092",
   "relationship-list": {"relationship": [
		{	},
        {
         	"related-to": "vserver",
         	"related-link": "https://aai-int1.test.att.com:8443/aai/v9/cloud-infrastructure/cloud-regions/cloud-region/att-aic/AAIAIC25/tenants/tenant/USUCP0PCOIL0110UJZZ01%3A%3AuCPE-VMS/vservers/vserver/3b2558f4-39d8-40e7-bfc7-30660fb52c45",
         	"relationship-data": [
            {
               "relationship-key": "cloud-region.cloud-owner",
               "relationship-value": "att-aic"
            },
            {
               	"relatedrelationship-tokey": "service-instancecloud-region.cloud-region-id",
           	"related-link    "relationship-value": "https://aai-int1.test.att.com:8443/aai/v9/business/customers/customer/1610_Func_Global_20160817084727/service-subscriptions/service-subscription/uCPE-VMS/service-instances/service-instance/USUCP0PCOIL0110UJZZ01",AAIAIC25"
             	"relationship-data": [},
            	{
               "relationship-key": "customertenant.global-customertenant-id",
               "relationship-value": "1610_Func_Global_20160817084727USUCP0PCOIL0110UJZZ01::uCPE-VMS"
            },
            {
               "relationship-key": "vserver.vserver-id",
               "relationship-value": "service-subscription.service-type",3b2558f4-39d8-40e7-bfc7-30660fb52c45"
            }
  "relationship-value": "uCPE-VMS"        	],
    },     	"related-to-property": [      
			{
               	"relationshipproperty-key": "service-instancevserver.servicevserver-instance-idname",
               	"relationshipproperty-value": "USUCP0PCOIL0110UJZZ01-vsrx"
         	}]
      	}
   	]}
}

Code Block

title	VFC request
linenumbers	true
collapse	true

Request URI: 
  	],
    POST http(s)://[hostname][:port]/api/nslcm/v1/ns/{nsInstanceId }/heal

Request JSON:
{
    "related-to-property healVnfData": [{"property-key": "service-instance.service-instance-name"}]
        “vnfInstanceId”: 	}”1”,
        {
“cause”: ”vm is down”,
        	"related-to": "vserver",“additionalParams”: {
            	"related-link": "https://aai-int1.test.att.com:8443/aai/v9/cloud-infrastructure/cloud-regions/cloud-region/att-aic/AAIAIC25/tenants/tenant/USUCP0PCOIL0110UJZZ01%3A%3AuCPE-VMS/vservers/vserver/3b2558f4-39d8-40e7-bfc7-30660fb52c45",“action”: ”restartvm”,
           	"relationship-data": [ “actionvminfo”: {
                {“vmid”: ”33”,
                "relationship-key"“vmname”: "cloud-region.cloud-owner",
”xgw - smp11”
              "relationship-value": "att-aic"}
        }
    },
            {
               "relationship-key": "cloud-region.cloud-region-id
}

Code Block

title	VFC response
linenumbers	true
collapse	true

Response JSON with response code 202:
{
	“jobId”:”1”
} 

Get Operation Status to read the status
GET http(s)://[hostname][:port]/api/nslcm/v1/jobs/{jobId}&responseId={responseId}

Response JSON with response code 200:
{
    "jobId": "1234566",
    "responseDescriptor":  {
        "relationship-valueprogress": "AAIAIC2540",
            }"status": "proccessing",
        "statusDescription": "OMC VMs are {decommissioned       in VIM",
        "relationship-keyerrorCode": "tenant.tenant-id",
      null,
        "relationship-valueresponseId": "USUCP0PCOIL0110UJZZ01::uCPE-VMS"42",
        "responseHistoryList": [{
  },               {"progress": "40",
                "relationship-keystatus": "vserver.vserver-idproccessing",
                "relationship-valuestatusDescription": "3b2558f4-39d8-40e7-bfc7-30660fb52c45"OMC VMs are decommissioned in VIM",
            }    "errorCode": null,
    	],            	"related-to-propertyresponseId": [ "1"
     			{       }, {
    	"property-key": "vserver.vserver-name",             	"property-value"progress": "USUCP0PCOIL0110UJZZ01-vsrx"41",
            	}]    "status": "proccessing",
 	}      	]} }

Code Block

title	VFC request
linenumbers	true
collapse	true

Request URI:  POST http(s)://[hostname][:port]/api/nslcm/v1/ns/{nsInstanceId }/heal  Request JSON"statusDescription": {"OMC VMs are decommissioned in VIM",
healVnfData": {         “vnfInstanceId”: ”1”,     "errorCode": null,
  “cause”:   ”vm is down”,         “additionalParams”: {"responseId": "2"
            }
“action”: ”restartvm”,       ]
     “actionvminfo”: }
}

vCPE Use Case

Code Block

title	vCPE - TCA Configuration Policy Payload
linenumbers	true
collapse	true

tca_policy: "{
       "domain": "measurementsForVfScaling",
       “vmid”"metricsPerEventName": ”33”,[{
              "eventName":  “vmname”: ”xgw - smp11”"Measurement_vGMUX",
              "controlLoopSchemaType": "VNF",
}         }     }
}

Code Block

title	VFC response
linenumbers	true
collapse	true

Response JSON with response code 202:
{
	“jobId”:”1”
} 

Get Operation Status to read the status
GET http(s)://[hostname][:port]/api/nslcm/v1/jobs/{jobId}&responseId={responseId}

Response JSON with response code 200:
{"policyScope": "DCAE",
              "policyName": "DCAE.Config_tca-hi-lo",
              "jobIdpolicyVersion": "1234566v0.0.1",
    "responseDescriptor": {         "progressthresholds": "40",[{
           "status": "proccessing",         "statusDescriptionclosedLoopControlName": "OMC VMs are decommissioned in VIM",ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e",
             "errorCode": null,         "responseIdversion": "421.0.2",
        "responseHistoryList": [{
                "progressfieldPath": "40$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value",
                     "statusthresholdValue": "proccessing",0,
                     "statusDescriptiondirection": "OMCEQUAL",
VMs are decommissioned in VIM",                 "errorCodeseverity": null,
   "MAJOR",
            "responseId": "1"             }, {"closedLoopEventStatus": "ABATED"
              }, {
   "progress": "41",                 "statusclosedLoopControlName": "proccessingControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e",
                     "statusDescriptionversion": "OMC VMs are decommissioned in VIM",1.0.2",
                     "errorCodefieldPath": null"$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value",
                "responseId": "2"         "thresholdValue": 0,
   }         ]     }
}

vCPE Use Case

Code Block

title	vCPE - TCA Configuration Policy Payload
linenumbers	true
collapse	true

tca_policy: "{   "domaindirection": "measurementsForVfScalingGREATER",
  "metricsPerEventName": [     {       "eventName": "Measurement_vGMUX",       "controlLoopSchemaTypeseverity": "VMCRITICAL",
      "policyScope": "DCAE",       "policyName": "DCAE.Config_tca-hi-lo",       "policyVersionclosedLoopEventStatus": "v0.0.1ONSET",
      "thresholds": [       }]
 {      }]
}"

Code Block

title	vCPE Operational Policy
linenumbers	true
collapse	true

controlLoop:
   "closedLoopControlName"version: 2.0.0
  controlLoopName: "ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e",
  trigger_policy: unique-policy-id-1-restart
  timeout: 3600
  abatement: true

policies:
  - id: unique-policy-id-1-restart
    name: Restart the VM
    "version": "1.0.2",description:
    actor: APPC
    "fieldPath": "$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value",recipe: Restart
    target:
      "thresholdValue"type: 0,VM
    retry: 3
    "direction"timeout: "EQUAL",1200
    success: final_success
    "severity"failure: "MAJOR",final_failure
    failure_timeout: final_failure_timeout
    "closedLoopEventStatus": "ABATED"failure_retries: final_failure_retries
    failure_exception: final_failure_exception
  },     failure_guard: final_failure_guard

Code Block

title	DCAE Control Loop Event (TCA) - vCPE
linenumbers	true
collapse	true

{
   {           "closedLoopControlName": "ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e",
            "version": "1.0.2",
            "fieldPathrequestID": "$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value0abc0000-b032-4e4b-bd30-88260f444888",
          "thresholdValue": 0,           "direction"closedLoopAlarmStart": "GREATER",
  1478189220547,
       "severity": "CRITICAL",           "closedLoopEventStatus"closedLoopEventClient": "ONSET"
        }
      ]
    }
    
  ]
 
}"

Code Block

title	vCPE Operational Policy
linenumbers	true
collapse	true

controlLoop:
  version: 2.0.0
  controlLoopName: ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e
  trigger_policy: unique-policy-id-1-restart
  timeout: 3600

policies:
  - id: unique-policy-id-1-restart
    name: Restart the VM
    description:
    actor: APPC
    recipe: Restart
    target:DCAE_INSTANCE_ID.dcae-tca",
            "target_type": "VNF",
            "target": "generic-vnf.vnf-name",
            "AAI": {
                      type: VM
    retry: 3 "generic-vnf.vnf-name" : "vCPE_Infrastructure_vGMUX_demo_app"
       timeout: 1200    },
success: final_success     failure: final_failure     failure_timeout: final_failure_timeout
    failure_retries: final_failure_retries"from": "DCAE",
       failure_exception: final_failure_exception     failure_guard: final_failure_guard

Code Block

title	DCAE Control Loop Event (TCA) - vCPE
linenumbers	true
collapse	true

{"policyScope": "DCAE",
            "closedLoopControlNamepolicyName": "ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6eDCAE.Config_tca-hi-lo",
            "versionpolicyVersion": "1v0.0.21",
            "requestIDclosedLoopEventStatus": "0abc0000-b032-4e4b-bd30-88260f444888",
   ONSET"
}

Code Block

title	APPC request
linenumbers	true
collapse	true

{
  "body": {
    "input": {
  "closedLoopAlarmStart": 1478189220547,   "common-header": {
        "closedLoopEventClienttimestamp": "tca.instance00001",
   2017-08-25T21:06:23.037Z",
        "target_typeapi-ver": "VNF2.00",
   
        "targetoriginator-id": "generic-vnf.vnf-ida20e2073-30b1-4357-893b-f5ed57b66ef0",

           "AAI"request-id": {"a20e2073-30b1-4357-893b-f5ed57b66ef0",
                        "generic-vnf.vnf"sub-request-id" : "????1",
        "flags": {}
  },    },
        "fromaction": "DCAERestart",
 
          "policyScope"action-identifiers": "DCAE",
{
           "policyName"vnf-id": "DCAE.Config_tca-hi-lo",
 vCPE_Infrastructure_vGMUX_demo_app"
      }
    }
  },
  "policyVersionversion": "v02.0.1",
  "rpc-name": "restart",
  "correlation-id": "a20e2073-30b1-4357-893b-f5ed57b66ef0-1",
    "closedLoopEventStatustype": "ONSETrequest"
}

Code Block

title	APPC requestresponse
linenumbers	true
collapse	true

{
  "body": {
    "inputoutput": {
      "common-header": {
        "timestamp": "2017-08-25T21:06:23.037Z",
        "api-ver": "52.00",
        "originator-id": "a20e2073-30b1-4357-893b-f5ed57b66ef0",
        "request-id": "a20e2073-30b1-4357-893b-f5ed57b66ef0",
        "sub-request-id": "1",
        "flags": {}
      },
      "originator-idstatus": "a20e2073-30b1-4357-893b-f5ed57b66ef0",{
        "request-idcode": "a20e2073-30b1-4357-893b-f5ed57b66ef0"400,
        "sub-request-idmessage": "1Restart Successful",
      }
 "flags": {}    }
  },
  "version": "2.00",
  "actionrpc-name": "restart",
  "correlation-id": "a20e2073-30b1-4357-893b-f5ed57b66ef0-1",
  "action-identifierstype": "response"
}

Code Block

title	DCAE ABATED Control Loop Event
linenumbers	true
collapse	true

{
        "vnf-id    "closedLoopControlName": "fw0001vm001fw001"ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e",
      }     }
  },   "version": "21.0.2",
   "rpc-name": "restart",         "correlation-idrequestID": "a20e20730abc0000-30b1b032-43574e4b-893bbd30-f5ed57b66ef0-188260f444888",
  "type": "request" }

Code Block

title	APPC response
linenumbers	true
collapse	true

{   "body": {     "outputclosedLoopAlarmStart": {1478189220547,
      "common-header": {     "closedLoopAlarmEnd": 1478589220547,
  "timestamp": "2017-08-25T21:06:23.037Z",         "api-verclosedLoopEventClient": "5.00DCAE_INSTANCE_ID.dcae-tca",
        "originator-id    "target_type": "a20e2073-30b1-4357-893b-f5ed57b66ef0VNF",
            "request-idtarget": "a20e2073-30b1-4357-893b-f5ed57b66ef0generic-vnf.vnf-name",
            "AAI": {

			"subgeneric-requestvnf.vnf-idname" : "1",vCPE_Infrastructure_vGMUX_demo_app"
           "flags": {},
      },      "from": "status": {DCAE",
            "codepolicyScope": 400"DCAE",
            "messagepolicyName": "Restart Successful"DCAE.Config_tca-hi-lo",
      }     }   },
  "version"policyVersion": "2v0.0.1",
  "rpc-name": "restart",      "correlation-id": "a20e2073-30b1-4357-893b-f5ed57b66ef0-1",   "typeclosedLoopEventStatus": "responseABATED"
}

Version	Old Version 40	New Version Current
Changes made by	Kang Xi	Vijay Kumar
Saved on	Oct 13, 2017	Aug 02, 2018

Versions Compared

Key

vDNS Use Case

VOLTE Use Case

VOLTE Use Case

vCPE Use Case

vCPE Use Case