SOL005 - NS Fault Management Interface - Network... · Notify about NS alarms POST...

SOL005 - NS Fault ManagementInterface

OverviewSOL005 - NS Fault Management Interface IMPORTANT: Please note that this file might be notaligned to the current version of the ETSI Group Specification it refers to and has not beenapproved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specificationtakes precedence. Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis

Version informationVersion : 1.0.0

Contact informationContact : NFV-SOL WG

License informationLicense : ETSI Forge copyright noticeLicense URL : https://forge.etsi.org/etsi-forge-copyright-notice.txtTerms of service : null

URI schemeBasePath : /nsfm/v1Schemes : HTTPS

Consumes• application/json

Produces• application/json

External DocsDescription : ETSI GS NFV-SOL 005 V2.4.1URL : http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf

Paths

1

https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis

https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis

https://forge.etsi.org/etsi-forge-copyright-notice.txt

http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf

http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf

Notify about NS alarms

POST /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification

Description

The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.

Parameters

Type Name Description Schema

HeaderAcceptrequired

Content-Types that are acceptable for theresponse. Reference: IETF RFC 7231

string

HeaderAuthorizationoptional

The authorization token for the request.Reference: IETF RFC 7235

string

HeaderContent-Typerequired

The MIME type of the body of the request.Reference: IETF RFC 7231

string

BodyalarmClearedNotificationrequired

Information of the clearance of a NS alarm.alarmClearedNotification

alarmClearedNotification

Name Description Schema

AlarmClearedNotificationoptional

This type represents an alarm cleared notification aboutVNF faults. The notification shall be triggered by the VNFMwhen an alarm has been cleared.

AlarmClearedNotification

AlarmClearedNotification


_linksrequired

Links to resources related to this notification. _links

alarmIdrequired

An identifier with the intention of being globally unique. string

2


idrequired


notificationTyperequired

Discriminator for the different notification types. Shall beset to "AlarmClearedNotification" for this notification type.

enum(AlarmClearedNotification)

subscriptionIdrequired


timeStamprequired

Date-time stamp. Representation: String formattedaccording to IETF RFC 3339.

string (date-time)

_links


alarmrequired

This type represents a link to a resource. alarm

subscriptionrequired

This type represents a link to a resource. subscription

alarm


hrefrequired

URI of the referenced resource. string (url)

subscription


hrefrequired


Responses

3

HTTPCode

Description Schema

204

204 No Content The notification was delivered successfully. Theresponse body shall be empty.Headers : WWW-Authenticate (string) : Challenge if the corresponding HTTPrequest has not provided authorization, or error details if thecorresponding HTTP request has provided an invalid authorizationtoken.

No Content

400

Bad Request Error: Invalid attribute-based filtering parameters. Theresponse body shall contain a ProblemDetails structure, in whichthe "detail" attribute should convey more information about theerror.Headers : Content-Type (string) : The MIME type of the body of the response.WWW-Authenticate (string) : Challenge if the corresponding HTTPrequest has not provided authorization, or error details if thecorresponding HTTP request has provided an invalid authorizationtoken.

Response 400

401

Unauthorized. If the request contains no access token even thoughone is required, or if the request contains an authorization tokenthat is invalid (e.g. expired or revoked), the API producer shouldrespond with this response. The details of the error shall bereturned in the WWW-Authenticate HTTP header, as defined in IETFRFC 6750 and IETF RFC 7235. The ProblemDetails structure may beprovided.Headers : Content-Type (string) : The MIME type of the body of the response.WWW-Authenticate (string) : Challenge if the corresponding HTTPrequest has not provided authorization, or error details if thecorresponding HTTP request has provided an invalid authorizationtoken.

Response 401

403

Forbidden If the API consumer is not allowed to perform aparticular request to a particular resource, the API producer shallrespond with this response code. The "ProblemDetails" structureshall be provided. It should include in the "detail" attributeinformation about the source of the problem, and may indicate howto solve it.Headers : Content-Type (string) : The MIME type of the body of the response.

Response 403

4

HTTPCode

Description Schema

500

Internal Server Error If there is an application error not related tothe client’s input that cannot be easily mapped to any other HTTPresponse code ("catch all error"), the API producer shall respondwiththis response code. The ProblemDetails structure shall beprovided, and shall include in the "detail" attribute moreinformation about the source of the problem.Headers : Content-Type (string) : The MIME type of the body of the response.

Response 500

503

Service Unavailable If the API producer encounters an internaloverload situation of itself or of a system it relies on, it shouldrespond with this response code, following the provisions in IETFRFC 7231 [13] for the use of the Retry-After HTTP header and for thealternative to refuse the connection. The "ProblemDetails" structuremay be omitted.Headers : Content-Type (string) : The MIME type of the body of the response.

