SOL005NSFaultManagement_def.yaml 19.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
  Alarm:
    description: >
      The alarm data type encapsulates information about an alarm.
      It shall comply with the provisions defined in Table 8.5.2.4-1
    type: object
    required: 
      - id
      - managedObjectId
rameshnaraya's avatar
rameshnaraya committed
12
      - alarmRaisedTime      
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
      - rootCauseFaultyComponent
      - ackState
      - perceivedSeverity
      - eventTime
      - eventType
      - probableCause      
      - isRootCause
      - _links 
    properties:
      id:
        description: >
          Identifier of this Alarm information element.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      managedObjectId:
        description: >
          Identifier of the affected NS instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      rootCauseFaultyComponent:
        description: >
          The NS components that are causing the NS fault.
        $ref: "#/definitions/FaultyComponentInfo"
      rootCauseFaultyResource:
        description: >
          The virtualised resources that are causing the NS
          fault. It shall be present when the faulty component
          is "NS Virtual Link" or "VNF".
        $ref: "#/definitions/FaultyResourceInfo"          
      alarmRaisedTime:
        description: >
          Alarm identifier.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
      alarmChangedTime:
        description: >
          The time stamp indicating when the alarm was cleared.
        $ref: "SOL005_def.yaml#/definitions/DateTime"          
      alarmClearedTime:
        description: >
          Links to resources related to this notification.
        $ref: "SOL005_def.yaml#/definitions/DateTime"    
      ackState:
        description: >
rameshnaraya's avatar
rameshnaraya committed
54
          Acknowledgment state of the alarm.
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 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
          Permitted values:
          UNACKNOWLEDGED
          ACKNOWLEDGED
        type: string
        enum:
          - UNACKNOWLEDGED
          - ACKNOWLEDGED
      perceivedSeverity:
        description: >
          Perceived severity of the managed object failure.
        $ref: "#/definitions/PerceivedSeverityType"
      eventTime:
        description: >
          Time stamp indicating when the fault was observed.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
      eventType:
        description: >
          Type of event.
        $ref: "#/definitions/EventType"
      faultType:
        description: >
          Additional information to clarify the type of the fault.
        type: string
      probableCause:
        description: >
          Information about the probable cause of the fault.
        type: string      
      isRootCause:
        description: >
          Attribute indicating if this fault is the root for other
          correlated alarms. If TRUE, then the alarms listed in
          the attribute CorrelatedAlarmId are caused by this fault.
        type: boolean
      correlatedAlarmIds:
        description: >
          List of identifiers of other alarms correlated to this fault.
        type: array
        items: 
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      faultDetails:
        description: >
          Provides additional information about the fault..
        type: string
      _links:
        description: >
          Links for this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "SOL005_def.yaml#/definitions/Link"     
            objectInstance:
              description: >
                Link to the resource representing the NS instance to
                which the notified alarm is correlated. Shall be
                present if the NS instance information is accessible
                as a resource.
              $ref: "SOL005_def.yaml#/definitions/Link"   
            
  AlarmClearedNotification:
    description: >
      This type represents an alarm cleared notification about VNF faults.
      The notification shall be triggered by the VNFM when an alarm has been
      cleared.
    type: object
    required: 
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - alarmId
      - alarmClearedTime
      - _links
    properties:
      id:
        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: "SOL005_def.yaml#/definitions/Identifier"
      notificationType:
        description: >
          Discriminator for the different notification types. Shall be set to
          "AlarmClearedNotification" for this notification type.
        type: string
        enum: 
          - AlarmClearedNotification
      subscriptionId:
        description: >
          Identifier of the subscription that this notification relates to.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
      alarmId:
        description: >
          Alarm identifier.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      alarmClearedTime:
        description: >
          The time stamp indicating when the alarm was cleared.
      _links:
        description: >
          Links to resources related to this notification.
        type: object
        required: 
          - subscription
          - alarm
        properties: 
          subscription: 
            description: >
              Link to the related subscription.
            $ref: "SOL005_def.yaml#/definitions/Link"
          alarm:
            description: >
              Link to the resource that represents the related alarm.
            $ref: "SOL005_def.yaml#/definitions/Link"

  AlarmListRebuiltNotification:
    description: >
      This type represents a notification that the alarm list has been
      rebuilt, e.g. if the VNFM detects its storage holding the alarm
      list is corrupted.
      The notification shall be triggered by the VNFM when the alarm list has
      been rebuilt.
    type: object
    required: 
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - _links
    properties:
      id:
        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: "SOL005_def.yaml#/definitions/Identifier"
      notificationType:
        description: >
          Discriminator for the different notification types. Shall be set to
          "AlarmListRebuiltNotification" for this notification type.
        type: string
        enum: 
          - AlarmListRebuiltNotification
      subscriptionId:
        description: >
          Identifier of the subscription that this notification relates to.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
      _links:
        description: >
          Links to resources related to this notification.
        type: object
        required: 
          - subscription
          - alarms
        properties: 
          subscription: 
            description: >
              Link to the related subscription.
            $ref: "SOL005_def.yaml#/definitions/Link"
          alarms:
            description: >
              Link to the alarm list, i.e. the "Alarms" resource.
            $ref: "SOL005_def.yaml#/definitions/Link"

  AlarmModifications:
    description: >
      This type represents attribute modifications for an "Individual alarm" resource, i.e. modifications to a resource
      representation based on the "Alarm" data type. The attributes of "Alarm" that can be modified according to the
      provisions in clause 8.5.2.4 are included in the "AlarmModifications" data type.
      The "AlarmModifications" data type shall comply with the provisions defined in Table 8.5.2.8-1.
    type: object
    required:
      - ackState
    properties: 
      ackState:
        description: >
          New value of the "ackState" attribute in "Alarm".
          Permitted values:
