InlineVnf_instances201Response
This type represents a VNF instance. NOTE: Clause B.3.2 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.
NOTE 1: Modifying the value of this attribute shall not be performed when conflicts exist between the previous and the newly referred VNF package, i.e. when the new VNFD is changed with respect to the previous VNFD in other aspects than merely referencing to other VNF software images. In order to avoid misalignment of the VnfInstance with the current VNF's on-boarded VNF Package, the values of attributes in the VnfInstance that have corresponding attributes in the VNFD shall be kept in sync with the values in the VNFD. NOTE 2: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. NOTE 3: VNF configurable properties are sometimes also referred to as configuration parameters applicable to a VNF. Some of these are set prior to instantiation and cannot be modified if the VNF is instantiated, some are set prior to instantiation (are part of initial configuration) and can be modified later, and others can be set only after instantiation. The applicability of certain configuration may depend on the VNF and the required operation of the VNF at a certain point in time. NOTE 4: Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with a defined initial value. The defined initial values can be declared in the VNFD, and/or, in case of "metadata", obtained from the "CreateVnfRequest" structure. Child attributes of "vnfConfigurableProperties", "metadata" and "extensions" that have no defined initial value shall not be created, in order to be consistent with the semantics of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion request. NOTE 5: It is possible to have several ExtManagedVirtualLinkInfo for the same VNF internal VL in case of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkInfo corresponding to the same VNF internal VL shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed multi-site VL instance (refer to clause 5.5.3.3). NOTE 6: Even though externally-managed internal VLs are also used for VNF-internal connectivity, they shall not be listed in the "vnfVirtualLinkResourceInfo" attribute as this would be redundant.
{
"id": "string",
"vnfInstanceName": "string",
"vnfInstanceDescription": "string",
"vnfdId": "string",
"vnfProvider": "string",
"vnfProductName": "string",
"vnfSoftwareVersion": "string",
"vnfdVersion": "string",
"instantiationState": "string",
"instantiatedVnfInfo": {
"flavourId": "string",
"vnfState": "string",
"scaleStatus": [
{
"aspectId": "string",
"vnfdId": "string",
"scaleToLevel": "string"
}
],
"maxScaleLevels": [
{
"aspectId": "string",
"vnfdId": "string",
"scaleToLevel": "string"
}
],
"extCpInfo": [
{
"id": "string",
"cpdId": "string",
"cpConfigId": "string",
"vnfdId": "string",
"cpProtocolInfo": [
{
"layerProtocol": "string",
"ipOverEthernet": {
"macAddress": "string",
"segmentationId": "string",
"ipAddresses": [
{
"type": "string",
"addresses": [
"string"
],
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"subnetId": "string"
}
]
},
"virtualCpAddress": {
"type": "string",
"loadBalancerIp": "string"
}
}
],
"extLinkPortId": "string",
"associatedVnfcCpId": "string",
"associatedVipCpId": "string",
"associatedVirtualCpId": "string",
"associatedVnfVirtualLinkId": "string",
"netAttDefResourceId": [
"string"
]
}
],
"vipCpInfo": [
{
"cpInstanceId": "string",
"cpdId": "string",
"vnfdId": "string",
"vnfExtCpId": "string",
"cpProtocolInfo": [
{
"layerProtocol": "string",
"ipOverEthernet": {
"macAddress": "string",
"segmentationId": "string",
"ipAddresses": [
{
"type": "string",
"addresses": [
"string"
],
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"subnetId": "string"
}
]
},
"virtualCpAddress": {
"type": "string",
"loadBalancerIp": "string"
}
}
],
"associatedVnfcCpIds": [
"string"
],
"vnfLinkPortId": "string",
"metadata": []
}
],
"virtualCpInfo": [
{
"cpInstanceId": "string",
"cpdId": "string",
"resourceHandle": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"vnfExtCpId": "string",
"cpProtocolInfo": [
{
"layerProtocol": "string",
"ipOverEthernet": {
"macAddress": "string",
"segmentationId": "string",
"ipAddresses": [
{
"type": "string",
"addresses": [
"string"
],
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"subnetId": "string"
}
]
},
"virtualCpAddress": {
"type": "string",
"loadBalancerIp": "string"
}
}
],
"vduIds": [
"string"
],
"additionalServiceInfo": [
{
"portInfo": [
{
"name": "string",
"protocol": "string",
"port": 0,
"portConfigurable": false
}
]
}
]
}
],
"extVirtualLinkInfo": [
{
"id": "string",
"resourceHandle": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"extLinkPorts": [
{
"id": "string",
"resourceHandle": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"cpInstanceId": "string",
"secondaryCpInstanceId": "string",
"trunkResourceId": "string"
}
],
"currentVnfExtCpData": [
{
"cpdId": "string"
}
],
"extNetAttDefResource": [
{
"netAttDefResourceInfoId": "string",
"netAttDefResource": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"associatedExtCpId": [
"string"
],
"associatedVnfcCpId": [
"string"
]
}
]
}
],
"extManagedVirtualLinkInfo": [
{
"id": "string",
"vnfVirtualLinkDescId": "string",
"vnfdId": "string",
"networkResource": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"vnfLinkPorts": [
{
"id": "string",
"resourceHandle": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"cpInstanceId": "string",
"cpInstanceType": "string",
"vipCpInstanceId": "string",
"trunkResourceId": "string"
}
],
"vnfNetAttDefResource": [
{
"netAttDefResourceInfoId": "string",
"netAttDefResource": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"associatedExtCpId": [
"string"
],
"associatedVnfcCpId": [
"string"
]
}
],
"extManagedMultisiteVirtualLinkId": "string"
}
],
"monitoringParameters": [
{
"id": "string",
"vnfdId": "string",
"name": "string",
"performanceMetric": "string"
}
],
"localizationLanguage": "string",
"vnfcResourceInfo": [
{
"id": "string",
"vduId": "string",
"vnfdId": "string",
"computeResource": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"zoneId": "string",
"storageResourceIds": [
"string"
],
"reservationId": "string",
"vnfcCpInfo": [
{
"id": "string",
"cpdId": "string",
"vnfExtCpId": "string",
"cpProtocolInfo": [
{
"layerProtocol": "string",
"ipOverEthernet": {
"macAddress": "string",
"segmentationId": "string",
"ipAddresses": [
{
"type": "string",
"addresses": [
"string"
],
"isDynamic": false,
"addressRange": {
"minAddress": "string",
"maxAddress": "string"
},
"subnetId": "string"
}
]
},
"virtualCpAddress": {
"type": "string",
"loadBalancerIp": "string"
}
}
],
"vnfLinkPortId": "string",
"parentCpId": "string",
"netAttDefResourceId": [
"string"
]
}
]
}
],
"vnfVirtualLinkResourceInfo": [
{
"id": "string",
"vnfVirtualLinkDescId": "string",
"vnfdId": "string",
"networkResource": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"zoneId": "string",
"reservationId": "string",
"vnfLinkPorts": [
{
"id": "string",
"resourceHandle": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"cpInstanceId": "string",
"cpInstanceType": "string",
"vipCpInstanceId": "string",
"trunkResourceId": "string"
}
]
}
],
"virtualStorageResourceInfo": [
{
"id": "string",
"virtualStorageDescId": "string",
"vnfdId": "string",
"storageResource": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"zoneId": "string",
"reservationId": "string"
}
],
"mcioInfo": [
{
"mcioId": "string",
"mcioName": "string",
"mcioNamespace": "string",
"vduId": "string",
"cismId": "string",
"mcioType": "string",
"desiredInstances": 0,
"availableInstances": 0
}
]
},
"_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"
},
"createSnapshot": {
"href": "string"
},
"revertToSnapshot": {
"href": "string"
},
"changeCurrentVnfPkg": {
"href": "string"
}
}
}Identifier of the VNF instance.
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.
Identifier of the VNFD on which the VNF instance is based. See note 1.
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.
Software version of the VNF. The value is copied from the VNFD.
Identifies the version of the VNFD. The value is copied from the VNFD.
Additional VNF-specific attributes that provide the current values of the configurable properties of the VNF instance. These attributes represent values that are stored persistently in the VnfInstance structure and that correspond to configuration parameters of the VNF instance. Modifying these attributes affects the configuration of the VNF instance either directly (if the VNF instance is in INSTANTIATED state at the time of the modification) or as part of the subsequent VNF instantiation operation (if the VNF instance is in NOT_INSTANTIATED state at the time of the modification). Configurable properties referred in these attributes are declared in the VNFD. The declaration of configurable properties in the VNFD can optionally contain the specification of initial values. See notes 2, 3 and 4. The VNFM shall reject requests to write configurable properties that are not declared in the VNFD with a "422 Unprocessable entity" error response as defined in clause 6.4 of ETSI GS NFV SOL 013. These configurable properties include the following standard attributes, which are declared in the VNFD if auto-scaling and/or auto-healing are supported by the VNF: - isAutoscaleEnabled: If present, the VNF supports auto-scaling. If set to true, auto-scaling is currently enabled. If set to false, auto-scaling is currently disabled. - isAutohealEnabled: If present, the VNF supports auto-healing. If set to true, auto-healing is currently enabled. If set to false, auto-healing is currently disabled.
These configurable properties can be initialized with default values from the VNFD (see note 4). Configurable properties can be modified with values passed in the request structures of certain LCM operations, such as the InstantiateVnfRequest structure. Further, these configurable properties can be created, modified or deleted with the PATCH method. In addition, the provisions in clause 5.7 shall apply.
Information about VIM or CISM connections to be used for managing the resources for the VNF instance. The keys of the map, each of which identifies information about a particular VIM connection, are managed by the NFVO and referenced from other data structures via the "vimConnectionId" attribute. This attribute shall only be supported and present if - the resources of at least of the VNFCs are managed by a VIM and VNF-related resource management in direct mode is applicable. - the resources of at least of the VNFCs are managed by a CISM. This attribute can be modified with the PATCH method.
Information about the CIR connection for managing OS container images for the VNF instance. Shall be present when all or part of the VNF is realized by a set of OS containers and shall be absent otherwise.
Information about the MCIOP repository for the VNF instance. Shall be present when all or part of the VNF is realized by a set of OS containers and shall be absent otherwise. See note 1.
The instantiation state of the VNF. Permitted values: - NOT_INSTANTIATED: The VNF instance is terminated or not instantiated. - INSTANTIATED: The VNF instance is instantiated.
Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.
Additional VNF-specific attributes that provide metadata describing the VNF instance. These attributes represent values that are stored persistently in the VnfInstance structure for consumption by functional blocks that invoke the VNF lifecycle management interface. They are not consumed by the VNFM, or the lifecycle management scripts. Modifying the values of these attributes has no effect on the VNF instance, it only affects the information represented in the VnfInstance structure. Metadata that the VNF provider foresees are expected to be declared in the VNFD. The declaration of metadata in the VNFD can optionally contain the specification of initial values. See notes 2 and 4. The VNFM shall accept requests to write metadata that are not declared in the VNFD. These attributes can be initialized with default values from the VNFD (see note 4) or with values passed in the CreateVnfRequest structure (see clause 5.4.2.3.1). These attributes can be created, modified or removed with the PATCH method.
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 the lifecycle management scripts during the execution of VNF lifecycle management operations. All extensions that are allowed for the VNF are declared in the VNFD. The declaration of an extension in the VNFD contains information on whether its presence is optional or required, and optionally can specify an initial value. See notes 2 and 4. The VNFM shall reject requests to write extension attributes that are not declared in the VNFD with a "422 Unprocessable entity" error response as defined in clause 6.4 of ETSI GS NFV-SOL 013. 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. These attributes can be initialized with default values from the VNFD (see note 4). These attributes can be modified with values passed in the request structures of certain LCM operations, such as the InstantiateVnfRequest structure. Further, these attributes can be created, modified or deleted with the PATCH method. In addition, the provisions in clause 5.7 shall apply.
Links to resources related to this resource.