SOL005VNFSnapshotPackageManagement_def.yaml 33 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt

definitions:
  CreateVnfSnapshotPkgInfoRequest:
    description: >
      This type represents the request parameters for creating a new "Individual VNF snapshot package" resource. 
      It shall comply with the provisions defined in table 11.5.2.2-1.
    type: object
    required:
      - name
    properties:
      name:
        description: >
          Human-readable name of the VNF snapshot package.
        type: string
      userDefinedData:
        description: >
          User defined data for the VNF snapshot package to be built/uploaded.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

  VnfSnapshotPkgInfo:
    description: >
      This type represents the information of a VNF snapshot package. It shall comply with the provisions 
      defined in table 11.5.2.3-1.
    type: object
    required:
      - id
      - name
      - isFullSnapshot
      - state
      - isCancelPending
      - _links
    properties:
      id:
        description: >
          Identifier of the VNF snapshot package information held by the NFVO. 
          This identifier is allocated by the NFVO.
        type: 
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" 
      vnfSnapshotPkgUniqueId:
        description: >
          Identifier of the VNF snapshot package, which identifies the VNF snapshot package in 
          a globally unique way. It is created during the "build VNF snapshot package operation". 
          
          Multiples instances of the same VNF snapshot package share the same vnfSnapshotPkgUniqueId.

          The attribute shall not be present before the VNF snapshot package content has been 
          uploaded or built. Otherwise, this attribute shall be present unless it has been requested 
          to be excluded per attribute selector.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" 
      name:
        description: >
          Human-readable name of the VNF snapshot package.
        type: string
      checksum:
        description: >
          Checksum of the stored VNF snapshot package.

60 61
          Hash algorithms applicable to VNF snapshot package are defined in ETSI GS NFV-SOL 010.

62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
          The attribute shall not be present before the VNF snapshot package content has been 
          uploaded or built. Otherwise, this attribute shall be present unless it has been requested 
          to be excluded per attribute selector.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum" 
      createdAt:
        description: >
          Timestamp indicating when the VNF snapshot package creation has been completed. 
          
          The attribute shall not be present before the VNF snapshot package content has been 
          uploaded or built. Otherwise, this attribute shall be present unless it has been requested 
          to be excluded per attribute selector.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime" 
      vnfSnapshotId:
        description: >
          Identifier of the specific VNF snapshot in the VNF snapshot package. This identifier is 
          allocated by the VNFM during the VNF snapshot creation.

          The attribute shall not be present before the VNF snapshot package content has been 
          uploaded or built. Otherwise, this attribute shall be present unless it has been requested 
          to be excluded per attribute selector.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" 
83
      vnfcSnapshotInfoIds:
84
        description: >
85 86 87
          Identifier of information held by the VNFM about specific VNFC snapshot(s) part of the VNF 
          snapshot and contained in the VNF snapshot package. This identifier is allocated by the VNFM 
          during the VNF snapshot creation.
88 89 90 91 92 93

          The attribute shall not be present before the VNF snapshot package content has been 
          uploaded or built. Otherwise, this attribute shall be present unless it has been requested 
          to be excluded per attribute selector.
        type: array
        items:
