NsInstance
NsInstance
This type represents a response for Query NS operation. It shall comply with the provisions defined in Table 6.5.2.10-1.
JSON Example
{
"id": "string",
"nsInstanceName": "string",
"nsInstanceDescription": "string",
"nsdId": "string",
"nsdInfoId": "string",
"flavourId": "string",
"vnfInstance": [
{
"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
}
}
],
"pnfInfo": [
{
"pnfId": "string",
"pnfName": "string",
"pnfdId": "string",
"pnfdInfoId": "string",
"pnfProfileId": "string",
"cpInfo": {
"cpInstanceId": "string",
"cpdId": "string",
"cpProtocolData": [
{
"layerProtocol": "string",
"ipOverEthernet": {
"macAddress": "string",
"ipAddresses": [
{
"type": "string",
"fixedAddresses": [
"string"
],
"numDynamicAddresses": 0,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"subnetId": "string"
}
]
}
}
]
}
}
],
"virtualLinkInfo": [
{
"id": "string",
"nsVirtualLinkDescId": "string",
"nsVirtualLinkProfileId": "string",
"resourceHandle": [
{
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
}
],
"linkPort": [
{
"id": "string",
"resourceHandle": {
"vimId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string"
},
"nsCpHandle": [
{
"vnfInstanceId": "string",
"vnfExtCpInstanceId": "string",
"pnfInfoId": "string",
"pnfExtCpInstanceId": "string",
"nsInstanceId": "string",
"nsSapInstanceId": "string"
}
]
}
]
}
],
"vnffgInfo": [
{
"id": "string",
"vnffgdId": "string",
"vnfInstanceId": [
"string"
],
"pnfdInfoId": [
"string"
],
"nsVirtualLinkInfoId": [
"string"
],
"nsCpHandle": [
{
"vnfInstanceId": "string",
"vnfExtCpInstanceId": "string",
"pnfInfoId": "string",
"pnfExtCpInstanceId": "string",
"nsInstanceId": "string",
"nsSapInstanceId": "string"
}
]
}
],
"sapInfo": [
{
"id": "string",
"sapdId": "string",
"sapName": "string",
"description": "string",
"sapProtocolInfo": [
{
"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"
}
}
]
}
],
"nestedNsInstanceId": [
"string"
],
"nsState": "string",
"monitoringParameter": [
{
"id": "string",
"name": "string",
"performanceMetric": "string"
}
],
"nsScaleStatus": [
{
"nsScalingAspectId": "string",
"nsScaleLevelId": "string"
}
],
"additionalAffinityOrAntiAffinityRule": [
{
"vnfdId": [
"string"
],
"vnfProfileId": [
"string"
],
"vnfInstanceId": [
"string"
],
"affinityOrAntiAffiinty": "string",
"scope": "string"
}
],
"_links": {
"self": {
"href": "string"
},
"nestedNsInstances": [
{
"href": "string"
}
],
"instantiate": {
"href": "string"
},
"terminate": {
"href": "string"
},
"update": {
"href": "string"
},
"scale": {
"href": "string"
},
"heal": {
"href": "string"
}
}
}string
nsInstanceName
Required
Human readable name of the NS instance.
string
nsInstanceDescription
Required
Human readable description of the NS instance.
array of NsVirtualLinkInfo
virtualLinkInfo
Optional
Information on the VL(s) of the NS instance. This attribute shall be present if the nsState attribute value is INSTANTIATED and if the NS instance has specified connectivity.
string
nsState
Required
The state of the NS instance. Permitted values: NOT_INSTANTIATED: The NS instance is terminated or not instantiated. INSTANTIATED: The NS instance is instantiated.
Possible values are : NOT_INSTANTIATED, INSTANTIATED,
array of NsMonitoringParameter
monitoringParameter
Optional
Performance metrics tracked by the NFVO (e.g. for auto-scaling purposes) as identified by the NS designer in the NSD.
array of NsScaleInfo
nsScaleStatus
Optional
Status of each NS scaling aspect declared in the applicable DF, how "big" the NS instance has been scaled w.r.t. that aspect. This attribute shall be present if the nsState attribute value is INSTANTIATED.
array of AffinityOrAntiAffinityRule
additionalAffinityOrAntiAffinityRule
Optional
Information on the additional affinity or anti-affinity rule from NS instantiation operation. Shall not conflict with rules already specified in the NSD.