Response 503

Response 400


detailrequired

A human-readable explanation specific to this occurrenceof the problem.

string

instanceoptional

A URI reference that identifies the specific occurrence ofthe problem. It may yield further information ifdereferenced.

string (URI)

statusoptional

The HTTP status code for this occurrence of the problem.The HTTP status code ([RFC7231], Section 6) generated bythe origin server for this occurrence of the problem.

integer

titleoptional

A short, human-readable summary of the problem type. Itshould not change from occurrence to occurrence of theproblem, except for purposes of localization. If type is givenand other than "about:blank", this attribute shall also beprovided. A short, human-readable summary of theproblem type. It SHOULD NOT change from occurrence tooccurrence of the problem, except for purposes oflocalization (e.g., using proactive content negotiation; see[RFC7231], Section 3.4).

string

5


typeoptional

A URI reference according to IETF RFC 3986 [5] thatidentifies the problem type. It is encouraged that the URIprovides human-readable documentation for the problem(e.g. using HTML) when dereferenced. When this memberis not present, its value is assumed to be "about:blank".

string (URI)

Response 401


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 403


detailrequired


string

6


instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 500


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

7


titleoptional


string

typeoptional


string (URI)

Response 503


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

8


typeoptional


string (URI)


POST /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification

Description


Parameters




string



string



string

Body

AlarmListRebuiltNotificationrequired

Information that the alarm list has been rebuiltby the NFVO.

AlarmListRebuiltNotification



AlarmListRebuiltNotificationoptional

This type represents a notification that the alarm list hasbeen rebuilt, e.g. if the VNFM detects its storage holding thealarm list is corrupted. The notification shall be triggeredby the VNFM when the alarm list has been rebuilt.



9


_linksrequired


idrequired



Discriminator for the different notification types. Shall beset to "AlarmListRebuiltNotification" for this notificationtype.

enum(AlarmListRebuiltNotification)



timeStamprequired


string (date-time)

_links


alarmsrequired

This type represents a link to a resource. alarms



alarms


hrefrequired


subscription


hrefrequired


Responses

10

HTTPCode

Description Schema

204


No Content

400


Response 400

401


Response 401

403


Response 403

11

HTTPCode

Description Schema

500


Response 500

503


Response 503

Response 400


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

12


typeoptional


string (URI)

Response 401


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 403


detailrequired


string

13


instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 500


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

14


titleoptional


string

typeoptional


string (URI)

Response 503


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

15


typeoptional


string (URI)

Test the notification endpoint

GET /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification

Description

The GET method allows the server to test the notification endpoint that is provided by the client,e.g. during subscription.

Parameters




string



string

Responses

HTTPCode

Description Schema

204

204 No Content The notification endpoint was tested successfully.The response body shall be empty.Headers : WWW-Authenticate (string) : Challenge if the corresponding HTTPrequest has not provided authorization, or error details if thecorresponding HTTP request has provided an invalid authorizationtoken.

No Content

16

HTTPCode

Description Schema

400


Response 400

401


Response 401

403


Response 403

500


Response 500

17

HTTPCode

Description Schema

503


Response 503

Response 400


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 401

18


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 403


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

19


titleoptional


string

typeoptional


string (URI)

Response 500


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

20


typeoptional


string (URI)

Response 503


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)


POST /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification

21

Description


Parameters




string



string



string

BodyalarmNotificationrequired

Information of a NS alarm. alarmNotification

alarmNotification


AlarmNotificationoptional

This type represents an alarm notification about NS faults. AlarmNotification

AlarmNotification


_linksrequired


alarmrequired

The alarm data type encapsulates information about analarm. It shall comply with the provisions defined in Table8.5.2.4-1

alarm

idrequired



Discriminator for the different notification types. Shall beset to "AlarmNotification" for this notification type.

enum(AlarmClearedNotification)

22




timeStamprequired


string (date-time)

_links


alarmrequired

This type represents a link to a resource. alarm



alarm


hrefrequired


subscription


hrefrequired


alarm


_linksrequired

Links for this resource. _links

ackStaterequired

Acknowledgment state of the alarm. Permitted values:UNACKNOWLEDGED ACKNOWLEDGED

enum(UNACKNOWLEDGED,ACKNOWLEDGED)

23


alarmChangedTimeoptional


string (date-time)

alarmClearedTimeoptional


string (date-time)

alarmRaisedTimerequired


string (date-time)

correlatedAlarmIdsoptional

List of identifiers of other alarms correlated to this fault. < string > array

