blob: 503d6ca87fed0c9f5b4c144cba2fa107a19ce7cf [file] [log] [blame]
{
"self": {
"name": "DCAE_CL_OUTPUT",
"version": "1.0.0",
"description": "The output format of PM Subscription CL event to Policy"
},
"dataformatversion": "1.0.0",
"jsonSchema": {
"name": "PM Subscription CL event",
"version": "1.0.0",
"properties": {
"version": {
"type": "string",
"enum": [
"1.0.2"
]
},
"closedLoopControlName": {
"type": "string",
"description" : "This is the unique ID for the Control Loop. It is created by the CLAMP platform during Control Loop design"
},
"requestID": {
"type": "string",
"description" : "For the control loop, when an instance of the Control Loop occurs, this unique ID must be created. The same ID must be forwarded for both the ONSET and the ABATED control loop messages"
},
"closedLoopEventStatus": {
"type": "string",
"description" : "This is the status of the closedLoopControlName/requestID pair",
"enum": [
"ONSET",
"ABATED"
]
},
"closedLoopAlarmStart": {
"type": "string",
"description" : "When the alarm was first detected"
},
"closedLoopAlarmEnd" : {
"type" : "string",
"description" : "When the alarm was cleared. This field need only be present in the ABATED message"
},
"policyVersion": {
"type": "string",
"description" : "The version of the Policy driving the DCAE Micro service. Should be a part of the configuration policy setup by CLAMP and passed by DCAE controller"
},
"policyName": {
"type": "string",
"description" : "The name of the Operational Policy driving the DCAE micro service."
},
"policyScope": {
"type": "string",
"description" : "The scope of the Policy driving the DCAE micro service. Should be a part of the configuration policy setup by CLAMP and passed by DCAE controller"
},
"from": {
"type": "string",
"description" : "The ONAP platform component publishing this message",
"enum": [
"DCAE"
]
},
"target_type": {
"type": "string",
"description" : "The type of the target: PNF or VNF",
"enum": [
"VNF",
"PNF"
]
},
"target": {
"type": "string",
"description" : "This is the name of the field within the A&AI sub-tag that indicates the actual entity Node details. There should be a matching node field within the A&AI subtag holding this value",
"enum": [
"generic-vnf.vnf-name",
"pnf.pnf-name"
]
},
"AAI": {
"description" : "Contains the A&AI Node-Attribute list",
"anyOf": [
{
"generic-vnf.vnf-name": {
"type": "string"
}
},
{
"pnf.pnf-name": {
"type": "string"
}
}
]
},
"changeType": {
"type": "string",
"description": "This is the change indicator that determines whether to apply/remove a PM subscription",
"enum": [
"CREATE",
"DELETE"
]
},
"subscription": {
"type": "object",
"description": "This is the PM subscription to be applied/removed to/from an xNF",
"properties": {
"subscriptionName": {
"type": "string"
},
"administrativeState": {
"type": "string",
"enum": [
"UNLOCKED",
"LOCKED"
]
},
"fileBasedGP": {
"type": "integer"
},
"fileLocation": {
"type": "string"
},
"measurementGroups": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"measurementGroup": {
"type": "object",
"properties": {
"measurementTypes": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"measurementType": {
"type": "string"
}
},
"required": [
"measurementType"
]
}
]
},
"managedObjectDNsBasic": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"DN": {
"type": "string"
}
},
"required": [
"DN"
]
}
]
}
},
"required": [
"measurementTypes",
"managedObjectDNsBasic"
]
}
},
"required": [
"measurementGroup"
]
}
]
}
},
"required": [
"subscriptionName",
"administrativeState",
"fileBasedGP",
"fileLocation",
"measurementGroups"
]
}
},
"required": [
"version",
"closedLoopControlName",
"requestID",
"closedLoopEventStatus",
"closedLoopAlarmStart",
"policyName",
"from",
"target_type",
"target",
"AAI",
"changeType",
"subscription"
]
}
}