# 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. Hash algorithms applicable to VNF snapshot package are defined in ETSI GS NFV-SOL 010. 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" vnfcSnapshotInfoIds: description: > 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. 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/SOL005_def.yaml#/definitions/IdentifierLocal" 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 operation, affected artifact, reason for cancellation, etc.). See clause 6.3 of ETSI 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 anyOf: - required: - name - required: - userDefinedData - required: - state 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: > Identifier held by the NFVO about the "Individual VNF snapshot" resource with the information managed by the VNFM about a specific VNF snapshot to be packaged into the VNF snapshot package. $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfcSnapshotsInfoIds: description: > 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. type: array items: $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" importSnapshotResource: description: > 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. $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 oneOf: - required: - vnfSnapshotInfoId - required: - vnfInstanceId 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: description: > #no definition found VnfSnapshotPkgExtArtifactsAccessInfo description ! 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: > Access configuration information for an external artifact. 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. It shall comply with the provisions defined in table 11.5.3.2-1. 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: description: > Checksum of the snapshot image file. Hash algorithms applicable to VNF snapshot package artifacts are defined in ETSI GS NFV-SOL 010. $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: > Checksum of the artifact file. Hash algorithms applicable to VNF snapshot package artifacts are defined in ETSI GS NFV-SOL 010. $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 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. 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: > Checksum of the VNFD archive file. Hash algorithms applicable to VNF snapshot package artifacts are defined in ETSI GS NFV-SOL 010. $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: > Checksum of the VNF snapshot record file. Hash algorithms applicable to VNF snapshot package artifacts are defined in ETSI GS NFV-SOL 010. $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"