eventTimerequired


string (date-time)

eventTyperequired

The enumeration EventType represents those types ofevents that trigger an alarm. - COMMUNICATIONS_ALARM:An alarm of this type is associated with the procedureand/or process required conveying information from onepoint to another (ITU-T Recommendation X.733). -PROCESSING_ERROR_ALARM: An alarm of this type isassociated with a software or processing fault (ITU-TRecommendation X.733). - ENVIRONMENTAL_ALARM: Analarm of this type is associated with a condition related toan enclosure in which the equipment resides (ITU-TRecommendation X.733). - QOS_ALARM: An alarm of thistype is associated with degradation in the quality of aservice (ITU-T Recommendation X.733). -EQUIPMENT_ALARM: An alarm of this type is associatedwith an equipment fault (ITU-T Recommendation X.733).

enum(COMMUNICATIONS_ALARM,PROCESSING_ERROR_ALARM,ENVIRONMENTAL_ALARM,QOS_ALARM,EQUIPMENT_ALARM)

faultDetailsoptional

Provides additional information about the fault.. string

faultTypeoptional

Additional information to clarify the type of the fault. string

idrequired


24


isRootCauserequired

Attribute indicating if this fault is the root for othercorrelated alarms. If TRUE, then the alarms listed in theattribute CorrelatedAlarmId are caused by this fault.

boolean

managedObjectIdrequired


perceivedSeverityrequired

Indicates the relative level of urgency for operatorattention. * CRITICAL: The Critical severity level indicatesthat a service affecting condition has occurred and animmediate corrective action is required. Such a severitycan be reported, for example, when a managed objectbecomes totally out of service and its capability needs to berestored (ITU-T Recommendation X.733). * MAJOR: TheMajor severity level indicates that a service affectingcondition has developed and an urgent corrective action isrequired. Such a severity can be reported, for example,when there is a severe degradation in the capability of themanaged object and its full capability needs to be restored(ITU-T Recommendation X.733). * MINOR: The Minorseverity level indicates the existence of a non-serviceaffecting fault condition and that corrective action shouldbe taken in order to prevent a more serious (for example,service affecting) fault. Such a severity can be reported, forexample, when the detected alarm condition is notcurrently degrading the capacity of the managed object(ITU-T Recommendation X.733). * WARNING: The Warningseverity level indicates the detection of a potential orimpending service affecting fault, before any significanteffects have been felt. Action should be taken to furtherdiagnose (if necessary) and correct the problem in order toprevent it from becoming a more serious service affectingfault (ITU-T Recommendation X.733). * INDETERMINATE:The Indeterminate severity level indicates that the severitylevel cannot be determined (ITU-T Recommendation X.733).* CLEARED: The Cleared severity level indicates theclearing of one or more previously reported alarms. Thisalarm clears all alarms for this managed object that havethe same Alarm type, Probable cause and Specific problems(if given) (ITU-T Recommendation X.733).

enum (CRITICAL,MAJOR, MINOR,WARNING,INDETERMINATE,CLEARED)

probableCauserequired

Information about the probable cause of the fault. string

25


rootCauseFaultyComponentrequired

This type represents the faulty component that has anegative impact on an NS. It shall comply with theprovisions defined in Table 8.5.3.4-1.

rootCauseFaultyComponent

rootCauseFaultyResourceoptional

This type represents the faulty virtual resources that have anegative impact on a NS.

rootCauseFaultyResource

_links


selfrequired

This type represents a link to a resource. self

self


hrefrequired




faultyNestedNsInstanceIdoptional


faultyNsVirtualLinkInstanceIdoptional


faultyResourceTypeoptional



26


faultyResourcerequired

This type represents the information that allows addressinga virtualised resource that is used by a VNF instance or byan NS instance. Information about the resource is availablefrom the VIM. The ResourceHandle type shall comply withthe provisions defined in Table 6.5.3.54-1..

faultyResource

faultyResourceTyperequired

The enumeration FaultyResourceType represents thosetypes of faulty resource. Acceptable values are: - COMPUTE- Virtual compute resource. - STORAGE - Virtual storageresource. - NETWORK - Virtual network resource.

enum (COMPUTE,STORAGE,NETWORK)

faultyResource


resourceIdrequired

An identifier maintained by the VIM or other resourceprovider. It is expected to be unique within the VIMinstance.

string

resourceProviderIdoptional


vimIdoptional


vimLevelResourceTypeoptional

Type of the resource in the scope of the VIM or the resourceprovider.

string

Responses

HTTPCode

Description Schema

204


No Content

27

HTTPCode

Description Schema

400


Response 400

401


Response 401

403


Response 403

500


Response 500

28

HTTPCode

Description Schema

503


Response 503

Response 400


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 401

29


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 403


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

30


titleoptional


string

typeoptional


string (URI)

Response 500


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

31


typeoptional


string (URI)

Response 503


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Query alarms related to NS instances.

GET /alarms

32

Description

Get Alarm List. The client can use this method to retrieve information about the alarm list.

Parameters




string



string

Queryfilteroptional

Attribute-based filtering parameters accordingto clause 4.3.2. The NFVO shall support receivingfiltering parameters as part of the URI querystring. The OSS/BSS may supply filteringparameters. The following attribute names shallbe supported in attribute-based filteringparameters: - id - nsInstanceId -rootCauseFaultyComponent.faultyNestedNsInstanceId -rootCauseFaultyComponent.faultyNsVirtualLinkInstanceId -rootCauseFaultyComponent.faultyVnfInstanceId- rootCauseFaultyResource.faultyResourceType -eventType - perceivedSeverity - probableCause

string

Responses

HTTPCode

Description Schema

200

200 OK The request has succeeded. The response body shall containthe list of related alarms.Headers : Content-Type (string) : The MIME type of the body of the response.WWW-Authenticate (string) : Challenge if the corresponding HTTPrequest has not provided authorization, or error details if thecorresponding HTTP request has provided an invalid authorizationtoken.

< Response 200 >array

33

HTTPCode

Description Schema

400


Response 400

401


Response 401

403


Response 403

405

Method Not Allowed If a particular HTTP method is not supportedfor a particular resource, the API producer shall respond with thisresponse code. The "ProblemDetails" structure may be omitted inthat case.Headers : Content-Type (string) : The MIME type of the body of the response.

Response 405

34

HTTPCode

Description Schema

406

If the "Accept" header does not contain at least one name of acontent type for which the NFVO can provide a representation of theNSD, the NFVO shall respond with this response code. The"ProblemDetails" structure may be included with the "detail"attribute providing more information about the error.Headers : Content-Type (string) : The MIME type of the body of the response.

Response 406

500


Response 500

503


Response 503

Response 200


Alarmoptional


Alarm

Alarm


_linksrequired


35


ackStaterequired





string (date-time)



string (date-time)



string (date-time)



eventTimerequired


string (date-time)

eventTyperequired





36


faultTypeoptional


idrequired


isRootCauserequired


boolean



37













38

_links


selfrequired


self


hrefrequired














faultyResource




faultyResource

39


resourceIdrequired


string



vimIdoptional




string

Response 400


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

40


typeoptional


string (URI)

Response 401


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 403


detailrequired


string

41


instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 405


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

42


titleoptional


string

typeoptional


string (URI)

Response 406


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

43


typeoptional


string (URI)

Response 500


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 503


detailrequired


string

44


instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Read individual alarm.

GET /alarms/{alarmId}

Description

The client can use this method to read an individual alarm.

Parameters




string



string

45




string

PathalarmIdrequired

Identifier of the alarm. This identifier can beretrieved from the "id" attribute of the "alarm"attribute in the AlarmNotification orAlarmClearedNotification. It can also beretrieved from the "id" attribute of theapplicable array element in the payload body ofthe response to a GET request to the "Alarms"resource.

string

Responses

HTTPCode

Description Schema

200

200 OK Information about an individual alarm was readsuccessfully. The response body shall contain a representation of theindividual alarm.Headers : Content-Type (string) : The MIME type of the body of the response.WWW-Authenticate (string) : Challenge if the corresponding HTTPrequest has not provided authorization, or error details if thecorresponding HTTP request has provided an invalid authorizationtoken.

Response 200

400


Response 400

46

HTTPCode

Description Schema

401


Response 401

403


Response 403

405


Response 405

406


Response 406

47

HTTPCode

Description Schema

500


Response 500

503


Response 503

Response 200


Alarmoptional


Alarm

Alarm


_linksrequired


ackStaterequired





string (date-time)

48




string (date-time)



string (date-time)



eventTimerequired


string (date-time)

eventTyperequired





faultTypeoptional


idrequired


isRootCauserequired


boolean

49












50





_links


selfrequired


self


hrefrequired














faultyResource

51





faultyResource


resourceIdrequired


string



vimIdoptional




string

Response 400


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

52


titleoptional


string

typeoptional


string (URI)

Response 401


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

53


typeoptional


string (URI)

Response 403


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 405


detailrequired


string

54


instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 406


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

55


titleoptional


string

typeoptional


string (URI)

Response 500


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

56


typeoptional


string (URI)

Response 503


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Acknowledge individual alarm.

