Content Comparison

...

Code Block

title	vFirewall - Operational Policy
linenumbers	true
collapse	true

* TODO point to drools-application JUnit test operational policy

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-id": "zdfw1fwl01fwl02"
	},
	"closedLoopAlarmStart": 1484855291527925,
	"closedLoopEventStatus": "ONSET",
	"closedLoopControlName": "CL-FRWL-LOW-TRAFFIC-SIG-d925ed73-8231-4d02-9545-db4e101f88f8",
	"version": "1.0.2",
	"target": "generic-vnf.vnf-id",
	"requestID": "8c1b8bd8-06f7-493f-8ed7-daaa4cc481bc",
	"from": "DCAE"
}

Code Block

title	AAI named-query request
linenumbers	true
collapse	true

POST /aai/search/named-query

{ 
	"query-parameters": { 
        "named-query": { 
            "named-query-uuid": "a93ac487-409c-4e8c-9e5f-334ae8f99087"
        } 
    }, 
    "instance-filters":{
    	"instance-filter":[ {
            "generic-vnf": { 
                "vnf-id": "zdfw1fwl01fwl02"
            }
        } ] 
    }
}

AAI named-query response

Code Block

title

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


policies:
  - id: unique-policy-id-1-modifyConfig
    name: modify packet gen config
    description:
    actor: APPC
    recipe: ModifyConfig
    target:
      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

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


