SOL005NSPerformanceManagement_def.yaml 25.2 KB
Newer Older
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
#  PmSubscriptionRequest:
#    description: >
#      This type represents a subscription request.
#    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/PmNotificationsFilter"
#      callbackUri:
#        description: >
#          The URI of the endpoint to send the notification to.
#        $ref: "../../definitions/SOL005_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: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
#
#  PmSubscription:
#    description: >
#      This type represents a subscription.
#    type: object
#    required:
#      - id
#      - callbackUri
#      - _links
#    properties:
#      id:
#        description: >
#          Identifier that identifies the subscription.
#        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
#      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/PmNotificationsFilter"
#      callbackUri:
#        description: >
#          The URI of the endpoint to send the notification to.
#        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
#      _links:
#        description: >
#          Links to resources related to this resource.
#        type: object
#        required:
#          - self
#        properties:
#          self:
#            description: >
#              URI of this resource.
#            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
  CreatePmJobRequest:
    description: >
      This type represents a request to create a PM job. 
      It shall comply with the provisions defined in Table 7.5.2.6-1.
    type: object
    required:
      objectType:
        description: >
          Type of the measured object.
          The applicable measured object type for a measurement
          is defined in clause 7.3 of ETSI GS NFV-IFA 027.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      objectInstanceIds:
        description: >
          Identifiers of the NS instances for which
          performance information is requested to be collected.
        type: "array"
          $ref: "../../definitions/SOL005_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: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
      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: "../../definitions/SOL005_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: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
  PmJob:
    description: >
      This type represents a PM job.
    type: object
    required:
      - id
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      objectType:
        description: >
          Type of the measured object.
          The applicable measured object type for a measurement
          is defined in clause 7.3 of ETSI GS NFV-IFA 027.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      objectInstanceIds:
        description: >
          Identifiers of the NS instances for which
          performance information is collected.
        type: array
        items:
          $ref: "../../definitions/SOL005_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: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
      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: "../../definitions/SOL005_def.yaml#/definitions/Uri"
      reports:
        description: >
          Information about available reports collected by this PM job.
        type: object
        required:
          - href
          - readyTime
          - _links
        properties:
          href:
            description: >
              The Uri where the report can be obtained.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
          readyTime:
            description: >
              The time when the report was made available.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
          expiryTime:
            description: >
              The time when the report will expire.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
          fileSize:
            description: >
              The size of the report file in bytes, if known.
          _links:
            description: >
              Links for this resource.
            type: object
            required:
              - self
            properties:
              self:
                description: >
                  URI of this resource.
                $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
                  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.
                  $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
  CreateThresholdRequest:
    description: >
      This type represents a request to create a threshold.
    type: object
    required:
      objectType:
        description: >
          Type of the measured object.
          The applicable measured object type for a measurement
          is defined in clause 7.3 of ETSI GS NFV-IFA 027.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
          Identifier of the NS instance associated with this threshold.
        $ref: "../../definitions/SOL005_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: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
      criteria:
        description: >
          Criteria that define this threshold.
        $ref: "#/definitions/ThresholdCriteria"
      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: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
  Threshold:
    description: >
      This type represents a threshold.
    type: object
      id:
        description: >
          Identifier of this threshold resource.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      objectType:
        description: >
          Type of the measured object.
          The applicable measured object type for a measurement
          is defined in clause 7.3 of ETSI GS NFV IFA 027.
          Identifier of the NS instance associated with the threshold.
        $ref: "../../definitions/SOL005_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
          n 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: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
      criteria:
        description: >
          Criteria that define this threshold.
        $ref: "#/definitions/ThresholdCriteria"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
          object:
            description: >
              Link to a resource representing the NS instance for
              which performance information is collected. Shall be
              present if the NS instance information is accessible as
              a resource.
  PerformanceReport:
    description: >
      This type defines the format of a performance report provided by the NFVO
      to the OSS/BSS as a result of collecting
      performance information as part of a PM job.
      The type shall comply with the provisions defined in Table 7.5.2.10-1.
piscione's avatar
piscione committed
      NOTE:	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.).

    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. NS 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.3 of ETSI GS NFV-IFA 027.
              $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
            objectInstanceId:
              description: >
                Identifier of the measured object instance for which
                the performance metric is reported.
              $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
            subObjectInstanceId:
              description: >
                Identifier of the sub-object instance of the measured object
                instance for which the performance metric is reported.
                Shall be present if this is required in clause 6.2 of