94
          $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierLocal" 
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
      isFullSnapshot:
        description: >
          Value is TRUE in case of a "full" VNF snapshot package, i.e., containing all snapshotted 
          VNFC instances; otherwise the value is FALSE.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Boolean" 
      vnfdInfo:
        description: >
          VNFD of the snapshotted VNF instance that is contained in the stored VNF snapshot package. 
          
          The attribute shall not be present before the VNF snapshot package content has been 
          uploaded or built. Otherwise, this attribute shall be present unless it has been requested 
          to be excluded per attribute selector.
        $ref: '#/definitions/VnfdInfo'
      vnfsr:
        description: >
          VNF snapshot record with the information as present in the representation of The
          "Individual VNF snapshot" resource.
        $ref: '#/definitions/VnfSnapshotRecord'
      vnfcSnapshotImages:
        description: >
          Information about VNF snapshot artifacts that are VNFC snapshot images. Every local and 
          external snapshot image shall be included. No other artifacts shall be included. 
          
          The attribute shall not be present before the VNF snapshot package content has been 
          uploaded or built. Otherwise, this attribute shall be present unless it has been requested 
          to be excluded per attribute selector.
        type: array
        items:
          $ref: '#/definitions/VnfcSnapshotImageInfo'
      additionalArtifacts:
        description: >
          Information about VNF snapshot artifacts that are not VNFC snapshot images. 
          
          The attribute shall not be present before the VNF snapshot package content has been 
          uploaded or built. Otherwise, this attribute shall be present unless it has been requested 
          to be excluded per attribute selector.
        type: array
        items:
          $ref: '#/definitions/SnapshotPkgArtifactInfo'
      state:
        description: >
          State of the VNF snapshot package.

          Permitted values:
          - CREATED: the VNF snapshot package information has been created.
          - BUILDING: the VNF snapshot package is being built.
          - UPLOADING: the VNF snapshot package is being uploaded.
          - EXTRACTING: the VNF snapshot package’s content is being extracted.
          - AVAILABLE: the VNF snapshot package is available (i.e., build or upload is completed).
          - ERROR: failure during the VNF snapshot package building, uploading or processing.
          - ERROR_EXTRACTING: failure during the VNF snapshot package extraction task.
        type: string
        enum:
          - CREATED
          - BUILDING
          - UPLOADING
          - EXTRACTING
          - AVAILABLE
          - ERROR
          - ERROR_EXTRACTING
      isCancelPending:
        description: >
          Indicates if an ongoing operation with the content of the VNF snapshot package is being 
          cancelled. If the value of the "state" attribute is "BUILDING", "UPLOADING", "PROCESSING" 
          or "EXTRACTING" and the operation is being cancelled, this attribute shall be set to true. 
          Otherwise, it shall be set to false.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Boolean" 
      failureDetails:
        description: >
          Failure details associated to current error state of the VNF snapshot package state. 
          If "state" is "ERROR" or "ERROR_EXTRACTING", this attribute shall be present unless it 
          has been requested to be excluded via an attribute selector.
        type: object
        required:
          - errorType
          - details
        properties:
          errorType:
            description: >
              Type of error, when the failure happened (building, upload, processing, extracting).
              Permitted values: 
              - BUILD_ERROR
              - UPLOAD_ERROR
              - PROCESS_ERROR
              - CANCELLED
              - EXTRACTION_ERROR
            type: string
            enum:
              - BUILD_ERROR
              - UPLOAD_ERROR
              - PROCESS_ERROR
              - CANCELLED
              - EXTRACTION_ERROR
          details:
            description: >
              Failure details containing error information (such as failed uploading or processing
191
              operation, affected artifact, reason for cancellation, etc.). See clause 6.3 of ETSI
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
              GS NFV-SOL 013 for the details of "ProblemDetails" structure.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 
      userDefinedData:
        description: >
          User defined data for the VNF snapshot package to be built/uploaded.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" 
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
          - packageContent
        properties:
          self:
            description: URI of this resource.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"  
          packageContent:
            description: Link to the "VNF snapshot package content" resource.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"  

  VnfSnapshotPkgInfoModifications:
    description: >
      This type represents modifications to the information of a VNF snapshot package. 
      It shall comply with the provisions defined in table 11.5.2.4-1.
    type: object