{
    "inventory-response-item": [
        {
            "model-name": "service-instance",
            "generic-vnf": {
                "vnf-id": "de7cc3ab-0212-47df-9e64-da1c79234deb",
                "vnf-name": "ZRDM2MMEX39",
                "vnf-type": "vMME Svc Jul 14/vMME VF Jul 14 1",
  {
	"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-id": "zdfw1fwl01fwl02"
	},
	"closedLoopAlarmStart": 1484855291527925,
	"closedLoopEventStatus": "ONSET",
	"closedLoopControlName": "CL-FRWL-LOW-TRAFFIC-SIG-d925ed73-8231-4d02-9545-db4e101f88f8",
	"version": "1.0.2",
	"target": "generic-vnf.vnf-id",
	"requestID": "8c1b8bd8-06f7-493f-8ed7-daaa4cc481bc",
	"from": "DCAE"
}

Code Block

title	AAI named-query request
linenumbers	true
collapse	true

POST /aai/search/named-query

{ 
	"query-parameters": { 
        "named-query": { 
            "servicenamed-query-iduuid": "a9a77d5aa93ac487-123e409c-4ca24e8c-9eb99e5f-0b015d2ee0fb334ae8f99087",
        } 
    }, 
    "orchestrationinstance-statusfilters":{
"active",       	"instance-filter":[ {
            "ingeneric-maintvnf": false,{ 
                "is-closed-loop-disabledvnf-id": false,"zdfw1fwl01fwl02"
            }
     "resource-version": "1503082370097",
    } ] 
    }
}

Code Block

title	AAI named-query response
linenumbers	true
collapse	true

Below is a sample response format. Field  "model-invariant-id": "82194af1-3c2c-485a-8f44-420e22a9eaa4",
           values are just examples. Will update to real values for vFW later.


{
    "modelinventory-versionresponse-iditem": "46b92144-923a-4d20-b85a-3cbd847668a9"[
        {
   },             "extramodel-propertiesname": {}"service-instance",
            "inventorygeneric-response-itemsvnf": {
                "inventoryvnf-response-itemid": ["de7cc3ab-0212-47df-9e64-da1c79234deb",
                "vnf-name": "ZRDM2MMEX39",
  {                         "model-name"vnf-type": "service-instance",vMME Svc Jul 14/vMME VF Jul 14  1",
                "service-instanceid": {"a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",
                            "service-instance-id"orchestration-status": "37b8cdb7-94eb-468f-a0c2-4e3c3546578eactive",
                "in-maint": false,
            "service-instance-name    "is-closed-loop-disabled": "Changedfalse,
Service Instance NAME",              "resource-version": "1503082370097",
                "model-invariant-id": "82194af1-3c2c-485a-8f44-420e22a9eaa4",
  
                         "model-version-id": "46b92144-923a-4d20-b85a-3cbd847668a9",
              },
             "resourceextra-versionproperties": "1503082993532"{},
            "inventory-response-items": {
                "orchestrationinventory-response-statusitem": "Active"[
                    {
   },
                        "extramodel-propertiesname": {}"service-instance",
                        "inventoryservice-response-itemsinstance": {
                            "inventoryservice-responseinstance-itemid": ["37b8cdb7-94eb-468f-a0c2-4e3c3546578e",
                            "service-instance-name": "Changed Service  {
 Instance NAME",
                                  "model-invariant-nameid": "pnf82194af1-3c2c-485a-8f44-420e22a9eaa4",
                                    "generic-vnf": {
"model-version-id": "46b92144-923a-4d20-b85a-3cbd847668a9",
                            "resource-version": "1503082993532",
                  "vnf-id          "orchestration-status": "jimmy-testActive",
                        },
                "vnf-name": "jimmy-test-vnf",        "extra-properties": {},
                        "inventory-response-items": {
        "vnf-type": "vMME Svc Jul 14/vMME VF Jul 14 1",            "inventory-response-item": [
                           "service-id": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",    {
                                    "orchestrationmodel-statusname": "activepnf",
   
                                    "ingeneric-maintvnf": false,{
                                        "is-closed-loop-disabledvnf-id": false"jimmy-test",
                                        "resourcevnf-versionname": "1504013830207jimmy-test-vnf",
                                        "modelvnf-invariant-idtype": "862b25a1-262a-4961-bdaa-cdc55d69785avMME Svc Jul 14/vMME VF Jul 14 1",
                                        "modelservice-version-id": "e9f1fa7da9a77d5a-c839123e-418a4ca2-96019eb9-03dc0d2ad6870b015d2ee0fb",
                                    },    "orchestration-status": "active",
                               "extra-properties": {}        "in-maint": false,
                       },                 "is-closed-loop-disabled": false,
              {                                     "model-name"resource-version": "service-instance1504013830207",
                                    "generic-vnf": {
      "model-invariant-id": "862b25a1-262a-4961-bdaa-cdc55d69785a",
                                     "vnf   "model-version-id": "jimmy-test-vnf2",e9f1fa7d-c839-418a-9601-03dc0d2ad687"
                                    },
       "vnf-name": "jimmy-test-vnf2-named",                            "extra-properties": {}
           "vnf-type": "vMME Svc Jul 14/vMME VF Jul 14 1",             },
                           "service-id": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",    {
                                    "orchestrationmodel-statusname": "activeservice-instance",
                                        "ingeneric-maintvnf": false,{
                                        "is-closed-loop-disabled": falsevnf-id": "jimmy-test-vnf2",
                                        "resourcevnf-versionname": "1504014833841jimmy-test-vnf2-named",
                                        "modelvnf-invariant-idtype": "82194af1-3c2c-485a-8f44-420e22a9eaa4vMME Svc Jul 14/vMME VF Jul 14 1",
                                        "modelservice-version-id": "46b92144a9a77d5a-923a123e-4d204ca2-b85a9eb9-3cbd847668a90b015d2ee0fb",
                                        },"orchestration-status": "active",
                                        "extrain-propertiesmaint": false,
{}                                 }       "is-closed-loop-disabled": false,
                    ]                    "resource-version": "1504014833841",
   }                     }                 ]"model-invariant-id": "82194af1-3c2c-485a-8f44-420e22a9eaa4",
            }         }     ] }

Code Block

title	APPC request
linenumbers	true
collapse	true

{   	"CommonHeader": {   		  "TimeStamp": 1500997725298,   		  "APIver"model-version-id": "1.01",46b92144-923a-4d20-b85a-3cbd847668a9"
    		  "RequestID": "664be3d2-6c12-4f4b-a3e7-c349acced200",   		  "RequestTrack": [],   		  "Flags": []   	},   	"Action": "ModifyConfig",   	"Payload": {     	"generic-vnf.vnf-id": "fw0001vm001fw001" },
    	"pg-streams": {       		"pg-stream": [ 			{           		"id": "fw_udp1",           		"isextra-enabledproperties": "true"{}
         	},         	{           		"id": "fw_udp2",
   }
         		"is-enabled": "true"         	},         	{]
         		"id": "fw_udp3",           		"is-enabled": "true"  }
      	},         	{     }
     		"id": "fw_udp4",           		"is-enabled": "true"]
          	},  }
      	{  }
    ]
}

Code Block

title	APPC request
linenumbers	true
collapse	true

{
  		"idCommonHeader": "fw_udp5",{
  		  "TimeStamp": 1500997725298,
  		  		"is-enabledAPIver": "true1.01",
        	}]		     	}
  	}
}

Code Block

