VnfInstance

VnfInstance
VnfInstance

This type represents a VNF instance.

JSON Example
{
    "id": "string",
    "vnfInstanceName": "string",
    "vnfInstanceDescription": "string",
    "vnfdId": "string",
    "vnfProvider": "string",
    "vnfProductName": "string",
    "vnfSoftwareVersion": "string",
    "vnfdVersion": "string",
    "vimConnectionInfo": [
        {
            "id": "string",
            "vimId": "string",
            "vimType": "string",
            "extra": {
                "deploymentProfileId": "string",
                "nodeProfileName": "string",
                "nodePoolId": "string",
                "nodePoolName": "string",
                "vimName": "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"
                                }
                            ]
                        }
                    }
                ],
                "extLinkPortId": "string",
                "associatedVnfcCpId": "string",
                "associatedVnfVirtualLinkId": "string"
            }
        ],
        "extVirtualLinkInfo": [
            {
                "id": "string",
                "resourceHandle": {
                    "vimConnectionId": "string",
                    "resourceProviderId": "string",
                    "resourceId": "string",
                    "vimLevelResourceType": "string"
                },
                "extLinkPorts": [
                    {
                        "id": "string",
                        "resourceHandle": {
                            "vimConnectionId": "string",
                            "resourceProviderId": "string",
                            "resourceId": "string",
                            "vimLevelResourceType": "string"
                        },
                        "cpInstanceId": "string"
                    }
                ]
            }
        ],
        "extManagedVirtualLinkInfo": [
            {
                "id": "string",
                "vnfVirtualLinkDescId": "string",
                "networkResource": {
                    "vimConnectionId": "string",
                    "resourceProviderId": "string",
                    "resourceId": "string",
                    "vimLevelResourceType": "string"
                },
                "vnfLinkPorts": [
                    {
                        "id": "string",
                        "resourceHandle": {
                            "vimConnectionId": "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": {
                    "vimConnectionId": "string",
                    "resourceProviderId": "string",
                    "resourceId": "string",
                    "vimLevelResourceType": "string"
                },
                "zoneId": "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"
                                        }
                                    ]
                                }
                            }
                        ],
                        "vnfLinkPortId": "string"
                    }
                ],
                "metadata": {
                    "dispatchType": "string",
                    "namespace": "string",
                    "chartName": "string",
                    "chartVersion": "string",
                    "repoUrl": "string",
                    "username": "string",
                    "helmVersion": "string",
                    "instantiationState": "string"
                }
            }
        ],
        "virtualLinkResourceInfo": [
            {
                "id": "string",
                "vnfVirtualLinkDescId": "string",
                "networkResource": {
                    "vimConnectionId": "string",
                    "resourceProviderId": "string",
                    "resourceId": "string",
                    "vimLevelResourceType": "string"
                },
                "zoneId": "string",
                "reservationId": "string",
                "vnfLinkPorts": [
                    {
                        "id": "string",
                        "resourceHandle": {
                            "vimConnectionId": "string",
                            "resourceProviderId": "string",
                            "resourceId": "string",
                            "vimLevelResourceType": "string"
                        },
                        "cpInstanceId": "string",
                        "cpInstanceType": "string"
                    }
                ]
            }
        ],
        "virtualStorageResourceInfo": [
            {
                "id": "string",
                "virtualStorageDescId": "string",
                "storageResource": {
                    "vimConnectionId": "string",
                    "resourceProviderId": "string",
                    "resourceId": "string",
                    "vimLevelResourceType": "string"
                },
                "zoneId": "string",
                "reservationId": "string"
            }
        ]
    },
    "metadata": {
        "vnfPkgId": "string",
        "vnfCatalogName": "string",
        "managedBy": {
            "extensionSubtype": "string",
            "extensionName": "string"
        },
        "nfType": "string",
        "lcmOperation": "string",
        "lcmOperationState": "string",
        "isUsedByNS": "string",
        "attachedNSCount": 0,
        "extVirtualLinks": [
            {
                "id": "string",
                "vimConnectionId": "string",
                "resourceProviderId": "string",
                "resourceId": "string",
                "extCps": [
                    {
                        "cpdId": "string",
                        "cpConfig": [
                            {
                                "cpInstanceId": "string",
                                "linkPortId": "string",
                                "cpProtocolData": [
                                    {
                                        "layerProtocol": "string",
                                        "ipOverEthernet": {
                                            "macAddress": "string",
                                            "ipAddresses": [
                                                {
                                                    "type": "string",
                                                    "fixedAddresses": [
                                                        "string"
                                                    ],
                                                    "numDynamicAddresses": 0,
                                                    "addressRange": {
                                                        "minAddress": "string",
                                                        "maxAddress": "string"
                                                    },
                                                    "subnetId": "string"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        ]
                    }
                ],
                "extLinkPorts": [
                    {
                        "id": "string",
                        "resourceHandle": {
                            "vimConnectionId": "string",
                            "resourceProviderId": "string",
                            "resourceId": "string",
                            "vimLevelResourceType": "string"
                        }
                    }
                ]
            }
        ],
        "tags": [
            {
                "name": "string",
                "autoCreated": false
            }
        ]
    },
    "_links": {
        "self": {
            "href": "string"
        },
        "indicators": {
            "href": "string"
        },
        "instantiate": {
            "href": "string"
        },
        "terminate": {
            "href": "string"
        },
        "scale": {
            "href": "string"
        },
        "scaleToLevel": {
            "href": "string"
        },
        "changeFlavour": {
            "href": "string"
        },
        "heal": {
            "href": "string"
        },
        "operate": {
            "href": "string"
        },
        "changeExtConn": {
            "href": "string"
        }
    }
}
id
Required

id

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.

vnfdId
Required

vnfdId

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.

vnfSoftwareVersion
Required

vnfSoftwareVersion

vnfdVersion
Required

vnfdVersion

vnfConfigurableProperties
Optional

vnfConfigurableProperties

vimConnectionInfo
Optional

Information about VIM connections to be used for managing the resources for the VNF instance. This attribute shall only be supported and present if VNF-related resource management in direct mode is applicable. This attribute can be modified with the PATCH method.

string
instantiationState
Required

The instantiation state of the VNF.

Possible values are : NOT_INSTANTIATED, INSTANTIATED,
instantiatedVnfInfo
Optional

instantiatedVnfInfo

metadata
Optional

metadata

extensions
Optional

extensions

_links
Optional

_links