rameshnaraya's avatar
rameshnaraya committed
244
          - ACKNOWLEDGED
245 246 247 248 249 250 251
        type: string
        enum:
          - ACKNOWLEDGED
  EventType:
    description: >
      The enumeration EventType represents those types of events that trigger
      an alarm.
rameshnaraya's avatar
rameshnaraya committed
252
      - COMMUNICATIONS_ALARM: An alarm of this type is associated with the
253 254
        procedure and/or process required conveying information from one point
        to another (ITU-T Recommendation X.733).
rameshnaraya's avatar
rameshnaraya committed
255
      - PROCESSING_ERROR_ALARM: An alarm of this type is associated with a
256
        software or processing fault (ITU-T Recommendation X.733).
rameshnaraya's avatar
rameshnaraya committed
257
      - ENVIRONMENTAL_ALARM: An alarm of this type is associated with a
258 259
        condition related to an enclosure in which the equipment resides
        (ITU-T Recommendation X.733).
rameshnaraya's avatar
rameshnaraya committed
260
      - QOS_ALARM: An alarm of this type is associated with degradation in the
261
        quality of a service (ITU-T Recommendation X.733).
rameshnaraya's avatar
rameshnaraya committed
262
      - EQUIPMENT_ALARM: An alarm of this type is associated with an equipment
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
        fault (ITU-T Recommendation X.733).
    type: string
    enum: 
      - COMMUNICATIONS_ALARM
      - PROCESSING_ERROR_ALARM
      - ENVIRONMENTAL_ALARM
      - QOS_ALARM
      - EQUIPMENT_ALARM

  FaultyResourceInfo:
    description: >
      This type represents the faulty virtual resources that have a negative impact on a NS.
    type: object
    required: 
      - faultyResource
      - faultyResourceType
    properties: 
      faultyResource:
        description: >
          Information that identifies the faulty resource instance and
          its managing entity.
        $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      faultyResourceType:
        description: >
          Type of the faulty resource.
        $ref: "#/definitions/FaultyResourceType"

  FaultyResourceType:
    description: >
      The enumeration FaultyResourceType represents those types of faulty
      resource.
rameshnaraya's avatar
rameshnaraya committed
294 295 296 297
      Acceptable values are:
      - COMPUTE - Virtual compute resource.
      - STORAGE - Virtual storage resource.
      - NETWORK - Virtual network resource.
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
    type: string
    enum: 
      - COMPUTE
      - STORAGE
      - NETWORK

  FmNotificationsFilter:
    description: >
      This type represents a subscription filter related to notifications about NS faults. 
      It shall comply with the provisions
      defined in Table 8.5.3.2-1.
      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
    properties:
      nsInstanceSubscriptionFilter:
        description: >
          Filter criteria to select NS instances about which to notify.    
        $ref: "SOL005_def.yaml#/definitions/NsInstanceSubscriptionFilter"
      notificationTypes:
        description: >
          Match particular notification types.
          Permitted values:
