SOL002VNFFaultManagement_def.yaml 5.2 KB
Newer Older
1
2
3
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt

4
definitions:
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
  Alarm:
    description: >
      The alarm data type encapsulates information about an alarm.
    type: object
    required:
      - id
      - managedObjectId
      - alarmRaisedTime
      - ackState
      - perceivedSeverity
      - eventTime
      - eventType
      - probableCause
      - isRootCause
      - _links
    properties:
21
      id:
22
23
24
25
26
27
28
        description: >
          Identifier of this Alarm information element.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      managedObjectId:
        description: >
          Identifier of the affected VNF instance.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
29
30
31
      vnfcInstanceIds:
        description: >
          Identifiers of the affected VNFC instances.
32
33
          Each identifier references the "id" attribute in a "VnfcInfo" structure.
          Shall be present if the alarm affects at least one VNFC instance.
34
35
36
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
      rootCauseFaultyResource:
        description: >
          The virtualised resources that are causing the VNF fault.
        $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FaultyResourceInfo"
      alarmRaisedTime:
        description: >
          Time stamp indicating when the alarm is raised by the managed
          object.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
      alarmChangedTime:
        description: >
          Time stamp indicating when the alarm was last changed. It shall be
          present if the alarm has been updated.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
      alarmClearedTime:
        description: >
          Time stamp indicating when the alarm was cleared. It shall be
          present if the alarm has been cleared.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
56
57
58
59
60
61
      alarmAcknowledgedTime:
        description: >
          Time stamp indicating when the alarm was
          acknowledged. It shall be present if the alarm has
          been acknowledged.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
62
63
64
65
66
67
68
      ackState:
        description: >
          Acknowledgement state of the alarm. 
          Permitted values:
          * UNACKNOWLEDGED
          * ACKNOWLEDGED.
        type: string
69
        enum:
70
71
72
          - UNACKNOWLEDGED
          - ACKNOWLEDGED
      perceivedSeverity:
73
74
75
76
        description: >
          Perceived severity of the managed object failure.
        $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType"
      eventTime:
77
78
79
80
        description: >
          Time stamp indicating when the fault was observed.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
      eventType:
81
82
83
        description: >
          Type of event.
        $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/EventType"
84
85
86
87
88
89
90
91
92
93
94
95
96
97
        type: string
      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.
98
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean"
99
100
101
102
      correlatedAlarmIds:
        description: >
          List of identifiers of other alarms correlated to this fault.
        type: array
103
        items:
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      faultDetails:
        description: >
          Provides additional information about the fault.
        type: array
        items:
          type: string
      _links:
        description: >
          Links for this resource.
        type: object
        required:
          - self
        properties:
          self:
119
120
            description: >
              URI of this resource.
121
122
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          objectInstance:
123
124
125
126
            description: >
              Link to the resource representing the VNF instance to which the
              notified alarm is correlated. Shall be present if the VNF
              instance information is accessible as a resource.
127
128
129
130
131
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"

  PerceivedSeverityRequest:
    description: >
      This type represents the escalated value of the perceived severity for an alarm.
132
    type: object
133
134
135
136
137
138
139
    required:
      - proposedPerceivedSeverity
    properties:
      proposedPerceivedSeverity:
        description: >
          Indicates the proposed escalated perceived severity for an alarm.
        $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType"