Loading src/SOL002/APIVersion/APIVersion.yaml +2 −2 Viewed Changes for src/SOL002/APIVersion/APIVersion.yaml: 2 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -19,8 +19,8 @@ info: version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 002 V3.6.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf description: ETSI GS NFV-SOL 002 V3.7.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.07.01_60/gs_NFV-SOL002v030701p.pdf paths: /vnfconfig/api_versions: Loading src/definitions/SOL002SOL003_def.yaml→src/SOL002/General_Definitions/SOL002_def.yaml +91 −134 Viewed File changed and moved.Preview size limit exceeded, changes collapsed. Show changes src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml +8 −18 Viewed Changes for src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml: 8 added lines, 18 removed lines. Original line number Diff line number Diff line Loading @@ -53,7 +53,7 @@ definitions: as "deleteIdList" as defined below this table. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" VnfConfiguration: description: > Loading Loading @@ -86,16 +86,11 @@ definitions: type: array items: $ref: '#/definitions/CpConfiguration' dhcpServer: description: > IP address of the DHCP server that the VNF instance can use to obtain IP addresses to be assigned to its external CPs. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' vnfSpecificData: description: > Additional configurable properties of the VNF instance declared in the VNFD as "VnfConfigurableProperties". see note. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs' VnfcConfigurationData: description: > Loading @@ -110,23 +105,18 @@ definitions: description: > Identifier of a VNFC instance to which this set of configuration data applies. The identifier references the "id" attribute in a "VnfcInfo" structure. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf' intCpConfig: description: > Configuration parameters for the internal CPs of the VNFC instance. type: array items: $ref: '#/definitions/CpConfiguration' dhcpServer: description: > IP address of the DHCP server that the VNF instance can use to obtain IP addresses to be assigned to its external CPs. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' vnfcSpecificData: description: > Additional configurable properties of the VNFC instance declared in the VNFD as "VnfcConfigurableProperties". See note. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs' CpConfiguration: description: > Loading @@ -140,11 +130,11 @@ definitions: cpId: description: > Identifier of a CP instance within the namespace of a specific VNF instance or a VNFC instance. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf' cpdId: description: > Identifier of the CPD in the VNFD. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnfd' addresses: description: > Network address and port assigned to the CP. Loading Loading @@ -177,11 +167,11 @@ definitions: macAddress: description: > Mac address. See NOTE 2. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/MacAddress' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/MacAddress' ipAddress: description: > IP address. See NOTE 2. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IpAddress' useDynamicAddress: description: > Set to true if an address shall be assigned dynamically. Otherwise set to false. Loading src/SOL002/VNFConfiguration/VNFConfiguration.yaml +37 −3 Viewed Changes for src/SOL002/VNFConfiguration/VNFConfiguration.yaml: 37 added lines, 3 removed lines. Original line number Diff line number Diff line Loading @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt version: 1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 002 V3.6.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf description: ETSI GS NFV-SOL 002 V3.7.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.07.01_60/gs_NFV-SOL002v030701p.pdf servers: - url: http://127.0.0.1/vnfconfig/v1 Loading Loading @@ -67,6 +67,9 @@ paths: patch: description: | This method sets or modifies a configuration resource. See clause 9.4.2.3.4. parameters: - $ref: ../../components/SOL002_params.yaml#/components/parameters/If-Unmodified-Since - $ref: ../../components/SOL002_params.yaml#/components/parameters/If-Match requestBody: $ref: '#/components/requestBodies/ConfigurationRequest' responses: Loading Loading @@ -137,6 +140,22 @@ components: explode: false schema: type: string ETag: description: > Used to provide the current entity-tag for the selected resource representation. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string Last-Modified: description: > Used to provide a timestamp indicating the date and time at which the server believes the selected resource representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string format: date-time content: application/json: schema: Loading @@ -160,6 +179,21 @@ components: explode: false schema: type: string ETag: description: > Used to provide the current entity-tag for the selected resource representation. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string Last-Modified: description: > Used to provide a timestamp indicating the date and time at which the server believes the selected resource representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string format: date-time content: application/json: schema: Loading src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml +240 −60 Viewed Changes for src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml: 240 added lines, 60 removed lines. Original line number Diff line number Diff line Loading @@ -4,8 +4,7 @@ definitions: Alarm: description: > The alarm data type encapsulates information about an alarm. It shall comply with the provisions defined in table 7.5.2.4-1. The alarm data type encapsulates information about an alarm. If the attribute "faultType" has the value "NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE", the following provisions apply for the values of the attribute "faultDetails" related to Loading Loading @@ -43,12 +42,12 @@ definitions: properties: id: description: > Identifier of this Alarm information element. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" Identifier of this Alarm. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" managedObjectId: description: > Identifier of the affected VNF instance. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" vnfcInstanceIds: description: > Identifiers of the affected VNFC instances. Each identifier references the Loading @@ -56,33 +55,33 @@ definitions: at least one VNFC instance. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf" rootCauseFaultyResource: description: > The virtualised resources that are causing the VNF fault. Shall be present if the alarm affects virtualised resources. See note 1. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FaultyResourceInfo" $ref: "#/definitions/FaultyResourceInfo" alarmRaisedTime: description: > Time stamp indicating when the alarm is raised by the managed object. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_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" $ref: "../../General_Definitions/SOL002_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" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" 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" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" ackState: description: > Acknowledgement state of the alarm. Loading @@ -96,15 +95,15 @@ definitions: perceivedSeverity: description: > Perceived severity of the managed object failure. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType" $ref: "#/definitions/PerceivedSeverityType" eventTime: description: > Time stamp indicating when the fault was observed. See note 2. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" eventType: description: > Type of event. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/EventType" $ref: "#/definitions/EventType" type: string faultType: description: > Loading @@ -128,13 +127,13 @@ definitions: 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. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Boolean" correlatedAlarmIds: description: > List of identifiers of other alarms correlated to this fault. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" faultDetails: description: > Provides additional information about the fault. See notes 1 and 2. Loading @@ -151,76 +150,257 @@ definitions: self: description: > URI of this resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" $ref: "../../General_Definitions/SOL002_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" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Link" AlarmNotification: PerceivedSeverityRequest: description: > This type represents the escalated value of the perceived severity for an alarm. type: object required: - proposedPerceivedSeverity properties: proposedPerceivedSeverity: description: > Indicates the proposed escalated perceived severity for an alarm. $ref: "#/definitions/PerceivedSeverityType" FmSubscriptionRequest: 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. 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. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Uri" authentication: description: > Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013. This attribute shall only be present if the subscriber requires authorization of notifications. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/SubscriptionAuthentication" FmSubscription: description: > This type represents a subscription related to notifications about VNF faults. type: object required: - id - notificationType - subscriptionId - timeStamp - alarm - callbackUri - _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: Identifier of this "Individual subscription" resource. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" filter: description: > Discriminator for the different notification types. Shall be set to "AlarmNotification" for this notification type. type: string enum: - AlarmNotification subscriptionId: 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: > Identifier of the subscription that this notification relates to. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" timeStamp: The URI of the endpoint to send the notification to. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Uri" _links: description: > Date-time of the generation of the notification. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" alarm: Links for this resource. type: object required: - self properties: self: description: > Information about an alarm including AlarmId, affected VNF identifier, and FaultDetails. $ref: "#/definitions/Alarm" _links: URI of this resource. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Link" AlarmModifications: description: > Links to resources related to this notification. 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 are included in the "AlarmModifications" data type. type: object required: - subscription - ackState properties: subscription: ackState: description: > Link to the related subscription. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink" New value of the "ackState" attribute in "Alarm". Permitted values: * ACKNOWLEDGED * UNACKNOWLEDGED type: string enum: - ACKNOWLEDGED - UNACKNOWLEDGED PerceivedSeverityRequest: EventType: description: > This type represents the escalated value of the perceived severity for an alarm. The enumeration EventType represents those types of events that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type is associated with the procedure and/or process required conveying information from one point to another (ITU-T Recommendation X.733). * PROCESSING_ERROR_ALARM: An alarm of this type is associated with a software or processing fault (ITU-T Recommendation X.733). * ENVIRONMENTAL_ALARM: An alarm of this type is associated with a condition related to an enclosure in which the equipment resides (ITU-T Recommendation X.733). * QOS_ALARM: An alarm of this type is associated with degradation in the quality of a service (ITU-T Recommendation X.733). * EQUIPMENT_ALARM: An alarm of this type is associated with an equipment 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 VNF. type: object required: - proposedPerceivedSeverity - faultyResource - faultyResourceType properties: proposedPerceivedSeverity: faultyResource: description: > Indicates the proposed escalated perceived severity for an alarm. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType" No newline at end of file Information that identifies the faulty resource instance and its managing entity. $ref: "../../General_Definitions/SOL002_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. type: string enum: - COMPUTE - STORAGE - NETWORK FmNotificationsFilter: description: > This type represents a subscription filter related to notifications about VNF faults. 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). NOTE: The permitted values of the "notificationTypes" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems. type: object properties: vnfInstanceSubscriptionFilter: description: > Filter criteria to select VNF instances about which to notify. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/VnfInstanceSubscriptionFilter" notificationTypes: description: > Match particular notification types. Permitted values: - AlarmNotification - AlarmClearedNotification - AlarmListRebuiltNotification See note. type: array items: type: string enum: - AlarmNotification - AlarmClearedNotification - AlarmListRebuiltNotification faultyResourceTypes: description: > Match VNF alarms 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 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 Loading
src/SOL002/APIVersion/APIVersion.yaml +2 −2 Viewed Changes for src/SOL002/APIVersion/APIVersion.yaml: 2 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -19,8 +19,8 @@ info: version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 002 V3.6.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf description: ETSI GS NFV-SOL 002 V3.7.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.07.01_60/gs_NFV-SOL002v030701p.pdf paths: /vnfconfig/api_versions: Loading
src/definitions/SOL002SOL003_def.yaml→src/SOL002/General_Definitions/SOL002_def.yaml +91 −134 Viewed File changed and moved.Preview size limit exceeded, changes collapsed. Show changes
src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml +8 −18 Viewed Changes for src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml: 8 added lines, 18 removed lines. Original line number Diff line number Diff line Loading @@ -53,7 +53,7 @@ definitions: as "deleteIdList" as defined below this table. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" VnfConfiguration: description: > Loading Loading @@ -86,16 +86,11 @@ definitions: type: array items: $ref: '#/definitions/CpConfiguration' dhcpServer: description: > IP address of the DHCP server that the VNF instance can use to obtain IP addresses to be assigned to its external CPs. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' vnfSpecificData: description: > Additional configurable properties of the VNF instance declared in the VNFD as "VnfConfigurableProperties". see note. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs' VnfcConfigurationData: description: > Loading @@ -110,23 +105,18 @@ definitions: description: > Identifier of a VNFC instance to which this set of configuration data applies. The identifier references the "id" attribute in a "VnfcInfo" structure. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf' intCpConfig: description: > Configuration parameters for the internal CPs of the VNFC instance. type: array items: $ref: '#/definitions/CpConfiguration' dhcpServer: description: > IP address of the DHCP server that the VNF instance can use to obtain IP addresses to be assigned to its external CPs. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' vnfcSpecificData: description: > Additional configurable properties of the VNFC instance declared in the VNFD as "VnfcConfigurableProperties". See note. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs' CpConfiguration: description: > Loading @@ -140,11 +130,11 @@ definitions: cpId: description: > Identifier of a CP instance within the namespace of a specific VNF instance or a VNFC instance. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf' cpdId: description: > Identifier of the CPD in the VNFD. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnfd' addresses: description: > Network address and port assigned to the CP. Loading Loading @@ -177,11 +167,11 @@ definitions: macAddress: description: > Mac address. See NOTE 2. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/MacAddress' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/MacAddress' ipAddress: description: > IP address. See NOTE 2. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IpAddress' useDynamicAddress: description: > Set to true if an address shall be assigned dynamically. Otherwise set to false. Loading
src/SOL002/VNFConfiguration/VNFConfiguration.yaml +37 −3 Viewed Changes for src/SOL002/VNFConfiguration/VNFConfiguration.yaml: 37 added lines, 3 removed lines. Original line number Diff line number Diff line Loading @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt version: 1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 002 V3.6.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf description: ETSI GS NFV-SOL 002 V3.7.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.07.01_60/gs_NFV-SOL002v030701p.pdf servers: - url: http://127.0.0.1/vnfconfig/v1 Loading Loading @@ -67,6 +67,9 @@ paths: patch: description: | This method sets or modifies a configuration resource. See clause 9.4.2.3.4. parameters: - $ref: ../../components/SOL002_params.yaml#/components/parameters/If-Unmodified-Since - $ref: ../../components/SOL002_params.yaml#/components/parameters/If-Match requestBody: $ref: '#/components/requestBodies/ConfigurationRequest' responses: Loading Loading @@ -137,6 +140,22 @@ components: explode: false schema: type: string ETag: description: > Used to provide the current entity-tag for the selected resource representation. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string Last-Modified: description: > Used to provide a timestamp indicating the date and time at which the server believes the selected resource representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string format: date-time content: application/json: schema: Loading @@ -160,6 +179,21 @@ components: explode: false schema: type: string ETag: description: > Used to provide the current entity-tag for the selected resource representation. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string Last-Modified: description: > Used to provide a timestamp indicating the date and time at which the server believes the selected resource representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string format: date-time content: application/json: schema: Loading
src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml +240 −60 Viewed Changes for src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml: 240 added lines, 60 removed lines. Original line number Diff line number Diff line Loading @@ -4,8 +4,7 @@ definitions: Alarm: description: > The alarm data type encapsulates information about an alarm. It shall comply with the provisions defined in table 7.5.2.4-1. The alarm data type encapsulates information about an alarm. If the attribute "faultType" has the value "NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE", the following provisions apply for the values of the attribute "faultDetails" related to Loading Loading @@ -43,12 +42,12 @@ definitions: properties: id: description: > Identifier of this Alarm information element. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" Identifier of this Alarm. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" managedObjectId: description: > Identifier of the affected VNF instance. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" vnfcInstanceIds: description: > Identifiers of the affected VNFC instances. Each identifier references the Loading @@ -56,33 +55,33 @@ definitions: at least one VNFC instance. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf" rootCauseFaultyResource: description: > The virtualised resources that are causing the VNF fault. Shall be present if the alarm affects virtualised resources. See note 1. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FaultyResourceInfo" $ref: "#/definitions/FaultyResourceInfo" alarmRaisedTime: description: > Time stamp indicating when the alarm is raised by the managed object. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_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" $ref: "../../General_Definitions/SOL002_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" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" 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" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" ackState: description: > Acknowledgement state of the alarm. Loading @@ -96,15 +95,15 @@ definitions: perceivedSeverity: description: > Perceived severity of the managed object failure. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType" $ref: "#/definitions/PerceivedSeverityType" eventTime: description: > Time stamp indicating when the fault was observed. See note 2. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" eventType: description: > Type of event. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/EventType" $ref: "#/definitions/EventType" type: string faultType: description: > Loading @@ -128,13 +127,13 @@ definitions: 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. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Boolean" correlatedAlarmIds: description: > List of identifiers of other alarms correlated to this fault. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" faultDetails: description: > Provides additional information about the fault. See notes 1 and 2. Loading @@ -151,76 +150,257 @@ definitions: self: description: > URI of this resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" $ref: "../../General_Definitions/SOL002_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" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Link" AlarmNotification: PerceivedSeverityRequest: description: > This type represents the escalated value of the perceived severity for an alarm. type: object required: - proposedPerceivedSeverity properties: proposedPerceivedSeverity: description: > Indicates the proposed escalated perceived severity for an alarm. $ref: "#/definitions/PerceivedSeverityType" FmSubscriptionRequest: 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. 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. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Uri" authentication: description: > Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013. This attribute shall only be present if the subscriber requires authorization of notifications. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/SubscriptionAuthentication" FmSubscription: description: > This type represents a subscription related to notifications about VNF faults. type: object required: - id - notificationType - subscriptionId - timeStamp - alarm - callbackUri - _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: Identifier of this "Individual subscription" resource. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" filter: description: > Discriminator for the different notification types. Shall be set to "AlarmNotification" for this notification type. type: string enum: - AlarmNotification subscriptionId: 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: > Identifier of the subscription that this notification relates to. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" timeStamp: The URI of the endpoint to send the notification to. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Uri" _links: description: > Date-time of the generation of the notification. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" alarm: Links for this resource. type: object required: - self properties: self: description: > Information about an alarm including AlarmId, affected VNF identifier, and FaultDetails. $ref: "#/definitions/Alarm" _links: URI of this resource. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Link" AlarmModifications: description: > Links to resources related to this notification. 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 are included in the "AlarmModifications" data type. type: object required: - subscription - ackState properties: subscription: ackState: description: > Link to the related subscription. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink" New value of the "ackState" attribute in "Alarm". Permitted values: * ACKNOWLEDGED * UNACKNOWLEDGED type: string enum: - ACKNOWLEDGED - UNACKNOWLEDGED PerceivedSeverityRequest: EventType: description: > This type represents the escalated value of the perceived severity for an alarm. The enumeration EventType represents those types of events that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type is associated with the procedure and/or process required conveying information from one point to another (ITU-T Recommendation X.733). * PROCESSING_ERROR_ALARM: An alarm of this type is associated with a software or processing fault (ITU-T Recommendation X.733). * ENVIRONMENTAL_ALARM: An alarm of this type is associated with a condition related to an enclosure in which the equipment resides (ITU-T Recommendation X.733). * QOS_ALARM: An alarm of this type is associated with degradation in the quality of a service (ITU-T Recommendation X.733). * EQUIPMENT_ALARM: An alarm of this type is associated with an equipment 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 VNF. type: object required: - proposedPerceivedSeverity - faultyResource - faultyResourceType properties: proposedPerceivedSeverity: faultyResource: description: > Indicates the proposed escalated perceived severity for an alarm. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType" No newline at end of file Information that identifies the faulty resource instance and its managing entity. $ref: "../../General_Definitions/SOL002_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. type: string enum: - COMPUTE - STORAGE - NETWORK FmNotificationsFilter: description: > This type represents a subscription filter related to notifications about VNF faults. 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). NOTE: The permitted values of the "notificationTypes" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems. type: object properties: vnfInstanceSubscriptionFilter: description: > Filter criteria to select VNF instances about which to notify. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/VnfInstanceSubscriptionFilter" notificationTypes: description: > Match particular notification types. Permitted values: - AlarmNotification - AlarmClearedNotification - AlarmListRebuiltNotification See note. type: array items: type: string enum: - AlarmNotification - AlarmClearedNotification - AlarmListRebuiltNotification faultyResourceTypes: description: > Match VNF alarms 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 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