SOL003: VNF Fault Management datatypes consolidated (d5a43886) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL003/definitions/SOL003_def.yaml

deleted100644 → 0

+0 −167

Original line number	Diff line number	Diff line
		# 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.
		type: object
		required:
		- id
		- managedObjectId
		- rootCauseFaultyResource
		- alarmRaisedTime
		- ackState
		- perceivedSeverity
		- eventTime
		- eventType
		- probableCause
		- isRootCause
		- _links
		properties:
		id:
		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"
		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"
		ackState:
		description: >
		Acknowledgement state of the alarm.
		Permitted values:
		* UNACKNOWLEDGED
		* ACKNOWLEDGED.
		type: string
		enum:
		- UNACKNOWLEDGED
		- ACKNOWLEDGED
		perceivedSeverity:
		description: >
		Perceived severity of the managed object failure.
		$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType"
		eventTime:
		description: >
		Time stamp indicating when the fault was observed.
		$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
		eventType:
		description: >
		Type of event.
		$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/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: "../../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:
		description: >
		URI of this resource.
		$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
		objectInstance:
		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.
		$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Link"

		AlarmNotification:
		description: >
		This type represents an alarm notification about VNF faults.
		This notification shall be triggered by the VNFM when:
		* An alarm has been created.
		* An alarm has been updated, e.g. if the severity of the alarm has
		changed.
		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: "../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		notificationType:
		description: >
		Discriminator for the different notification types. Shall be set to
		"AlarmNotification" for this notification type.
		type: string
		enum:
		- AlarmNotification
		subscriptionId:
		description: >
		Identifier of the subscription that this notification relates to.
		$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		timeStamp:
		description: >
		Date-time of the generation of the notification.
		$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
		alarm:
		description: >
		Information about an alarm including AlarmId, affected VNF
		identifier, and FaultDetails.
		$ref: "#/definitions/Alarm"
		_links:
		description: >
		Links to resources related to this notification.
		type: object
		required:
		- subscription
		properties:
		subscription:
		description: >
		Link to the related subscription.
		$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink"
		No newline at end of file

Admin message