Skip to content
Normal view History Permalink
SOL003-VNFLifecycleManagement-API.yaml 1.7 MiB
Newer Older
mengxuan.zhao's avatar
Progress on VNF LCM
mengxuan.zhao committed
11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 
              detail:
                description: >
                  A human-readable explanation specific to this occurrence of
                  the problem.
                type: string
              instance:
                description: >
                  A URI reference that identifies the specific occurrence of the
                  problem. It may yield further information if dereferenced.
                type: string
                format: URI
        '503':
          description: >
            Service Unavailable

            If the API producer encounters an internal overload situation of
            itself or of a system it relies on, it should respond with this
            response code, following the provisions in IETF RFC 7231 [13] for
            the use of the "Retry-After" HTTP header and for the alternative to
            refuse the connection. The "ProblemDetails" structure may be
            omitted.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
          schema:
            description: >
              The definition of the general "ProblemDetails" data structure from
              IETF RFC 7807 [19] is reproduced inthis structure. Compared to the
              general framework defined in IETF RFC 7807 [19], the "status" and
              "detail" attributes are mandated to be included by the present
              document, to ensure that the response contains additional textual
              information about an error. IETF RFC 7807 [19] foresees
              extensibility of the "ProblemDetails" type. It is possible that
              particular APIs in the present document, or particular
              implementations, define extensions to define additional attributes
              that provide more information about the error. The description
              column only provides some explanation of the meaning to Facilitate
              understanding of the design. For a full description, see IETF RFC
              7807 [19].
            type: object
            required:
              - status
              - detail
            properties:
              type:
                description: >
                  A URI reference according to IETF RFC 3986 [5] that identifies
                  the problem type. It is encouraged that the URI provides
                  human-readable documentation for the problem (e.g. using HTML)
                  when dereferenced. When this member is not present, its value
                  is assumed to be "about:blank".
                type: string
                format: URI
              title:
                description: >
                  A short, human-readable summary of the problem type. It should
                  not change from occurrence to occurrence of the problem,
                  except for purposes of localization. If type is given and
                  other than "about:blank", this attribute shall also be
                  provided. A short, human-readable summary of the problem
                  type.  It SHOULD NOT change from occurrence to occurrence of
                  the problem, except for purposes of localization (e.g., using
                  proactive content negotiation; see [RFC7231], Section 3.4).
                type: string
              status:
                description: >
                  The HTTP status code for this occurrence of the problem. The
                  HTTP status code ([RFC7231], Section 6) generated by the
                  origin server for this occurrence of the problem.
                type: integer
              detail:
                description: >
                  A human-readable explanation specific to this occurrence of
                  the problem.
                type: string
              instance:
                description: >
                  A URI reference that identifies the specific occurrence of the
                  problem. It may yield further information if dereferenced.
                type: string
                format: URI
  '/vnf_instances/{vnfInstanceId}/scale_to_level':
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be scaled to a target level. This
          identifier can be retrieved from the resource referenced by the
          "Location" HTTP header in the response to a POST request creating a
          new VNF instance resource. It can also be retrieved from the "id"
          attribute in the payload body of that response.
        in: path
        type: string
        required: true
    post:
      description: >
        Scale VNF to Level


        The POST method requests to scale a VNF instance resource to a target
        level.
      parameters:
        - name: ScaleVnfToLevelRequest
          description: Parameters for the scale VNF to Level operation.
          in: body
          required: true
          schema:
            description: >
              This type represents request parameters for the "Scale VNF to
              Level" operation.
            type: object
            properties:
              instantiationLevelId:
                description: |
                  An identifier that is unique within a VNF descriptor.
                type: string
              scaleInfo:
                description: >
                  For each scaling aspect of the current deployment flavour,
                  indicates the target scale level to which the VNF is to be
                  scaled. Either the instantiationLevelId attribute or the
                  scaleInfo attribute shall be included.
                type: array
                items:
                  required:
                    - aspectId
                    - scaleLevel
                  type: object
                  properties:
                    aspectId:
                      description: |
                        An identifier that is unique within a VNF descriptor.
                      type: string
                    scaleLevel:
                      description: >
                        Indicates the scale level. The minimum value shall be 0
                        and the maximum value shall be <= maxScaleLevel as
                        described in the VNFD.
                      type: integer
              additionalParams:
                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
        - 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:
        '202':
          description: >
            Accepted

            The request was accepted for processing, but the processing has not
            been completed. On success, the HTTP response shall include a
            "Location" HTTP header that contains the URI of the newly-created
            "VNF LCM operation occurrence" resource corresponding to the
            operation.
          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
                        structure of the "interfaceInfo" and "accessInfo"
                        attributes, based on the type of the VIM. The set of
                        permitted values is expected to change over time as new
                        types or versions of VIMs become available. The ETSI NFV
                        registry of VIM-related information provides access to
                        information about VimConnectionInfo definitions for
                        various VIM types. The structure of the registry is
                        defined in Annex C of SOL003.
                      type: string
                    interfaceInfo:
                      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
                    accessInfo:
                      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
                    extra:
                      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
              instantiationState:
                description: |
                  The instantiation state of the VNF.
                type: string
                enum:
                  - NOT_INSTANTIATED
                  - INSTANTIATED
              instantiatedVnfInfo:
                description: >
                  Information specific to an instantiated VNF instance. This
                  attribute shall be present if the instantiateState attribute
                  value is INSTANTIATED.
                type: object
                required:
                  - flavourId
                  - vnfState
                properties:
                  flavourId:
                    description: |
                      An identifier that is unique within a VNF descriptor.
                    type: string
                  vnfState:
                    type: string
                    enum:
                      - STARTED
                      - STOPPED
                  scaleStatus:
                    description: >
                      Scale status of the VNF, one entry per aspect. Represents
                      for every scaling aspect how "big" the VNF has been scaled
                      w.r.t. that aspect.
                    type: array
                    items:
                      required:
                        - aspectId
                        - scaleLevel
                      type: object
                      properties:
                        aspectId:
                          description: >
                            An identifier that is unique within a VNF
                            descriptor.
                          type: string
                        scaleLevel:
                          description: >
                            Indicates the scale level. The minimum value shall
                            be 0 and the maximum value shall be <= maxScaleLevel
                            as described in the VNFD.
                          type: integer
                  extCpInfo:
                    description: >
                      Information about the external CPs exposed by the VNF
                      instance.
                    type: array
                    minItems: 1
                    items:
                      type: object
                      required:
                        - id
                        - cpdId
                      properties:
                        id:
                          description: >
                            An identifier that is unique for the respective type
                            within a VNF instance, but may not be globally
                            unique.
                          type: string
                        cpdId:
                          description: >
                            An identifier that is unique within a VNF
                            descriptor.
                          type: string
                        cpProtocolInfo:
                          description: |
                            Network protocol information for this CP.
                          type: array
                          items:
                            description: >
                              This type describes the protocol layer(s) that a
                              CP uses together with protocol-related
                              information, like addresses. 
                            required:
                              - layerProtocol
                            properties:
                              layerProtocol:
                                description: >
                                  The identifier of layer(s) and protocol(s)
                                  associated to the network address
                                  information.  Permitted values:
                                  IP_OVER_ETHERNET This attribute allows to
                                  signal the addition of further types of layer
                                  and protocol in future versions of the present
                                  document in a backwards-compatible way. In the
                                  current version of the present document, only
                                  IP over Ethernet is supported.
                                type: string
                                enum:
                                  - IP_OVER_ETHERNET
                              ipOverEthernet:
                                description: >
                                  This type represents information about a
                                  network address that has been assigned. 
                                type: object
                                required:
                                  - macAddress
                                properties:
                                  macAddress:
                                    description: >
                                      A MAC address. Representation: string that
                                      consists of groups of two hexadecimal
                                      digits, separated by hyphens or colons.
                                    type: string
                                    format: MAC
                                  ipAddresses:
                                    description: >
                                      Addresses assigned to the CP instance.
                                      Each entry represents IP addresses
                                      assigned by fixed or dynamic IP address
                                      assignment per subnet.
                                    type: array
                                    items:
                                      type: object
                                      required:
                                        - type
                                      properties:
                                        type:
                                          description: >
                                            The type of the IP addresses. Permitted
                                            values: IPV4, IPV6.
                                          type: string
                                          enum:
                                            - IPV4
                                            - IPV6
                                        addresses:
                                          description: >
                                            Fixed addresses assigned (from the
                                            subnet defined by "subnetId" if
                                            provided).
                                          type: array
                                          items:
                                            description: >
                                              An IPV4 or IPV6 address. Representation:
                                              In case of an IPV4 address, string that
                                              consists of four decimal integers
                                              separated by dots, each integer ranging
                                              from 0 to 255. In case of an IPV6
                                              address, string that  consists of groups
                                              of zero to four hexadecimal digits,
                                              separated by colons.
                                            type: string
                                            format: IP
                                        isDynamic:
                                          description: >
                                            Indicates whether this set of addresses
                                            was assigned dynamically (true) or based
                                            on address information provided as input
                                            from the API consumer (false). Shall be
                                            present if "addresses" is present and
                                            shall be absent otherwise.
                                          type: boolean
                                        addressRange:
                                          description: >
                                            An IP address range used, e.g., in case
                                            of egress connections. Exactly one of
                                            "addresses" or "addressRange" shall be
                                            present.
                                          type: object
                                          required:
                                            - minAddress
                                            - maxAddress
                                          properties:
                                            minAddress:
                                              description: >
                                                An IPV4 or IPV6 address. Representation:
                                                In case of an IPV4 address, string that
                                                consists of four decimal integers
                                                separated by dots, each integer ranging
                                                from 0 to 255. In case of an IPV6
                                                address, string that  consists of groups
                                                of zero to four hexadecimal digits,
                                                separated by colons.
                                              type: string
                                              format: IP
                                            maxAddress:
                                              description: >
                                                An IPV4 or IPV6 address. Representation:
                                                In case of an IPV4 address, string that
                                                consists of four decimal integers
                                                separated by dots, each integer ranging
                                                from 0 to 255. In case of an IPV6
                                                address, string that  consists of groups
                                                of zero to four hexadecimal digits,
                                                separated by colons.
                                              type: string
                                              format: IP
                                        subnetId:
                                          description: >
                                            An IPV4 or IPV6 address. Representation:
                                            In case of an IPV4 address, string that
                                            consists of four decimal integers
                                            separated by dots, each integer ranging
                                            from 0 to 255. In case of an IPV6
                                            address, string that  consists of groups
                                            of zero to four hexadecimal digits,
                                            separated by colons.
                                          type: string
                                          format: IP
                        extLinkPortId:
                          description: >
                            An identifier with the intention of being globally
                            unique.
                          type: string
                  extVirtualLinkInfo:
                    description: >
                      Information about the external VLs the VNF instance is
                      connected to.
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - resourceHandle
                      properties:
                        id:
                          description: >
                            An identifier with the intention of being globally
                            unique.
                          type: string
                        resourceHandle:
                          required:
                            - vimConnectionId
                            - resourceId
                          type: object
                          description: >
                            This type represents the information that allows
                            addressing a virtualised resource that is used by a
                            VNF instance. Information about the resource is
                            available from the VIM.
                          properties:
                            vimConnectionId:
                              description: >
                                An identifier with the intention of being
                                globally unique.
                              type: string
                            resourceProviderId:
                              description: >
                                An identifier with the intention of being
                                globally unique.
                              type: string
                            resourceId:
                              description: >
                                An identifier maintained by the VIM or other
                                resource provider. It is expected to be unique
                                within the VIM instance.
                              type: string
                            vimLevelResourceType:
                              description: >
                                Type of the resource in the scope of the VIM or
                                the resource provider.
                              type: string
                        extLinkPorts:
                          description: |
                            Link ports of this VL.
                          type: array
                          items:
                            description: >
                              This type represents information about a link port
                              of an external VL, i.e. a port providing
                              connectivity for the VNF to an NS VL. 
                            type: object
                            required:
                              - id
                              - resourceHandle
                            properties:
                              id:
                                description: >
                                  An identifier with the intention of being
                                  globally unique.
                                type: string
                              resourceHandle:
                                required:
                                  - vimConnectionId
                                  - resourceId
                                type: object
                                description: >
                                  This type represents the information that
                                  allows addressing a virtualised resource that
                                  is used by a VNF instance. Information about
                                  the resource is available from the VIM.
                                properties:
                                  vimConnectionId:
                                    description: >
                                      An identifier with the intention of being
                                      globally unique.
                                    type: string
                                  resourceProviderId:
                                    description: >
                                      An identifier with the intention of being
                                      globally unique.
                                    type: string
                                  resourceId:
                                    description: >
                                      An identifier maintained by the VIM or
                                      other resource provider. It is expected to
                                      be unique within the VIM instance.
                                    type: string
                                  vimLevelResourceType:
                                    description: >
                                      Type of the resource in the scope of the
                                      VIM or the resource provider.
                                    type: string
                              cpInstanceId:
                                description: >
                                  An identifier that is unique for the
                                  respective type within a VNF instance, but may
                                  not be globally unique.
                                type: string
                  extManagedVirtualLinkInfo:
                    description: |
                      External virtual links the VNF instance is connected to.
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - vnfVirtualLinkDescId
                      properties:
                        id:
                          description: >
                            An identifier with the intention of being globally
                            unique.
                          type: string
                        vnfVirtualLinkDescId:
                          description: >
                            An identifier that is unique for the respective type
                            within a VNF instance, but may not be globally
                            unique.
                          type: string
                        networkResource:
                          required:
                            - vimConnectionId
                            - resourceId
                          type: object
                          description: >
                            This type represents the information that allows
                            addressing a virtualised resource that is used by a
                            VNF instance. Information about the resource is
                            available from the VIM.
                          properties:
                            vimConnectionId:
                              description: >
                                An identifier with the intention of being
                                globally unique.
                              type: string
                            resourceProviderId:
                              description: >
                                An identifier with the intention of being
                                globally unique.
                              type: string
                            resourceId:
                              description: >
                                An identifier maintained by the VIM or other
                                resource provider. It is expected to be unique
                                within the VIM instance.
                              type: string
                            vimLevelResourceType:
                              description: >
                                Type of the resource in the scope of the VIM or
                                the resource provider.
                              type: string
                        vnfLinkPorts:
                          description: |
                            Link ports of this VL.
                          type: array
                          items:
                            type: object
                            required:
                              - id
                              - resourceHandle
                            properties:
                              id:
                                description: >
                                  An identifier that is unique for the
                                  respective type within a VNF instance, but may
                                  not be globally unique.
                                type: string
                              resourceHandle:
                                required:
                                  - vimConnectionId
                                  - resourceId
                                type: object
                                description: >
                                  This type represents the information that
                                  allows addressing a virtualised resource that
                                  is used by a VNF instance. Information about
                                  the resource is available from the VIM.
                                properties:
                                  vimConnectionId:
                                    description: >
                                      An identifier with the intention of being
                                      globally unique.
                                    type: string
                                  resourceProviderId:
                                    description: >
                                      An identifier with the intention of being
                                      globally unique.
                                    type: string
                                  resourceId:
                                    description: >
                                      An identifier maintained by the VIM or
                                      other resource provider. It is expected to
                                      be unique within the VIM instance.
                                    type: string
                                  vimLevelResourceType:
                                    description: >
                                      Type of the resource in the scope of the
                                      VIM or the resource provider.
                                    type: string
                              cpInstanceId:
                                description: >
                                  An identifier that is unique for the
                                  respective type within a VNF instance, but may
                                  not be globally unique.
                                type: string
                  monitoringParameters:
                    description: |
                      Active monitoring parameters.
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - value
                        - timeStamp
                      properties:
                        id:
                          description: >
                            An identifier that is unique within a VNF
                            descriptor.
                          type: string
                        name:
                          description: >
                            Human readable name of the monitoring parameter, as
                            defined in the VNFD.
                          type: string
                        value:
                          description: >
                            Value of the monitoring parameter known to the VNFM
                            (e.g. obtained for autoscaling purposes). The type
                            of the "value" attribute (i.e. scalar, structure
                            (Object in JSON), or array (of scalars, arrays or
                            structures/Objects)) is assumed to be defined in an
                            external measurement specification.
                          type: object
                        timeStamp:
                          description: >
                            Represents the point in time when the measurement
                            has been performed, as known to the VNFM. Should be
                            formatted according to ETF RFC 3339.
                          type: string
                  localizationLanguage:
                    description: >
                      Information about localization language of the VNF
                      (includes e.g. strings in the VNFD). The localization
                      languages supported by a VNF can be declared in the VNFD,
                      and localization language selection can take place at
                      instantiation time. The value shall comply with the format
                      defined in IETF RFC 5646.
                    type: string
                  vnfcResourceInfo:
                    description: >
                      Information about the virtualised compute and storage
                      resources used by the VNFCs of the VNF instance.
                    type: array
                    items:
                      description: >
                        This type represents the information on virtualised
                        compute and storage resources used by a VNFC in a VNF
                        instance.
                      type: object
                      required:
                        - id
                        - vduId
                        - computeResource
                      properties:
                        id:
                          description: >
                            An identifier that is unique for the respective type
                            within a VNF instance, but may not be globally
                            unique.
                          type: string
                        vduId:
                          description: >
                            An identifier that is unique within a VNF
                            descriptor.
                          type: string
                        computeResource:
                          required:
                            - vimConnectionId
                            - resourceId
                          type: object
                          description: >
                            This type represents the information that allows
                            addressing a virtualised resource that is used by a
                            VNF instance. Information about the resource is
                            available from the VIM.
                          properties:
                            vimConnectionId:
                              description: >
                                An identifier with the intention of being
                                globally unique.
                              type: string
                            resourceProviderId:
                              description: >
                                An identifier with the intention of being
                                globally unique.
                              type: string
                            resourceId:
                              description: >
                                An identifier maintained by the VIM or other
                                resource provider. It is expected to be unique
                                within the VIM instance.
                              type: string
                            vimLevelResourceType:
                              description: >
                                Type of the resource in the scope of the VIM or
                                the resource provider.
                              type: string
                        storageResourceIds:
                          description: >
                            References to the VirtualStorage resources. The
                            value refers to a VirtualStorageResourceInfo item in
                            the VnfInstance.
                          type: array
                          items:
                            description: >
                              An identifier that is unique for the respective
                              type within a VNF instance, but may not be
                              globally unique.
                            type: string
                        reservationId:
                          description: >
                            An identifier with the intention of being globally
                            unique.
                          type: string
                        vnfcCpInfo:
                          description: >
                            CPs of the VNFC instance. Shall be present when that
                            particular CP of the VNFC instance is associated to
                            an external CP of the VNF instance. May be present
                            otherwise.
                          type: array
                          items:
                            type: object
                            required:
                              - id
                              - cpdId
                            properties:
                              id:
                                description: >
                                  An identifier that is unique for the
                                  respective type within a VNF instance, but may
                                  not be globally unique.
                                type: string
                              cpdId:
                                description: >
                                  An identifier that is unique within a VNF
                                  descriptor.
                                type: string
                              vnfExtCpId:
                                description: >
                                  An identifier that is unique for the
                                  respective type within a VNF instance, but may
                                  not be globally unique.
                                type: string
                              cpProtocolInfo:
                                description: |
                                  Network protocol information for this CP.
                                type: array
                                items:
                                  description: >
                                    This type describes the protocol layer(s)
                                    that a CP uses together with
                                    protocol-related information, like
                                    addresses. 
                                  required:
                                    - layerProtocol
                                  properties:
                                    layerProtocol:
                                      description: >
                                        The identifier of layer(s) and
                                        protocol(s) associated to the network
                                        address information.  Permitted values:
                                        IP_OVER_ETHERNET This attribute allows
                                        to signal the addition of further types
                                        of layer and protocol in future versions
                                        of the present document in a
                                        backwards-compatible way. In the current
                                        version of the present document, only IP
                                        over Ethernet is supported.
                                      type: string
                                      enum:
                                        - IP_OVER_ETHERNET
                                    ipOverEthernet:
                                      description: >
                                        This type represents information about a
                                        network address that has been assigned. 
                                      type: object
                                      required:
                                        - macAddress
                                      properties:
                                        macAddress:
                                          description: >
                                            A MAC address. Representation: string
                                            that consists of groups of two
                                            hexadecimal digits, separated by hyphens
                                            or colons.
                                          type: string
                                          format: MAC
                                        ipAddresses:
                                          description: >
                                            Addresses assigned to the CP instance.
                                            Each entry represents IP addresses
                                            assigned by fixed or dynamic IP address
                                            assignment per subnet.
                                          type: array
                                          items:
                                            type: object
                                            required:
                                              - type
                                            properties:
                                              type:
                                                description: >
                                                  The type of the IP addresses. Permitted
                                                  values: IPV4, IPV6.
                                                type: string
                                                enum:
                                                  - IPV4
                                                  - IPV6
                                              addresses:
                                                description: >
                                                  Fixed addresses assigned (from the
                                                  subnet defined by "subnetId" if
                                                  provided).
                                                type: array
                                                items:
                                                  description: >
                                                    An IPV4 or IPV6 address. Representation:
                                                    In case of an IPV4 address, string that
                                                    consists of four decimal integers
                                                    separated by dots, each integer ranging
                                                    from 0 to 255. In case of an IPV6
                                                    address, string that  consists of groups
                                                    of zero to four hexadecimal digits,
                                                    separated by colons.
                                                  type: string
                                                  format: IP
                                              isDynamic:
                                                description: >
                                                  Indicates whether this set of addresses
                                                  was assigned dynamically (true) or based
                                                  on address information provided as input
                                                  from the API consumer (false). Shall be
                                                  present if "addresses" is present and
                                                  shall be absent otherwise.
                                                type: boolean
                                              addressRange:
                                                description: >
                                                  An IP address range used, e.g., in case
                                                  of egress connections. Exactly one of
                                                  "addresses" or "addressRange" shall be
                                                  present.
                                                type: object
                                                required:
                                                  - minAddress
                                                  - maxAddress
Show full blame