PATCH /alarms/{alarmId}

57

Description

Acknowledge Alarm This method modifies an individual alarm resource.

Parameters




string



string


The Content-Type header shall be set to"application/merge-patch+json" according toIETF RFC 7396.

enum(application/merge-patch+json)

PathalarmIdrequired

Identifier of the alarm. This identifier can beretrieved from the "id" attribute of the "alarm"attribute in the AlarmNotification orAlarmClearedNotification. It can also beretrieved from the "id" attribute of theapplicable array element in the payload body ofthe response to a GET request to the "Alarms"resource.

string

Bodybodyrequired

body

body


AlarmModificationsrequired

This type represents attribute modifications for an"Individual alarm" resource, i.e. modifications to a resourcerepresentation based on the "Alarm" data type. Theattributes of "Alarm" that can be modified according to theprovisions in clause 8.5.2.4 are included in the"AlarmModifications" data type. The "AlarmModifications"data type shall comply with the provisions defined in Table8.5.2.8-1.

AlarmModifications

AlarmModifications

58


ackStaterequired

New value of the "ackState" attribute in "Alarm". Permittedvalues: - ACKNOWLEDGED

enum(ACKNOWLEDGED)

Responses

HTTPCode

Description Schema

200

200 OK The request was accepted and completed. The response bodyshall contain attribute modifications for an 'Individual alarm'resource (see clause 8.5.2.4).Headers : Content-Type (string) : The MIME type of the body of the response.WWW-Authenticate (string) : Challenge if the corresponding HTTPrequest has not provided authorization, or error details if thecorresponding HTTP request has provided an invalid authorizationtoken.

Response 200

400


Response 400

401


Response 401

59

HTTPCode

Description Schema

403


Response 403

405


Response 405

406


Response 406

409

Conflict Error: The operation cannot be executed currently, due to aconflict with the state of the "Individual alarm" resource. Typically,this is due to the fact that the alarm is already in the state that isrequested to be set (such as trying to acknowledge an already-acknowledged alarm). The response body shall contain aProblemDetails structure, in which the "detail" attribute shallconvey more information about the error.Headers : Content-Type (string) : The MIME type of the body of the response.WWW-Authenticate (string) : Challenge if the corresponding HTTPrequest has not provided authorization, or error details if thecorresponding HTTP request has provided an invalid authorizationtoken.

Response 409

60

HTTPCode

Description Schema

412

Precondition Failed. Error: A precondition given in an HTTP requestheader is not fulfilled. Typically, this is due to an ETag mismatch,indicating that the resource was modified by another entity. Theresponse body should contain a ProblemDetails structure, in whichthe "detail" attribute should convey more information about theerror.Headers : Content-Type (string) : The MIME type of the body of the response.

Response 412

500


Response 500

503


Response 503

Response 200


AlarmModificationsoptional

This type represents attribute modifications for an"Individual alarm" resource, i.e. modifications to a resourcerepresentation based on the "Alarm" data type. Theattributes of "Alarm" that can be modified according to theprovisions in clause 8.5.2.4 are included in the"AlarmModifications" data type. The "AlarmModifications"data type shall comply with the provisions defined in Table8.5.2.8-1.

AlarmModifications

AlarmModifications

61


ackStaterequired

New value of the "ackState" attribute in "Alarm". Permittedvalues: - ACKNOWLEDGED

enum(ACKNOWLEDGED)

Response 400


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 401


detailrequired


string

instanceoptional


string (URI)

62


statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 403


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

63


typeoptional


string (URI)

Response 405


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 406


detailrequired


string

64


instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 409


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

65


titleoptional


string

typeoptional


string (URI)

Response 412


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

66


typeoptional


string (URI)

Response 500


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 503


detailrequired


string

67


instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Subscribe to alarms related to NSs.

POST /subscriptions

Description

The POST method creates a new subscription. This method shall follow the provisions specified inthe Tables 8.4.4.3.1-1 and 8.4.4.3.1-2 for URI query parameters, request and response datastructures, and response codes. Creation of two subscription resources with the same callbackURIand the same filter can result in performance degradation and will provide duplicates ofnotifications to the OSS, and might make sense only in very rare use cases. Consequently, the NFVOmay either allow creating a subscription resource if another subscription resource with the samefilter and callbackUri already exists (in which case it shall return the "201 Created" response code),or may decide to not create a duplicate subscription resource (in which case it shall return a "303See Other" response code referencing the existing subscription resource with the same filter andcallbackUri).

68

Parameters




string



string



string

Bodybodyrequired

body

body


FmSubscriptionRequestrequired

This type represents a subscription request related tonotifications about VNF faults.

