Skip to content
SOL003-VNFLifecycleManagement-API.yaml 1.7 MiB
Newer Older
mengxuan.zhao's avatar
mengxuan.zhao committed
swagger: '2.0'
info:
  version: 1.1.1
  title: SOL003 - VNF Lifecycle Management interface
  description: >
    SOL003 - VNF Lifecycle Management interface definition


    IMPORTANT: Please note that this file might be not aligned to the current
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.


    In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering
    mechanism is defined. This mechanism is currently not included in the
    corresponding OpenAPI design for this GS version. Changes to the
    attribute-based filtering mechanism are being considered in v2.5.1 of this
    GS for inclusion in the corresponding future ETSI NFV OpenAPI design.

    Please report bugs to
    https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
  license:
    name: ETSI Forge copyright notice
    url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
externalDocs:
  description: ETSI GS NFV-SOL 003 V2.4.1
  url: >-
    http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.04.01_60/gs_NFV-SOL003v020401p.pdf
basePath: /vnflcm/v1
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  /vnf_instances:
    post:
      description: |
        Create VNF Identifier

        The POST method creates a new VNF instance resource.
      parameters:
        - name: createVnfRequest
          description: The VNF creation parameters
          in: body
          required: true
          schema:
            type: object
            required:
              - vnfdId
            properties:
              vnfdId:
                description: |
                  An identifier with the intention of being globally unique.
                type: string
              vnfInstanceName:
                description: |
                  Human-readable name of the VNF instance to be created.
                type: string
              vnfInstanceDescription:
                description: |
                  Human-readable description of the VNF instance to be created.
                type: string
        - name: Accept
          description: >
            Content-Types that are acceptable for the response. Reference: IETF
            RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: |
            The authorization token for the request. Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        '201':
          description: A VNF Instance identifier was created successfully
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
          schema:
            description: |
              This type represents a VNF instance.
            type: object
            required:
              - id
              - vnfdId
              - vnfProvider
              - vnfProductName
              - vnfSoftwareVersion
              - vnfdVersion
              - vnfPkgId
              - instantiationState
            properties:
              id:
                description: |
                  An identifier with the intention of being globally unique.
                type: string
              vnfInstanceName:
                description: >
                  Name of the VNF instance. This attribute can be modified with
                  the PATCH method.
                type: string
              vnfInstanceDescription:
                description: >
                  Human-readable description of the VNF instance. This attribute
                  can be modified with the PATCH method.
                type: string
              vnfdId:
                description: |
                  An identifier with the intention of being globally unique.
                type: string
              vnfProvider:
                description: >
                  Provider of the VNF and the VNFD. The value is copied from the
                  VNFD.
                type: string
              vnfProductName:
                description: >
                  Name to identify the VNF Product. The value is copied from the
                  VNFD.
                type: string
              vnfSoftwareVersion:
                description: |
                  A Version.
                type: string
              vnfdVersion:
                description: |
                  A Version.
                type: string
              vnfPkgId:
                description: |
                  An identifier with the intention of being globally unique.
                type: string
              vnfConfigurableProperties:
                description: >
                  This type represents a list of key-value pairs. The order of
                  the pairs in the list is not significant. In JSON, a set of
                  key- value pairs is represented as an object. It shall comply
                  with the provisions  defined in clause 4 of IETF RFC 7159. 
                type: object
              vimConnectionInfo:
                description: >
                  Information about VIM connections to be used for managing the
                  resources for the VNF instance. This attribute shall only be
                  supported and present if VNF-related resource management in
                  direct mode is applicable. This attribute can be modified with
                  the PATCH method.
                type: array
                items:
                  description: >
                    This type represents parameters to connect to a VIM for
                    managing the resources of a VNF instance. This structure is
                    used to convey VIM-related parameters over the Or-Vnfm
                    interface. Additional parameters for a VIM may be configured
                    into the VNFM by means outside the scope of the present
                    document, and bound to the identifier of that VIM.
                  type: object
                  required:
                    - id
                    - vimType
                  properties:
                    id:
                      description: >
                        An identifier with the intention of being globally
                        unique.
                      type: string
                    vimId:
                      description: >
                        An identifier with the intention of being globally
                        unique.
                      type: string
                    vimType:
                      description: >
                        Discriminator for the different types of the VIM
                        information. The value of this attribute determines the
Loading full blame...