Skip to content
GitLab
Find file Normal viewHistoryPermalink
VNFLifecycleManagement.yaml 158 KB
Newer Older
Samir Medjiah's avatar
SOL003_9>SOL003_30 : VNF LCM interface updated  
Samir Medjiah committed
3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 
          the "id" attribute in the payload body of that response.
        in: path
        type: string
        required: true
    post:
      description: >
        The POST method requests reverting a VNF instance to a VNF snapshot.
        This method shall follow the provisions specified in the tables 5.4.22.3.1-1 
        and 5.4.22.3.1-2 for URI query parameters, request and response data structures, 
        and response codes.
      parameters:
        - name: RevertToVnfSnapshotRequest
          description: >
            Parameters for the Revert to VNF snapshot operation, as defined in clause 5.5.2.23.
          in: body
          required: true
          schema:
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/RevertToVnfSnapshotRequest"
        - 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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        202:
          description: >
            202 ACCEPTED

            Shall be returned when the request was accepted for processing, but the processing has 
            not been completed.
            The response body shall be empty.
            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:
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
              maximum: 1
              minimum: 1
            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
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
        404:
          #description: >
          #404 NOT FOUND

          #Shall be returned upon the following error: The API producer did not find a current representation 
          #for the target resource or is not willing to disclose that one exists.
          #The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
          #including rules for the presence of the response body.
          #Specifically in case of this task resource, the response code 404 shall also be returned if the task
          #is not supported for the VNF instance represented by the parent resource, which means that the task
          #resource consequently does not exist. 
          #In this case, the response body shall be present, and shall contain a ProblemDetails structure, in
          #which the "detail" attribute shall convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
        409:
          #description: >
            #409 CONFLICT

            #Shall be returned upon the following error: The operation cannot be executed currently, 
            #due to a conflict with the state of the resource.
            #Typically, this is due to the fact that the VNF instance resource is in NOT_INSTANTIATED 
            #state, or that another lifecycle management operation is ongoing.
            #The response body shall contain a ProblemDetails structure, in which the "detail" attribute 
            #shall convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"

  ###############################################################################
  # VNF snapshots                                                               #
  ###############################################################################
  '/vnf_snapshots':
    #SOL003 location: 5.4.23.2
    post:
      description: >
        The POST method creates a new "Individual VNF snapshot" resource.
        This method shall follow the provisions specified in the tables 5.4.23.3.1-1 
        and 5.4.23.3.1-2 for URI query parameters, request and response data structures, 
        and response codes.
      parameters:
        - 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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        201:
          description: >
            201 CREATED

            Shall be returned when an "Individual VNF snapshot" resource has been created 
            successfully.
            The response body shall contain a representation of the new "Individual VNF snapshot" 
            resource, as defined in clause 5.5.2.21.
            The HTTP response shall include a "Location" HTTP header that contains the resource URI 
            of the "Individual VNF snapshot" resource.
          headers:
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
              maximum: 1
              minimum: 1
            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
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
          schema:
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
        409:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
    get:
      description:  >
        The GET method queries information about multiple VNF snapshots.
        This method shall follow the provisions specified in the tables 5.4.23.3.2-1 
        and 5.4.23.3.2-2 for URI query parameters, request and response data structures, 
        and response codes.
      parameters:
        - 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: filter
          description: >
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
            The VNFM shall support receiving this parameter as part of the URI query string.
            The NFVO may supply this parameter.
            All attribute names that appear in the VnfSnapshot and in data types referenced from
            it shall be supported by the VNFM in the filter expression.
          in: query
          required: false
          type: string
        - name: all_fields
          description: >
            Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
            The VNFM shall support this parameter.
          in: query
          required: false
          type: string
        - name: fields
          description: >
            Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
            The VNFM should support this parameter.
          in: query
          required: false
          type: string
        - name: exclude_fields
          description: >
            Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
            The VNFM should support this parameter.
          in: query
          required: false
          type: string
        - name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response.
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter.
            The following attributes shall be excluded from the VnfSnapshot structure
            in the response body if this parameter is provided, or none of the parameters
            "all_fields", "fields", "exclude_fields", "exclude_default" are provided:
            -	vnfInstance
            - vnfcSnapshots
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the 
            VNFM if the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of
            ETSI GS NFV-SOL 013 for this resource.
          in: query
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
            200 OK

            Shall be returned when information about zero or more VNF snapshots was queried successfully.
            The response body shall contain in an array the representations of zero or more 
            "Individual VNF snapshot" resources, as defined in clause 5.5.2.21.
            If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
            for this resource, inclusion of the Link HTTP header in this response shall follow the provisions 
            in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
          schema:
            type: array
            items:
              $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"

  ###############################################################################
  # Individual VNF snapshot                                                     #
  ###############################################################################
  '/vnf_snapshots/{vnfSnapshotInfoId}':
    #SOL003 location: 5.4.24.2
    parameters:
      - name: vnfSnapshotInfoId
        description: >
          Identifier of the "Individual VNF snapshot" resource. 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 snapshot resource. It can also be retrieved from the "id" attribute in
          the payload body of that response.
        in: path
        type: string
        required: true

    get:
      #SOL003 location: 5.4.24.3.2
      description: >
        The GET method retrieves information about a VNF snapshot by reading an "Individual VNF snapshot" 
        resource.
        This method shall follow the provisions specified in the tables 5.4.24.3.2-1 and 5.4.24.3.2-2 
        for URI query parameters, request and response data structures, and response codes.
      parameters:
        - 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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
            200 OK

            Shall be returned when information about an individual VNF snapshot was read successfully.
            The response body shall contain a representation of the "Individual VNF snapshot" resource, 
            as defined in clause 5.5.2.21.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
          schema:
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"

    delete:
      #SOL003 location: 5.4.24.3.5
      description: >
        This method deletes an "Individual VNF snapshot" resource and the associated VNF snapshot 
        information managed by the VNFM, and any resource associated to the VNF snapshot managed 
        by the VIM.
        As the result of successfully executing this method, the "Individual VNF snapshot" resource 
        shall not exist any longer.
        This method shall follow the provisions specified in the tables 5.4.24.3.5-1 and 5.4.24.3.5-2 
        for URI query parameters, request and response data structures, and response codes.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 NO CONTENT

            Shall be returned when the VNF snapshot resource and the associated VNF snapshot were 
            deleted successfully.
            The response body shall be empty.
          headers:
            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
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
        409:
          #description: >
            #409 CONFLICT

            #Shall be returned upon the following error: The operation cannot be executed currently, 
            #due to a conflict with the state of the resource. 
            #Typically, this is due to the fact that the VNF snapshot is in use by some operation such 
            #as reverting a VNF instance to a VNF snapshot or creating a VNF snapshot package.
            #The response body shall contain a ProblemDetails structure, in which the "detail" attribute 
            #shall convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
Show full blame