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.
{
"id": "string",
"vnfInstanceName": "string",
"vnfInstanceDescription": "string",
"vnfdId": "string",
"vnfProvider": "string",
"vnfProductName": "string",
"vnfSoftwareVersion": "string",
"vnfdVersion": "string",
"vnfPkgId": "string",
"vimId": "string",
"instantiationState": "string",
"instantiatedVnfInfo": {
"flavourId": "string",
"vnfState": "string",
"scaleStatus": [
{
"aspectId": "string",
"scaleLevel": 0
}
],
"maxScaleLevels": [
{
"aspectId": "string",
"scaleLevel": 0
}
],
"extCpInfo": [
{
"id": "string",
"cpdId": "string",
"cpProtocolInfo": [
{
"layerProtocol": "string",
"ipOverEthernet": {
"macAddress": "string",
"ipAddresses": [
{
"type": "string",
"addresses": [
"string"
],
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"subnetId": "string"
}
],
"type": "string",
"addresses": "string",
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"minAddress": "string",
"maxAddress": "string",
"subnetId": "string"
}
}
],
"extLinkPortId": {
"layerProtocol": "string",
"ipOverEthernet": {
"macAddress": "string",
"ipAddresses": [
{
"type": "string",
"addresses": [
"string"
],
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"subnetId": "string"
}
],
"type": "string",
"addresses": "string",
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"minAddress": "string",
"maxAddress": "string",
"subnetId": "string"
}
},
"associatedVnfcCpId": "string",
"associatedVnfVirtualLinkId": "string"
}
],
"extVirtualLinkInfo": [
{
"id": "string",
"resourceHandle": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"extLinkPorts": [
{
"id": "string",
"resourceHandle": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"cpInstanceId": "string"
}
]
}
],
"extManagedVirtualLinkInfo": [
{
"id": "string",
"vnfVirtualLinkDescId": "string",
"networkResource": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"vnfLinkPorts": [
{
"id": "string",
"resourceHandle": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"cpInstanceId": "string",
"cpInstanceType": "string"
}
]
}
],
"monitoringParameters": [
{
"id": "string",
"name": "string",
"performanceMetric": "string"
}
],
"localizationLanguage": "string",
"vnfcResourceInfo": [
{
"id": "string",
"vduId": "string",
"computeResource": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"storageResourceIds": [
"string"
],
"reservationId": "string",
"vnfcCpInfo": [
{
"id": "string",
"cpdId": "string",
"vnfExtCpId": "string",
"cpProtocolInfo": [
{
"layerProtocol": "string",
"ipOverEthernet": {
"macAddress": "string",
"ipAddresses": [
{
"type": "string",
"addresses": [
"string"
],
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"subnetId": "string"
}
],
"type": "string",
"addresses": "string",
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"minAddress": "string",
"maxAddress": "string",
"subnetId": "string"
}
}
],
"vnfLinkPortId": "string"
}
]
}
],
"virtualLinkResourceInfo": [
{
"id": "string",
"vnfVirtualLinkDescId": "string",
"networkResource": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"reservationId": "string",
"vnfLinkPorts": [
{
"id": "string",
"resourceHandle": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"cpInstanceId": "string",
"cpInstanceType": "string"
}
]
}
],
"virtualStorageResourceInfo": [
{
"id": "string",
"virtualStorageDescId": "string",
"storageResource": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"reservationId": "string"
}
]
},
"extensions": {
"managedBy": {
"extensionSubtype": "string",
"extensionName": "string"
},
"type": "string",
"networks": [
{
"resourceId": "string",
"networkName": "string",
"vl_id": "string",
"key_name": "string"
}
],
"vimName": "string",
"lcmOperation": "string",
"lcmOperationState": "string",
"isOrchestrated": false
}
}
Name of the VNF instance. This attribute can be modified with the PATCH method.
Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.
Provider of the VNF and the VNFD. The value is copied from the VNFD.
Name to identify the VNF Product. The value is copied from the VNFD.
The instantiation state of the VNF.
Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.
Additional VNF-specific attributes that affect the lifecycle management of this VNF instance. These attributes represent values that are stored persistently in the VnfInstance structure for consumption by the VNFM, or by the lifecycle management scripts. during the execution of VNF lifecycle management operations. Modifying the values of these attributes has no direct effect on the VNF instance; however, the modified attribute values can be considered during subsequent VNF lifecycle management operations, which means that the modified values can indirectly affect the configuration of the VNF instance. Extensions that are writeable are declared in the VNFD. This attribute These attributes can be modified with the PATCH method. ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.