summaryrefslogtreecommitdiffstats
path: root/components/pm-subscription-handler/dpo/data-formats/dcae-cl-output.json
blob: b5cfa8bf01bb76a9fe4f75ce70accf082508ad1b (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
{
  "self": {
    "name": "DCAE_CL_OUTPUT",
    "version": "1.0.0",
    "description": "The output format of PM Subscription CL event sent to Policy."
  },
  "dataformatversion": "1.0.0",
  "jsonSchema": {
    "name": "PM Subscription CL event",
    "version": "1.0.0",
    "properties": {
      "name": "PM Subscription CL event",
      "version": "1.0.0",
      "nfName": {
        "type": "string",
        "description": "The name of the nf in A&AI."
      },
      "ipv4Address": {
        "type": "string",
        "description": "The ipv4address of the nf being targeted."
      },
      "policyName": {
        "type": "string",
        "description": "The name of the Operational Policy driving the DCAE microservice."
      },
      "closedLoopControlName": {
        "type": "string",
        "description": "This is the unique ID for the Control Loop. It is created by the CLAMP platform during Control Loop design."
      },
      "blueprintName": {
        "type": "string",
        "description": "The name of the blueprint to be executed by CDS towards the nf."
      },
      "blueprintVersion": {
        "type": "string",
        "description": "The version of the blueprint to be executed by CDS towards the nf."
      },
      "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": {
          "administrativeState": {
            "type": "string",
            "description": "The administrative state of the subscription object.",
            "enum": [
              "UNLOCKED",
              "LOCKED"
            ]
          },
          "subscriptionName": {
            "type": "string",
            "description": "The unique name of the subscription object."
          },
          "fileBasedGP": {
            "type": "integer",
            "description": "The granularity period of measurement collection in minutes."
          },
          "fileLocation": {
            "type": "string",
            "description": "The location of the PM measurements file on the nf."
          },
          "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": [
      "nfName",
      "ipv4Address",
      "policyName",
      "closedLoopControlName",
      "blueprintName",
      "blueprintVersion",
      "changeType",
      "subscription"
    ]
  }
}