FmSubscriptionRequest

FmSubscriptionRequest


authenticationoptional

Authentication parameters to conFigure the use ofAuthorization when sendingnotifications corresponding tothis subscription, as defined in clause 4.5.3.4. This attributeshall only be present if the subscriber requiresauthorization of notifications.

authentication

callbackUrirequired

The URI of the endpoint to send the notification to. string (url)

filteroptional

This type represents a subscription filter related tonotifications about NS faults. It shall comply with theprovisions defined in Table 8.5.3.2-1. At a particular nestinglevel in the filter structure, the following applies: Allattributes shall match in order for the filter to match(logical "and" between different filter attributes). If anattribute is an array, the attribute shall match if at least oneof the values in the array matches (logical "or" between thevalues of one filter attribute)..

filter

69

authentication


authTyperequired

Defines the types of Authentication / Authorization whichthe API consumer is willing to accept when receiving anotification. Permitted values: * BASIC: In every HTTPrequest to the notification endpoint, use HTTP Basicauthentication with the client credentials. *OAUTH2_CLIENT_CREDENTIALS: In every HTTP request tothe notification endpoint, use an OAuth 2.0 Bearer token,obtained using the client credentials grant type. *TLS_CERT: Every HTTP request to the notification endpointis sent over a mutually authenticated TLS session, i.e. notonly the server is authenticated, but also the client isauthenticated during the TLS tunnel setup.

< enum (BASIC,OAUTH2_CLIENT_CREDENTIALS,TLS_CERT) > array

paramsBasicoptional

Parameters for authentication/authorization using BASIC.Shall be present if authType is "BASIC" and the containedinformation has not been provisioned out of band. Shall beabsent otherwise.

paramsBasic

paramsOauth2ClientCredentialsoptional

Parameters for authentication/authorization usingOAUTH2_CLIENT_CREDENTIALS. Shall be present ifauthType is "OAUTH2_CLIENT_CREDENTIALS" and thecontained information has not been provisioned out ofband. Shall be absent otherwise.

paramsOauth2ClientCredentials

paramsBasic


passwordoptional

Password to be used in HTTP Basic authentication. Shall bepresent if it has not been provisioned out of band.

string

userNameoptional

Username to be used in HTTP Basic authentication. Shall bepresent if it has not been provisioned out of band.

string

paramsOauth2ClientCredentials

70


clientIdoptional

Client identifier to be used in the access token request ofthe OAuth 2.0 client credentials grant type. Shall be presentif it has not been provisioned out of band. The clientId andclientPassword passed in a subscription shall not be thesame as the clientId and clientPassword that are used toobtain authorization for API requests. Client credentialsmay differ between subscriptions. The value ofclientPassword should be generated by a random process.

string

clientPasswordoptional

Client password to be used in the access token request ofthe OAuth 2.0 client credentials grant type. Shall be presentif it has not been provisioned out of band. The clientId andclientPassword passed in a subscription shall not be thesame as the clientId and clientPassword that are used toobtain authorization for API requests. Client credentialsmay differ between subscriptions. The value ofclientPassword should be generated by a random process.

string

tokenEndpointoptional

String formatted according to IETF RFC 3986. string

filter


eventTypesoptional

Match VNF alarms with an event type listed in thisattribute.

< enum(COMMUNICATIONS_ALARM,PROCESSING_ERROR_ALARM,ENVIRONMENTAL_ALARM,QOS_ALARM,EQUIPMENT_ALARM) > array

faultyResourceTypesoptional

Match alarms related to NSs with a faulty resource typelisted in this attribute.

< enum (COMPUTE,STORAGE,NETWORK) > array

71


notificationTypesoptional

Match particular notification types. Permitted values: -AlarmNotification - AlarmClearedNotification -AlarmListRebuiltNotification.

< enum(AlarmNotification,AlarmClearedNotification,AlarmListRebuiltNotification) > array

nsInstanceSubscriptionFilteroptional

This type represents subscription filter criteria to match NSinstances. It shall comply with the provisions defined inTable 4.4.1.5-1.

nsInstanceSubscriptionFilter

perceivedSeveritiesoptional

Match VNF alarms with a perceived severity listed in thisattribute.

< enum (CRITICAL,MAJOR, MINOR,WARNING,INDETERMINATE,CLEARED) > array

probableCausesoptional

Match VNF alarms with a probable cause listed in thisattribute.

< string > array



nsInstanceIdsrequired

If present, match NS instances with an instance dentifierlisted in this attribute.

< string > array

nsInstanceNamesoptional

If present, match NS instances with a NS Instance Namelisted in this attribute.