218 219 220 221 222 223 224
    anyOf:
      - required:
        - name
      - required:
        - userDefinedData
      - required:
        - state
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
    properties:
      name:
        description: >
          New value of the human-readable name of the VNF snapshot package. 
          
          At least one of the three parameters shall be present. If the VNF snapshot package 
          is not uploaded or built, the operation is used only to update existing or add additional 
          user defined data using the userDefinedData attribute.
        type: string
      userDefinedData:
        description: >
          User defined data for the VNF snapshot package to be updated. 
          For existing keys, the value is replaced. 
          
          At least one of the three parameters shall be present. If the VNF snapshot package 
          is not uploaded or built, the operation is used only to update existing or add additional 
          user defined data using the userDefinedData attribute.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" 
      state:
        description: >
          New value of the "state" of the VNF snapshot package.
          
          Permitted values: 
          - AVAILABLE: to change the "Individual VNF snapshot package" resource state to "AVAILABLE".
          
          Explicit change of state is only permitted from the following states:
          - ERROR_EXTRACTING 
          
          At least one of the three parameters shall be present. If the VNF snapshot package 
          is not uploaded or built, the operation is used only to update existing or add additional 
          user defined data using the userDefinedData attribute.
        type: string
        enum:
          - AVAILABLE

  UploadVnfSnapshotPkgFromUriRequest:
    description: >
      This type represents the request parameters for uploading the content of a VNF snapshot package.
      The NFVO can obtain the VNF snapshot package content through the information provided in the 
      request parameters. It shall comply with the provisions defined in table 11.5.2.5-1.
    type: object
    required:
      - addressInformation
    properties:
      addressInformation:
        description: >
          Address information of the VNF snapshot package content. The NFVO can use this address to 
          obtain the VNF snapshot package.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri" 
      authType:
        description: >
          Defines the type of authentication / authorization for downloading the VNF snapshot package.
          
          Permitted values:
          - BASIC: Only the "username" and "password" attributes shall be present.
          - OAUTH2_CLIENT_CREDENTIALS: Only the "paramsOauth2ClientCredentials" attribute shall be present.
          
          This attribute shall not be present if the credentials were provisioned out of band.
        type: string
        enum:
          - BASIC
          - OAUTH2_CLIENT_CREDENTIALS
      username:
        description: >
          Username to be used for authentication. Shall be present if user name is needed and has 
          not been provisioned out of band.
        type: string
      password:
        description: >
          Password to be used for authentication. Shall be present if password is needed and has 
          not been provisioned out of band.
        type: string
      paramsOauth2ClientCredentials:
        description: >
          Parameters for authentication/authorization using OAuth 2.0.
        type: object
        required:
          - clientId
          - clientPassword
          - tokenEndpoint
        properties:
          clientId:
            description: >
              Client identifier to be used in the access token request of the OAuth 2.0 client 
              credentials grant type.
            type: string
          clientPassword:
            description: >
              Client password to be used in the access token request of the OAuth 2.0 client 
              credentials grant type.
            type: string
          tokenEndpoint:
            description: >
              The token endpoint from which the access token can be obtained.
            type: string

  BuildVnfSnapshotPkgRequest:
    description: >
      This type represents the request parameters for building the content of a VNF snapshot package.
      The NFVO can obtain the VNF snapshot data through the information provided in the request 
      parameters. It shall comply with the provisions defined in table 11.5.2.6-1.
    type: object
    required:
      - vnfSnapshotInfoId
    properties:
      vnfSnapshotInfoId:
        description: >
332
          Identifier held by the NFVO about the "Individual VNF snapshot" resource with the information 
333 334
          managed by the VNFM about a specific VNF snapshot to be packaged into the VNF snapshot package.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" 
335
      vnfcSnapshotsInfoIds:
336
        description: >
337 338 339 340 341
          List of identifiers of information held by the NFVO about VNFC snapshots to be packaged 
          into the VNF snapshot package. Shall be present when it is requested to build a "partial” 
          VNF snapshot package by packaging specific VNFC snapshots of the VNF snapshot. If not present, 
          a "full" VNF snapshot package is requested to be built including all the constituents of 
          the VNF snapshot.
342 343
        type: array
        items:
344 345 346 347 348 349 350 351 352 353 354 355 356
          $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierLocal" 
      overrideImportForVnfcSnapshotIds:
        description: |
          If present, it indicates the list of VNFC snapshots to which the VNF snapshot-level 
          import snapshot resource policy indicated by the "importSnapshotResource" attribute 
          does not apply and the opposite value shall be considered. 
          
          The "overrideImportForVnfcSnapshotIds" provides the list of VNFC snapshots for which the 
          VNF snapshot-level snapshot resource import policy is overridden. See also examples in the 
          present clause.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierLocal"  
357 358
      importSnapshotResource:
        description: >
359 360 361 362 363 364 365
          VNF snapshot-level policy indicating whether the NFVO shall import the snapshotted resources 
          from the NFVI (TRUE) or keep in the NFVI the snapshotted resources as external artifacts 
          during the building of the VNF snapshot package file (FALSE). Default value is TRUE. 
          
          The "overrideImportForVnfcSnapshotIds" provides the list of VNFC snapshots for which the 
          VNF snapshot-level snapshot resource import policy is overridden. See also examples in the 
          present clause.