title	APPC response
linenumbers	true
collapse	true

ACCEPT response

{
    "Status": {
   "RequestID": "664be3d2-6c12-4f4b-a3e7-c349acced200",
  		  "RequestTrack": [],
  		  "Flags": []
  	},
  	"Action": "ModifyConfig",
  	"Payload": {
    "Value	"generic-vnf.vnf-id": "ACCEPTEDfw0001vm001fw001",
    	"pg-streams": {
  "Code    		"pg-stream": "100" [
			{
     },     		"Payloadid": { "fw_udp1",
          		"pgis-streamsenabled": "{\\\"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",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": {
        "APIverValue": "1.01ACCEPTED",
        "RequestIDCode": "664be3d2-6c12-4f4b-a3e7-c349acced200",100"
    },
    "SubrequestIDPayload": null,{
        "OriginatorID": null
    }
}


SUCCESS response

{
    "Status": {
        "Value": "SUCCESS",
        "Code": "400"
    },
    "Payload": {
        "pg-streams": "{\\\"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\\\"}]}}",
 \\\"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
    }
}

vDNS Use Case

Code Block

title	vDNS - TCA Configuration Policy Payload
linenumbers	true
collapse	true

tca_policy: "{
  "domain": "measurementsForVfScaling",
  "metricsPerEventName": [
    {
      "generic-vnf.vnf-ideventName": "fw0001vm001fw001vLoadBalancer",
    },     "CommonHeadercontrolLoopSchemaType": {"VM",
        "TimeStamppolicyScope": "1493841850199DCAE",
 
      "APIverpolicyName": "1.01DCAE.Config_tca-hi-lo",
        "RequestIDpolicyVersion": "664be3d2-6c12-4f4b-a3e7-c349acced200v0.0.1",
        "SubrequestIDthresholds": null, [
        {
    "OriginatorID": null     }
}

...

Code Block

title	vDNS - TCA Configuration Policy Payload
linenumbers	true
collapse	true

tca_policy: "{
  "domain": "measurementsForVfScaling",
  "metricsPerEventName": ["closedLoopControlName": "CL-LBAL-LOW-TRAFFIC-SIG-FB480F95-A453-6F24-B767-FD703241AB1A",
          "version": "1.0.2",
    {       "eventNamefieldPath": "vLoadBalancer$$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated",
          "controlLoopSchemaTypethresholdValue": "VM"500,
          "policyScopedirection": "DCAELESS_OR_EQUAL",
          "policyNameseverity": "DCAE.Config_tca-hi-loMAJOR",
          "policyVersionclosedLoopEventStatus": "v0.0.1",ONSET"
       "thresholds": [ },
        {
          "closedLoopControlName": "CL-LBAL-LOWHIGH-TRAFFIC-SIG-FB480F950C5920A6-A453B564-6F248035-B767C878-FD703241AB1A0E814352BC2B",
          "version": "1.0.2",
          "fieldPath": "$$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated",
          "thresholdValue": 5005000,
          "direction": "LESSGREATER_OR_EQUAL",
          "severity": "MAJORCRITICAL",
          "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: 
    - "closedLoopControlName"serviceName: "CLd4738992-LBAL6497-HIGH-TRAFFIC-SIG-0C5920A6-B564-8035-C878-0E814352BC2B",4dca-9db9
      serviceInvariantUUID: dc112d6e-7e73-4777-9c6f-1a7fb5fd1b6f
      serviceUUID: 2eea06c6-e1d3-4c3a-b9c4-478c506eeedf
  "version"trigger_policy: "1.0.2",unique-policy-id-1-scale-up
  timeout: 1200

policies:
  -  "fieldPath": "$$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated",
     id: unique-policy-id-1-scale-up
    name: Create a new VF Module
    "thresholdValue"description:
5000,    actor: MSO
    recipe: VF Module "direction": "GREATER_OR_EQUAL",Create
    target:
      "severity"type: "CRITICAL",VNF
    retry: 0
    "closedLoopEventStatus"timeout: "ONSET"1200
    success: final_success
  }  failure: final_failure
   ] failure_timeout: final_failure_timeout
  }  failure_retries: final_failure_retries
    ]
 
}"

Code Block

title	vDNS - Operational Policy
linenumbers	true
collapse	true

TODO - show link to vDNS operational Policyfailure_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",
                "policyName": "vLoadBalancer",
                "policyScope": "resource=SampleResource,service=SampleService,type=SampleType,closedLoopControlName=SampleClosedLoop",
                "target_type": "VM",
                "AAI": {
                    "vserver.vserver-name": "dfw1lb01lb01"
                },
                "closedLoopAlarmStart": 1484677482204798,
                "closedLoopEventStatus": "ONSET",
                "closedLoopControlName": "CL-DNS-LOW-TRAFFIC-SIG-d925ed73-8231-4d02-9545-db4e101f88f8",
                "version": "1.0.2",
                "target": "vserver.vserver-name",
                "requestID": "97964e10-686e-4790-8c45-bdfa61df770f",
                "from": "DCAE"
}

...

Code Block

title	AAI named-query response
linenumbers	true
collapse	true

{
    "inventory-response-item": [
        {
            "extra-properties": {},
            "inventory-response-items": {
                "inventory-response-item": [
                    {
                        "extra-properties": {
                            "extra-property": [
                                {
                                    "property-name": "model.model-name",
                                    "property-value": "c15ce9e1-e914-4c8f-b8bb"
                                },
                                {
                                    "property-name": "model.model-type",
                                    "property-value": "resource"
                                },
                                {
                                    "property-name": "model.model-version",
                                    "property-value": "1"
                                },
                                {
                                    "property-name": "model.model-id",
                                    "property-value": "033a32ed-aa65-4764-a736-36f2942f1aa0"
                                },
                                {
                                    "property-name": "model.model-name-version-id",
                                    "property-value": "d4d072dc-4e21-4a03-9524-628985819a8e"
                                }
                            ]
                        },
                        "generic-vnf": {
                            "in-maint": false,
                            "is-closed-loop-disabled": false,
                            "orchestration-status": "Created",
                            "persona-model-id": "033a32ed-aa65-4764-a736-36f2942f1aa0",
                            "persona-model-version": "1.0",
                            "resource-version": "1485542422",
                            "service-id": "b3f70641-bdb9-4030-825e-6abb73a1f929",
                            "vnf-id": "594e2fe0-48b8-41ff-82e2-3d4bab69b192",
                            "vnf-name": "Vnf_Ete_Named90e1ab3-dcd5-4877-9edb-eadfc84e32c8",
                            "vnf-type": "8330e932-2a23-4943-8606/c15ce9e1-e914-4c8f-b8bb 1"
                        },
                        "inventory-response-items": {
                            "inventory-response-item": [
                                {
                                    "extra-properties": {
                                        "extra-property": [
                                            {
                                                "property-name": "model.model-name",
                                                "property-value": "8330e932-2a23-4943-8606"
                                            },
                                            {
                                                "property-name": "model.model-type",
                                                "property-value": "service"
                                            },
                                            {
                                                "property-name": "model.model-version",
                                                "property-value": "1"
                                            },
                                            {
                                                "property-name": "model.model-id",
                                                "property-value": "4fcbc1c0-7793-46d8-8aa1-fa1c2ed9ec7b"
                                            },
                                            {
                                                "property-name": "model.model-name-version-id",
                                                "property-value": "5c996219-b2e2-4c76-9b43-7e8672a33c1d"
                                            }
                                        ]
                                    },
                                    "service-instance": {
                                        "persona-model-id": "4fcbc1c0-7793-46d8-8aa1-fa1c2ed9ec7b",
                                       "persona-model-version": "1.0",
                                        "resource-version": "1485542400",
                                        "service-instance-id": "cf8426a6-0b53-4e3d-bfa6-4b2f4d5913a5",
                                        "service-instance-name": "Service_Ete_Named90e1ab3-dcd5-4877-9edb-eadfc84e32c8"
                                    }
                                },
                                {
                                    "extra-properties": {
                                        "extra-property": [
                                            {
                                                "property-name": "model.model-name",
                                                "property-value": "C15ce9e1E9144c8fB8bb..base_vlb..module-0"
                                            },
                                            {
                                                "property-name": "model.model-type",
                                                "property-value": "resource"
                                            },
                                            {
                                                "property-name": "model.model-version",
                                                "property-value": "1"
                                            },
                                            {
                                                "property-name": "model.model-id",
                                                "property-value": "79ee24cd-fc9a-4f14-afae-5e1dd2ab2941"
                                            },
                                            {
                                                "property-name": "model.model-name-version-id",
                                                "property-value": "5484cabb-1a0d-4f29-a616-094a3f643d73"
                                            }
                                        ]
                                    },
                                    "model-name": "C15ce9e1E9144c8fB8bb..base_vlb..module-0",
                                    "vf-module": {
                                        "heat-stack-id": "Vfmodule_Ete_Named90e1ab3-dcd5-4877-9edb-eadfc84e32c8/5845f37b-6cda-4e91-8ca3-f5572d226488",
                                        "is-base-vf-module": true,
                                        "orchestration-status": "active",
                                        "persona-model-id": "79ee24cd-fc9a-4f14-afae-5e1dd2ab2941",
                                        "persona-model-version": "1",
                                        "resource-version": "1485542667",
                                        "vf-module-id": "b0eff878-e2e1-4947-9597-39afdd0f51dd",
                                        "vf-module-name": "Vfmodule_Ete_Named90e1ab3-dcd5-4877-9edb-eadfc84e32c8"
                                    }
                                },
                                {
                                    "extra-properties": {
                                        "extra-property": [
                                            {
                                                "property-name": "model.model-name",
                                                "property-value": "C15ce9e1E9144c8fB8bb..dnsscaling..module-1"
                                            },
                                            {
                                                "property-name": "model.model-type",
                                                "property-value": "resource"
                                            },
                                            {
                                                "property-name": "model.model-version",
                                                "property-value": "1"
                                            },
                                            {
                                                "property-name": "model.model-id",
                                                "property-value": "f32568ec-2f1c-458a-864b-0593d53d141a"
                                            },
                                            {
                                                "property-name": "model.model-name-version-id",
                                                "property-value": "69615025-879d-4f0d-afe3-b7d1a7eeed1f"
                                            }
                                        ]
                                    },
                                    "vf-module": {
                                        "is-base-vf-module": false,
                                        "persona-model-id": "f32568ec-2f1c-458a-864b-0593d53d141a",
                                        "persona-model-version": "1.0",
                                        "resource-version": "1485561752",
                                        "vf-module-id": "dummy",
                                        "vf-module-name": "dummy"
                                    }
                                },
                                {
                                    "extra-properties": {
                                        "extra-property": [
                                            {
                                                "property-name": "model.model-name",
                                                "property-value": "C15ce9e1E9144c8fB8bb..dnsscaling..module-1"
                                            },
                                            {
                                                "property-name": "model.model-type",
                                                "property-value": "resource"
                                            },
                                            {
                                                "property-name": "model.model-version",
                                                "property-value": "1"
                                            },
                                            {
                                                "property-name": "model.model-id",
                                                "property-value": "f32568ec-2f1c-458a-864b-0593d53d141a"
                                            },
                                            {
  
                                             "property-name": "model.model-name-version-id",                                },
                "property-value": "69615025-879d-4f0d-afe3-b7d1a7eeed1f"                           {
                 }                               "property-name": "model.model-name-version-id",
        ]                                     },   "property-value": "69615025-879d-4f0d-afe3-b7d1a7eeed1f"
                                "vf-module": {            }
                              "heat-stack-id": "vDNS_Ete_Named90e1ab3-dcd5-4877-9edb-eadfc84e32c8/f447ce51-14dd-4dcd-9957-68a047c79673",         ]
                               "is-base-vf-module": false,    },
                                    "orchestrationvf-statusmodule": "active",{
                                        "personaheat-modelstack-id": "f32568ec-2f1c-458a-864b-0593d53d141avDNS_Ete_Named90e1ab3-dcd5-4877-9edb-eadfc84e32c8/f447ce51-14dd-4dcd-9957-68a047c79673",
                                        "personais-base-modelvf-versionmodule": "1.0"false,
                                        "resourceorchestration-versionstatus": "1485562712active",
                                        "vfpersona-modulemodel-id": "8cd79e44f32568ec-1fae2f1c-48c1458a-a160864b-609f90b467490593d53d141a",
                                        "vfpersona-modulemodel-nameversion": "vDNS_Ete_Named90e1ab3-dcd5-4877-9edb-eadfc84e32c8"1.0",
                                    }      "resource-version": "1485562712",
                          }              "vf-module-id": "8cd79e44-1fae-48c1-a160-609f90b46749",
             ]                         }                     },
         "vf-module-name": "vDNS_Ete_Named90e1ab3-dcd5-4877-9edb-eadfc84e32c8"
          {                         "extra-properties": {},
                        "inventory-response-items": {       }
                     "inventory-response-item": [      ]
                        }
 {                   },
                 "cloud-region": {  {
                        "extra-properties": {},
            "cloud-owner": "Rackspace",           "inventory-response-items": {
                            "cloudinventory-regionresponse-iditem": "DFW",[
                                        "cloud-region-version": "v1",{
                                        "cloud-typeregion": "SharedNode",{
                                        "cloud-zoneowner": "CloudZoneRackspace",
                                        "ownercloud-definedregion-typeid": "OwnerTypeDFW",
                                        "resourcecloud-region-version": "1485465545v1",
                                    },          "cloud-type": "SharedNode",
                          "extra-properties": {}             "cloud-zone": "CloudZone",
                  }                      "owner-defined-type": "OwnerType",
     ]                         },          "resource-version": "1485465545"
             "tenant": {                      },
      "resource-version": "1485465545",                             "tenantextra-idproperties": "1015548", {}
                                }
"tenant-name": "1015548"                         }  ]
                  }      },
          ]             }, "tenant": {
          "vserver": {                 "inresource-maintversion": false"1485465545",
                "is-closed-loop-disabled": false,                 "prov-status"tenant-id": "ACTIVE1015548",
     
          "resource-version": "1485546436",                  "vservertenant-idname": "70f081eb-2a87-4c81-9296-4b93d7d145c6",1015548"
                "vserver-name": "vlb-lb-32c8",       }
         "vserver-name2": "vlb-lb-32c8",          }
      "vserver-selflink": "https://dfw.servers.api.rackspacecloud.com/v2/1015548/servers/70f081eb-2a87-4c81-9296-4b93d7d145c6"         ]
   }         },
    ]
}

