# Copyright (c) ETSI 2017. # https://forge.etsi.org/etsi-forge-copyright-notice.txt definitions: CreateThresholdRequest: description: > This type represents a request to create a threshold. type: object required: - objectType - objectInstanceId - criteria - callbackUri properties: objectType: description: > Type of the measured object. The applicable measured object type for a measurement is defined in clause 7.2 of ETSI GS NFV-IFA 027. type: string objectInstanceId: description: > Identifier of the VNF instance associated with this threshold. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" subObjectInstanceIds: description: > Identifiers of the sub-object instances of the measured object instance associated with this threshold. May be present if a sub-object is defined in clause 6.2 of ETSI GS NFV-IFA 027 for the related measured object type. If this attribute is absent and a sub-object is defined in clause 6.2 of ETSI GS NFV-IFA 027 for the measured object type, measurements will be taken for all sub-object instances of the measured object instance. type: array items: $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" criteria: description: > Criteria that define this threshold. $ref: "#/definitions/ThresholdCriteria" callbackUri: description: > The URI of the endpoint to send the notification to. $ref: "SOL002SOL003_def.yaml#/definitions/Uri" authentication: description: > Authentication parameters to configure the use of Authorization when sending notifications corresponding to this threshold, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013. This attribute shall only be present if the API consumer requires authorization of notifications. $ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication" CreatePmJobRequest: description: > This type represents a request to create a PM job. type: object required: - objectType - objectInstanceIds - criteria - callbackUri properties: objectType: description: > Type of the measured object. The applicable measured object type for a measurement is defined in clause 7.2 of ETSI GS NFV-IFA 027. type: string objectInstanceIds: description: > Identifiers of the measured object instances for which performance information is requested to be collected. type: array items: $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" subObjectInstanceIds: description: > Identifiers of the sub-object instances of the measured object instance for which performance information is requested to be collected. May be present if a sub-object is defined in clause 6.2 of ETSI GS NFV-IFA 027for the related measured object type. If this attribute is present, the cardinality of the "objectInstanceIds" attribute shall be 1. If this attribute is absent and a sub-object is defined in clause 6.2 of ETSI GS NFV IFA 027 for the related measured object type, measurements will be taken for all sub-object instances of the measured object instance. type: array items: $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" criteria: description: > Criteria of the collection of performance information. $ref: "#/definitions/PmJobCriteria" callbackUri: description: > The URI of the endpoint to send the notification to. $ref: "SOL002SOL003_def.yaml#/definitions/Uri" authentication: description: > Authentication parameters to configure the use of Authorization when sending notifications corresponding to this PM job, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013. This attribute shall only be present if the API consumer requires authorization of notifications. $ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication" CrossingDirectionType: type: string enum: - UP - DOWN PerformanceInformationAvailableNotification: description: > This notification informs the receiver that performance information is available. The notification shall be triggered by the VNFM when new performance information collected by a PM job is available. The periodicity of triggering this notification is influenced by the "reportingPeriod" attribute in the "PmJobCriteria" data structure. type: object required: - id - notificationType - timeStamp - pmJobId - objectType - objectInstanceId - _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: "SOL002SOL003_def.yaml#/definitions/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to "PerformanceInformationAvailableNotification" for this notification type. type: string enum: - PerformanceInformationAvailableNotification timeStamp: description: > Date and time of the generation of the notification. $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" pmJobId: description: > Identifier of the PM job for which performance information is available. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" objectType: description: > Type of the measured object. The applicable measured object type for a measurement is defined in clause 7.2 of ETSI GS NFV-IFA 027. type: string objectInstanceId: description: > Identifier of the measured object instance. as per clause 6.2 of ETSI GS NFV-IFA 027. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" subObjectInstanceIds: description: > Identifiers of the sub-object instances of the measured object instance for which the measurements have been taken. Shall be present if the related PM job has been set up to measure only a subset of all sub-object instances of the measured object instance and a sub-object is defined in clause 6.2 of ETSI GS NFV-IFA 027 for the related measured object type. Shall be absent otherwise. type: array items: $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" _links: description: > Links to resources related to this notification. type: object required: - pmJob - performanceReport properties: objectInstance: description: > Link to the resource representing the measured object instance to which the notification applies. Shall be present if the measured object instance information is accessible as a resource. $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" pmJob: description: > Link to the resource that represents the PM job for which performance information is available. $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" performanceReport: description: > Link from which the available performance information of data type "PerformanceReport" can be obtained. This link should point to an "Individual performance report" resource. $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" PerformanceReport: description: > This type defines the format of a performance report provided by the VNFM to the API consumer as a result of collecting performance information as part of a PM job. The type shall comply with the provisions defined in table 6.5.2.10-1. type: object required: - entries properties: entries: description: > List of performance information entries. Each performance report entry is for a given metric of a given object (i.e. VNF instance), but can include multiple collected values. type: array items: type: object required: - objectType - objectInstanceId - performanceMetric - performanceValue properties: objectType: description: > Type of the measured object. The applicable measured object type for a measurement is defined in clause 7.2 of ETSI GS NFV-IFA 027. type: string objectInstanceId: description: > Identifier of the measured object instance for which the performance metric is reported $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" subObjectInstanceId: description: > Identifier of the sub-object instance of the measured object (i.e. of the measured object instance) for which the performance metric is reported. Shall be present if this is required in clause 6.2 of ETSI GS NFV-IFA 027 for the related measured object type. The sub-object allows to structure the measured object but is not to be confused with sub-counters which allow to structure the measurement value. EXAMPLE: Measured object: VnfInstanceXYZ Sub-object: VnfcInstance1 Measurement: vCPU_utilization Sub-counters: vCPU utilization of each of the vCPUs of VnfcInstance1 (vCPU_utilization.vCPU1, vCPU_utilization.vCPU2, etc.). $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" performanceMetric: description: > Name of the metric collected. This attribute shall contain the related "Measurement Name" value as defined in clause 7.2 of ETSI GS NFV-IFA 027. type: string performanceValues: description: > List of performance values with associated timestamp. type: array items: type: object required: - timeStamp - value properties: timeStamp: description: > Time stamp indicating when the data has been collected. $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" value: description: > Value of the metric collected. The type of this attribute shall correspond to the related "Measurement Unit" as defined in clause 7.2. of ETSI GS NFV-IFA 027. type: object context: description: > Measurement context information related to the measured value. The set of applicable keys is defined per measurement in the related "Measurement Context" in clause 7.2 of ETSI GS NFV-IFA 027. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" PmJob: description: > This type represents a PM job. type: object required: - id - objectType - objectInstanceIds - criteria - callbackUri - _links properties: id: description: > Identifier of this PM job. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" objectType: description: > Type of the measured object. The applicable measured object type for a measurement is defined in clause 7.2 of ETSI GS NFV-IFA 027. type: string objectInstanceIds: description: > Identifiers of the measured object instances for which performance information is collected. type: array items: $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" subObjectInstanceIds: description: > Identifiers of the sub-object instances of the measured object instance for which performance information is requested to be collected. May be present if a sub-object is defined in clause 6.2 of ETSI GS NFV-IFA 027 for the related measured object type. If this attribute is present, the cardinality of the "objectInstanceIds" attribute shall be 1. If this attribute is absent and a sub-object is defined in clause 6.2 of ETSI GS NFV IFA 027 for the related measured object type, measurements will be taken for all sub-object instances of the measured object instance. type: array items: $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" criteria: description: > Criteria of the collection of performance information. $ref: "#/definitions/PmJobCriteria" callbackUri: description: > The URI of the endpoint to send the notification to. $ref: "SOL002SOL003_def.yaml#/definitions/Uri" reports: description: > Information about available reports collected by this PM job. type: object required: - href - readyTime properties: href: description: > The URI where the report can be obtained. type: string format: url readyTime: description: > The time when the report was made available. $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" expiryTime: description: > The time when the report will expire. $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" fileSize: description: > The size of the report file in bytes, if known. type: integer minimum: 0 maximum: 1024 # TODO: How to express unsigned int? # Done using min and max params to set a range for positive int. _links: description: > Links for this resource. type: object required: - self properties: self: description: > URI of this resource. $ref: "SOL002SOL003_def.yaml#/definitions/Link" objects: description: > Links to resources representing the measured object instances for which performance information is collected. Shall be present if the measured object instance information is accessible as a resource. type: array items: $ref: "SOL002SOL003_def.yaml#/definitions/Link" PmJobModifications: description: > This type represents modifications to a PM job. It shall comply with the provisions defined in table 6.5.2.12-1. type: object properties: callbackUri: description: > New value of the "callbackUri" attribute. The value "null" is not permitted. See note. $ref: "SOL002SOL003_def.yaml#/definitions/Uri" authentication: description: > New value of the "authentication" attribute, or "null" to remove the attribute. If present in a request body, these modifications shall be applied according to the rules of JSON Merge Patch. This attribute shall not be present in response bodies. At least one of the attributes defined in this type shall be present in request bodies. $ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication" PmJobCriteria: description: > Criteria of the collection of performance information. type: object required: - collectionPeriod - reportingPeriod properties: performanceMetric: description: > This defines the types of performance metrics for the specified object instances. Valid values are specified as "Measurement Name" values in clause 7.2 of ETSI GS NFV-IFA 027. At least one of the two attributes (performance metric or group) shall be present. type: array items: type: string performanceMetricGroup: description: > Group of performance metrics. A metric group is a pre-defined list of metrics, known to the API producer that it can decompose to individual metrics. Valid values are specified as "Measurement Group" values in clause 7.2 of ETSI GS NFV-IFA 027. At least one of the two attributes (performance metric or group) shall be present. type: array items: type: string collectionPeriod: description: > Specifies the periodicity at which the API producer will collect performance information. The unit shall be seconds. See notes 1 and 2. NOTE 1: At the end of each reportingPeriod, the API producer will inform the API consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period are reported together. NOTE 2: In particular when choosing short collection and reporting periods, the number of PM jobs that can be supported depends on the capability of the producing entity. type: integer minimum: 0 maximum: 1024 # TODO: How to express unsigned int? # Done using min and max params to set a range for positive int. reportingPeriod: description: > Specifies the periodicity at which the API producer will report to the API consumer about performance information. The unit shall be seconds. See notes 1 and 2. NOTE 1: At the end of each reportingPeriod, the API producer will inform the API consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period are reported together. NOTE 2: In particular when choosing short collection and reporting periods, the number of PM jobs that can be supported depends on the capability of the producing entity. type: integer minimum: 0 maximum: 1024 # TODO: How to express unsigned int? # Done using min and max params to set a range for positive int. reportingBoundary: description: > Identifies a time boundary after which the reporting will stop. The boundary shall allow a single reporting as well as periodic reporting up to the boundary. $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" Threshold: description: > This type represents a threshold. type: object required: - id - objectType - objectInstanceId - criteria - callbackUri - _links properties: id: description: > Identifier of this threshold resource. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" objectType: description: > Type of the measured object. The applicable measured object type for a measurement is defined in clause 7.2 of ETSI GS NFV-IFA 027. type: string objectInstanceId: description: > Identifier of the VNF instance associated with the threshold. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" subObjectInstanceIds: description: > Identifiers of the sub-object instances of the measured object instance associated with the threshold. May be present if a sub-object is defined in clause 6.2 of ETSI GS NFV-IFA 027 for the related measurement type. If this attribute is absent and a sub-object is defined in clause 6.2 of ETSI GS NFV-IFA 027 for the related measured object type, measurements will be taken for all sub-object instances of the measured object instance. type: array items: $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" criteria: description: > Criteria that define this threshold. $ref: "#/definitions/ThresholdCriteria" callbackUri: description: > The URI of the endpoint to send the notification to. $ref: "SOL002SOL003_def.yaml#/definitions/Uri" _links: description: > Links for this resource. type: object required: - self properties: self: description: > URI of this resource. $ref: "SOL002SOL003_def.yaml#/definitions/Link" object: description: > Link to a resource representing the measured object instance for which performance information is collected. Shall be present if the measured object instance information is accessible as a resource. $ref: "SOL002SOL003_def.yaml#/definitions/Link" ThresholdModifications: description: > This type represents modifications to a threshold. It shall comply with the provisions defined in table 6.5.2.11-1. type: object properties: callbackUri: description: > New value of the "callbackUri" attribute. The value "null" is not permitted. See note. $ref: "SOL002SOL003_def.yaml#/definitions/Uri" authentication: description: > New value of the "authentication" attribute, or "null" to remove the attribute. If present in a request body, these modifications shall be applied according to the rules of JSON Merge Patch. This attribute shall not be present in response bodies. At least one of the attributes defined in this type shall be present in request bodies. $ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication" ThresholdCriteria: description: > This type represents criteria that define a threshold. type: object required: - performanceMetric - thresholdType properties: performanceMetric: description: > Defines the performance metric associated with the threshold. Valid values are specified as "Measurement Name" values in clause 7.2 of ETSI GS NFV-IFA 027. type: string thresholdType: description: > Type of threshold. This attribute determines which other attributes are present in the data structure. Permitted values: * SIMPLE: Single-valued static threshold In the present document, simple thresholds are defined. The definition of additional threshold types is left for future specification. type: string enum: - SIMPLE simpleThresholdDetails: description: > Details of a simple threshold. Shall be present if thresholdType="SIMPLE". type: object required: - thresholdValue - hysteresis properties: thresholdValue: description: > The threshold value. Shall be represented as a floating point number. # TODO: This should be floating. # Done using Number type and floating formate type: number format: float hysteresis: description: > The hysteresis of the threshold. Shall be represented as a non-negative floating point number. A notification with crossing direction "UP" will be generated if the measured value reaches or exceeds "thresholdValue" + "hysteresis". A notification with crossing direction "DOWN" will be generated if the measured value reaches or undercuts "thresholdValue" - "hysteresis". The hysteresis is defined to prevent storms of threshold crossing notifications. When processing a request to create a threshold, implementations should enforce a suitable minimum value for this attribute (e.g. override the value or reject the request). # TODO: This should be floating. # Done using Number type and floating format. type: number minimum: 0 maximum: 1024 format: float ThresholdCrossedNotification: description: > This type represents a notification that is sent when a threshold has been crossed. The timing of sending this notification is determined by the capability of the producing entity to evaluate the threshold crossing condition. The notification shall be triggered by the VNFM when a threshold has been crossed. type: object required: - id - notificationType - timeStamp - thresholdId - crossingDirection - objectType - objectInstanceId - performanceMetric - performanceValue - _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: "SOL002SOL003_def.yaml#/definitions/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to "ThresholdCrossedNotification" for this notification type. type: string enum: - ThresholdCrossedNotification timeStamp: description: > Date and time of the generation of the notification. $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" thresholdId: description: > Identifier of the threshold which has been crossed. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" crossingDirection: description: > An indication of whether the threshold was crossed in upward or downward direction. $ref: "#/definitions/CrossingDirectionType" objectType: description: > Type of the measured object. The applicable measured object type for a measurement is defined in clause 7.2 of ETSI GS NFV-IFA 027. type: string objectInstanceId: description: > Identifier that identifies a VNF instance. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" subObjectInstanceId: description: > Identifier of the sub-object of the measured object (i.e. a VNFC instance) to which the measurement applies. Shall be present if this is required in an external measurement specification. The sub-object allows to structure the measured object, but is not to be confused with sub-counters which allow to structure the measurement. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" performanceMetric: description: > Performance metric associated with the threshold. This attribute shall contain the related "Measurement Name" value as defined in clause 7.2 of ETSI GS NFV-IFA 027. type: string performanceValue: description: > Value of the metric that resulted in threshold crossing. The type of this attribute shall correspond to the related "Measurement Unit" as defined in clause 7.2 of ETSI GS NFV-IFA 027. type: object context: description: > Measurement context information related to the measured value. The set of applicable keys is defined per measurement in the related "Measurement Context" in clause 7.2 of ETSI GS NFV-IFA 027. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" _links: description: > Links to resources related to this notification. type: object required: - threshold properties: objectInstance: description: > Link to the resource representing the measured object instance to which the notified change applies. Shall be present if the measured object instance information is accessible as a resource. $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" threshold: description: > Link to the resource that represents the threshold that was crossed. $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"