Something went wrong on our end
VnfSnapshotPkgInfo.schema.json 19.96 KiB
{
"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.\n",
"type": "object",
"required": [
"id",
"name",
"isFullSnapshot",
"state",
"isCancelPending",
"_links"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfSnapshotPkgUniqueId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"name": {
"description": "Human-readable name of the VNF snapshot package.\n",
"type": "string"
},
"checksum": {
"description": "This type represents the checksum of a VNF package or an artifact file.\n",
"required": [
"algorithm",
"hash"
],
"type": "object",
"properties": {
"algorithm": {
"description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512.\n",
"type": "string"
},
"hash": {
"description": "The hexadecimal value of the checksum.\n",
"type": "string"
}
}
},
"createdAt": {
"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
"format": "date-time"
},
"vnfSnapshotId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"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.\nThe 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.\n",
"type": "array",
"items": {
"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
"type": "string"
}
},
"isFullSnapshot": {
"description": "The Boolean is a data type having two values (TRUE and FALSE).\n",
"type": "boolean"
},
"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.\n",
"type": "object",
"required": [
"vnfdId",
"vnfdPath",
"checksum",
"isEncrypted" ],
"properties": {
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"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.\nThe 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 \"/\".\nEXAMPLE: foo/bar/m@ster\n",
"type": "string"
},
"checksum": {
"description": "This type represents the checksum of a VNF package or an artifact file.\n",
"required": [
"algorithm",
"hash"
],
"type": "object",
"properties": {
"algorithm": {
"description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512.\n",
"type": "string"
},
"hash": {
"description": "The hexadecimal value of the checksum.\n",
"type": "string"
}
}
},
"isEncrypted": {
"description": "The Boolean is a data type having two values (TRUE and FALSE).\n",
"type": "boolean"
}
}
},
"vnfsr": {
"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.\n",
"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.\nThe 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 \"/\".\nEXAMPLE: foo/bar/m@ster\n",
"type": "string"
},
"checksum": {
"description": "This type represents the checksum of a VNF package or an artifact file.\n",
"required": [
"algorithm",
"hash"
],
"type": "object",
"properties": {
"algorithm": {
"description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512.\n",
"type": "string"
},
"hash": {
"description": "The hexadecimal value of the checksum.\n",
"type": "string"
}
}
},
"isEncrypted": {
"description": "The Boolean is a data type having two values (TRUE and FALSE).\n",
"type": "boolean"
}
} },
"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. \nThe 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.\n",
"type": "array",
"items": {
"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.\n",
"type": "object",
"required": [
"id",
"name",
"checksum",
"isEncrypted",
"vnfcInstanceId",
"containerFormat",
"diskFormat",
"createdAt",
"minDisk",
"minRam",
"size"
],
"properties": {
"id": {
"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
"type": "string"
},
"name": {
"description": "Name of the VNFC snapshot image.",
"type": "string"
},
"checksum": {
"description": "This type represents the checksum of a VNF package or an artifact file.\n",
"required": [
"algorithm",
"hash"
],
"type": "object",
"properties": {
"algorithm": {
"description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512.\n",
"type": "string"
},
"hash": {
"description": "The hexadecimal value of the checksum.\n",
"type": "string"
}
}
},
"isEncrypted": {
"description": "The Boolean is a data type having two values (TRUE and FALSE).\n",
"type": "boolean"
},
"vnfcInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"containerFormat": {
"description": "Container format indicates whether the snapshot image is in a file format that also contains metadata about the actual snapshot.\nPermitted 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.\nThe 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)\n",
"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.\nPermitted 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.\nThe 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)\n", "type": "string",
"enum": [
"AKI",
"AMI",
"ARI",
"ISO",
"QCOW2",
"RAW",
"VDI",
"VHD",
"VHDX",
"VMDK"
]
},
"createdAt": {
"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
"format": "date-time"
},
"minDisk": {
"description": "Unsigned integer number\n",
"type": "integer",
"minimum": 0
},
"minRam": {
"description": "Unsigned integer number\n",
"type": "integer",
"minimum": 0
},
"size": {
"description": "Unsigned integer number\n",
"type": "integer",
"minimum": 0
},
"userMetadata": {
"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.\n",
"type": "object"
},
"imagePath": {
"description": "Path which identifies the image artifact and also allows to access a copy of the image artifact. \nFor 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 \"/\".\nEXAMPLE: foo/bar/m%40ster.vhd\nFor 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.\n",
"type": "string"
},
"imageUri": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string",
"format": "uri"
}
}
}
},
"additionalArtifacts": {
"description": "Information about VNF snapshot artifacts that are not VNFC snapshot images. \nThe 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.\n",
"type": "array",
"items": {
"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.\n",
"type": "object",
"required": [
"checksum",
"isEncrypted"
],
"properties": {
"artifactPath": {
"description": "Path which identifies the artifact and also allows to access a copy of the artifact.\nFor 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 \"/\".\nEXAMPLE: foo/bar/m%40ster.sh\nFor 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.\n",
"type": "string"
},
"artifactUri": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string",
"format": "uri"
},
"checksum": { "description": "This type represents the checksum of a VNF package or an artifact file.\n",
"required": [
"algorithm",
"hash"
],
"type": "object",
"properties": {
"algorithm": {
"description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512.\n",
"type": "string"
},
"hash": {
"description": "The hexadecimal value of the checksum.\n",
"type": "string"
}
}
},
"isEncrypted": {
"description": "The Boolean is a data type having two values (TRUE and FALSE).\n",
"type": "boolean"
},
"metadata": {
"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.\n",
"type": "object"
}
}
}
},
"state": {
"description": "State of the VNF snapshot package.\nPermitted 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 packages 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.\n",
"type": "string",
"enum": [
"CREATED",
"BUILDING",
"UPLOADING",
"EXTRACTING",
"AVAILABLE",
"ERROR",
"ERROR_EXTRACTING"
]
},
"isCancelPending": {
"description": "The Boolean is a data type having two values (TRUE and FALSE).\n",
"type": "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.\n",
"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\n",
"type": "string",
"enum": [
"BUILD_ERROR",
"UPLOAD_ERROR",
"PROCESS_ERROR",
"CANCELLED",
"EXTRACTION_ERROR"
]
},
"details": {
"description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this 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].\n",
"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\".\n",
"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).\n",
"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.\n",
"type": "integer"
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
"type": "string",
"format": "URI"
}
}
}
}
},
"userDefinedData": {
"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.\n",
"type": "object"
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self",
"packageContent"
],
"properties": {
"self": {
"description": "This type represents a link to a resource.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
"type": "string",
"format": "url"
}
}
},
"packageContent": {
"description": "This type represents a link to a resource.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
"type": "string",
"format": "url"
}
}
}
}
} }
}