Code Block

title	SO request
linenumbers	true
collapse	true

{        "requestDetailsvserver": {
      "modelInfo": {         "in-maint":  “modelType”: “vfModule”,false,
               “modelInvariantId”: “ff5256d2"is-5a33closed-55df-13ab-12abad84e7ff”loop-disabled": false,
          “modelNameVersionId”: “fe6478e5-ea33-3346-ac12-ab121484a3fe”,     "prov-status": "ACTIVE",
    “modelName”: “vSAMP12..base..module-0”,           "modelVersionresource-version": "11485546436",
      },       “cloudConfiguration”: {  "vserver-id": "70f081eb-2a87-4c81-9296-4b93d7d145c6",
       “lcpCloudRegionId”: “mdt1”,        "vserver-name": "vlb-lb-32c8",
 “tenantId”: “88a6ca3ee0394ade9403f075db23167e”       },       "requestInfovserver-name2": { "vlb-lb-32c8",
                “instanceName”: “MSOTEST103a-vSAMP12_base_module-0”,
 "vserver-selflink": "https://dfw.servers.api.rackspacecloud.com/v2/1015548/servers/70f081eb-2a87-4c81-9296-4b93d7d145c6"
        “source”: “VID”,   }
       “suppressRollback”: true}
    ]
 },}

