VnfInstance
VnfInstance
This type represents a VNF instance. Clause B.3.2 of ETSI GS NFV-SOL 003 [4] provides examples illustrating the relationship among the different run-time information elements (CP, VL and link ports) used to represent the connectivity of a VNF.
JSON Example
{
"vnfProductName": "vnfProductName",
"vnfdVersion": "vnfdVersion",
"metadata": {
"key": "metadata"
},
"vnfProvider": "vnfProvider",
"vimId": "vimId",
"vnfPkgId": "vnfPkgId",
"vnfConfigurableProperties": {
"key": "vnfConfigurableProperties"
},
"vnfdId": "vnfdId",
"instantiationState": "NOT_INSTANTIATED",
"vnfInstanceDescription": "vnfInstanceDescription",
"extensions": null,
"instantiatedVnfInfo": {
"virtualLinkResourceInfo": [
{
"metadata": {
"key": "metadata"
},
"reservationId": "reservationId",
"networkResource": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"id": "id",
"vnfVirtualLinkDescId": "vnfVirtualLinkDescId",
"vnfLinkPorts": [
{
"resourceHandle": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"cpInstanceType": "VNFC_CP",
"id": "id",
"cpInstanceId": "cpInstanceId"
},
{
"resourceHandle": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"cpInstanceType": "VNFC_CP",
"id": "id",
"cpInstanceId": "cpInstanceId"
}
]
},
{
"metadata": {
"key": "metadata"
},
"reservationId": "reservationId",
"networkResource": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"id": "id",
"vnfVirtualLinkDescId": "vnfVirtualLinkDescId",
"vnfLinkPorts": [
{
"resourceHandle": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"cpInstanceType": "VNFC_CP",
"id": "id",
"cpInstanceId": "cpInstanceId"
},
{
"resourceHandle": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"cpInstanceType": "VNFC_CP",
"id": "id",
"cpInstanceId": "cpInstanceId"
}
]
}
],
"monitoringParameters": [
{
"name": "name",
"id": "id",
"performanceMetric": "performanceMetric"
},
{
"name": "name",
"id": "id",
"performanceMetric": "performanceMetric"
}
],
"flavourId": "flavourId",
"scaleStatus": [
{
"scaleLevel": 0,
"aspectId": "aspectId"
},
{
"scaleLevel": 0,
"aspectId": "aspectId"
}
],
"extVirtualLinkInfo": [
{
"resourceHandle": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"extLinkPorts": [
{
"resourceHandle": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"id": "id",
"cpInstanceId": "cpInstanceId"
},
{
"resourceHandle": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"id": "id",
"cpInstanceId": "cpInstanceId"
}
],
"id": "id"
},
{
"resourceHandle": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"extLinkPorts": [
{
"resourceHandle": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"id": "id",
"cpInstanceId": "cpInstanceId"
},
{
"resourceHandle": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"id": "id",
"cpInstanceId": "cpInstanceId"
}
],
"id": "id"
}
],
"localizationLanguage": "localizationLanguage",
"extManagedVirtualLinkInfo": [
{
"networkResource": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"id": "id",
"vnfVirtualLinkDescId": "vnfVirtualLinkDescId",
"vnfLinkPorts": [
{
"resourceHandle": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"cpInstanceType": "VNFC_CP",
"id": "id",
"cpInstanceId": "cpInstanceId"
},
{
"resourceHandle": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"cpInstanceType": "VNFC_CP",
"id": "id",
"cpInstanceId": "cpInstanceId"
}
]
},
{
"networkResource": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"id": "id",
"vnfVirtualLinkDescId": "vnfVirtualLinkDescId",
"vnfLinkPorts": [
{
"resourceHandle": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"cpInstanceType": "VNFC_CP",
"id": "id",
"cpInstanceId": "cpInstanceId"
},
{
"resourceHandle": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
},
"cpInstanceType": "VNFC_CP",
"id": "id",
"cpInstanceId": "cpInstanceId"
}
]
}
],
"maxScaleLevels": [
{
"scaleLevel": 0,
"aspectId": "aspectId"
},
{
"scaleLevel": 0,
"aspectId": "aspectId"
}
],
"vnfcResourceInfo": [
{
"metadata": {
"key": "metadata"
},
"storageResourceIds": [
null,
null
],
"reservationId": "reservationId",
"vnfcCpInfo": [
{
"metadata": {
"key": "metadata"
},
"cpProtocolInfo": [
{
"ipOverEthernet": {
"maxAddress": "maxAddress",
"subnetId": "subnetId",
"macAddress": "macAddress",
"addresses": "addresses",
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"ipAddresses": [
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
},
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
}
],
"minAddress": "minAddress",
"type": "PV4"
},
"layerProtocol": "IP_OVER_ETHERNET"
},
{
"ipOverEthernet": {
"maxAddress": "maxAddress",
"subnetId": "subnetId",
"macAddress": "macAddress",
"addresses": "addresses",
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"ipAddresses": [
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
},
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
}
],
"minAddress": "minAddress",
"type": "PV4"
},
"layerProtocol": "IP_OVER_ETHERNET"
}
],
"cpdId": "cpdId",
"id": "id",
"vnfExtCpId": "vnfExtCpId",
"vnfLinkPortId": "vnfLinkPortId"
},
{
"metadata": {
"key": "metadata"
},
"cpProtocolInfo": [
{
"ipOverEthernet": {
"maxAddress": "maxAddress",
"subnetId": "subnetId",
"macAddress": "macAddress",
"addresses": "addresses",
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"ipAddresses": [
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
},
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
}
],
"minAddress": "minAddress",
"type": "PV4"
},
"layerProtocol": "IP_OVER_ETHERNET"
},
{
"ipOverEthernet": {
"maxAddress": "maxAddress",
"subnetId": "subnetId",
"macAddress": "macAddress",
"addresses": "addresses",
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"ipAddresses": [
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
},
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
}
],
"minAddress": "minAddress",
"type": "PV4"
},
"layerProtocol": "IP_OVER_ETHERNET"
}
],
"cpdId": "cpdId",
"id": "id",
"vnfExtCpId": "vnfExtCpId",
"vnfLinkPortId": "vnfLinkPortId"
}
],
"id": "id",
"vduId": "vduId",
"computeResource": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
}
},
{
"metadata": {
"key": "metadata"
},
"storageResourceIds": [
null,
null
],
"reservationId": "reservationId",
"vnfcCpInfo": [
{
"metadata": {
"key": "metadata"
},
"cpProtocolInfo": [
{
"ipOverEthernet": {
"maxAddress": "maxAddress",
"subnetId": "subnetId",
"macAddress": "macAddress",
"addresses": "addresses",
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"ipAddresses": [
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
},
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
}
],
"minAddress": "minAddress",
"type": "PV4"
},
"layerProtocol": "IP_OVER_ETHERNET"
},
{
"ipOverEthernet": {
"maxAddress": "maxAddress",
"subnetId": "subnetId",
"macAddress": "macAddress",
"addresses": "addresses",
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"ipAddresses": [
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
},
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
}
],
"minAddress": "minAddress",
"type": "PV4"
},
"layerProtocol": "IP_OVER_ETHERNET"
}
],
"cpdId": "cpdId",
"id": "id",
"vnfExtCpId": "vnfExtCpId",
"vnfLinkPortId": "vnfLinkPortId"
},
{
"metadata": {
"key": "metadata"
},
"cpProtocolInfo": [
{
"ipOverEthernet": {
"maxAddress": "maxAddress",
"subnetId": "subnetId",
"macAddress": "macAddress",
"addresses": "addresses",
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"ipAddresses": [
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
},
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
}
],
"minAddress": "minAddress",
"type": "PV4"
},
"layerProtocol": "IP_OVER_ETHERNET"
},
{
"ipOverEthernet": {
"maxAddress": "maxAddress",
"subnetId": "subnetId",
"macAddress": "macAddress",
"addresses": "addresses",
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"ipAddresses": [
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
},
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
}
],
"minAddress": "minAddress",
"type": "PV4"
},
"layerProtocol": "IP_OVER_ETHERNET"
}
],
"cpdId": "cpdId",
"id": "id",
"vnfExtCpId": "vnfExtCpId",
"vnfLinkPortId": "vnfLinkPortId"
}
],
"id": "id",
"vduId": "vduId",
"computeResource": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
}
}
],
"vnfState": null,
"extCpInfo": [
{
"metadata": {
"key": "metadata"
},
"cpProtocolInfo": [
{
"ipOverEthernet": {
"maxAddress": "maxAddress",
"subnetId": "subnetId",
"macAddress": "macAddress",
"addresses": "addresses",
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"ipAddresses": [
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
},
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
}
],
"minAddress": "minAddress",
"type": "PV4"
},
"layerProtocol": "IP_OVER_ETHERNET"
},
{
"ipOverEthernet": {
"maxAddress": "maxAddress",
"subnetId": "subnetId",
"macAddress": "macAddress",
"addresses": "addresses",
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"ipAddresses": [
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
},
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
}
],
"minAddress": "minAddress",
"type": "PV4"
},
"layerProtocol": "IP_OVER_ETHERNET"
}
],
"cpdId": "cpdId",
"associatedVnfVirtualLinkId": "associatedVnfVirtualLinkId",
"associatedVnfcCpId": "associatedVnfcCpId",
"id": "id",
"extLinkPortId": {
"ipOverEthernet": {
"maxAddress": "maxAddress",
"subnetId": "subnetId",
"macAddress": "macAddress",
"addresses": "addresses",
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"ipAddresses": [
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
},
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
}
],
"minAddress": "minAddress",
"type": "PV4"
},
"layerProtocol": "IP_OVER_ETHERNET"
}
},
{
"metadata": {
"key": "metadata"
},
"cpProtocolInfo": [
{
"ipOverEthernet": {
"maxAddress": "maxAddress",
"subnetId": "subnetId",
"macAddress": "macAddress",
"addresses": "addresses",
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"ipAddresses": [
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
},
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
}
],
"minAddress": "minAddress",
"type": "PV4"
},
"layerProtocol": "IP_OVER_ETHERNET"
},
{
"ipOverEthernet": {
"maxAddress": "maxAddress",
"subnetId": "subnetId",
"macAddress": "macAddress",
"addresses": "addresses",
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"ipAddresses": [
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
},
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
}
],
"minAddress": "minAddress",
"type": "PV4"
},
"layerProtocol": "IP_OVER_ETHERNET"
}
],
"cpdId": "cpdId",
"associatedVnfVirtualLinkId": "associatedVnfVirtualLinkId",
"associatedVnfcCpId": "associatedVnfcCpId",
"id": "id",
"extLinkPortId": {
"ipOverEthernet": {
"maxAddress": "maxAddress",
"subnetId": "subnetId",
"macAddress": "macAddress",
"addresses": "addresses",
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"ipAddresses": [
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
},
{
"subnetId": "subnetId",
"addresses": [
null,
null
],
"isDynamic": true,
"addressRange": {
"maxAddress": "maxAddress",
"minAddress": "minAddress"
},
"type": "IPV4"
}
],
"minAddress": "minAddress",
"type": "PV4"
},
"layerProtocol": "IP_OVER_ETHERNET"
}
}
],
"virtualStorageResourceInfo": [
{
"metadata": {
"key": "metadata"
},
"reservationId": "reservationId",
"virtualStorageDescId": "virtualStorageDescId",
"id": "id",
"storageResource": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
}
},
{
"metadata": {
"key": "metadata"
},
"reservationId": "reservationId",
"virtualStorageDescId": "virtualStorageDescId",
"id": "id",
"storageResource": {
"resourceId": "resourceId",
"vimId": "vimId",
"vimLevelResourceType": "vimLevelResourceType",
"resourceProviderId": "resourceProviderId"
}
}
]
},
"vnfInstanceName": "vnfInstanceName",
"id": "id",
"vnfSoftwareVersion": "vnfSoftwareVersion"
}string
id
Required
An identifier with the intention of being globally unique.
string
vnfInstanceName
Optional
Name of the VNF instance. This attribute can be modified with the PATCH method.
string
vnfInstanceDescription
Optional
Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.
string
vnfdId
Required
An identifier with the intention of being globally unique.
string
vnfProvider
Required
Provider of the VNF and the VNFD. The value is copied from the VNFD.
string
vnfProductName
Required
Name to identify the VNF Product. The value is copied from the VNFD.
string
vnfSoftwareVersion
Required
A Version. Representation: string of variable length.
string
vnfdVersion
Required
A Version. Representation: string of variable length.
string
vnfPkgId
Required
An identifier with the intention of being globally unique.
object
vnfConfigurableProperties
Optional
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.
string
vimId
Optional
An identifier with the intention of being globally unique.
string
instantiationState
Required
The instantiation state of the VNF.
Possible values are : NOT_INSTANTIATED, INSTANTIATED,
object
metadata
Optional
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.