SOL002VNFPerformanceManagement_def.yaml

# 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: "../../General_Definitions/SOL002_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: "../../General_Definitions/SOL002_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: "../../General_Definitions/SOL002_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: "../../General_Definitions/SOL002_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