Code Block

title	SO request
linenumbers	true
collapse	true

{
      "relatedInstanceListrequestDetails": [{
        "modelInfo": {
            “relatedInstance”“modelType”: {“vfModule”,
               “instanceId”: “{serviceInstanceId}”“modelInvariantId”: “ff5256d2-5a33-55df-13ab-12abad84e7ff”,
               “modelInfo”: {“modelNameVersionId”: “fe6478e5-ea33-3346-ac12-ab121484a3fe”,
                    “modelType”: “service”“modelName”: “vSAMP12..base..module-0”,
          "modelVersion": "1"
      “modelInvariantId”: “ff3514e3-5a33-55df-13ab-12abad84e7ff”},
      “cloudConfiguration”: {
          “modelNameVersionId”: “fe6985cd-ea33-3346-ac12-ab121484a3fe”,
  “lcpCloudRegionId”: “mdt1”,
          “tenantId”: “88a6ca3ee0394ade9403f075db23167e”
   “modelName”: “{parent service model name}”,
      "requestInfo": {
          "modelVersion": "1.0"“instanceName”: “MSOTEST103a-vSAMP12_base_module-0”,
          “source”: “VID”,
   }       “suppressRollback”: true
    }  },
       },"relatedInstanceList": [
         {
            “relatedInstance”: {
               “instanceId”: “{vnfInstanceIdserviceInstanceId}”,
               "modelInfo"“modelInfo”: {  
                  “modelType”: “vnf”“service”,
                  “modelInvariantId”: “ff5256d1“ff3514e3-5a33-55df-13ab-12abad84e7ff”,
                  “modelNameVersionId”: “fe6478e4“fe6985cd-ea33-3346-ac12-ab121484a3fe”,
                  “modelName”: “vSAMP12” “{parent service model name}”,
                  "modelVersion": "1.0"
               }
            }
         },
         {
        “modelCustomizationName”    “relatedInstance”: “vSAMP12 1”{
               “instanceId”: “{vnfInstanceId}”,
        }       "modelInfo": {
    }          }    “modelType”:   ]“vnf”,
      “requestParameters”: {           “userParams”“modelInvariantId”: []“ff5256d1-5a33-55df-13ab-12abad84e7ff”,
      }   } }

Code Block

title	SO Response
linenumbers	true
collapse	true

*TODO show the SO API response message

VOLTE Use Case

Code Block

title	VOLTE - Holmes Configuration Policy Payload
linenumbers	true
collapse	true

*TBD from Holmes Team

Code Block

title	VOLTE - Operational Policy
linenumbers	true
collapse	true

*TODO show Operational Policy

Code Block

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

{“modelNameVersionId”: “fe6478e4-ea33-3346-ac12-ab121484a3fe”,
                  "closedLoopEventClient"“modelName”: "DCAE.HolmesInstance"“vSAMP12”,
                  "policyVersionmodelVersion": "1.0.0.5",
                "policyName": "vVOLTE"  “modelCustomizationName”: “vSAMP12 1”
               }
            }
         }
      ],
      “requestParameters”: {
        "policyScope": "resource=volte,service=VolteSErvice,type=SampleType,closedLoopControlName=CL-VOLTE-SIG-d925ed73-8231-4d02-9545-db4e101f88f8",  “userParams”: []
      }
  }
}

