NFVManoConfigurationAndInformationManagement_def.yaml

            Supported VNFD data formats.
          type: object
          properties:
            vnfdFormat:
              description: >
                Name of the VNFD format.

                Permitted values:
                  - TOSCA: The VNFD follows TOSCA definition, according to ETSI
                  GS NFV-SOL 001 standard.
                  - YANG: The VNFD follows YANG definition according to ETSI
                  GS NFV-SOL 006 standard.
              type: string
              enum:
                - TOSCA
                - YANG
            standardVersion:
              description: >
                Name and version of the standard the VNFD is compliant to. See note 1.
              $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Version"
          required:
            - vnfdFormat
            - standardVersion
        supportedNsdFormats:
          description: >
            Supported NSD data formats.
          type: object
          properties:
            nsdFormat:
              description: >
                Name of the NSD format.

                Permitted values:
                  - TOSCA: The VNFD follows TOSCA definition, according to ETSI
                  GS NFV-SOL 001 standard.
                  - YANG: The VNFD follows YANG definition according to ETSI
                  GS NFV-SOL 006 standard.
              type: string
              enum:
                - TOSCA
                - YANG
            standardVersion:
              description: >
                Name and version of the standard the NSD is compliant to. See note 1.
              $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Version"
          required:
            - nsdFormat
            - standardVersion

    VnfmSpecificInfo:
      description: >
        This type represents information attributes specific to a VNFM entity,
        and that can be relevant to more than one NFV-MANO service offered by a VNFM entity.
        * NOTE:	The information to be provided in this attribute shall relate to the specification and version
                of the specification. For instance, "ETSI GS NFV-SOL 001 (V2.5.1)".
      type: object
      required:
        - resoruceMgmtModeSupport
        - managedVnfInstanceInfos
        - supportedVnfdFormats
      properties:
        resoruceMgmtModeSupport:
          description: >
            The supported resource management modes of the VNFM.

            Permitted values:
              - DIRECT: The VNFM supports direct mode only.
              - INDIRECT: The VNFM supports indirect mode only.
              - BOTH: The VNFM supports both direct and indirect mode.
          type: string
          enum:
            - DIRECT
            - INDIRECT
            - BOTH
        managedVnfInstanceInfos:
          description: >
            The kinds of VNF instances that can be managed, e.g. to determine the
            compatibility of a VNF with certain VNFM according to the vnfmInfo
            attribute in the VNFD (see table 7.1.2.2-1 in ETSI GS NFV-IFA 011).
          type: array
          items:
            type: string
          minItems: 1
        supportedVnfdFormats:
          description: >
            Supported VNFD data formats.
          type: array
          items:
            type: object
            properties:
              vnfdFormat:
                description: >
                  Name of the VNFD format.

                  Permitted values:
                    - TOSCA: The VNFD follows TOSCA definition, according to ETSI
                    GS NFV-SOL 001 standard.
                    - YANG: The VNFD follows YANG definition according to ETSI
                    GS NFV-SOL 006 standard.
                type: string
                enum:
                  - TOSCA
                  - YANG
              standardVersion:
                description: >
                  Name and version of the standard the VNFD is compliant to. See note
                $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Version"
            required:
              - vnfdFormat
              - standardVersion
          minItems: 1

    VimSpecificInfo:
      description: >
        This type represents information attributes specific to a VIM entity,
        and that can be relevant to more than one NFV MANO service offered by
        a VIM entity. It shall comply with the provisions defined in table
        5.6.3.6-1.
        The present document version does not specify the support for
        "maximum number of virtualised resources (attribute "maxVirtualResourceNum")"
        as specified in clause 7.2.9.2 of ETSI GS NFV IFA 031 [1].

        NOTE:	Recommendations on appropriate algorithms and key lengths are given e.g.,
        in NIST Special Publication 800-57 Part 3 Revision 1 [i.26] or in documents
        related to local legislation.
      type: object
      required:
        - imageContainerFormats
        - imageDiskFormats
        - imageSignatureVerification
        - imageDigestAlgorithms
      properties:
        imageContainerFormats:
          description: >
            List of supported image container formats. Container format indicates whether a
            software image is in a file that also contains metadata about the actual software.
            Valid values are all values for "container_format" as defined in ETSI GS NFV-SOL 001
            [i.16] and all values for "container-format" as defined in ETSI GS NFV-SOL 006 [i.17].
          type: array
          items:
            type: string
        imageDiskFormats:
          description: >
            List of supported image disk formats. The Disk format of a software image is the format
            of the underlying disk image.
            Valid values are all values for "disk_format" as defined in ETSI GS NFV-SOL 001 [16] and
            all values of "disk-format" as defined in ETSI GS NFV-SOL 006 [i.17].
          type: array
          items:
            type: string
        imageSignatureVerification:
          description: >
            Information about the supported mechanisms, algorithms, and protocols for verifying the
            signature of software images.
          type: object
          required:
            - signatureVerificationAlgorithms
          properties:
            additionalVerificationCapabilities:
              description: >
                List of additional image signature verification capabilities. The "key" in the KeyValuePairs
                determines the name of the capability, and the "value" shall indicate whether or not the
                capability is enabled. Examples of capabilities can include performing a validation of the
                image’s signing certificate during the image signature verification.
              $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
            signatureVerificationAlgorithms:
              description: >
                List of algorithms for verifying the signature of software images that are supported by the VIM.
              type: array
              items:
                type: object
                required:
                  - algorithm
                  - keyLengths
                properties:
                  algorithm:
                    description: >
                      The name of the algorithm. Permitted values are: "RSA", "DSA", "ECDSA".
                    type: string
                  keyLengths:
                    description: >
                      List of supported key lengths of the algorithm. The key length indicates the number of bits,
                      such as “256”, “512”, etc. See note.
                    type: array
                    items:
                      type: string
                  additionalAlgParams:
                    description: >
                      Additional parameters specific to the signature verification algorithm.
                    $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
        imageDigestAlgorithms:
          description: >
            List of supported digest algorithms that can be used for digital signatures.
          type: array
          items:
            type: object
            required:
              - algorithm
              - keyLengths
            properties:
              algorithm:
                description: >
                  The name of the algorithm. Permitted values are: “SHA2“,“SHA3“.
                type: string
              keyLengths:
                description: >
                  List of supported key lengths of the algorithm. The key length indicates the number of bits,
                  such as “256”, “512”, etc. See note.
                type: array
                items:
                  type: string

    WimSpecificInfo:
      description: >
        This type represents information attributes specific to a WIM entity,
        and that can be relevant to more than one NFV MANO service offered by
        a WIM entity.
      type: object
      required:
        - maxMscsNums
        - maxMsncNum
        - mscsLayerProtocolSupport
      properties:
        maxMscsNums:
          description: >
            Maximum number of MSCS that the WIM can manage.
          type: object
          required:
            - numMscs
          properties:
            numMscs:
              description: >
                Maximum number of MSCS.
              type: integer
            criteriaNumMscs:
              description: >
                Reference criteria for derivation/computation of the referred maximum number of MSCS in
                attribute "numMscs". Shall be provided if specific criteria has been taken into account
                for deriving the referred number.
              $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
        maxMsncNum:
          description: >
            Maximum number of MSNC that the WIM can manage
          type: object
          required:
            - numMsnc
          properties:
            numMsnc:
              description: >
                Maximum number of MSNC..
              type: integer
            criteriaNumMsnc:
              description: >
                Reference criteria for derivation/computation of the referred maximum
                number of MSNC in attribute "numMsnc".
              $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
        mscsLayerProtocolSupport:
          description: >
            List of protocols of particular layers used to realize an MSCS
            that are supported by the WIM.

            Permitted values:
              - EVPN_BGP_MPLS: L2 MSCS realized by BGP MPLS-based Ethernet VPN (EVPN) as specified in IETF RFC 7432.
              - EVPN_VPWS: L2 MSCS realized by EVPN Virtual Private Wire Service (VPWS) as specified in IETF RFC 8214.
              - VPLS_BGP: L2 MSCS realized by Virtual Private LAN Service (VPLS) using BGP as specified
                in IETF RFC 4761 and IETF RFC.
              - VPLS_LDP_L2TP: L2 MSCS realized by VPLS using Label Distribution Protocol (LDP) Layer 2
                Tunnelling Protocol (L2TP) as specified in IETF RFC 4762 and IETF RFC 6074.
              - VPWS_LDP_L2TP: L2 MSCS realized by VPWS using LDP L2TP as specified in IETF RFC 6074.
              - BGP_IP_VPN: L3 MSCS realized by BGP/MPLS based IP VPN as specified in IETF RFC 4364.
          type: string
          enum:
            - EVPN_BGP_MPLS
            - EVPN_VPWS
            - VPLS_BGP
            - VPLS_LDP_L2TP
            - VPWS_LDP_L2TP
            - BGP_IP_VPN

    ManoEntityConfigurableParams:
      description: >
        This type represents list of parameters that can be configured on the
        NFV MANO functional entity.
      type: object
      required:
        - clockSyncs
        - defaultLogCompileBySizeValue
        - defaultLogCompileByTimerValue
      properties:
        clockSyncs:
          description: >
            Properties of the clock synchronization to be used by the NFV-MANO
            functional entity.

            The keys of the map, each of which identifies a particular ClockSyncInfo
            structure, are managed by the API consumer.
          type: object
          additionalProperties:
            $ref: "#/components/schemas/ClockSyncInfo"
          minItems: 1
        defaultLogCompileBySizeValue:
          description:
            Default value for the log compilation by size to be used.
          $ref: "../../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
        defaultLogCompileByTimerValue:
          description:
            Default value for the log compilation by timer to be used.
          $ref: "../../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"

    ConsumedManoInterfaceInfo:
      description: >
        This type represents an interface consumed by the producer NFV MANO
        functional entity from another peer functional entity.
        * NOTE 1:	The information to be provided in this attribute shall relate to the specification and its version.
                    For instance, "ETSI GS NFV-SOL 003 (V2.4.1)".
        * NOTE 2:	Due to the security sensitive information associated to the attribute, based on access control
                    policies, the API consumer might have read only, write only, read/write, or no access at all to
                    the attribute's value. In case the API consumer is not allowed to read the value of the security
                    sensitive attribute, the attribute shall be omitted when the information is to be provided in a
                    response message, and shall be provided otherwise. In case the API consumer is not allowed to
                    modify the value of the security sensitive attribute, and the modification request includes new
                    attribute values, the whole modification request shall be rejected, and proper error information returned.
      type: object
      required:
        - id
        - name
        - type
        - standardVersion
        - apiVersion
        - apiEndpoint
      properties:
        name:
          description: >
            Human-readable name of the NFV-MANO interface.
          type: string
        type:
          description: >
            Type of the NFV-MANO service interface consumed by the NFV-MANO
            functional entity. Valid values are defined in clause 5.6.4.3.
          type: string
        standardVersion:
          description: >
            Version of the standard the interface is compliant to. See note 1.
          $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Version"
        apiVersion:
          description: >
            API version, in compliance with the version identifiers and parameters
            format specified in clause 9.1 of ETSI GS NFV-SOL 013.
          $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Version"
        apiEndpoint:
          description: >
            Consumable API endpoint of the interface.
            It provides the information relevant about the protocol, host and port,
            and path where the interface API can be accessed.
          type: object
          properties:
            apiRoot:
              description: >
                Indicates the scheme ("http" or "https"), the host name and optional
                port, and an optional sequence of path segments that together
                represent a prefix path. Shall be present for ETSI NFV specified
                RESTful NFV-MANO APIs (see also clause 4.1 of ETSI GS NFV-SOL 013).
                May be present otherwise.
              $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri"
            apiName:
              description: >
                Indicates the interface name in an abbreviated form. Shall be present
                for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each
                interface is defined in the standard the interface is compliant to
                (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.
              type: string
            apiMajorVersion:
              description: >
                Indicates the current major version of the API. Shall be present for
                ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined
                in the standard the interface is compliant to (see also clause 4.1
                of ETSI GS NFV-SOL 013). May be present otherwise.
              type: string
            apiUri:
              description: >
                URL of the API endpoint. For ETSI NFV specified RESTful NFV-MANO APIs,
                the following prefix structure is used (see also clause 4.1 of ETSI
                GS NFV-SOL 013): {apiRoot}/{apiName}/{apiMajorVersion}
              $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri"
          required:
            - apiUri
        securityInfo:
          description: >
            Security related information including credentials information if needed
            for consuming the API. See note 2.
          $ref: "#/components/schemas/ClientInterfaceSecurityInfo"

    CimNotificationsFilter:
      description: >
        This type represents a subscription filter related to notifications
        about NFV-MANO configuration and information management.
        * 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:
        manoEntitySubscriptionFilter:
          description: >
            Filter criteria to select the NFV-MANO functional entity and its
            associated managed objects.
          $ref: "../../components/SOL009_schemas.yaml#/components/schemas/ManoEntitySubscriptionFilter"
        notificationTypes:
          description: >
            Match particular notification types.

            Permitted values:
              - InformationChangedNotification
              - ChangeStateNotification

            See note.
          type: array
          items:
            type: string
            enum:
              - InformationChangedNotification
              - ChangeStateNotification

    ClockSyncInfo:
      description: >
        This type represents parameters for connecting to an NTP server.
        * NOTE:	Either ipAddress or hostname shall be set, but not both at the same time.
      type: object
      required:
        - type
      properties:
        type:
          description: >
            Type of clock synchronization.

            Permitted values:
              - NTP: For Network Time Protocol (NTP) based clock synchronization.
              - OTHER: For other types of clock synchronization.
          type: string
          enum:
            - NTP
            - OTHER
        ntpServerInfo:
          description: >
            Information for the NTP based clock synchronization. Shall be present if type = "NTP".
          type: object
          properties:
            ipAddress:
              description: >
                IP address of the NTP server. See note
              $ref: "../../components/SOL009_schemas.yaml#/components/schemas/IpAddress"
            hostname:
              description: >
                Indicates the hostname of the NTP server. See note.
              type: string
        otherClockSyncParams:
          description: >
            Information for the other types of clock synchronization.
            May be present if type = "OTHER".
          $ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"

    ServerInterfaceSecurityInfo:
      description: >
        This type represents security related information of an NFV-MANO
        service interface produced by an NFV-MANO functional entity.
        * NOTE:	Provided configuration of the OAuth 2.0 authorization server information and configuration
                shall be supported, and dynamic configuration may be supported.
      type: object
      required:
        - authType
        - oauthServerInfo
      properties:
        authType:
          description: >
            Type of API request authorization to be used by the API producer.

            The support of authorization methods for the API producer is specified
            in clause 8.3.6 of ETSI GS NFV-SOL 013.

            Permitted values:
              - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.
              - OAUTH2: Using access token, as defined by the OAuth 2.0 specification
              in IETF RFC 6749.
          type: array
          items:
            type: string
            enum:
              - TLS_TUNNEL
              - OAUTH2
          minItems: 1
        oauthServerInfo:
          description: >
            OAuth 2.0 authorization server information and configuration.
          type: object
          required:
            - providedConfiguration
            - tlsCipherSuites
          properties:
            dynamicDiscovery:
              description: >
                Configuration data used when performing dynamic discovery of
                the authorization server identifier. See note.
              type: object
              required:
                - webFingerHost
              properties:
                webFingerHost:
                  description: >
                    Server where the WebFinger service is hosted. When used,
                    the request to the WebFinger resource shall conform as specified
                    in clause 5.1.3 of ETSI GS NFV-SEC 022.
                  $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri"
            providedConfiguration:
              description: >
                Configuration data used to setup the authorization server identifier. See note.
              type: object
              required:
                - authServerId
              properties:
                authServerId:
                  description: >
                    Authorization server identifier as defined in ETSI GS NFV-SEC 022.
                  $ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri"
            tlsCipherSuites:
              description: >
                List of cipher suites that shall be declared as supported by the
                API producer when performing the SSL or TLS negotiation with the
                authorization server. Valid values of cipher suites are defined
                in IETF RFC 8447.
              type: array
              items:
                type: string
                minItems: 1
        tlsTunnelInfo:
          description: >
            Information and configuration related to the use of TLS tunnel.
            Shall be present if authType contains "TLS_TUNNEL".
          type: object
          properties:
            tlsTunnelCipherSuites:
              description: >
                List of cipher suites that shall be declared as supported by the API
                producer when performing the SSL or TLS negotiation with the API client.
                Valid values of cipher suites are defined in IETF RFC 8447.
              type: array
              items:
                type: string
              minItems: 1
          required:
            - tlsTunnelCipherSuites

    ClientInterfaceSecurityInfo:
      description: >
        This type represents security related information for accessing an NFV-MANO
        service interface produced by an NFV-MANO functional entity.
        * NOTE:	Provided configuration of the OAuth 2.0 authorization server information and configuration
                shall be supported, and dynamic configuration may be supported.
      type: object
      required:
        - authType
        - oauthServerInfo
      properties:
        authType:
          description: >
            Type of API request authorization to be used by the API consumer accessing
            the API.

            The support of authorization methods for the API consumer is specified in
            clause 8.3.6 of ETSI GS NFV-SOL 013.

            Permitted values:
            - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.
            - OAUTH2: Using access token, as defined by the OAuth 2.0 specification
            in IETF RFC 6749.
          type: array
          items:
            type: string
            enum:
              - TLS_TUNNEL
              - OAUTH2
          minItems: 1
        oauthServerInfo:
          description: >
            OAuth 2.0 authorization server information and configuration.
          type: object
          properties:
            dynamicDiscovery:
              description: >
                Configuration data used when performing dynamic discovery of the authorization
                server identifier. See note.
              type: object
              required:
                - webFingerHost
              properties:
                webFingerHost:
                  description: >
                    Server where the WebFinger service is hosted. When used, the request to
                    the WebFinger resource shall conform as specified in clause 5.1.3 of
                    ETSI GS NFV-SEC 022.
                  type: string
                  format: uri
            providedConfiguration:
              description: >
                Configuration data used to setup the authorization server identifier. See note.
              type: object
              required:
                - authServerId
              properties:
                authServerId:
                  description: >
                    Authorization server identifier as defined in ETSI GS NFV-SEC 022.
                  type: string
                  format: uri
            tlsCipherSuites:
              description: >
                List of cipher suites that shall be declared as supported by the API consumer when
                performing the SSL or TLS negotiation with the authorization server. Valid values
                of cipher suites are defined in IETF RFC 8447.
              type: array
              items:
                type: string
                minItems: 1
        tlsTunnelInfo:
          description: >
            Information and configuration related to the use of TLS tunnel. Shall be
            present if authType contains "TLS_TUNNEL".
          type: object
          properties:
            tlsTunnelCipherSuites:
              description: >
                List of cipher suites that shall be declared as supported by the API
                consumer when performing the SSL or TLS negotiation with the API producer.
                Valid values of cipher suites are defined in IETF RFC 8447.
              type: array
              items:
                type: string
                minItems: 1

    #referenced simple data types
    ManoServiceInterfaceTypeShortName:
      description: >
        For the RESTful NFV-MANO APIs, valid values are all values for "apiName" as defined
        in ETSI GS NFV-SOL 002, ETSI GS NFV-SOL 003, and ETSI GS NFV-SOL 005.

        For the NFV-MANO service interfaces for which no API is specified by ETSI NFV, valid
        values are defined in table 5.6.4.3-1.

        NOTE:	The table is expected to be updated, by removing the corresponding listed entries,
        once the interfaces are specified as a RESTful NFV-MANO API.
      type: string

    UsageStateEnumType:
      description: >
        The enumeration UsageStateEnumType defines values representing the usage
        state of a managed entity.
        The UsageStateEnumType shall comply with the provisions:
          - IN_USE	The managed entity is currently being used.
          - NOT_IN_USE	The managed entity is currently not being used.
      type: string
      enum:
        - IN_USE
        - NOT_IN_USE

    ChangeOperationalStateEnumType:
      description: >
        The enumeration ChangeOperationalStateEnumType defines permitted values
        for the change state operation.
        The ChangeOperationalStateEnumType shall comply with the provisions:
          - START	To start the managed entity.
          - STOP	To stop the managed entity.
          - RESTART	To stop and start again the managed entity.
      type: string
      enum:
        - START
        - STOP
        - RESTART

    ChangeAdministrativeStateEnumType:
      description: >
        The enumeration ChangeAdministrativeStateEnumType defines permitted values
        for the change of administrative state operation.
        The ChangeAdministrativeStateEnumType shall comply with the provisions:
          - LOCK	To lock the managed entity.
          - UNLOCK	To unlock the managed entity.
      type: string
      enum:
        - LOCK
        - UNLOCK

    InterfaceOperationalStateEnumType:
      description: >
        The enumeration InterfaceOperationalStateEnumType defines values representing
        the operational state of an NFV-MANO service interface type of managed entity.
        The InterfaceOperationalStateEnumType shall comply with the provisions :
           - STARTED	The managed entity is operational.
           - STOPPED	The managed entity is not operational.
           - STOPPING	The managed entity is in the transition to stop.
           - STARTING	The managed entity is in the transition to start and become operational.
      type: string
      enum:
        - STARTED
        - STOPPED
        - STOPPING
        - STARTING

    StopEnumType:
      description: >
        The enumeration ChangeStateOpOccStateEnumType defines permitted values
        for the change state operation. It shall comply with the provisions:
          - GRACEFUL	To stop the managed entity immediately after accepting the request.
          - FORCEFUL	To stop the managed entity attempting to gracefully discharge the entity from service.
      type: string
      enum:
        - GRACEFUL
        - FORCEFUL

    ManoEntityEnumType:
      description: >
        The enumeration ManoEntityEnumType defines the permitted values to
        represent NFV-MANO functional entities. It shall comply with
        the provisions :
          - NFVO	The NFV-MANO functional entity is an NFVO.
          - VNFM	The NFV-MANO functional entity is a VNFM.
          - VIM	    The NFV-MANO functional entity is a VIM.
          - WIM     The NFV-MANO functional entity is a WIM.
      type: string
      enum:
        - NFVO
        - VNFM
        - VIM
        - WIM

    PeerEntityEnumType:
      description: >
        The enumeration PeerEntityEnumType defines the permitted values
        to represent peer functional entities. it shall complains with
        the provisions :
        - NFVO	The peer functional entity is an NFVO.
        - VNFM	The peer functional entity is a VNFM.
        - VIM	  The peer functional entity is a VIM.
        - WIM	  The peer functional entity is a WIM.
        - EM	  The peer functional entity is an EM.
        - OSS	  The peer functional entity is an OSS/BSS.
      type: string
      enum:
        - NFVO
        - VNFM
        - VIM
        - WIM
        - EM
        - OSS