366 367 368 369 370 371 372
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Boolean" 

  ExtractVnfSnapshotPkgRequest:
    description: >
      This type represents the request parameters for extracting the content of a VNF snapshot package.
      It shall comply with the provisions defined in table 11.5.2.7-1.
    type: object
373 374 375 376 377
    oneOf:
      - required:
        - vnfSnapshotInfoId
      - required:
        - vnfInstanceId
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
    properties:
      vnfSnapshotInfoId:
        description: >
          Identifier held by the NFVO about an "Individual VNF snapshot" resource managed by the VNFM 
          to which the content of the VNF snapshot package will be extracted to. 
          
          Either the parameter vnfSnapshotInfoId or vnfInstanceId, but not both, shall be provided.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" 
      vnfInstanceId:
        description: >
          Identifier of the VNF instance to which the content and extraction of the VNF snapshot 
          package is to be associated. 
          
          Either the parameter vnfSnapshotInfoId or vnfInstanceId, but not both, shall be provided.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"

  CancelVnfSnapshotPkgOperationRequest:
    description: >
      This type represents the request parameters for cancelling an ongoing operation related 
      to the content of a VNF snapshot package. It shall comply with the provisions defined in 
      table 11.5.2.8-1.
    type: object
    properties:
      cause:
        description: >
          Description about the reason for cancelling the operation. If this attribute is present, 
          the NFVO shall add such information into the "failureDetails" of the representation of 
          the "Individual VNF snapshot package" resource.
        type: string

  VnfSnapshotPkgExtArtifactsAccessInfo:
409 410
    description: > #no definition found 
      VnfSnapshotPkgExtArtifactsAccessInfo description !
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
    type: string

  VnfSnapshotPkgExtArtifactsAccessConfig:
    description: >
      This type represents the access configuration information for downloading external VNF snapshot 
      package artifacts.
      The NFVO can obtain the external VNF snapshot package artifact file through the information 
      provided in this structure, together with information provided in the manifest. The data 
      structure shall comply with the provisions defined in Table 11.5.2.9-1. If the data structure 
      is part of a response body, security-sensitive attributes shall be excluded as specified in 
      Table 11.5.2.9-1.
    type: object
    properties:
      artifact:
        description: >
426
          Access configuration information for an external artifact.
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
        type: array
        items:
          type: object  
          required: 
            - artifactUri
          properties:
            artifactUri:
              description: >
                The artifactUri attribute as defined in the VNF snapshot package manifest that
                identifies the external artifact for which the access configuration information 
                is provided, and that provides the default download location for this artifact.
              $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
            overrideUri:
              description: >
                The URI from which the external artifact can be downloaded. If this attribute is
                present, the NFVO shall download from this address. If this attribute is not present,
                the NFVO shall download from the address provided in "artifactUri".
              $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
            authType:
              description: >
                Defines the type of authentication / authorization for downloading the VNF package.

                Permitted values:
                - BASIC: Only the "username" and "password" attributes shall be present.
                - OAUTH2_CLIENT_CREDENTIALS: Only the "paramsOauth2ClientCredentials" attribute shall 
                be present.

                This attribute shall not be present if no credentials are provided for the artifact.
              type: string
              enum:
                - BASIC
                - OAUTH2_CLIENT_CREDENTIALS
            username:
              description: >
                Username to be used for authentication.
              type: string
            password:
              description: >
                Password to be used for authentication. Shall not be present in response bodies.
              type: string
            paramsOauth2ClientCredentials:
              description: >
                Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.
              type: object
              required:
                - clientId
                - clientPassword
                - tokenEndpoint
              properties:
                clientId:
                  description: >
                    Client identifier to be used in the access token request of the OAuth 2.0 client
                    credentials grant type.
                  type: string
                clientPassword:
                  description: >
                    Client password to be used in the access token request of the OAuth 2.0 client
                    credentials grant type. Shall not be present in response bodies.
                  type: string
                tokenEndpoint:
                  description: >
                    The token endpoint from which the access token can be obtained.
                  $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"

  #Referenced structured data types
  VnfcSnapshotImageInfo:
    description: >
      This type represents an artifact contained in or external to a VNF snapshot package which 
      represents a snapshot image. 