piscione's avatar
piscione committed
                ETSI GS NFV-IFA 027 for the related measured object type. See note.
              type: array
              items:
                $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
            performanceMetric:
              description: >
                Name of the metric collected. This attribute shall contain
                the related "Measurement Name" value as defined in clause
                7.3 of ETSI GS NFV-IFA 027.
              $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
            performanceValues:
              description: >
                List of performance values with associated timestamp.
              type: array
              items:
                type: object
                required:
                  - timeStamp
                  - performanceValue
                properties:
                  timeStamp:
                    description: >
                      Time stamp indicating when the data has been collected.
                    $ref: "../../definitions/SOL005_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.3 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.3 of ETSI GS NFV-IFA 027.
                    $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
  PmJobModifications:
      This type represents modifications to a PM job.
      It shall comply with the provisions defined in Table 7.5.2.12-1.
piscione's avatar
piscione committed
      NOTE:	At least one of the attributes defined in this type shall be present in request bodies.
    anyOf:
      - required:
        - callbackUri
      - required:
        - authentication
          New value of the "callbackUri" attribute. The value "null" is not permitted.
piscione's avatar
piscione committed
          See note.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
      authentication:
          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 (see IETF RFC 7396).
          This attribute shall not be present in response bodies.
piscione's avatar
piscione committed
          See note.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"

  ThresholdModifications:
    description: >
      This type represents modifications to a threshold.
      It shall comply with the provisions defined in Table 7.5.2.11-1.
piscione's avatar
piscione committed
      NOTE:	At least one of the attributes defined in this type shall be present in request bodies.
    anyOf:
      - required:
        - callbackUri
      - required:
        - authentication
    properties:
      callbackUri:
        description: >
          New value of the "callbackUri" attribute. The value "null" is not permitted.
piscione's avatar
piscione committed
          See note.
        $ref: "../../definitions/SOL005_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 (see IETF RFC 7396).
          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.
piscione's avatar
piscione committed
          See note.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"

#  PmNotificationsFilter:
#    description: >
#      This type represents a filter that can be used to subscribe for
#      notifications related to performance management events. It
#      shall comply with the provisions defined in Table 7.5.3.2-1.
#      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).
#    type: object
#    properties:
#      nsInstanceSubscriptionFilter:
#        description: >
#          Filter criteria to select NS instances about which to notify.
#        $ref: "../../definitions/SOL005_def.yaml#/definitions/NsInstanceSubscriptionFilter"
#      notificationTypes:
#        description: >
#          Match particular notification types.
#          Permitted values:
#          - ThresholdCrossedNotification
#          - PerformanceInformationAvailableNotification
#          The permitted values of the "notificationTypes" attribute are
#          spelled exactly as the names of the notification types to facilitate
#          automated code generation systems.
#        type: array
#        items:
#          type: string
#          enum:
#            - ThresholdCrossedNotification
#            - PerformanceInformationAvailableNotification
      This type represents collection criteria for PM jobs. 
      It shall comply with the provisions defined in Table 7.5.3.3-1.
piscione's avatar
piscione committed

      NOTE 1:	At the end of each reportingPeriod, the API producer
      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.

      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.
      reporting period are reported together.
          for the specified object instances. Valid values are specified
          as "Measurement Name" values in clause 7.3 of ETSI GS NFV-IFA 027.
          At least one of the two attributes (performance metric or group)
          shall be present.
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      performanceMetricGroup:
          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.3 of ETSI
          GS NFV-IFA 027. At least one of the two attributes
          (performance metric or group) shall be present.
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      collectionPeriod:
          Specifies the periodicity at which the API producer
          will collect performance information. The unit
piscione's avatar
piscione committed
          shall be seconds. See note 1 and note 2.
          Specifies the periodicity at which the API producer
          will report to the API consumer.
          about performance information. The unit shall be seconds.
piscione's avatar
piscione committed
          See note 1 and note 2.
          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: "../../definitions/SOL005_def.yaml#/definitions/DateTime"

  ThresholdCriteria:
    description: >
      This type represents criteria that define a threshold.
piscione's avatar
piscione committed
      NOTE 1:	In the present document, simple thresholds are defined.
      The definition of additional threshold types is left for future specification.
      NOTE 2:	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).
    type: object
    required:
      - performanceMetric
      - thresholdType
    properties:
          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 of threshold. This attribute determines which other attributes
          are present in the data structure.
          Permitted values:
          * SIMPLE: Single-valued static threshold
piscione's avatar
piscione committed
          See note 1.
          Details of a simple threshold. Shall be present if
          thresholdType="SIMPLE".
              The threshold value. Shall be represented as a floating point
              number.               
            type: integer
          hysteresis:
              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".
piscione's avatar
piscione committed
              See note 2.
            type: integer