Code Block

title	SO Response
linenumbers	true
collapse	true

SUCCESS:
{
	"requestReferences": {
    	"target_typeinstanceId": "VMff305d54-75b4-ff1b-bdb2-eb6b9e5460ff",
    	"requestId": "e4f95e0c-a013-4530-8e59-c5c5f9e539b6"
  	},
       "AAI	"httpResponseCode": {
								# the value "dfw1lb01lb01" comes from VES sourceName field
                                "vserver.vserver-name": "dfw1lb01lb01",
#
# WE ARE TRYING TO DETERMINE IF HOLMES CAN POPULATE SOME OF THESE VALUES
#
 								"service-instance.service-instance-id" : "TBD - Can Holmes provide this?",
								"generic-vnf.vnf-id" : "TBD",
								"vserver.vserver-id" : "TBD"
                },
                "closedLoopAlarmStart": 1484677482204798,
                "closedLoopEventStatus": "ONSET",
                "closedLoopControlName": "200
}

VOLTE Use Case

Code Block

title	VOLTE - Holmes Configuration Policy Payload
linenumbers	true
collapse	true

*TBD from Holmes Team

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",
 
              "version"target_type": "1.0.2",
         VM",
      "targetAAI": {
		"vserver.vserver-name": "dfw1lb01lb01",
 		"service-instance.service-instance-id"               "requestID": "97964e10-686e-4790-8c45-bdfa61df770f",
                "from": "DCAE"
}

