SOL002SOL003VNFIndicator_def.yaml 7.42 KB
Newer Older
Gergely Csatari's avatar
Gergely Csatari committed
1
2
3
4
5
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt

definitions:
  VnfIndicator:
6
    description: >
Gergely Csatari's avatar
Gergely Csatari committed
7
8
      This type represents a VNF indicator value.
    type: object
9
    required:
Gergely Csatari's avatar
Gergely Csatari committed
10
11
12
13
      - id
      - value
      - vnfInstanceId
      - _links
14
    properties:
Gergely Csatari's avatar
Gergely Csatari committed
15
16
17
18
19
20
21
22
23
      id:
        description: >
          Identifier of this VNF indicator.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      name:
        description: >
          Human readable name of the indicator. Shall be present if defined in
          the VNFD.
        type: string
24
      value:
Gergely Csatari's avatar
Gergely Csatari committed
25
26
27
28
29
30
31
32
33
34
35
36
37
38
        description: >
          Provides the value of the indicator. The value format is defined in
          the VNFD.
          ETSI GS NFV-SOL 001 specifies the structure and format of the 
          VNFD based on TOSCA specifications.
        type: object
      vnfInstanceId:
        description: >
          Identifier of the VNF instance which provides the indicator value.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      _links:
        description: >
          Links for this resource.
        type: object
39
        required:
Gergely Csatari's avatar
Gergely Csatari committed
40
41
          - self
          - vnfInstance
42
        properties:
Gergely Csatari's avatar
Gergely Csatari committed
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
          self:
            description: >
              URI of this resource.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
          vnfInstance:
            description: >
              Link to the related VNF instance resource.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"

  VnfIndicatorNotificationsFilter:
    description: >
      This type represents a subscription filter related to notifications
      about VNF indicator value changes.
      At a particular nesting level in the filter structure, the following
      applies: All attributes shall match in order for the filter to match
      (logical "and" between different filter attributes). If an attribute is
      an array, the attribute shall match if at least one of the values in the
      array matches (logical "or" between the values of one filter attribute).
    type: object
62
    properties:
Gergely Csatari's avatar
Gergely Csatari committed
63
64
65
66
67
68
69
70
      vnfInstanceSubscriptionFilter:
        description: >
          Filter criteria to select VNF instances about which to notify.
        $ref: "SOL002SOL003_def.yaml#/definitions/VnfInstanceSubscriptionFilter"
      indicatorIds:
        description: >
          Match particular VNF indicator identifiers.
        type: array
71
        items:
Gergely Csatari's avatar
Gergely Csatari committed
72
73
74
75
76
77
78
          $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"

  VnfIndicatorSubscription:
    description: >
      This type represents a subscription related to notifications about VNF
      indicator value changes.
    type: object
79
    required:
Gergely Csatari's avatar
Gergely Csatari committed
80
81
82
      - id
      - callbackUri
      - _links
83
    properties:
Gergely Csatari's avatar
Gergely Csatari committed
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
      id:
        description: >
          Identifier of this subscription resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      filter:
        description: >
          Filter settings for this subscription, to define the subset of all
          notifications this subscription relates to. A particular
          notification is sent to the subscriber if the filter matches, or if
          there is no filter.
        $ref: "#/definitions/VnfIndicatorNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
        type: string
        format: url
      _links:
        description: >
          Links for this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"

  VnfIndicatorSubscriptionRequest:
    description: >
      This type represents a subscription request related to VNF indicator
      value change notifications.
    type: object
117
    required:
Gergely Csatari's avatar
Gergely Csatari committed
118
      - callbackUri
119
    properties:
Gergely Csatari's avatar
Gergely Csatari committed
120
121
122
123
124
125
126
127
128
129
      filter:
        description: >
          Filter settings for this subscription, to define the subset of all
          notifications this subscription relates to. A particular
          notification is sent to the subscriber if the filter matches, or if
          there is no filter.
        $ref: "#/definitions/VnfIndicatorNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
130
        $ref: "SOL002SOl003_def.yaml#/definitions/Uri"
Gergely Csatari's avatar
Gergely Csatari committed
131
132
133
134
135
136
137
138
139
140
141
      authentication:
        description: >
          Authentication parameters to configure the use of Authorization
          when sending notifications corresponding to this subscription.
          This attribute shall only be present if the subscriber requires
          authorization of notifications.
        $ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"

  VnfIndicatorValueChangeNotification:
    description: >
      This type represents a VNF indicator value change notification.
142
143
      The notification shall be triggered by the VNFM when the value of an
      indicator has changed.
Gergely Csatari's avatar
Gergely Csatari committed
144
    type: object
145
    required:
Gergely Csatari's avatar
Gergely Csatari committed
146
147
148
149
150
151
152
153
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - vnfIndicatorId
      - value
      - vnfInstanceId
      - _links
154
155
    properties:
      id:
Gergely Csatari's avatar
Gergely Csatari committed
156
157
158
159
160
161
162
163
164
165
        description: >
          Identifier of this notification. If a notification is sent multiple
          times due to multiple subscriptions, the "id" attribute of all these
          notifications shall have the same value.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      notificationType:
        description: >
          Discriminator for the different notification types. Shall be set to
          "VnfIndicatorValueChangeNotification" for this notification type.
        type: string
166
        enum:
Gergely Csatari's avatar
Gergely Csatari committed
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
          - VnfIndicatorValueChangeNotification
      subscriptionId:
        description: >
          Identifier of the subscription that this notification relates to.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
      vnfIndicatorId:
        description: >
          Identifier of the VNF indicator whose value has changed.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      name:
        description: >
          Human readable name of the VNF indicator. Shall be present if
          defined in the VNFD.
        type: string
      value:
        description: >
          Provides the value of the VNF indicator. The value format is defined
          in the VNFD.
          ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD
          based on TOSCA specifications.
        type: object
      vnfInstanceId:
        description: >
          Identifier of the VNF instance which provides the indicator value.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      _links:
        description: >
          Links for this resource.
        type: object
200
        required:
Gergely Csatari's avatar
Gergely Csatari committed
201
202
203
204
          - subscription
        properties:
          vnfInstance:
            description: >
205
206
207
              Link to the related VNF instance resource. Shall be present 
              if the VNF instance information is accessible as a resource.
            $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
Gergely Csatari's avatar
Gergely Csatari committed
208
209
210
          subscription:
            description: >
              Link to the related subscription.
211
            $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"