rameshnaraya's avatar
rameshnaraya committed
324 325 326
          - AlarmNotification
          - AlarmClearedNotification
          - AlarmListRebuiltNotification.
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
        type: array
        items:
          type: string
          enum:
            - AlarmNotification
            - AlarmClearedNotification
            - AlarmListRebuiltNotification
      faultyResourceTypes:
        description: >
          Match alarms related to NSs with a faulty resource type listed in this attribute.
        type: array
        items: 
          $ref: "#/definitions/FaultyResourceType"
      perceivedSeverities:
        description: >
          Match VNF alarms with a perceived severity listed in this attribute.
        type: array
        items: 
          $ref: "#/definitions/PerceivedSeverityType"
      eventTypes:
        description: >
          Match VNF alarms with an event type listed in this attribute.
        type: array
        items: 
          $ref: "#/definitions/EventType"
      probableCauses:
        description: >
          Match VNF alarms with a probable cause listed in this attribute.
        type: array
        items: 
          type: string        

  FmSubscription:
    description: >
      This type represents a subscription related to notifications about VNF
      faults.
    type: object
    required: 
      - id
      - callbackUri
      - _links
    properties: 
      id:
        description: >
          Identifier of this subscription resource.
        $ref: "SOL005_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/FmNotificationsFilter"
      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: "SOL005_def.yaml#/definitions/Link"

  FmSubscriptionRequest:
    description: >
      This type represents a subscription request related to notifications
      about VNF faults.
    type: object
    required: 
      - callbackUri
    properties:
      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/FmNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
        type: string
        format: url
      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: "SOL005_def.yaml#/definitions/SubscriptionAuthentication"

  PerceivedSeverityType:
    description: >
      Indicates the relative level of urgency for operator attention.
      * CRITICAL: The Critical severity level indicates that a service
        affecting condition has occurred and an immediate corrective action
        is required. Such a severity can be reported, for example, when a
        managed object becomes totally out of service and its capability needs
        to be restored (ITU-T Recommendation X.733).
      * MAJOR: The Major severity level indicates that a service affecting
        condition has developed and an urgent corrective action is required.
        Such a severity can be reported, for example, when there is a severe
        degradation in the capability of the managed object and its full
        capability needs to be restored (ITU-T Recommendation X.733).
      * MINOR: The Minor severity level indicates the existence of a
        non-service affecting fault condition and that corrective action
        should be taken in order to prevent a more serious (for example,
        service affecting) fault. Such a severity can be reported, for
        example, when the detected alarm condition is not currently degrading
        the capacity of the managed object (ITU-T Recommendation X.733).
      * WARNING: The Warning severity level indicates the detection of a
        potential or impending service affecting fault, before any significant
        effects have been felt. Action should be taken to further diagnose (if
        necessary) and correct the problem in order to prevent it from
        becoming a more serious service affecting fault (ITU-T Recommendation
        X.733).
      * INDETERMINATE: The Indeterminate severity level indicates that the
        severity level cannot be determined (ITU-T Recommendation X.733).
      * CLEARED: The Cleared severity level indicates the clearing of one or
        more previously reported alarms. This alarm clears all alarms for this
        managed object that have the same Alarm type, Probable cause and
        Specific problems (if given) (ITU-T Recommendation X.733).
    type: string
    enum: 
      - CRITICAL
      - MAJOR
      - MINOR
      - WARNING
      - INDETERMINATE
      - CLEARED
      
  FaultyComponentInfo:
    description: >
      This type represents the faulty component that has a negative impact on an NS. 
      It shall comply with the provisions
      defined in Table 8.5.3.4-1.
    type: object
    properties: 
      faultyNestedNsInstanceId:
        description: >
          Identifier of the faulty nested NS instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      faultyResourceType:
        description: >
          Identifier of the faulty NS virtual link instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      faultyNsVirtualLinkInstanceId:
        description: >
          Identifier of the faulty VNF instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
        
  AlarmNotification:
    description: >
      This type represents an alarm notification about NS faults.
    type: object
    required: 
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - alarm
      - _links
    properties:
      id:
        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: "SOL005_def.yaml#/definitions/Identifier"
      notificationType:
        description: >
          Discriminator for the different notification types.
          Shall be set to "AlarmNotification" for this notification type.
        type: string
        enum: 
          - AlarmClearedNotification
      subscriptionId:
        description: >
          Identifier of the subscription that this notification relates to.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
      alarm:
        description: >
          Information about an alarm including AlarmId, affected
          NS identifier, and FaultDetails.
        $ref: "#/definitions/Alarm"
      alarmClearedTime:
        description: >
          The time stamp indicating when the alarm was cleared.
      _links:
        description: >
          Links to resources related to this notification.
        type: object
        required: 
          - subscription
          - alarm
        properties: 
          subscription: 
            description: >
              Link to the related subscription.
            $ref: "SOL005_def.yaml#/definitions/Link"
          alarm:
            description: >
              Link to the resource that represents the related alarm.
            $ref: "SOL005_def.yaml#/definitions/Link"