WARNING! Gitlab maintenance operation scheduled for Monday, 20 April between 12:00 and 14:00 (CET). During this time window, short service interruptions (less than 5 minutes) may occur. Thank you in advance for your understanding.
"description":"This type represents the information of an VNF package.\n",
"description":"This type represents the information of a VNF package. It shall comply with the provisions defined in table 10.5.2.2-1.\nNOTE 1:\tIf the value of the onboardingState attribute is not equal to \"ONBOARDED\", the value of the operationalState \n attribute shall be equal to \"DISABLED\".\nNOTE 2:\tIf the value of the onboardingState attribute is not equal to \"ONBOARDED\", the value of the usageState attribute \n shall be equal to \"NOT_IN_USE\".\nNOTE 3:\tETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.\n",
"description":"An identifier with the intention of being globally unique.\n",
@@ -17,121 +12,83 @@
"type":"string"
},
"vnfProvider":{
"description":"Provider of the VNF package and the VNFD. This information is copied from the VNFD.\n",
"description":"A string defined in IETF RFC 8259.\n",
"type":"string"
},
"vnfProductName":{
"description":"Name to identify the VNF product. Invariant for the VNF product lifetime. This information is copied from the VNFD. It shall be present after the VNF package content has been on-boarded and absent otherwise.\n",
"description":"A string defined in IETF RFC 8259.\n",
"type":"string"
},
"vnfSoftwareVersion":{
"description":"A Version.\n",
"description":"A version.\n",
"type":"string"
},
"vnfdVersion":{
"description":"A Version.\n",
"description":"A version.\n",
"type":"string"
},
"compatibleSpecificationVersions":{
"description":"Indicates which versions of the ETSI GS NFV-SOL 004 specification the package complies to, as defined in the manifest of the package. Each entry shall be formatted as defined in clause 4.3.2 of ETSI GS NFV-SOL 004.\n",
"type":"array",
"items":{
"description":"A version.\n",
"type":"string"
}
},
"checksum":{
"description":"This type represents the checksum of a VNF package or an artifact file.\n",
"type":"object",
"required":[
"algorithm",
"hash"
],
"properties":{
"algorithm":{
"description":"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.\n",
"description":"Cheksum description\n",
"type":"string"
},
"hash":{
"description":"The hexadecimal value of the checksum.\n",
"packageSecurityOption":{
"description":"Signals the security option used by the package as defined in clause 5.1 of ETSI GS NFV-SOL 004. It shall be present after the VNF package content has been on-boarded and absent otherwise. Valid values: OPTION_1, OPTION_2\n",
"type":"string",
"enum":["OPTION_1","OPTION_2"]
},
"signingCertificate":{
"description":"A string defined in IETF RFC 8259.\n",
"type":"string"
}
}
},
"softwareImages":{
"description":"Information about VNF package artifacts that are software images. This attribute shall not be present before the VNF package content is on-boarded. 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 a VNF package which represents a software image.\n",
"description":"This type represents an artifact contained in or external to a VNF package which represents a software image. It shall comply with the provisions defined in table 10.5.3.2-1.\nNOTE 1:\tThe list of permitted values was taken from \"Container formats\" in OpenStack® documentation: \"Disk and container formats for images\"\n (Available at https://docs.openstack.org/glance/pike/user/formats.html).\nNOTE 2:\tThe list of permitted values was adapted from \"Disk formats\" in OpenStack® documentation: \"Disk and container formats for images\"\n (Available at https://docs.openstack.org/glance/pike/user/formats.html).\n",
"description":"An identifier that is unique within a VNF descriptor.\n",
"type":"string"
},
"name":{
"description":"Name of the software image.\n",
"description":"A string defined in IETF RFC 8259.\n",
"type":"string"
},
"provider":{
"description":"Provider of the software image.\n",
"description":"A string defined in IETF RFC 8259.\n",
"type":"string"
},
"version":{
"description":"A Version.\n",
"description":"A version.\n",
"type":"string"
},
"checksum":{
"description":"This type represents the checksum of a VNF package or an artifact file.\n",
"type":"object",
"required":[
"algorithm",
"hash"
],
"properties":{
"algorithm":{
"description":"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.\n",
"description":"Cheksum description\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"
},
"containerFormat":{
"description":"Container format indicates whether the software image is in a file format that also contains metadata about the actual software. 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 http://docs.openstack.org/image-guide/image-formats.html\n",
"description":"Container format indicates whether the software image is in a file format that also contains metadata about the actual software. 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 See note 1.\n",
"description":"Disk format of a software 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\n- QCOW2: a common disk image format, which can expand dynamically and supports copy on write\n- 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 http://docs.openstack.org/image-guide/image-formats.html\n",
"description":"Disk format of a software 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\n- QCOW2: a common disk image format, which can expand dynamically and supports copy on write\n- 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 See note 2.\n",
"description":"Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
@@ -151,128 +108,151 @@
"type":"integer"
},
"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",
"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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type":"object"
},
"imagePath":{
"description":"Path in the VNF package, which identifies the image artifact and also allows to access a copy of the image artifact.\n",
"description":"Path which identifies the image artifact and also allows to access a copy of the image artifact. For a software image contained as a file in the VNF 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 software image represented as a URI in the VNF descriptor, this attribute shall be present if the image artifact has been downloaded by the NFVO 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 package\" resource defined in clause 9.4.7. 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 image artifacts included in the package.\n",
"type":"string"
},
"imageUri":{
"description":"String formatted according to IETF RFC 3986.\n",
"type":"string"
}
}
}
},
"additionalArtifacts":{
"description":"Information about VNF package artifacts contained in the VNF package that are not software images. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present if the VNF package contains additional artifacts.\n",
"description":"Information about VNF package artifacts contained in the VNF package that are not software images. Every local and external artifact declared in the manifest shall be included, except the software images and the files that make up the parts of the VNFD (see clause 10.4.4.3.2). Signature files and certificate files are not considered as artifacts, however, the content of the \"Licenses\" and \"Testing\" directories in the VNF package is. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present if the VNF package contains additional artifacts.\n",
"type":"array",
"items":{
"description":"This type represents an artifact other than a software image which is contained in a VNF package.\n",
"description":"This type represents an artifact other than a software image which is contained in or external to a VNF package.\n",
"description":"Path in the VNF package, which identifies the artifact and also allows to access a copy of the artifact.\n",
"description":"A string defined in IETF RFC 8259.\n",
"type":"string"
},
"artifactURI":{
"description":"URI of the artifact as defined in the VNF package manifest. Shall be present if the artifact is external to the package and shall be absent otherwise.\nEXAMPLE: https://example.com/m%40ster.sh\n",
"type":"array",
"items":{
"description":"String formatted according to IETF RFC 3986.\n",
"type":"string"
}
},
"checksum":{
"description":"This type represents the checksum of a VNF package or an artifact file.\n",
"type":"object",
"required":[
"algorithm",
"hash"
],
"properties":{
"algorithm":{
"description":"Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.\n",
"description":"Cheksum description\n",
"type":"string"
},
"hash":{
"description":"The hexadecimal value of the checksum.\n",
"isEncrypted":{
"description":"The Boolean is a data type having two values (true and false).\n",
"type":"boolean"
},
"nonManoArtifactSetId":{
"description":"A string defined in IETF RFC 8259.\n",
"type":"string"
}
}
},
"artifactClassification":{
"description":"Marks specific types of artifacts as defined in the VNF package. If none of the specific classes listed below applies, the attribute shall not be present.\nValid values: -\tHISTORY: a history artifact as per clause 4.3.3 in ETSI GS NFV-SOL 004 -\tTESTING: a testing artifact as per clause 4.3.4 in ETSI GS NFV-SOL 004 -\tLICENSE: a license artifact as per clause 4.3.5 in ETSI GS NFV-SOL 004\n",
"type":"string",
"enum":["HISTORY","TESTING","LICENSE"]
},
"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",
"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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type":"object"
}
}
}
},
"onboardingState":{
"description":"CREATED: The VNF package resource has been created. UPLOADING: The associated VNF package content is being uploaded. PROCESSING: The associated VNF package content is being processed, e.g., validation.\nONBOARDED: The associated VNF package content has been successfully on-boarded.\n",
"description":"CREATED: The \"Individual VNF package\" resource has been created. UPLOADING: The associated VNF package content is being uploaded. PROCESSING: The associated VNF package content is being processed, e.g., validation.\nONBOARDED: The associated VNF package content has been on-boarded successfully. ERROR: There was an error during upload of the VNF package content or external artifacts, or during VNF package processing.\n",
"description":"- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances.\n- DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package\n is re-enabled).\n",
"description":"- ENABLED: The VNF package is enabled, i.e. it can be used for the creation of new \"Individual VNF instance\" resources.\n- DISABLED: The VNF package is disabled, i.e. it shall not be used for the creation of further \"Individual VNF instance\" resources\n (unless and until the VNF package is re-enabled).\n",
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
"enum":["ENABLED","DISABLED"]
},
"usageState":{
"description":"- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package.\n"
"description":"- IN_USE: \"Individual VNF instance\" resources created from this VNF package exist. - NOT_IN_USE: No \"Individual VNF instance\" resource created from this VNF package exists.\n",
"type":"string",
"enum":["IN_USE","NOT_IN_USE"]
},
"vnfmInfo":{
"description":"A string defined in IETF RFC 8259.\n",
"type":"string"
},
"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",
"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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type":"object"
},
"onboardingFailureDetails":{
"description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807, 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 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.\n",
"type":"object",
"required":["status","detail"],
"properties":{
"type":{
"description":"A URI reference according to IETF RFC 3986 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"
}
}
},
"_links":{
"description":"Links to resources related to this resource.\n",
"type":"object",
"required":[
"self",
"packageContent"
],
"required":["self","packageContent"],
"properties":{
"self":{
"description":"This type represents a link to a resource.\n",
"description":"This type represents a link to a resource using an absolute URI.\n",
"type":"object",
"required":[
"href"
],
"required":["href"],
"properties":{
"href":{
"description":"URI of the referenced resource.\n",
"type":"string",
"format":"url"
"description":"String formatted according to IETF RFC 3986.\n",
"type":"string"
}
}
},
"vnfd":{
"description":"This type represents a link to a resource.\n",
"description":"This type represents a link to a resource using an absolute URI.\n",
"type":"object",
"required":[
"href"
],
"required":["href"],
"properties":{
"href":{
"description":"URI of the referenced resource.\n",
"type":"string",
"format":"url"
"description":"String formatted according to IETF RFC 3986.\n",
"type":"string"
}
}
},
"packageContent":{
"description":"This type represents a link to a resource.\n",
"description":"This type represents a link to a resource using an absolute URI.\n",
"type":"object",
"required":[
"href"
],
"required":["href"],
"properties":{
"href":{
"description":"URI of the referenced resource.\n",
"type":"string",
"format":"url"
"description":"String formatted according to IETF RFC 3986.\n",
