InlineOnboarded_vnf_packagesVnfdId200Response

This type represents the information of a VNF package. NOTE 1: If the value of the onboardingState attribute is not equal to "ONBOARDED", the value of the operationalState attribute shall be equal to "DISABLED". NOTE 2: If the value of the onboardingState attribute is not equal to "ONBOARDED", the value of the usageState attribute shall be equal to "NOT_IN_USE". NOTE 3: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.

JSON Example

{
    "id": "string",
    "vnfdId": "string",
    "vnfdExtInvariantId": "string",
    "vnfProvider": "string",
    "vnfProductName": "string",
    "vnfSoftwareVersion": "string",
    "vnfdVersion": "string",
    "compatibleSpecificationVersions": [
        "string"
    ],
    "checksum": "string",
    "packageSecurityOption": "string",
    "signingCertificate": "string",
    "softwareImages": [
        {
            "id": "string",
            "name": "string",
            "provider": "string",
            "version": "string",
            "checksum": "string",
            "isEncrypted": false,
            "containerFormat": "string",
            "diskFormat": "string",
            "createdAt": "string",
            "minDisk": 0,
            "minRam": 0,
            "size": 0,
            "imagePath": "string",
            "imageUri": "string"
        }
    ],
    "additionalArtifacts": [
        {
            "artifactPath": "string",
            "artifactURI": [
                "string"
            ],
            "checksum": "string",
            "isEncrypted": false,
            "nonManoArtifactSetId": "string",
            "artifactClassification": "string"
        }
    ],
    "onboardingState": "string",
    "operationalState": "string",
    "usageState": "string",
    "vnfmInfo": "string",
    "onboardingFailureDetails": {
        "type": "string",
        "title": "string",
        "status": 0,
        "detail": "string",
        "instance": "string"
    },
    "_links": {
        "self": {
            "href": "string"
        },
        "vnfd": {
            "href": "string"
        },
        "packageContent": {
            "href": "string"
        }
    }
}

string

Required

Identifier of the on-boarded VNF package. This identifier is allocated by the NFVO.

string

vnfdId

Optional

This identifier, which is managed by the VNF provider, identifies the VNF package and the VNFD in a globally unique way. It's copied from the VNFD of the on-boarded VNF package. It shall be present after the VNF package content has been on-boarded and absent otherwise.

string

vnfdExtInvariantId

Optional

Identifies a VNFD in a version independent manner. This attribute is invariant across versions of the VNFD that fulfil certain conditions related to the external connectivity and management of the VNF. It shall be present after the VNF package content has been on-boarded if it is included in the VNFD and shall be absent otherwise. If present it is copied from the VNFD of the on-boarded VNF package.

string

vnfProvider

Optional

Provider of the VNF package and the VNFD. This information is copied from the VNFD.

string

vnfProductName

Optional

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.

string

vnfSoftwareVersion

Optional

Software version of the VNF. This is changed when there is any change to the software included in the VNF package. This information is copied from the VNFD. It shall be present after the VNF package content has been on-boarded and absent otherwise.

string

vnfdVersion

Optional

The version of the VNFD. This information is copied from the VNFD. It shall be present after the VNF package content has been on-boarded and absent otherwise.

array of string

compatibleSpecificationVersions

Optional

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.

string

checksum

Optional

Checksum of the on-boarded VNF package. It shall be present after the VNF package content has been on-boarded and absent otherwise. Permitted hash algorithms are defined in ETSI GS NFV-SOL 004.

string

packageSecurityOption

Optional

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

Possible values are : OPTION_1, OPTION_2,

string

signingCertificate

Optional

The singleton signing certificate if it is included as a file in the VNF package.

array of object

softwareImages

Optional

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.

array of object

additionalArtifacts

Optional

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.

string

onboardingState

Required

On-boarding state of the VNF package.

Possible values are : CREATED, UPLOADING, PROCESSING, ONBOARDED, ERROR,

string

operationalState

Required

Operational state of the VNF package. See note 1.

Possible values are : ENABLED, DISABLED,

string

usageState

Required

Usage state of the VNF package. See note 2.

Possible values are : IN_USE, NOT_IN_USE,

string

vnfmInfo

Required

Specifies VNFMs compatible with the VNF. This information is copied from the VNFD. See note 3.

object

userDefinedData

Optional

User defined data for the VNF package.

object

onboardingFailureDetails

Optional

Failure details of current onboarding procedure. See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure. If "onboardingState" is "ERROR", this attribute shall be present and contain error information (such as failed onboarding or processing operation, affected artifact etc.), unless it has been requested to be excluded via an attribute selector.

object

_links

Required

Links to resources related to this resource.

Returned By

Get Vnfd Id