Code Block

title	A&AI Call
linenumbers	true
collapse	true

* TODO Sample A&AI call to retrieve these values:


 								"service-instance.service-instance-id" : "TBD - Can Holmes provide this?",
								"generic-vnf.vnf-id" : "TBD",
								"vserver.vserver-id" : "TBD"
 
May require 2 calls. We are also hoping Holmes could prepopulate this if that team is going to retrieve topology details from A&AI anyway.

: "TBD",
		"generic-vnf.vnf-id" : "TBD",
		"vserver.vserver-name" : "TBD"
    },
    "closedLoopAlarmStart": 1484677482204798,
    "closedLoopEventStatus": "ONSET",
    "closedLoopControlName": "CL-VOLTE-SIG-d925ed73-8231-4d02-9545-db4e101f88f8",
    "version": "1.0.2",
    "target": "vserver.vserver-name",
    "requestID": "97964e10-686e-4790-8c45-bdfa61df770f",
    "from": "DCAE"
}

Code Block

title	A&AI Call
linenumbers	true
collapse	true

Code Block

title	A&AI Response
linenumbers	true
collapse	true

* TODO - A&AI response(s)

...

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": {
        "progress": "40",
        "status": "proccessing",
        "statusDescription": "OMC VMs are decommissioned in VIM",
        "errorCode": null,
        "responseId": { "42",
        "responseHistoryList": [{
                "progress": "40",
                "progressstatus": "40proccessing",
        "status": "proccessing",         "statusDescription": "OMC VMs are decommissioned in VIM",
                "errorCode": null,
                "responseId": "42",1"
            "responseHistoryList": [}, {
                "progress": "4041",
                "status": "proccessing",
                "statusDescription": "OMC VMs are decommissioned in VIM",
                "errorCode": null,
                "responseId": "12"
            },
{        ]
    }
}

vCPE Use Case

Code Block

title	vCPE - TCA Configuration Policy Payload
linenumbers	true
collapse	true

tca_policy: "{
  "progressdomain": "41measurementsForVfScaling",
  "metricsPerEventName": [
    {
       "statuseventName": "proccessingvCPEvGMUXPacketLoss",
                "statusDescription"controlLoopSchemaType": "OMC VMs are decommissioned in VIMVM",
                "errorCode"policyScope": null,
         "DCAE",
      "responseIdpolicyName": "2"DCAE.Config_tca-hi-lo",
      "policyVersion": "v0.0.1",
    }  "thresholds": [
     ]   {
 } }

vCPE Use Case

Code Block

title	vCPE - TCA Configuration Policy Payload
linenumbers	true
collapse	true

tca_policy: "{   "domain": "measurementsForVfScaling",   "metricsPerEventNameclosedLoopControlName": ["CL-vCPEvGMUX-TRAFFIC-SIG-FB480F95-A453-6F24-B767-FD703241ABA1",
    {       "eventNameversion": "vCPEvGMUXPacketLoss1.0.2",
          "controlLoopSchemaTypefieldPath": "VM$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedDiscardedPacketsDelta",
          "policyScopethresholdValue": "DCAE"0,
          "policyNamedirection": "DCAE.Config_tca-hi-loEQUAL",
          "policyVersionseverity": "v0.0.1MAJOR",
          "thresholdsclosedLoopEventStatus": [ "ABATED
        },
        {
          "closedLoopControlName": "CL-vCPEvGMUX-TRAFFIC-SIG-FB480F95-A453-6F24-B767-FD703241ABA1",
          "version": "1.0.2",
          "fieldPath": "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedDiscardedPacketsDelta",
          "thresholdValue": 01000,
          "direction": "GREATER_OR_EQUAL",
          "severity": "MAJORCRITICAL",
          "closedLoopEventStatus": "ONSET"ABATED
        },
      ]
   { }
    
  ]
 "closedLoopControlName": "CL-vCPEvGMUX-TRAFFIC-SIG-FB480F95-A453-6F24-B767-FD703241ABA1",
          "version": "1.0.2",
   
}"

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 "fieldPath": "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedDiscardedPacketsDelta",the VM
    description:
     "thresholdValue"actor: 1000,APPC
    recipe: Restart
    "direction"target:
