summaryrefslogtreecommitdiffstats
path: root/components/pm-subscription-handler/dpo/data-formats/pmsh-cl-output.json
blob: 503d6ca87fed0c9f5b4c144cba2fa107a19ce7cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
{
  "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"
    ]
  }
}