< string > array

nsdIdsrequired

If present, match NS instances that were created based on aNSD identified by one of the nsdId values listed in thisattribute.

< string > array

pnfdIdsrequired

If present, match NS instances that contain PNFs that arerepresented by a PNFD identified by one of the pnfdIdvalues listed in this attribute.

< string > array

vnfdIdsrequired

If present, match NS instances that contain VNF instancesthat were created based on a VNFD identified by one of thevnfdId values listed in this attribute.

< string > array

72

Responses

HTTPCode

Description Schema

201

201 Created The subscription was created successfully. The responsebody shall contain a representation of the created subscriptionresource. The HTTP response shall include a "Location:" HTTPheader that points to the created subscription resource.Headers : Content-Type (string) : The MIME type of the body of theresponse.This header field shall be present if the response has anon-empty message body.WWW-Authenticate (string) : Challenge if the corresponding HTTPrequest has not provided authorization, or error details if thecorresponding HTTP request has provided an invalid authorizationtoken.

Response 201

303

See Other A subscription with the same callbackURI and the samefilter already exits and the policy of the NFVO is to not createredundant subscriptions. The HTTP response shall include a"Location" HTTP eader that contains the resource URI of the existingsubscription resource. The response body shall be empty.

No Content

400


Response 400

73

HTTPCode

Description Schema

401


Response 401

403


Response 403

405


Response 405

406


Response 406

74

HTTPCode

Description Schema

500


Response 500

503


Response 503

Response 201


FmSubscriptionoptional

This type represents a subscription related to notificationsabout VNF faults.

FmSubscription

FmSubscription


_linksrequired


callbackUrirequired


75


filteroptional


filter

idrequired


_links


selfrequired


self


hrefrequired


filter


eventTypesoptional






76













< string > array





< string > array



< string > array

nsdIdsrequired


< string > array

pnfdIdsrequired


< string > array

vnfdIdsrequired


< string > array

77

Response 400


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 401


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

78


titleoptional


string

typeoptional


string (URI)

Response 403


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

79


typeoptional


string (URI)

Response 405


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 406


detailrequired


string

80


instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 500


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

81


titleoptional


string

typeoptional


string (URI)

Response 503


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

82


typeoptional


string (URI)

Query multiple subscriptions.

GET /subscriptions

Description

Query Subscription Information The client can use this method to retrieve the list of activesubscriptions for alarms related to a NS subscribed by the client. It can be used e.g. forresynchronization after error situations. This method shall follow the provisions specified in theTables 8.4.4.3.2-1 and 8.4.4.3.2-2 for URI query parameters, request and response data structures,and response codes. Table 8.4.4.3.2-1: URI query parameters supported.

Parameters




string



string



string

Queryfilteroptional

Attribute-based filtering parameters accordingto clause 4.3.2. The NFVO shall support receivingfiltering parameters as part of the URI querystring. The OSS/BSS may supply filteringparameters. All attribute names that appear inthe FmSubscription and in data typesreferenced from it shall be supported inattribute-based filtering parameters.

string

Responses

83

HTTPCode

Description Schema

200

200 OK The list of subscriptions was queried successfully. Theresponse body shall contain the representations of all activesubscriptions of the functional block that invokes the method.Headers : Content-Type (string) : The MIME type of the body of the response.WWW-Authenticate (string) : Challenge if the corresponding HTTPrequest has not provided authorization, or error details if thecorresponding HTTP request has provided an invalid authorizationtoken.

< Response 200 >array

400

Bad Request Invalid attribute-based filtering parameters or Invalidattribute selector. It the request is malformed or syntacticallyincorrect (e.g. if the request URI contains incorrect queryparameters or a syntactically incorrect payload body), the APIproducer shall respond with this response code. The"ProblemDetails" structure shall be provided, and should include inthe "detail" attribute more information about the source of theproblem. If the request contains a malformed access token, the APIproducer should respond with this response. The details of the errorshall be returned in the WWW-Authenticate HTTP header, asdefined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetailsstructure may be provided. If there is an application error related tothe client’s input that cannot be easily mapped to any other HTTPresponse code ("catch all error"), the API producer shall respondwith this response code.The "ProblemDetails" structure shall beprovided, and shall include in the "detail" attribute moreinformation about the source of the problem.Headers : Content-Type (string) : The MIME type of the body of the response.WWW-Authenticate (string) : Challenge if the corresponding HTTPrequest has not provided authorization, or error details if thecorresponding HTTP request has provided an invalid authorizationtoken.

Response 400

84

HTTPCode

Description Schema

401


Response 401

403


Response 403

405


Response 405

406


Response 406

85