"GREATER_OR_EQUAL",           "severity"type: "CRITICAL",VM
    retry: 3
    "closedLoopEventStatus"timeout: "ONSET"1200
    success: final_success
  }  failure: final_failure
   ] failure_timeout: final_failure_timeout
  }  failure_retries: final_failure_retries
    ]
 
}"

Code Block

title	vCPE Operational Policy
linenumbers	true
collapse	true

*TODO operational policy for vCPEfailure_exception: final_failure_exception
    failure_guard: final_failure_guard

Code Block

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

{
            "closedLoopControlName": "CL-vCPEvGMUX-TRAFFIC-SIG-FB480F95-A453-6F24-B767-FD703241ABA1",
            "version": "1.0.2",
            "requestID": "0abc0000-b032-4e4b-bd30-88260f444888",
            "closedLoopAlarmStart": 1478189220547,
            "closedLoopEventClient": "tca.instance00001",
            "target_type": "VNF",
            "target": "generic-vnf.vnf-id",
            "AAI": {
                        "generic-vnf.vnf-id" : "????"
            },
            "from": "DCAE",
            "policyScope": "DCAE",
            "policyName": "DCAE.Config_tca-hi-lo",
            "policyVersion": "v0.0.1",
            "closedLoopEventStatus": "ONSET"
}

...

Version	Old Version 21	New Version 22
Changes made by	Pamela Dragosh	Chenfei Gao
Saved on	Sept 22, 2017	Sept 22, 2017

Versions Compared

Key

vDNS Use Case

VOLTE Use Case

VOLTE Use Case

vCPE Use Case

vCPE Use Case