496
      It shall comply with the provisions defined in table 11.5.3.2-1.
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
    type: object
    required:
      - id
      - name
      - checksum
      - isEncrypted
      - vnfcInstanceId
      - containerFormat
      - diskFormat
      - createdAt
      - minDisk
      - minRam
      - size
    properties:
      id:
        description: Identifier of the VNFC snapshot image.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierLocal" 
      name:
        description: Name of the VNFC snapshot image.
        type: string
      checksum:
518 519 520
        description: >
          Checksum of the snapshot image file. Hash algorithms applicable to VNF snapshot package 
          artifacts are defined in ETSI GS NFV-SOL 010.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum" 
      isEncrypted:
        description: Reflects whether the artifact is encrypted (true) or not (false).
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Boolean" 
      vnfcInstanceId:
        description: Identifier of the snapshotted VNFC instance that this snapshot image belongs to.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" 
      containerFormat:
        description: >
          Container format indicates whether the snapshot image is in a file format that also 
          contains metadata about the actual snapshot.

          Permitted values:
          - AKI: a kernel image format.
          - AMI: a machine image format.
          - ARI: a ramdisk image format.
          - BARE: the image does not have a container or metadata envelope.
          - DOCKER: docker container format.
          - OVA: OVF package in a tarfile.
          - OVF: OVF container format.

          The list of permitted values was taken from "Container formats" in 
          OpenStack®: "Disk and container formats for images" 
          (Available from https://docs.openstack.org/glance/pike/user/formats.html)
        type: string
        enum:
          - AKI
          - AMI
          - ARI
          - BARE
          - DOCKER
          - OVA
          - OVF
      diskFormat:
        description: >
          Disk format of a snapshot image is the format of the underlying disk image.

          Permitted values:
          - AKI: a kernel image format.
          - AMI: a machine image format.
          - ARI: a ramdisk image format.
          - ISO: an archive format for the data contents of an optical disc, such as CD-ROM.
          - QCOW2: a common disk image format, which can expand dynamically and supports copy 
          on write.
          - RAW: an unstructured disk image format.
          - VDI: a common disk image format. 
          - VHD: a common disk image format. 
          - VHDX: enhanced version of VHD format.
          - VMDK: a common disk image format.

          The list of permitted values was adapted from "Disk formats" in 
          OpenStack®: "Disk and container formats for images" 
          (Available from https://docs.openstack.org/glance/pike/user/formats.html)
        type: string
        enum:
          - AKI
          - AMI
          - ARI
          - ISO
          - QCOW2
          - RAW
          - VDI
          - VHD
          - VHDX
          - VMDK
      createdAt:
        description: Timestamp indicating when the VNFC snapshot image was created.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime" 
      minDisk:
        description: The minimal disk for this VNFC snapshot image (in bytes).
        $ref: "../../definitions/SOL005_def.yaml#/definitions/UnsignedInt" 
      minRam:
        description: The minimal RAM for this VNFC snapshot image (in bytes).
        $ref: "../../definitions/SOL005_def.yaml#/definitions/UnsignedInt" 
      size:
        description: Size of this VNFC snapshot image (in bytes).
        $ref: "../../definitions/SOL005_def.yaml#/definitions/UnsignedInt" 
      userMetadata:
        description: User-defined metadata.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" 
      imagePath:
        description: >
          Path which identifies the image artifact and also allows to access a copy of the 
          image artifact. 
          
          For an image artifact contained as a file in the VNF snapshot package, this attribute 
          shall be present, and the value of this attribute shall start with the name of the 
          first segment in the path in the package, i.e., it shall not be prefixed by path 
          separator characters such as "." and "/".

          EXAMPLE: foo/bar/m%40ster.vhd

          For an external image artifact represented as a URI in the manifest file, this attribute 
          shall be present if the artifact has been downloaded by the NFVO or the artifact has been 
          processed after building the VNF snapshot package and shall be absent otherwise. If present, 
          it shall contain the artifactPath under which the image artifact can be obtained using the 
          "Individual artifact in a VNF snapshot package" resource defined in clause 11.4.10. 
          It is the responsibility of the NFVO to synthesize this path in a manner that avoids any 
          collision of the synthesized artifact path with the paths and names of artifacts included 
          in the snapshot package.
        type: string
      imageUri:
        description: >
          URI of the image artifact as defined in the VNF snapshot package manifest. Shall be present
          if the image artifact is external to the snapshot package and shall be absent otherwise.

          EXAMPLE: https://example.com/m%40ster.vhd
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri" 

  SnapshotPkgArtifactInfo:
    description: >
      This type represents an artifact other than a software image which is contained in a VNF 
      snapshot package. It shall comply with provisions defined in table 11.5.3.3-1.
    type: object
    required:
      - checksum
      - isEncrypted
    properties:
      artifactPath:
        description: >
          Path which identifies the artifact and also allows to access a copy of the artifact.

          For an artifact contained as a file in the VNF snapshot package, this attribute shall be 
          present, and the value of this attribute shall start with the name of the first segment in 
          the path in the package, i.e. it shall not be prefixed by path separator characters such 
          as "." and "/".

          EXAMPLE: foo/bar/m%40ster.sh

          For an external artifact represented as a URI in the manifest file, this attribute shall 
          be present if the artifact has been downloaded by the NFVO or the artifact has been 
          processed after building the VNF snapshot package and shall be absent otherwise. If present, 
          it shall contain the artifactPath under which the artifact can be obtained using the 
          "Individual artifact in a VNF snapshot package" resource defined in clause 11.4.10. It is 
          the responsibility of the NFVO to synthesize this path in a manner that avoids any 
          collision of the synthesized artifact path with the paths and names of artifacts included 
          in the snapshot package.
        type: string
      artifactUri:
        description: >
          URI of the artifact as defined in the VNF snapshot package manifest. Shall be present if 
          the artifact is external to the snapshot package and shall be absent otherwise.

          EXAMPLE: https://example.com/m%40ster.sh
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri" 
      checksum:
        description: >
668 669
          Checksum of the artifact file. Hash algorithms applicable to VNF snapshot package 
          artifacts are defined in ETSI GS NFV-SOL 010.
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum" 
      isEncrypted:
        description: >
          Reflects whether the artifact is encrypted (true) or not (false).
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Boolean" 
      metadata:
        description: >
          The metadata of the artifact that are available in the VNF package, such as Content type, 
          size, creation date, etc.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" 

  VnfdInfo:
    description: >
      This type represents the VNFD which is contained in a VNF snapshot package. It shall comply 
      with provisions defined in Table 11.5.3.4-1.
    type: object
    required:
      - vnfdId
      - vnfdPath
      - checksum
      - isEncrypted
    properties:
      vnfdId:
        description: >
          VNFD identifier of the snapshotted VNF instance.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" 
      vnfdPath:
        description: >
          Path which allows to access a copy of the VNFD. The VNFD is implemented as a collection 
699 700
          of one or more files, and the path refers to the ZIP archive file embedding these files.
          The VNF snapshot package format is defined in the ETSI GS NFV-SOL 010.
701 702 703 704 705 706 707 708 709

          The value of this attribute shall start with the name of the first segment of the path 
          in the package, i.e. it shall not be prefixed by path separator characters such 
          as "." and "/".

          EXAMPLE: foo/bar/m@ster
        type: string
      checksum:
        description: >
710 711
          Checksum of the VNFD archive file. Hash algorithms applicable to VNF snapshot package 
          artifacts are defined in ETSI GS NFV-SOL 010.
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum" 
      isEncrypted:
        description: >
          Reflects whether the VNFD archive file is encrypted (true) or not (false).
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Boolean" 

  VnfSnapshotRecord:
    description: >
      This type represents the VNF snapshot record which is contained in a VNF snapshot package. 
      It shall comply with provisions defined in Table 11.5.3.5-1.
    type: object
    required:
      - recordPath
      - checksum
      - isEncrypted
    properties:
      recordPath:
        description: >
          Path which identifies the VNF snapshot record and allows to access a copy of the VNF 
          snapshot record for the extraction.

          The value of this attribute shall start with the name of the first segment of the path 
          in the package, i.e. it shall not be prefixed by path separator characters such as "." 
          and "/".

          EXAMPLE: foo/bar/m@ster
        type: string
      checksum:
        description: >
741 742
          Checksum of the VNF snapshot record file. Hash algorithms applicable to VNF snapshot package 
          artifacts are defined in ETSI GS NFV-SOL 010.
743 744 745 746 747
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum" 
      isEncrypted:
        description: >
          Reflects whether the VNF snapshot record file is encrypted (true) or not (false).
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Boolean"