HTTPCode

Description Schema

412

Precondition Failed. Error: A precondition given in an HTTP requestheader is not fulfilled. Typically, this is due to an ETag mismatch,indicating that the resource was modified by another entity. Theresponse body should contain a ProblemDetails structure, in whichthe "detail" attribute should convey more information about theerror.Headers : Content-Type (string) : The MIME type of the body of the response.

Response 412

500


Response 500

503


Response 503

Response 200




FmSubscription

FmSubscription


_linksrequired


callbackUrirequired


86


filteroptional


filter

idrequired


_links


selfrequired


self


hrefrequired


filter


eventTypesoptional






87













< string > array





< string > array



< string > array

nsdIdsrequired


< string > array

pnfdIdsrequired


< string > array

vnfdIdsrequired


< string > array

88

Response 400


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 401


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

89


titleoptional


string

typeoptional


string (URI)

Response 403


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

90


typeoptional


string (URI)

Response 405


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 406


detailrequired


string

91


instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 412


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

92


titleoptional


string

typeoptional


string (URI)

Response 500


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

93


typeoptional


string (URI)

Response 503


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Read an individual subscription.

GET /subscriptions/{subscriptionId}

94

Description

Query Subscription Information The client can use this method for reading an individualsubscription for alarms related to NSs subscribed by the client. This method shall follow theprovisions specified in the Tables 8.4.5.3.2-1 and 8.4.5.3.2-2 for URI query parameters, request andresponse data structures, and response codes

Parameters




string



string



string

PathsubscriptionIdrequired

Identifier of this subscription. This identifier canbe retrieved from the resource referenced bythe "Location" HTTP header in the response to aPOST request creating a new subscriptionresource. It can also be retrieved from the "id"attribute in the payload body of that response.

string

Responses

HTTPCode

Description Schema

200

200 OK The operation has completed successfully. The responsebody shall contain a representation of the subscription resource.Headers : Content-Type (string) : The MIME type of the body of the request.Reference: IETF RFC 7231.WWW-Authenticate (string) : Challenge if the corresponding HTTPrequest has not provided authorization, or error details if thecorresponding HTTP request has provided an invalid authorizationtoken.

Response 200

95

HTTPCode

Description Schema

400


Response 400

401


Response 401

403


Response 403

405


Response 405

96

HTTPCode

Description Schema

406


Response 406

500


Response 500

503


Response 503

Response 200




FmSubscription

FmSubscription


_linksrequired


callbackUrirequired


97


filteroptional


filter

idrequired


_links


selfrequired


self


hrefrequired


filter


eventTypesoptional






98













< string > array





< string > array



< string > array

nsdIdsrequired


< string > array

pnfdIdsrequired


< string > array

vnfdIdsrequired


< string > array

99

Response 400


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 401


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

100


titleoptional


string

typeoptional


string (URI)

Response 403


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

101


typeoptional


string (URI)

Response 405


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 406


detailrequired


string

102


instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 500


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

103


titleoptional


string

typeoptional


string (URI)

Response 503


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

104


typeoptional


string (URI)

Terminate a subscription.

DELETE /subscriptions/{subscriptionId}

Description

Terminate Subscription

This method terminates an individual subscription.

Parameters




string

PathsubscriptionIdrequired

Identifier of this subscription. This identifier canbe retrieved from the resource referenced bythe "Location" HTTP header in the response to aPOST request creating a new subscriptionresource. It can also be retrieved from the "id"attribute in the payload body of that response.

string

Responses

HTTPCode

Description Schema

204

204 - No Content The subscription resource was deleted successfully.The response body shall be empty.Headers : WWW-Authenticate (string) : Challenge if the corresponding HTTPrequest has not provided authorization, or error details if thecorresponding HTTP request has provided an invalid authorizationtoken.

No Content

105

HTTPCode

Description Schema

400


Response 400

401


Response 401

403


Response 403

405


Response 405

106

HTTPCode

Description Schema

406


Response 406

500


Response 500

503


Response 503

Response 400


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

107


titleoptional


string

typeoptional


string (URI)

Response 401


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

108


typeoptional


string (URI)

Response 403


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 405


detailrequired


string

109


instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

Response 406


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

110


titleoptional


string

typeoptional


string (URI)

Response 500


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

111


typeoptional


string (URI)

Response 503


detailrequired


string

instanceoptional


string (URI)

statusoptional


integer

titleoptional


string

typeoptional


string (URI)

112

SOL005 - NS Fault Management Interface - Network... · Notify about NS alarms POST...

Documents

Transcript of SOL005 - NS Fault Management Interface - Network... · Notify about NS alarms POST...