Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • nfv/api-tests
  • reinaortega/api-tests
2 results
Show changes
Hide whitespace changes
Inline Side-by-side
Showing
with 8848 additions and 3384 deletions
SOL002/VNFLifecycleManagement-API/jsons/operateVnfRequest.json
View file @ 29614667
{{
"vnfcInstanceId": [],
"changeStateTo": "{changeStateTo}",
"stopType": "FORCEFUL",
"gracefulStopTimeout": "",
"additionalParams": {}
}}
\ No newline at end of file
SOL002/VNFLifecycleManagement-API/jsons/terminateVnfRequest.json
View file @ 29614667
{{
"terminationType": "{terminationType}",
"additionalParams": {}
"gracefulTerminationTimeout": ""
}}
\ No newline at end of file
SOL002/VNFLifecycleManagement-API/schemas/VnfLcmOperationOccurrenceNotification.schema.json
View file @ 29614667
{
"description": "This type represents a VNF lifecycle management operation occurrence notification, which informs the receiver of changes in the VNF lifecycle caused by a VNF LCM operation occurrence. The support of the notification is mandatory. This notification shall be triggered by the VNFM when there is a change in the VNF lifecycle caused by a VNF LCM operation occurrence, including: * Instantiation of the VNF * Scaling of the VNF instance (including auto-scaling) * Healing of the VNF instance (including auto-healing) * Change of the state of the VNF instance (i.e. Operate VNF) * Change of the deployment flavour of the VNF instance * Change of the external connectivity of the VNF instance * Termination of the VNF instance * Modification of VNF instance information and/or VNF configurable\n properties through the \"PATCH\" method on the \"Individual VNF instance\"\n resource.\nIf this is the initial notification about the start of a VNF LCM operation occurrence, it is assumed that the notification is sent by the VNFM before any action (including sending the grant request) is taken as part of the LCM operation. Due to possible race conditions, the \"start\" notification, the grant request and the LCM operation acknowledgment can arrive in any order at the NFVO, and the NFVO shall be able to handle such a situation. If this is a notification about a final or intermediate result state of a VNF LCM operation occurrence, the notification shall be sent after all related actions of the LCM operation that led to this state have been executed. The new state shall be set in the \"Individual VNF LCM operation occurrence\" resource before the notification about the state change is sent.\n",
"type": "object",
"required": [
"id",
"notificationType",
"subscriptionId",
"timeStamp",
"notificationStatus",
"operationState",
"vnfInstanceId",
"operation",
"isAutomaticInvocation",
"vnfLcmOpOccId",
"_links"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"notificationType": {
"description": "Discriminator for the different notification types. Shall be set to \"VnfLcmOperationOccurrenceNotification\" for this notification type.\n",
"type": "string",
"enum": [
"VnfLcmOperationOccurrenceNotification"
]
},
"subscriptionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"timeStamp": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"notificationStatus": {
"description": "Indicates whether this notification reports about the start of a lifecycle operation or the result of a lifecycle operation. Permitted values: * START: Informs about the start of the VNF LCM operation\n occurrence.\n* RESULT: Informs about the final or intermediate result of the VNF\n LCM operation occurrence.\n",
"type": "string",
"enum": [
"START",
"RESULT"
]
},
"operationState": {
"description": "STARTING: The LCM operation is starting. PROCESSING: The LCM operation is currently in execution. COMPLETED: The LCM operation has been completed successfully. FAILED_TEMP: The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED: The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK: The LCM operation is currently being rolled back. ROLLED_BACK: The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n",
"type": "string",
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
"FAILED_TEMP",
"FAILED",
"ROLLING_BACK",
"ROLLED_BACK"
]
},
"vnfInstanceId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"operation": {
"description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. CREATE_SNAPSHOT | Represents the \"Create VNF Snapshot\" LCM operation. REVERT_TO_SNAPSHOT | Represents the “Revert-To VNF Snapshot\" LCM operation. CHANGE_VNFPKG | Represents the \"Change current VNF package\" LCM operation.\n",
"type": "string",
"enum": [
"INSTANTIATE",
"SCALE",
"SCALE_TO_LEVEL",
"CHANGE_FLAVOUR",
"TERMINATE",
"HEAL",
"OPERATE",
"CHANGE_EXT_CONN",
"MODIFY_INFO",
"CREATE_SNAPSHOT",
"REVERT_TO_SNAPSHOT",
"CHANGE_VNFPKG"
]
},
"isAutomaticInvocation": {
"description": "Set to true if this VNF LCM operation occurrence has been triggered by an automated procedure inside the VNFM (i.e. ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf triggered by auto-heal). Set to false otherwise.\n",
"type": "boolean"
},
"verbosity": {
"description": "The enumeration LcmOpOccNotificationVerbosityType provides values to control the verbosity of LCM operation occurrence notifications. * FULL: This signals a full notification which contains all change details. * SHORT: This signals a short notification which omits large-volume change details to reduce the size of data to\n be sent via the notification mechanism.\n",
"type": "string",
"enum": [
"FULL",
"SHORT"
]
},
"vnfLcmOpOccId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"affectedVnfcs": {
"description": "Information about VNFC instances that were affected during the lifecycle operation. Shall be present if the \"notificationStatus\" is set to \"RESULT\" and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the VNF LCM operation occurrence and by any of the error handling procedures for that operation occurrence.\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary VNFCs.\n",
"type": "object",
"required": [
"id",
"vduId",
"changeType",
"computeResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVnfc structure exists as long as the temporary resource exists.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY"
]
},
"computeResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"affectedVnfcCpIds": {
"description": "Identifiers of CP(s) of the VNFC instance that were affected by the change. Shall be present for those affected CPs of the VNFC instance that are associated to an external CP of the VNF instance. May be present for further affected CPs of the VNFC instance.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
},
"addedStorageResourceIds": {
"description": "References to VirtualStorage resources that have been added. Each value refers to a VirtualStorageResourceInfo item in the VnfInstance that was added to the VNFC. It shall be provided if at least one storage resource was added to the VNFC.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
},
"removedStorageResourceIds": {
"description": "References to VirtualStorage resources that have been removed. The value contains the identifier of a VirtualStorageResourceInfo item that has been removed from the VNFC, and might no longer exist in the VnfInstance. It shall be provided if at least one storage resource was removed from the VNFC.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
}
},
"affectedVirtualLinks": {
"description": "Information about VL instances that were affected during the lifecycle operation. Shall be present if the \"notificationStatus\" is set to \"RESULT\" and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the VNF LCM operation occurrence and by any of the error handling procedures for that operation occurrence.\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary VLs, and added or removed VNF link ports.\n",
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"changeType",
"networkResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY * LINK_PORT_ADDED * LINK_PORT_REMOVED For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists. When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the \"networkResource\" attribute refers to the affected virtual link instance, not the link port instance. The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the \"vnfLinkPortIds\" attribute.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY",
"LINK_PORT_ADDED",
"LINK_PORT_REMOVED"
]
},
"networkResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"vnfLinkPortIds": {
"description": "Identifiers of the link ports of the affected VL (reference to the vnfLinkPortInfo) related to the change. Each identifier references a \"VnfLinkPortInfo\" structure. Shall be set when changeType is equal to \"LINK_PORT_ADDED\" or \"LINK_PORT_REMOVED\", and the related “VnfLinkPortInfo” structures are present (case \"added\") or have been present (case \"removed\") in the “VnfVirtualLinkResourceInfo” or \"ExtManagedVirtualLinkInfo\" structures that are represented by the \"vnfVirtualLinkResourceInfo\" or \"extManagedVirtualLinkInfo\" attribute in the \"VnfInstance\" structure. When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the \"networkResource\" attribute refers to the affected virtual link instance, not the link port instance. The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the \"vnfLinkPortIds\" attribute.\n",
"type": "array",
"items": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"affectedExtLinkPorts": {
"description": "Information about external VNF link ports that were affected during the lifecycle operation. Shall be present if the \"notificationStatus\" is set to \"RESULT\", the \"verbosity\" attribute is set to \"FULL\" and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the VNF LCM operation occurrence and by any of the error handling procedures for that operation occurrence.\n",
"type": "array",
"items": {
"description": "This type provides information about added and deleted external link ports (link ports attached to external virtual links).\n",
"type": "object",
"required": [
"id",
"changeType",
"extCpInstanceId",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: -\tADDED -\tREMOVED\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED"
]
},
"extCpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
}
}
}
},
"affectedVirtualStorages": {
"description": "Information about virtualised storage instances that were affected during the lifecycle operation. Shall be present if the \"notificationStatus\" is set to \"RESULT\" and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the VNF LCM operation occurrence and by any of the error handling procedures for that operation occurrence.\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary virtual storage resources.\n",
"type": "object",
"required": [
"id",
"virtualStorageDescId",
"changeType",
"storageResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"virtualStorageDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVirtualStorage structure exists as long as the temporary resource exists.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY"
]
},
"storageResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"changedInfo": {
"description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"VnfInfoModificationRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly e.g. when modifying the referenced VNF package.\n",
"type": "object",
"properties": {
"vnfInstanceName": {
"description": "If present, this attribute signals modifications of the \"vnfInstanceName\" attribute in \"VnfInstance\".\n",
"type": "string"
},
"vnfInstanceDescription": {
"description": "If present, this attribute signals modifications of the \"vnfInstanceDescription\" attribute in \"VnfInstance\".\n",
"type": "string"
},
"vnfConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"extensions": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "If present, this attribute signals modifications of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId” attribute.\n",
"type": "string"
},
"vnfProductName": {
"description": "If present, this attribute signals modifications of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId” attribute.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfcInfoModifications": {
"description": "If present, this attribute signals modifications of certain entries in the \"vnfcInfo\" attribute array in the \"instantiatedVnfInfo\" attribute of \"VnfInstance\", as defined in clause 5.5.2.12\n",
"type": "array",
"items": {
"description": "This type represents modifications of an entry in an array of \"VnfcInfo\" objects. It shall comply with the provisions defined in table 5.5.3.24-1.\n",
"type": "object",
"required": [
"id",
"vnfcConfigurableProperties"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
}
}
},
"changedExtConnectivity": {
"description": "Information about changed external connectivity, if this notification represents the result of a lifecycle operation occurrence. Shall be present if the \"notificationStatus\" is set to \"RESULT\" and the \"operation\" has made any change of the external connectivity of the VNF instance. Shall be absent otherwise.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle",
"currentVnfExtCpData"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"extLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
},
"currentVnfExtCpData": {
"description": "Allows the API consumer to read the current CP configuration information for the connection of external CPs to the external virtual link. This attribute reflects the current configuration information that has resulted from merging into this attribute the \"VnfExtCpData\" information which was passed as part of the \"ExtVirtualLinkData\" structure in the input of the most recent VNF LCM operation such as \"InstantiateVnfRequest\", \"ChangeExtVnfConnectivityRequest\", \"ChangeVnfFlavourRequest\" or \"ChangeCurrentVnfPkgRequest\", or has been provided by the NFVO during the granting procedure. If applying such change results in an empty list of \"currentVnfExtCpData\" structure instances, the affected instance of \"ExtVirtualLinkInfo\" shall be removed from its parent data structure.\n",
"type": "array",
"items": {
"description": "This type represents configuration information for external CPs created from a CPD.\n",
"type": "object",
"required": [
"cpdId"
],
"properties": {
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"cpConfig": {
"description": "Map of instance data that need to be configured on the CP instances created from the respective CPD. The key of the map which identifies the individual VnfExtCpConfig entries is managed by the API consumer. The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396). Within one VNF instance, all VNFC instances created from a particular VDU have the same external connectivity. Thus, given a particular value of the “cpdId” attribute, there shall be one “cpConfig” entry for each VNFC instance that has been or can be created from a VDU which includes a CPD identified by the “cpdId” attribute. If the cpConfig represents a subport in a trunk, all “cpConfig” entries in this list shall have the same segmentationId, which means they are connected to the same set of external VLs via the trunk. The map entry value shall be set to \"null\" in order to delete a \"VnfExtCpConfig\" entry identified by a particular key value from the map, i.e. for the disconnection of an existing external CP instance addressed by cpInstanceId in the deleted map entry from a particular external virtual link, and deletion of that instance in case it represents a subport. Deleting the last key from the map removes the affected instance of the \"VnfExtCpData\" structure from its parent data structure.\n",
"type": "object",
"additionalProperties": {
"description": "This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n",
"anyOf": [{
"required": [
"linkPortId"
]
},
{
"required": [
"cpProtocolData"
]
}
],
"type": "object",
"properties": {
"parentCpConfigId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"linkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"cpProtocolData": {
"description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": 1) Void 2) At least one of the \"linkPortId\" and \"cpProtocolData\" attributes \n shall be present for an external CP instance representing a subport \n that is to be created, or an external CP instance that is to be created \n by creating the corresponding VNFC or VNF instance during the current or \n a subsequent LCM operation, or for an existing external CP instance \n that is to be re-configured or added to a particular external virtual link.\n3) If the \"linkPortId\" attribute is absent, the VNFM shall create a\n link port.\n4) If the \"cpProtocolData\" attribute is absent, the \"linkPortId\"\n attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n5) If both \"cpProtocolData\" and \"linkportId\" are provided, the API\n consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n",
"type": "array",
"items": {
"description": "This type represents network protocol data.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "Identifier of layer(s) and protocol(s). This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents network address data for IP over Ethernet.\n",
"type": "object",
"anyOf": [{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [{
"required": [
"fixedAddresses"
]
},
{
"required": [
"numDynamicAddresses"
]
},
{
"required": [
"ipAddressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"fixedAddresses": {
"description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"numDynamicAddresses": {
"description": "Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "integer"
},
"addressRange": {
"description": "An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"modificationsTriggeredByVnfPkgChange": {
"description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource when changing the current VNF package. The attributes that can be included consist of those requested to be modified explicitly in the \"ChangeCurrentVnfPkgRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly during the operation.\n",
"type": "object",
"properties": {
"vnfConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"extensions": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "If present, this attribute signals the new value of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfdId\" attribute) was modified implicitly during the related operation, and contains a copy of the value of he related attribute from the VNFD in the VNF Package identified by the \"vnfdId\" attribute.\n",
"type": "string"
},
"vnfProductName": {
"description": "If present, this attribute signals the new value of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfdId\" attribute) was modified implicitly during the related operation, and contains a copy of the value of he related attribute from the VNFD in the VNF Package identified by the \"vnfdId\" attribute.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
}
}
},
"error": {
"description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
"type": "string",
"format": "URI"
}
}
},
"_links": {
"description": "This type represents the links to resources that a notification can contain.\n",
"type": "object",
"required": [
"vnfInstance",
"subscription"
],
"properties": {
"vnfInstance": {
"description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"subscription": {
"description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"vnfLcmOpOcc": {
"description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
}
\ No newline at end of file
SOL002/VNFLifecycleManagement-API/schemas/VnfSnapshotInfo.schema.json 0 → 100644
View file @ 29614667
{
"description": "This type represents an individual VNF snapshot resource.\n",
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfSnapshotPkgId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfSnapshot": {
"description": "This type represents a VNF snapshot.\n",
"type": "object",
"required": [
"id",
"vnfInstanceId",
"triggeredAt",
"vnfdId",
"vnfInfo",
"vnfcSnapshots"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfInstanceId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"creationStartedAt": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"creationFinishedAt": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfInstance": {
"description": "This type represents a VNF instance.\n",
"type": "object",
"required": [
"id",
"vnfdId",
"vnfProvider",
"vnfProductName",
"vnfSoftwareVersion",
"vnfdVersion",
"instantiationState",
"_links"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfInstanceName": {
"description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
"type": "string"
},
"vnfInstanceDescription": {
"description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
"type": "string"
},
"vnfProductName": {
"description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"instantiationState": {
"description": "The instantiation state of the VNF.\n",
"type": "string",
"enum": [
"NOT_INSTANTIATED",
"INSTANTIATED"
]
},
"instantiatedVnfInfo": {
"description": "Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.\n",
"type": "object",
"required": [
"flavourId",
"vnfState",
"extCpInfo"
],
"properties": {
"flavourId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfState": {
"description": "STARTED: The VNF instance is up and running. STOPPED: The VNF instance has been shut down.\n",
"type": "string",
"enum": [
"STARTED",
"STOPPED"
]
},
"scaleStatus": {
"description": "Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how \"big\" the VNF has been scaled w.r.t. that aspect.\n",
"type": "array",
"items": {
"required": [
"aspectId",
"scaleLevel"
],
"type": "object",
"properties": {
"aspectId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"scaleLevel": {
"description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
"type": "integer"
}
}
}
},
"maxScaleLevels": {
"description": "Maximum allowed scale levels of the VNF, one entry per aspect. This attribute shall be present if the VNF supports scaling.\n",
"type": "array",
"items": {
"required": [
"aspectId",
"scaleLevel"
],
"type": "object",
"properties": {
"aspectId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"scaleLevel": {
"description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
"type": "integer"
}
}
}
},
"extCpInfo": {
"description": "Information about the external CPs exposed by the VNF instance. When trunking is enabled, the list of entries includes both, external CPs corresponding to parent ports of a trunk, and external CPs associated to sub-ports of a trunk.\n",
"type": "array",
"minItems": 1,
"items": {
"description": "This type represents information about an external CP of a VNF. It shall comply with the provisions defined in table 5.5.3.25 1.\n",
"type": "object",
"required": [
"id",
"cpdId",
"cpConfigId",
"cpProtocolInfo"
],
"oneOf": [
{
"required": [
"associatedVnfcCpId"
]
},
{
"required": [
"associatedVnfVirtualLinkId"
]
}
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"cpConfigId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Network protocol information for this CP.\n",
"type": "array",
"items": {
"description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents information about a network address that has been assigned.\n",
"type": "object",
"anyOf": [
{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [
{
"required": [
"addresses"
]
},
{
"required": [
"addressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet. At least one of \"macAddress\" or \"ipAddresses\" shall be present.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"addresses": {
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
},
"extLinkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"associatedVnfcCpId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"associatedVnfVirtualLinkId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
}
}
},
"extVirtualLinkInfo": {
"description": "Information about the external VLs the VNF instance is connected to.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle",
"currentVnfExtCpData"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"extLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
},
"currentVnfExtCpData": {
"description": "Allows the API consumer to read the current CP configuration information for the connection of external CPs to the external virtual link. This attribute reflects the current configuration information that has resulted from merging into this attribute the \"VnfExtCpData\" information which was passed as part of the \"ExtVirtualLinkData\" structure in the input of the most recent VNF LCM operation such as \"InstantiateVnfRequest\", \"ChangeExtVnfConnectivityRequest\", \"ChangeVnfFlavourRequest\" or \"ChangeCurrentVnfPkgRequest\", or has been provided by the NFVO during the granting procedure. If applying such change results in an empty list of \"currentVnfExtCpData\" structure instances, the affected instance of \"ExtVirtualLinkInfo\" shall be removed from its parent data structure.\n",
"type": "array",
"items": {
"description": "This type represents configuration information for external CPs created from a CPD.\n",
"type": "object",
"required": [
"cpdId"
],
"properties": {
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"cpConfig": {
"description": "Map of instance data that need to be configured on the CP instances created from the respective CPD. The key of the map which identifies the individual VnfExtCpConfig entries is managed by the API consumer. The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396). Within one VNF instance, all VNFC instances created from a particular VDU have the same external connectivity. Thus, given a particular value of the “cpdId” attribute, there shall be one “cpConfig” entry for each VNFC instance that has been or can be created from a VDU which includes a CPD identified by the “cpdId” attribute. If the cpConfig represents a subport in a trunk, all “cpConfig” entries in this list shall have the same segmentationId, which means they are connected to the same set of external VLs via the trunk. The map entry value shall be set to \"null\" in order to delete a \"VnfExtCpConfig\" entry identified by a particular key value from the map, i.e. for the disconnection of an existing external CP instance addressed by cpInstanceId in the deleted map entry from a particular external virtual link, and deletion of that instance in case it represents a subport. Deleting the last key from the map removes the affected instance of the \"VnfExtCpData\" structure from its parent data structure.\n",
"type": "object",
"additionalProperties": {
"description": "This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n",
"anyOf": [
{
"required": [
"linkPortId"
]
},
{
"required": [
"cpProtocolData"
]
}
],
"type": "object",
"properties": {
"parentCpConfigId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"linkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"cpProtocolData": {
"description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": 1) Void 2) At least one of the \"linkPortId\" and \"cpProtocolData\" attributes \n shall be present for an external CP instance representing a subport \n that is to be created, or an external CP instance that is to be created \n by creating the corresponding VNFC or VNF instance during the current or \n a subsequent LCM operation, or for an existing external CP instance \n that is to be re-configured or added to a particular external virtual link.\n3) If the \"linkPortId\" attribute is absent, the VNFM shall create a\n link port.\n4) If the \"cpProtocolData\" attribute is absent, the \"linkPortId\"\n attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n5) If both \"cpProtocolData\" and \"linkportId\" are provided, the API\n consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n",
"type": "array",
"items": {
"description": "This type represents network protocol data.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "Identifier of layer(s) and protocol(s). This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents network address data for IP over Ethernet.\n",
"type": "object",
"anyOf": [
{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [
{
"required": [
"fixedAddresses"
]
},
{
"required": [
"numDynamicAddresses"
]
},
{
"required": [
"ipAddressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"fixedAddresses": {
"description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"numDynamicAddresses": {
"description": "Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "integer"
},
"addressRange": {
"description": "An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"extManagedVirtualLinkInfo": {
"description": "External virtual links the VNF instance is connected to. 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.5).\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"networkResource"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"networkResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"vnfLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpInstanceType": {
"description": "Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: VNFC_CP: The link port is connected to a VNFC CP EXT_CP: The link port is associated to an external CP.\n",
"type": "string",
"enum": [
"VNFC_CP",
"EXT_CP"
]
}
}
}
}
}
}
},
"monitoringParameters": {
"description": "Active monitoring parameters.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"performanceMetric"
],
"properties": {
"id": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"name": {
"description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
"type": "string"
},
"performanceMetric": {
"description": "Performance metric that is monitored. This attribute shall contain the related \"Measurement Name\" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.\n",
"type": "string"
}
}
}
},
"localizationLanguage": {
"description": "Information about localization language of the VNF (includes e.g. strings in the VNFD). The localization languages supported by a VNF can be declared in the VNFD, and localization language selection can take place at instantiation time. The value shall comply with the format defined in IETF RFC 5646.\n",
"type": "string"
},
"vnfcResourceInfo": {
"description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
"type": "object",
"required": [
"id",
"vduId",
"computeResource",
"vnfcCpInfo"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"computeResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"storageResourceIds": {
"description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfcCpInfo": {
"description": "All the CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is exposed as an external CP of the VNF instance or is connected to an external CP of the VNF instance. A VNFC CP is \"connected to\" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. A VNFC CP is \"exposed as\" an external CP if it is connected directly to an external VL. May be present otherwise.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"cpdId"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfExtCpId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Network protocol information for this CP. May be omitted if the VNFC CP is exposed as an external CP. The information can be omitted because it is already available as part of the external CP information.\n",
"type": "array",
"items": {
"description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents information about a network address that has been assigned.\n",
"type": "object",
"anyOf": [
{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [
{
"required": [
"addresses"
]
},
{
"required": [
"addressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet. At least one of \"macAddress\" or \"ipAddresses\" shall be present.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"addresses": {
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
},
"vnfLinkPortId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"vnfVirtualLinkResourceInfo": {
"description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"networkResource",
"vnfLinkPorts"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"networkResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfLinkPorts": {
"description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpInstanceType": {
"description": "Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: VNFC_CP: The link port is connected to a VNFC CP EXT_CP: The link port is associated to an external CP.\n",
"type": "string",
"enum": [
"VNFC_CP",
"EXT_CP"
]
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"vnfVirtualStorageResourceInfo": {
"description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
"type": "object",
"required": [
"id",
"virtualStorageDescId",
"storageResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"virtualStorageDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"storageResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"vnfcInfo": {
"description": "Information about the VNFC instances.\n",
"type": "array",
"items": {
"description": "This type represents the information about a VNFC instance that is part of a VNF instance. It shall comply with the provisions defined in table 5.5.3.23-1.\n",
"type": "object",
"required": [
"id",
"vduId",
"vnfcState"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcResourceInfoId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcState": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"extensions": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"indicators": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"instantiate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"terminate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"scale": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"scaleToLevel": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"changeFlavour": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"heal": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"operate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"changeExtConn": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"createSnapshot": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"revertToSnapshot": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
},
"vnfcSnapshots": {
"description": "Information about VNFC snapshots constituting this VNF snapshot.\n",
"type": "array",
"items": {
"description": "This type represents a VNFC snapshot.\n",
"type": "object",
"required": [
"id",
"vnfcInstanceId",
"triggeredAt",
"vnfcInfo"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfcInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"creationStartedAt": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"creationFinishedAt": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"vnfcResourceInfoId": {
"description": "This type represents the information about a VNFC instance that is part of a VNF instance. It shall comply with the provisions defined in table 5.5.3.23-1.\n",
"type": "object",
"required": [
"id",
"vduId",
"vnfcState"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcResourceInfoId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcState": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
},
"computeSnapshotResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"storageSnapshotResources": {
"description": "Mapping of the storage resources associated to the VNFC with the storage snapshot resources.\n",
"type": "object",
"required": [
"storageResourceId"
],
"properties": {
"storageResourceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"storageSnapshotResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
}
}
},
"userDefinedData": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"userDefinedData": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"takenFrom": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
}
\ No newline at end of file
SOL002/VNFLifecycleManagement-API/schemas/VnfSnapshotsInfo.schema.json 0 → 100644
View file @ 29614667
{
"type": "array",
"items":
{
"description": "This type represents an individual VNF snapshot resource.\n",
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfSnapshotPkgId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfSnapshot": {
"description": "This type represents a VNF snapshot.\n",
"type": "object",
"required": [
"id",
"vnfInstanceId",
"triggeredAt",
"vnfdId",
"vnfInfo",
"vnfcSnapshots"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfInstanceId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"creationStartedAt": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"creationFinishedAt": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfInstance": {
"description": "This type represents a VNF instance.\n",
"type": "object",
"required": [
"id",
"vnfdId",
"vnfProvider",
"vnfProductName",
"vnfSoftwareVersion",
"vnfdVersion",
"instantiationState",
"_links"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfInstanceName": {
"description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
"type": "string"
},
"vnfInstanceDescription": {
"description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
"type": "string"
},
"vnfProductName": {
"description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"instantiationState": {
"description": "The instantiation state of the VNF.\n",
"type": "string",
"enum": [
"NOT_INSTANTIATED",
"INSTANTIATED"
]
},
"instantiatedVnfInfo": {
"description": "Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.\n",
"type": "object",
"required": [
"flavourId",
"vnfState",
"extCpInfo"
],
"properties": {
"flavourId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfState": {
"description": "STARTED: The VNF instance is up and running. STOPPED: The VNF instance has been shut down.\n",
"type": "string",
"enum": [
"STARTED",
"STOPPED"
]
},
"scaleStatus": {
"description": "Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how \"big\" the VNF has been scaled w.r.t. that aspect.\n",
"type": "array",
"items": {
"required": [
"aspectId",
"scaleLevel"
],
"type": "object",
"properties": {
"aspectId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"scaleLevel": {
"description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
"type": "integer"
}
}
}
},
"maxScaleLevels": {
"description": "Maximum allowed scale levels of the VNF, one entry per aspect. This attribute shall be present if the VNF supports scaling.\n",
"type": "array",
"items": {
"required": [
"aspectId",
"scaleLevel"
],
"type": "object",
"properties": {
"aspectId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"scaleLevel": {
"description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
"type": "integer"
}
}
}
},
"extCpInfo": {
"description": "Information about the external CPs exposed by the VNF instance. When trunking is enabled, the list of entries includes both, external CPs corresponding to parent ports of a trunk, and external CPs associated to sub-ports of a trunk.\n",
"type": "array",
"minItems": 1,
"items": {
"description": "This type represents information about an external CP of a VNF. It shall comply with the provisions defined in table 5.5.3.25 1.\n",
"type": "object",
"required": [
"id",
"cpdId",
"cpConfigId",
"cpProtocolInfo"
],
"oneOf": [
{
"required": [
"associatedVnfcCpId"
]
},
{
"required": [
"associatedVnfVirtualLinkId"
]
}
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"cpConfigId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Network protocol information for this CP.\n",
"type": "array",
"items": {
"description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents information about a network address that has been assigned.\n",
"type": "object",
"anyOf": [
{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [
{
"required": [
"addresses"
]
},
{
"required": [
"addressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet. At least one of \"macAddress\" or \"ipAddresses\" shall be present.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"addresses": {
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
},
"extLinkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"associatedVnfcCpId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"associatedVnfVirtualLinkId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
}
}
},
"extVirtualLinkInfo": {
"description": "Information about the external VLs the VNF instance is connected to.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle",
"currentVnfExtCpData"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"extLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
},
"currentVnfExtCpData": {
"description": "Allows the API consumer to read the current CP configuration information for the connection of external CPs to the external virtual link. This attribute reflects the current configuration information that has resulted from merging into this attribute the \"VnfExtCpData\" information which was passed as part of the \"ExtVirtualLinkData\" structure in the input of the most recent VNF LCM operation such as \"InstantiateVnfRequest\", \"ChangeExtVnfConnectivityRequest\", \"ChangeVnfFlavourRequest\" or \"ChangeCurrentVnfPkgRequest\", or has been provided by the NFVO during the granting procedure. If applying such change results in an empty list of \"currentVnfExtCpData\" structure instances, the affected instance of \"ExtVirtualLinkInfo\" shall be removed from its parent data structure.\n",
"type": "array",
"items": {
"description": "This type represents configuration information for external CPs created from a CPD.\n",
"type": "object",
"required": [
"cpdId"
],
"properties": {
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"cpConfig": {
"description": "Map of instance data that need to be configured on the CP instances created from the respective CPD. The key of the map which identifies the individual VnfExtCpConfig entries is managed by the API consumer. The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396). Within one VNF instance, all VNFC instances created from a particular VDU have the same external connectivity. Thus, given a particular value of the “cpdId” attribute, there shall be one “cpConfig” entry for each VNFC instance that has been or can be created from a VDU which includes a CPD identified by the “cpdId” attribute. If the cpConfig represents a subport in a trunk, all “cpConfig” entries in this list shall have the same segmentationId, which means they are connected to the same set of external VLs via the trunk. The map entry value shall be set to \"null\" in order to delete a \"VnfExtCpConfig\" entry identified by a particular key value from the map, i.e. for the disconnection of an existing external CP instance addressed by cpInstanceId in the deleted map entry from a particular external virtual link, and deletion of that instance in case it represents a subport. Deleting the last key from the map removes the affected instance of the \"VnfExtCpData\" structure from its parent data structure.\n",
"type": "object",
"additionalProperties": {
"description": "This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n",
"anyOf": [
{
"required": [
"linkPortId"
]
},
{
"required": [
"cpProtocolData"
]
}
],
"type": "object",
"properties": {
"parentCpConfigId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"linkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"cpProtocolData": {
"description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": 1) Void 2) At least one of the \"linkPortId\" and \"cpProtocolData\" attributes \n shall be present for an external CP instance representing a subport \n that is to be created, or an external CP instance that is to be created \n by creating the corresponding VNFC or VNF instance during the current or \n a subsequent LCM operation, or for an existing external CP instance \n that is to be re-configured or added to a particular external virtual link.\n3) If the \"linkPortId\" attribute is absent, the VNFM shall create a\n link port.\n4) If the \"cpProtocolData\" attribute is absent, the \"linkPortId\"\n attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n5) If both \"cpProtocolData\" and \"linkportId\" are provided, the API\n consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n",
"type": "array",
"items": {
"description": "This type represents network protocol data.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "Identifier of layer(s) and protocol(s). This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents network address data for IP over Ethernet.\n",
"type": "object",
"anyOf": [
{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [
{
"required": [
"fixedAddresses"
]
},
{
"required": [
"numDynamicAddresses"
]
},
{
"required": [
"ipAddressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"fixedAddresses": {
"description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"numDynamicAddresses": {
"description": "Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "integer"
},
"addressRange": {
"description": "An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"extManagedVirtualLinkInfo": {
"description": "External virtual links the VNF instance is connected to. 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.5).\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"networkResource"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"networkResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"vnfLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpInstanceType": {
"description": "Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: VNFC_CP: The link port is connected to a VNFC CP EXT_CP: The link port is associated to an external CP.\n",
"type": "string",
"enum": [
"VNFC_CP",
"EXT_CP"
]
}
}
}
}
}
}
},
"monitoringParameters": {
"description": "Active monitoring parameters.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"performanceMetric"
],
"properties": {
"id": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"name": {
"description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
"type": "string"
},
"performanceMetric": {
"description": "Performance metric that is monitored. This attribute shall contain the related \"Measurement Name\" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.\n",
"type": "string"
}
}
}
},
"localizationLanguage": {
"description": "Information about localization language of the VNF (includes e.g. strings in the VNFD). The localization languages supported by a VNF can be declared in the VNFD, and localization language selection can take place at instantiation time. The value shall comply with the format defined in IETF RFC 5646.\n",
"type": "string"
},
"vnfcResourceInfo": {
"description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
"type": "object",
"required": [
"id",
"vduId",
"computeResource",
"vnfcCpInfo"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"computeResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"storageResourceIds": {
"description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfcCpInfo": {
"description": "All the CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is exposed as an external CP of the VNF instance or is connected to an external CP of the VNF instance. A VNFC CP is \"connected to\" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. A VNFC CP is \"exposed as\" an external CP if it is connected directly to an external VL. May be present otherwise.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"cpdId"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfExtCpId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Network protocol information for this CP. May be omitted if the VNFC CP is exposed as an external CP. The information can be omitted because it is already available as part of the external CP information.\n",
"type": "array",
"items": {
"description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents information about a network address that has been assigned.\n",
"type": "object",
"anyOf": [
{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [
{
"required": [
"addresses"
]
},
{
"required": [
"addressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet. At least one of \"macAddress\" or \"ipAddresses\" shall be present.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"addresses": {
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
},
"vnfLinkPortId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"vnfVirtualLinkResourceInfo": {
"description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"networkResource",
"vnfLinkPorts"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"networkResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfLinkPorts": {
"description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpInstanceType": {
"description": "Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: VNFC_CP: The link port is connected to a VNFC CP EXT_CP: The link port is associated to an external CP.\n",
"type": "string",
"enum": [
"VNFC_CP",
"EXT_CP"
]
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"vnfVirtualStorageResourceInfo": {
"description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
"type": "object",
"required": [
"id",
"virtualStorageDescId",
"storageResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"virtualStorageDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"storageResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"vnfcInfo": {
"description": "Information about the VNFC instances.\n",
"type": "array",
"items": {
"description": "This type represents the information about a VNFC instance that is part of a VNF instance. It shall comply with the provisions defined in table 5.5.3.23-1.\n",
"type": "object",
"required": [
"id",
"vduId",
"vnfcState"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcResourceInfoId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcState": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"extensions": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"indicators": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"instantiate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"terminate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"scale": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"scaleToLevel": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"changeFlavour": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"heal": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"operate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"changeExtConn": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"createSnapshot": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"revertToSnapshot": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
},
"vnfcSnapshots": {
"description": "Information about VNFC snapshots constituting this VNF snapshot.\n",
"type": "array",
"items": {
"description": "This type represents a VNFC snapshot.\n",
"type": "object",
"required": [
"id",
"vnfcInstanceId",
"triggeredAt",
"vnfcInfo"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfcInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"creationStartedAt": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"creationFinishedAt": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"vnfcResourceInfoId": {
"description": "This type represents the information about a VNFC instance that is part of a VNF instance. It shall comply with the provisions defined in table 5.5.3.23-1.\n",
"type": "object",
"required": [
"id",
"vduId",
"vnfcState"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcResourceInfoId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcState": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
},
"computeSnapshotResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"storageSnapshotResources": {
"description": "Mapping of the storage resources associated to the VNFC with the storage snapshot resources.\n",
"type": "object",
"required": [
"storageResourceId"
],
"properties": {
"storageResourceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"storageSnapshotResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
}
}
},
"userDefinedData": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"userDefinedData": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"takenFrom": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
}
}
\ No newline at end of file
SOL002/VNFLifecycleManagement-API/schemas/subscription.schema.json
View file @ 29614667
{
"type": "object",
"description": "This type represents a subscription related to notifications about VNF lifecycle changes.\n",
"required": [
"id",
"callbackUri",
"_links"
],
"properties": {
"id": {
"type": "string",
"description": "An identifier with the intention of being globally unique.\n"
},
"filter": {
"type": "object",
"description": "This type represents a subscription filter related to notifications about VNF lifecycle changes. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n",
"properties": {
"vnfInstanceSubscriptionFilter": {
"type": "object",
"description": "This type represents subscription filter criteria to match VNF instances.\n",
"properties": {
"vnfdIds": {
"type": "array",
"description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"items": {
"type": "string",
"description": "An identifier with the intention of being globally unique.\n"
}
},
"vnfProductsFromProviders": {
"type": "array",
"description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"items": {
"type": "object",
"required": [
"vnfProvider"
],
"properties": {
"vnfProvider": {
"type": "string",
"description": "Name of the VNF provider to match.\n"
},
"vnfProducts": {
"type": "array",
"description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
"items": {
"type": "object",
"required": [
"vnfProductName"
],
"properties": {
"vnfProductName": {
"type": "string",
"description": "Name of the VNF product to match.\n"
},
"versions": {
"type": "array",
"description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
"items": {
"type": "object",
"required": [
"vnfSoftwareVersion"
],
"properties": {
"vnfSoftwareVersion": {
"type": "string",
"description": "A version.\n"
},
"vnfdVersions": {
"type": "array",
"description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
"items": {
"type": "string",
"description": "A version.\n"
}
}
}
}
}
}
}
}
}
}
},
"vnfInstanceIds": {
"type": "array",
"description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"items": {
"type": "string",
"description": "An identifier with the intention of being globally unique.\n"
}
},
"vnfInstanceNames": {
"type": "array",
"description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"items": {
"type": "string"
}
}
}
},
"notificationTypes": {
"type": "array",
"description": "Match particular notification types. Permitted values: * VnfLcmOperationOccurrenceNotification * VnfIdentifierCreationNotification * VnfIdentifierDeletionNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
"items": {
"type": "string",
"enum": [
"VnfLcmOperationOccurrenceNotification",
"VnfIdentifierCreationNotification",
"VnfIdentifierDeletionNotification"
]
}
},
"operationTypes": {
"type": "array",
"description": "Match particular VNF lifecycle operation types for the notification of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
"items": {
"type": "string",
"enum": [
"INSTANTIATE",
"SCALE",
"SCALE_TO_LEVEL",
"CHANGE_FLAVOUR",
"TERMINATE",
"HEAL",
"OPERATE",
"CHANGE_EXT_CONN",
"MODIFY_INFO"
],
"description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. \n"
}
},
"operationStates": {
"type": "array",
"description": "Match particular LCM operation state values as reported in notifications of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
"items": {
"type": "string",
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
"FAILED_TEMP",
"FAILED",
"ROLLING_BACK",
"ROLLED_BACK"
],
"description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n"
}
}
}
},
"callbackUri": {
"type": "string",
"description": "String formatted according to IETF RFC 3986.\n"
},
"_links": {
"type": "object",
"description": "Links to resources related to this resource.\n",
"required": [
"self"
],
"properties": {
"self": {
"type": "object",
"description": "This type represents a link to a resource.\n",
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"description": "URI of the referenced resource.\n",
"format": "url"
}
}
}
}
}
}
"description": "This type represents a subscription related to notifications about VNF lifecycle changes.\n",
"type": "object",
"required": [
"id",
"callbackUri",
"verbosity",
"_links"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"filter": {
"description": "This type represents a subscription filter related to notifications about VNF lifecycle changes. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n",
"type": "object",
"properties": {
"vnfInstanceSubscriptionFilter": {
"description": "This type represents subscription filter criteria to match VNF instances.\n",
"type": "object",
"anyOf": [{
"oneOf": [{
"required": [
"vnfdId"
]
},
{
"required": [
"vnfProductsFromProviders"
]
}
]
},
{
"oneOf": [{
"required": [
"vnfInstanceIds"
]
},
{
"required": [
"vnfInstanceNames"
]
}
]
}
],
"properties": {
"vnfdIds": {
"description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"type": "array",
"items": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
},
"vnfProductsFromProviders": {
"description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"vnfProvider"
],
"properties": {
"vnfProvider": {
"description": "Name of the VNF provider to match.\n",
"type": "string"
},
"vnfProducts": {
"description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"vnfProductName"
],
"properties": {
"vnfProductName": {
"description": "Name of the VNF product to match.\n",
"type": "string"
},
"versions": {
"description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"vnfSoftwareVersion"
],
"properties": {
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersions": {
"description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
"type": "array",
"items": {
"description": "A version.\n",
"type": "string"
}
}
}
}
}
}
}
}
}
}
},
"vnfInstanceIds": {
"description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"type": "array",
"items": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
},
"vnfInstanceNames": {
"description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"notificationTypes": {
"description": "Match particular notification types. Permitted values: * VnfLcmOperationOccurrenceNotification * VnfIdentifierCreationNotification * VnfIdentifierDeletionNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
"type": "array",
"items": {
"type": "string",
"enum": [
"VnfLcmOperationOccurrenceNotification",
"VnfIdentifierCreationNotification",
"VnfIdentifierDeletionNotification"
]
}
},
"operationTypes": {
"description": "Match particular VNF lifecycle operation types for the notification of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
"type": "array",
"items": {
"description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. CREATE_SNAPSHOT | Represents the \"Create VNF Snapshot\" LCM operation. REVERT_TO_SNAPSHOT | Represents the “Revert-To VNF Snapshot\" LCM operation. CHANGE_VNFPKG | Represents the \"Change current VNF package\" LCM operation.\n",
"type": "string",
"enum": [
"INSTANTIATE",
"SCALE",
"SCALE_TO_LEVEL",
"CHANGE_FLAVOUR",
"TERMINATE",
"HEAL",
"OPERATE",
"CHANGE_EXT_CONN",
"MODIFY_INFO",
"CREATE_SNAPSHOT",
"REVERT_TO_SNAPSHOT",
"CHANGE_VNFPKG"
]
}
},
"operationStates": {
"description": "Match particular LCM operation state values as reported in notifications of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
"type": "array",
"items": {
"description": "STARTING: The LCM operation is starting. PROCESSING: The LCM operation is currently in execution. COMPLETED: The LCM operation has been completed successfully. FAILED_TEMP: The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED: The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK: The LCM operation is currently being rolled back. ROLLED_BACK: The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n",
"type": "string",
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
"FAILED_TEMP",
"FAILED",
"ROLLING_BACK",
"ROLLED_BACK"
]
}
}
}
},
"callbackUri": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
},
"verbosity": {
"description": "The enumeration LcmOpOccNotificationVerbosityType provides values to control the verbosity of LCM operation occurrence notifications. * FULL: This signals a full notification which contains all change details. * SHORT: This signals a short notification which omits large-volume change details to reduce the size of data to\n be sent via the notification mechanism.\n",
"type": "string",
"enum": [
"FULL",
"SHORT"
]
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
}
\ No newline at end of file
SOL002/VNFLifecycleManagement-API/schemas/subscriptions.schema.json
View file @ 29614667
{
"type": "array",
"items": {
"description": "This type represents a subscription.",
"type": "object",
"required": [
"id",
"callbackUri",
"_links"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"filter": {
"description": "This type represents a filter that can be used to subscribe for notifications related to performance management events.\n",
"type": "object",
"properties": {
"vnfInstanceSubscriptionFilter": {
"description": "This type represents subscription filter criteria to match VNF instances.\n",
"type": "object",
"properties": {
"vnfdIds": {
"description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"type": "array",
"items": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
},
"vnfProductsFromProviders": {
"description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"vnfProvider"
],
"properties": {
"vnfProvider": {
"description": "Name of the VNF provider to match.\n",
"type": "string"
},
"vnfProducts": {
"description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"vnfProductName"
],
"properties": {
"vnfProductName": {
"description": "Name of the VNF product to match.\n",
"type": "string"
},
"versions": {
"description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"vnfSoftwareVersion"
],
"properties": {
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersions": {
"description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
"type": "array",
"items": {
"description": "A version.\n",
"type": "string"
}
}
}
}
}
}
}
}
}
}
},
"vnfInstanceIds": {
"description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"type": "array",
"items": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
},
"vnfInstanceNames": {
"description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"notificationTypes": {
"description": "Match particular notification types. Permitted values: * ThresholdCrossedNotification * PerformanceInformationAvailableNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
"type": "string",
"enum": [
"ThresholdCrossedNotification",
"PerformanceInformationAvailableNotification"
]
}
}
},
"callbackUri": {
"description": "The URI of the endpoint to send the notification to.\n",
"type": "string",
"format": "url"
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"description": "This type represents a link to a resource.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "URI of the referenced resource.\n",
"type": "string",
"format": "url"
}
}
}
}
}
}
"items":
{
"description": "This type represents a subscription related to notifications about VNF lifecycle changes.\n",
"type": "object",
"required": [
"id",
"callbackUri",
"verbosity",
"_links"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"filter": {
"description": "This type represents a subscription filter related to notifications about VNF lifecycle changes. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n",
"type": "object",
"properties": {
"vnfInstanceSubscriptionFilter": {
"description": "This type represents subscription filter criteria to match VNF instances.\n",
"type": "object",
"anyOf": [{
"oneOf": [{
"required": [
"vnfdId"
]
},
{
"required": [
"vnfProductsFromProviders"
]
}
]
},
{
"oneOf": [{
"required": [
"vnfInstanceIds"
]
},
{
"required": [
"vnfInstanceNames"
]
}
]
}
],
"properties": {
"vnfdIds": {
"description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"type": "array",
"items": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
},
"vnfProductsFromProviders": {
"description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"vnfProvider"
],
"properties": {
"vnfProvider": {
"description": "Name of the VNF provider to match.\n",
"type": "string"
},
"vnfProducts": {
"description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"vnfProductName"
],
"properties": {
"vnfProductName": {
"description": "Name of the VNF product to match.\n",
"type": "string"
},
"versions": {
"description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"vnfSoftwareVersion"
],
"properties": {
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersions": {
"description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
"type": "array",
"items": {
"description": "A version.\n",
"type": "string"
}
}
}
}
}
}
}
}
}
}
},
"vnfInstanceIds": {
"description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"type": "array",
"items": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
},
"vnfInstanceNames": {
"description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"notificationTypes": {
"description": "Match particular notification types. Permitted values: * VnfLcmOperationOccurrenceNotification * VnfIdentifierCreationNotification * VnfIdentifierDeletionNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
"type": "array",
"items": {
"type": "string",
"enum": [
"VnfLcmOperationOccurrenceNotification",
"VnfIdentifierCreationNotification",
"VnfIdentifierDeletionNotification"
]
}
},
"operationTypes": {
"description": "Match particular VNF lifecycle operation types for the notification of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
"type": "array",
"items": {
"description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. CREATE_SNAPSHOT | Represents the \"Create VNF Snapshot\" LCM operation. REVERT_TO_SNAPSHOT | Represents the “Revert-To VNF Snapshot\" LCM operation. CHANGE_VNFPKG | Represents the \"Change current VNF package\" LCM operation.\n",
"type": "string",
"enum": [
"INSTANTIATE",
"SCALE",
"SCALE_TO_LEVEL",
"CHANGE_FLAVOUR",
"TERMINATE",
"HEAL",
"OPERATE",
"CHANGE_EXT_CONN",
"MODIFY_INFO",
"CREATE_SNAPSHOT",
"REVERT_TO_SNAPSHOT",
"CHANGE_VNFPKG"
]
}
},
"operationStates": {
"description": "Match particular LCM operation state values as reported in notifications of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
"type": "array",
"items": {
"description": "STARTING: The LCM operation is starting. PROCESSING: The LCM operation is currently in execution. COMPLETED: The LCM operation has been completed successfully. FAILED_TEMP: The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED: The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK: The LCM operation is currently being rolled back. ROLLED_BACK: The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n",
"type": "string",
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
"FAILED_TEMP",
"FAILED",
"ROLLING_BACK",
"ROLLED_BACK"
]
}
}
}
},
"callbackUri": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
},
"verbosity": {
"description": "The enumeration LcmOpOccNotificationVerbosityType provides values to control the verbosity of LCM operation occurrence notifications. * FULL: This signals a full notification which contains all change details. * SHORT: This signals a short notification which omits large-volume change details to reduce the size of data to\n be sent via the notification mechanism.\n",
"type": "string",
"enum": [
"FULL",
"SHORT"
]
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
}
}
\ No newline at end of file
SOL002/VNFLifecycleManagement-API/schemas/vnfInstance.schema.json
View file @ 29614667
{
"description": "This type represents a VNF instance.\n",
"type": "object",
"required": [
"id",
"vnfdId",
"vnfProvider",
"vnfProductName",
"vnfSoftwareVersion",
"vnfdVersion",
"vnfPkgInfoId",
"instantiationState"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfInstanceName": {
"description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
"type": "string"
},
"vnfInstanceDescription": {
"description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
"type": "string"
},
"vnfProductName": {
"description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfPkgInfoId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"instantiationState": {
"description": "The instantiation state of the VNF.\n",
"type": "string",
"enum": [
"NOT_INSTANTIATED",
"INSTANTIATED"
]
},
"instantiatedVnfInfo": {
"description": "Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.\n",
"type": "object",
"required": [
"flavourId",
"vnfState",
"extCpInfo"
],
"properties": {
"flavourId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfState": {
"description": "STARTED: The VNF instance is up and running. STOPPED: The VNF instance has been shut down.\n",
"type": "string",
"enum": [
"STARTED",
"STOPPED"
]
},
"scaleStatus": {
"description": "Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how \"big\" the VNF has been scaled w.r.t. that aspect.\n",
"type": "array",
"items": {
"required": [
"aspectId",
"scaleLevel"
],
"type": "object",
"properties": {
"aspectId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"scaleLevel": {
"description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
"type": "integer"
}
}
}
},
"extCpInfo": {
"description": "Information about the external CPs exposed by the VNF instance.\n",
"type": "array",
"minItems": 1,
"items": {
"description": "This type represents information about an external CP of a VNF. It shall comply with the provisions defined in table 5.5.3.25 1.\n",
"type": "object",
"required": [
"id",
"cpdId",
"cpProtocolInfo"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Network protocol information for this CP.\n",
"type": "array",
"items": {
"description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents information about a network address that has been assigned.\n",
"type": "object",
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"addresses": {
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
}
}
}
}
}
}
},
"extLinkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"associatedVnfcCpId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"associatedVnfVirtualLinkId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
}
}
},
"extVirtualLinkInfo": {
"description": "Information about the external VLs the VNF instance is connected to.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"extLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
}
}
}
},
"extManagedVirtualLinkInfo": {
"description": "External virtual links the VNF instance is connected to.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"networkResource": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"vnfLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpInstanceType": {
"description": "Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: VNFC_CP: The link port is connected to a VNFC CP EXT_CP: The link port is associated to an external CP.\n",
"type": "string",
"enum": [
"VNFC_CP",
"EXT_CP"
]
}
}
}
}
}
}
},
"monitoringParameters": {
"description": "Active monitoring parameters.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"performanceMetric"
],
"properties": {
"id": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"name": {
"description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
"type": "string"
},
"performanceMetric": {
"description": "Performance metric that is monitored. This attribute shall contain the related \"Measurement Name\" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.\n",
"type": "string"
}
}
}
},
"localizationLanguage": {
"description": "Information about localization language of the VNF (includes e.g. strings in the VNFD). The localization languages supported by a VNF can be declared in the VNFD, and localization language selection can take place at instantiation time. The value shall comply with the format defined in IETF RFC 5646.\n",
"type": "string"
},
"vnfcResourceInfo": {
"description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
"type": "object",
"required": [
"id",
"vduId",
"computeResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"computeResource": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"storageResourceIds": {
"description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfcCpInfo": {
"description": "CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is associated to an external CP of the VNF instance. May be present otherwise.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"cpdId"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfExtCpId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Network protocol information for this CP.\n",
"type": "array",
"items": {
"description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents information about a network address that has been assigned.\n",
"type": "object",
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"addresses": {
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
}
}
}
}
}
}
},
"vnfLinkPortId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"virtualLinkResourceInfo": {
"description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"networkResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"networkResource": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfLinkPorts": {
"description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpInstanceType": {
"description": "Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: VNFC_CP: The link port is connected to a VNFC CP EXT_CP: The link port is associated to an external CP.\n",
"type": "string",
"enum": [
"VNFC_CP",
"EXT_CP"
]
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"virtualStorageResourceInfo": {
"description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
"type": "object",
"required": [
"id",
"virtualStorageDescId",
"storageResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"virtualStorageDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"storageResource": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"extensions": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"indicators": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"instantiate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"terminate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"scale": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"scaleToLevel": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"changeFlavour": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"heal": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"operate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"changeExtConn": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
"description": "This type represents a VNF instance.\n",
"type": "object",
"required": [
"id",
"vnfdId",
"vnfProvider",
"vnfProductName",
"vnfSoftwareVersion",
"vnfdVersion",
"instantiationState",
"_links"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfInstanceName": {
"description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
"type": "string"
},
"vnfInstanceDescription": {
"description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
"type": "string"
},
"vnfProductName": {
"description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"instantiationState": {
"description": "The instantiation state of the VNF.\n",
"type": "string",
"enum": [
"NOT_INSTANTIATED",
"INSTANTIATED"
]
},
"instantiatedVnfInfo": {
"description": "Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.\n",
"type": "object",
"required": [
"flavourId",
"vnfState",
"extCpInfo"
],
"properties": {
"flavourId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfState": {
"description": "STARTED: The VNF instance is up and running. STOPPED: The VNF instance has been shut down.\n",
"type": "string",
"enum": [
"STARTED",
"STOPPED"
]
},
"scaleStatus": {
"description": "Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how \"big\" the VNF has been scaled w.r.t. that aspect.\n",
"type": "array",
"items": {
"required": [
"aspectId",
"scaleLevel"
],
"type": "object",
"properties": {
"aspectId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"scaleLevel": {
"description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
"type": "integer"
}
}
}
},
"maxScaleLevels": {
"description": "Maximum allowed scale levels of the VNF, one entry per aspect. This attribute shall be present if the VNF supports scaling.\n",
"type": "array",
"items": {
"required": [
"aspectId",
"scaleLevel"
],
"type": "object",
"properties": {
"aspectId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"scaleLevel": {
"description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
"type": "integer"
}
}
}
},
"extCpInfo": {
"description": "Information about the external CPs exposed by the VNF instance. When trunking is enabled, the list of entries includes both, external CPs corresponding to parent ports of a trunk, and external CPs associated to sub-ports of a trunk.\n",
"type": "array",
"minItems": 1,
"items": {
"description": "This type represents information about an external CP of a VNF. It shall comply with the provisions defined in table 5.5.3.25 1.\n",
"type": "object",
"required": [
"id",
"cpdId",
"cpConfigId",
"cpProtocolInfo"
],
"oneOf": [{
"required": [
"associatedVnfcCpId"
]
},
{
"required": [
"associatedVnfVirtualLinkId"
]
}
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"cpConfigId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Network protocol information for this CP.\n",
"type": "array",
"items": {
"description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents information about a network address that has been assigned.\n",
"type": "object",
"anyOf": [{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [{
"required": [
"addresses"
]
},
{
"required": [
"addressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet. At least one of \"macAddress\" or \"ipAddresses\" shall be present.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"addresses": {
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
},
"extLinkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"associatedVnfcCpId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"associatedVnfVirtualLinkId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
}
}
},
"extVirtualLinkInfo": {
"description": "Information about the external VLs the VNF instance is connected to.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle",
"currentVnfExtCpData"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"extLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
},
"currentVnfExtCpData": {
"description": "Allows the API consumer to read the current CP configuration information for the connection of external CPs to the external virtual link. This attribute reflects the current configuration information that has resulted from merging into this attribute the \"VnfExtCpData\" information which was passed as part of the \"ExtVirtualLinkData\" structure in the input of the most recent VNF LCM operation such as \"InstantiateVnfRequest\", \"ChangeExtVnfConnectivityRequest\", \"ChangeVnfFlavourRequest\" or \"ChangeCurrentVnfPkgRequest\", or has been provided by the NFVO during the granting procedure. If applying such change results in an empty list of \"currentVnfExtCpData\" structure instances, the affected instance of \"ExtVirtualLinkInfo\" shall be removed from its parent data structure.\n",
"type": "array",
"items": {
"description": "This type represents configuration information for external CPs created from a CPD.\n",
"type": "object",
"required": [
"cpdId"
],
"properties": {
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"cpConfig": {
"description": "Map of instance data that need to be configured on the CP instances created from the respective CPD. The key of the map which identifies the individual VnfExtCpConfig entries is managed by the API consumer. The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396). Within one VNF instance, all VNFC instances created from a particular VDU have the same external connectivity. Thus, given a particular value of the “cpdId” attribute, there shall be one “cpConfig” entry for each VNFC instance that has been or can be created from a VDU which includes a CPD identified by the “cpdId” attribute. If the cpConfig represents a subport in a trunk, all “cpConfig” entries in this list shall have the same segmentationId, which means they are connected to the same set of external VLs via the trunk. The map entry value shall be set to \"null\" in order to delete a \"VnfExtCpConfig\" entry identified by a particular key value from the map, i.e. for the disconnection of an existing external CP instance addressed by cpInstanceId in the deleted map entry from a particular external virtual link, and deletion of that instance in case it represents a subport. Deleting the last key from the map removes the affected instance of the \"VnfExtCpData\" structure from its parent data structure.\n",
"type": "object",
"additionalProperties": {
"description": "This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n",
"anyOf": [{
"required": [
"linkPortId"
]
},
{
"required": [
"cpProtocolData"
]
}
],
"type": "object",
"properties": {
"parentCpConfigId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"linkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"cpProtocolData": {
"description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": 1) Void 2) At least one of the \"linkPortId\" and \"cpProtocolData\" attributes \n shall be present for an external CP instance representing a subport \n that is to be created, or an external CP instance that is to be created \n by creating the corresponding VNFC or VNF instance during the current or \n a subsequent LCM operation, or for an existing external CP instance \n that is to be re-configured or added to a particular external virtual link.\n3) If the \"linkPortId\" attribute is absent, the VNFM shall create a\n link port.\n4) If the \"cpProtocolData\" attribute is absent, the \"linkPortId\"\n attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n5) If both \"cpProtocolData\" and \"linkportId\" are provided, the API\n consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n",
"type": "array",
"items": {
"description": "This type represents network protocol data.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "Identifier of layer(s) and protocol(s). This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents network address data for IP over Ethernet.\n",
"type": "object",
"anyOf": [{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [{
"required": [
"fixedAddresses"
]
},
{
"required": [
"numDynamicAddresses"
]
},
{
"required": [
"ipAddressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"fixedAddresses": {
"description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"numDynamicAddresses": {
"description": "Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "integer"
},
"addressRange": {
"description": "An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"extManagedVirtualLinkInfo": {
"description": "External virtual links the VNF instance is connected to. 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.5).\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"networkResource"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"networkResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"vnfLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpInstanceType": {
"description": "Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: VNFC_CP: The link port is connected to a VNFC CP EXT_CP: The link port is associated to an external CP.\n",
"type": "string",
"enum": [
"VNFC_CP",
"EXT_CP"
]
}
}
}
}
}
}
},
"monitoringParameters": {
"description": "Active monitoring parameters.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"performanceMetric"
],
"properties": {
"id": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"name": {
"description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
"type": "string"
},
"performanceMetric": {
"description": "Performance metric that is monitored. This attribute shall contain the related \"Measurement Name\" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.\n",
"type": "string"
}
}
}
},
"localizationLanguage": {
"description": "Information about localization language of the VNF (includes e.g. strings in the VNFD). The localization languages supported by a VNF can be declared in the VNFD, and localization language selection can take place at instantiation time. The value shall comply with the format defined in IETF RFC 5646.\n",
"type": "string"
},
"vnfcResourceInfo": {
"description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
"type": "object",
"required": [
"id",
"vduId",
"computeResource",
"vnfcCpInfo"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"computeResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"storageResourceIds": {
"description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfcCpInfo": {
"description": "All the CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is exposed as an external CP of the VNF instance or is connected to an external CP of the VNF instance. A VNFC CP is \"connected to\" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. A VNFC CP is \"exposed as\" an external CP if it is connected directly to an external VL. May be present otherwise.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"cpdId"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfExtCpId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Network protocol information for this CP. May be omitted if the VNFC CP is exposed as an external CP. The information can be omitted because it is already available as part of the external CP information.\n",
"type": "array",
"items": {
"description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents information about a network address that has been assigned.\n",
"type": "object",
"anyOf": [{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [{
"required": [
"addresses"
]
},
{
"required": [
"addressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet. At least one of \"macAddress\" or \"ipAddresses\" shall be present.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"addresses": {
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
},
"vnfLinkPortId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"vnfVirtualLinkResourceInfo": {
"description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"networkResource",
"vnfLinkPorts"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"networkResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfLinkPorts": {
"description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpInstanceType": {
"description": "Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: VNFC_CP: The link port is connected to a VNFC CP EXT_CP: The link port is associated to an external CP.\n",
"type": "string",
"enum": [
"VNFC_CP",
"EXT_CP"
]
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"vnfVirtualStorageResourceInfo": {
"description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
"type": "object",
"required": [
"id",
"virtualStorageDescId",
"storageResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"virtualStorageDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"storageResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"vnfcInfo": {
"description": "Information about the VNFC instances.\n",
"type": "array",
"items": {
"description": "This type represents the information about a VNFC instance that is part of a VNF instance. It shall comply with the provisions defined in table 5.5.3.23-1.\n",
"type": "object",
"required": [
"id",
"vduId",
"vnfcState"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcResourceInfoId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcState": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"extensions": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"indicators": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"instantiate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"terminate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"scale": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"scaleToLevel": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"changeFlavour": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"heal": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"operate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"changeExtConn": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"createSnapshot": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"revertToSnapshot": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
}
\ No newline at end of file
SOL002/VNFLifecycleManagement-API/schemas/vnfInstances.schema.json
View file @ 29614667
{
"type:" : "array",
"items": {
"description": "This type represents a VNF instance.\n",
"type": "object",
"required": [
"id",
"vnfdId",
"vnfProvider",
"vnfProductName",
"vnfSoftwareVersion",
"vnfdVersion",
"vnfPkgInfoId",
"instantiationState"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfInstanceName": {
"description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
"type": "string"
},
"vnfInstanceDescription": {
"description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
"type": "string"
},
"vnfProductName": {
"description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfPkgInfoId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"instantiationState": {
"description": "The instantiation state of the VNF.\n",
"type": "string",
"enum": [
"NOT_INSTANTIATED",
"INSTANTIATED"
]
},
"instantiatedVnfInfo": {
"description": "Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.\n",
"type": "object",
"required": [
"flavourId",
"vnfState",
"extCpInfo"
],
"properties": {
"flavourId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfState": {
"description": "STARTED: The VNF instance is up and running. STOPPED: The VNF instance has been shut down.\n",
"type": "string",
"enum": [
"STARTED",
"STOPPED"
]
},
"scaleStatus": {
"description": "Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how \"big\" the VNF has been scaled w.r.t. that aspect.\n",
"type": "array",
"items": {
"required": [
"aspectId",
"scaleLevel"
],
"type": "object",
"properties": {
"aspectId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"scaleLevel": {
"description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
"type": "integer"
}
}
}
},
"extCpInfo": {
"description": "Information about the external CPs exposed by the VNF instance.\n",
"type": "array",
"minItems": 1,
"items": {
"description": "This type represents information about an external CP of a VNF. It shall comply with the provisions defined in table 5.5.3.25 1.\n",
"type": "object",
"required": [
"id",
"cpdId",
"cpProtocolInfo"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Network protocol information for this CP.\n",
"type": "array",
"items": {
"description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents information about a network address that has been assigned.\n",
"type": "object",
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"addresses": {
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
}
}
}
}
}
}
},
"extLinkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"associatedVnfcCpId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"associatedVnfVirtualLinkId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
}
}
},
"extVirtualLinkInfo": {
"description": "Information about the external VLs the VNF instance is connected to.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"extLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
}
}
}
},
"extManagedVirtualLinkInfo": {
"description": "External virtual links the VNF instance is connected to.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"networkResource": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"vnfLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpInstanceType": {
"description": "Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: VNFC_CP: The link port is connected to a VNFC CP EXT_CP: The link port is associated to an external CP.\n",
"type": "string",
"enum": [
"VNFC_CP",
"EXT_CP"
]
}
}
}
}
}
}
},
"monitoringParameters": {
"description": "Active monitoring parameters.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"performanceMetric"
],
"properties": {
"id": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"name": {
"description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
"type": "string"
},
"performanceMetric": {
"description": "Performance metric that is monitored. This attribute shall contain the related \"Measurement Name\" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.\n",
"type": "string"
}
}
}
},
"localizationLanguage": {
"description": "Information about localization language of the VNF (includes e.g. strings in the VNFD). The localization languages supported by a VNF can be declared in the VNFD, and localization language selection can take place at instantiation time. The value shall comply with the format defined in IETF RFC 5646.\n",
"type": "string"
},
"vnfcResourceInfo": {
"description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
"type": "object",
"required": [
"id",
"vduId",
"computeResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"computeResource": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"storageResourceIds": {
"description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfcCpInfo": {
"description": "CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is associated to an external CP of the VNF instance. May be present otherwise.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"cpdId"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfExtCpId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Network protocol information for this CP.\n",
"type": "array",
"items": {
"description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents information about a network address that has been assigned.\n",
"type": "object",
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"addresses": {
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
}
}
}
}
}
}
},
"vnfLinkPortId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"virtualLinkResourceInfo": {
"description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"networkResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"networkResource": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfLinkPorts": {
"description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpInstanceType": {
"description": "Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: VNFC_CP: The link port is connected to a VNFC CP EXT_CP: The link port is associated to an external CP.\n",
"type": "string",
"enum": [
"VNFC_CP",
"EXT_CP"
]
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"virtualStorageResourceInfo": {
"description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
"type": "object",
"required": [
"id",
"virtualStorageDescId",
"storageResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"virtualStorageDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"storageResource": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"extensions": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"indicators": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"instantiate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"terminate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"scale": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"scaleToLevel": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"changeFlavour": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"heal": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"operate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"changeExtConn": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
"type": "array",
"items":
{
"description": "This type represents a VNF instance.\n",
"type": "object",
"required": [
"id",
"vnfdId",
"vnfProvider",
"vnfProductName",
"vnfSoftwareVersion",
"vnfdVersion",
"instantiationState",
"_links"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfInstanceName": {
"description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
"type": "string"
},
"vnfInstanceDescription": {
"description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
"type": "string"
},
"vnfProductName": {
"description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"instantiationState": {
"description": "The instantiation state of the VNF.\n",
"type": "string",
"enum": [
"NOT_INSTANTIATED",
"INSTANTIATED"
]
},
"instantiatedVnfInfo": {
"description": "Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.\n",
"type": "object",
"required": [
"flavourId",
"vnfState",
"extCpInfo"
],
"properties": {
"flavourId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfState": {
"description": "STARTED: The VNF instance is up and running. STOPPED: The VNF instance has been shut down.\n",
"type": "string",
"enum": [
"STARTED",
"STOPPED"
]
},
"scaleStatus": {
"description": "Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how \"big\" the VNF has been scaled w.r.t. that aspect.\n",
"type": "array",
"items": {
"required": [
"aspectId",
"scaleLevel"
],
"type": "object",
"properties": {
"aspectId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"scaleLevel": {
"description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
"type": "integer"
}
}
}
},
"maxScaleLevels": {
"description": "Maximum allowed scale levels of the VNF, one entry per aspect. This attribute shall be present if the VNF supports scaling.\n",
"type": "array",
"items": {
"required": [
"aspectId",
"scaleLevel"
],
"type": "object",
"properties": {
"aspectId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"scaleLevel": {
"description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
"type": "integer"
}
}
}
},
"extCpInfo": {
"description": "Information about the external CPs exposed by the VNF instance. When trunking is enabled, the list of entries includes both, external CPs corresponding to parent ports of a trunk, and external CPs associated to sub-ports of a trunk.\n",
"type": "array",
"minItems": 1,
"items": {
"description": "This type represents information about an external CP of a VNF. It shall comply with the provisions defined in table 5.5.3.25 1.\n",
"type": "object",
"required": [
"id",
"cpdId",
"cpConfigId",
"cpProtocolInfo"
],
"oneOf": [{
"required": [
"associatedVnfcCpId"
]
},
{
"required": [
"associatedVnfVirtualLinkId"
]
}
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"cpConfigId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Network protocol information for this CP.\n",
"type": "array",
"items": {
"description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents information about a network address that has been assigned.\n",
"type": "object",
"anyOf": [{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [{
"required": [
"addresses"
]
},
{
"required": [
"addressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet. At least one of \"macAddress\" or \"ipAddresses\" shall be present.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"addresses": {
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
},
"extLinkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"associatedVnfcCpId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"associatedVnfVirtualLinkId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
}
}
},
"extVirtualLinkInfo": {
"description": "Information about the external VLs the VNF instance is connected to.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle",
"currentVnfExtCpData"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"extLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
},
"currentVnfExtCpData": {
"description": "Allows the API consumer to read the current CP configuration information for the connection of external CPs to the external virtual link. This attribute reflects the current configuration information that has resulted from merging into this attribute the \"VnfExtCpData\" information which was passed as part of the \"ExtVirtualLinkData\" structure in the input of the most recent VNF LCM operation such as \"InstantiateVnfRequest\", \"ChangeExtVnfConnectivityRequest\", \"ChangeVnfFlavourRequest\" or \"ChangeCurrentVnfPkgRequest\", or has been provided by the NFVO during the granting procedure. If applying such change results in an empty list of \"currentVnfExtCpData\" structure instances, the affected instance of \"ExtVirtualLinkInfo\" shall be removed from its parent data structure.\n",
"type": "array",
"items": {
"description": "This type represents configuration information for external CPs created from a CPD.\n",
"type": "object",
"required": [
"cpdId"
],
"properties": {
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"cpConfig": {
"description": "Map of instance data that need to be configured on the CP instances created from the respective CPD. The key of the map which identifies the individual VnfExtCpConfig entries is managed by the API consumer. The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396). Within one VNF instance, all VNFC instances created from a particular VDU have the same external connectivity. Thus, given a particular value of the “cpdId” attribute, there shall be one “cpConfig” entry for each VNFC instance that has been or can be created from a VDU which includes a CPD identified by the “cpdId” attribute. If the cpConfig represents a subport in a trunk, all “cpConfig” entries in this list shall have the same segmentationId, which means they are connected to the same set of external VLs via the trunk. The map entry value shall be set to \"null\" in order to delete a \"VnfExtCpConfig\" entry identified by a particular key value from the map, i.e. for the disconnection of an existing external CP instance addressed by cpInstanceId in the deleted map entry from a particular external virtual link, and deletion of that instance in case it represents a subport. Deleting the last key from the map removes the affected instance of the \"VnfExtCpData\" structure from its parent data structure.\n",
"type": "object",
"additionalProperties": {
"description": "This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n",
"anyOf": [{
"required": [
"linkPortId"
]
},
{
"required": [
"cpProtocolData"
]
}
],
"type": "object",
"properties": {
"parentCpConfigId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"linkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"cpProtocolData": {
"description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": 1) Void 2) At least one of the \"linkPortId\" and \"cpProtocolData\" attributes \n shall be present for an external CP instance representing a subport \n that is to be created, or an external CP instance that is to be created \n by creating the corresponding VNFC or VNF instance during the current or \n a subsequent LCM operation, or for an existing external CP instance \n that is to be re-configured or added to a particular external virtual link.\n3) If the \"linkPortId\" attribute is absent, the VNFM shall create a\n link port.\n4) If the \"cpProtocolData\" attribute is absent, the \"linkPortId\"\n attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n5) If both \"cpProtocolData\" and \"linkportId\" are provided, the API\n consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n",
"type": "array",
"items": {
"description": "This type represents network protocol data.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "Identifier of layer(s) and protocol(s). This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents network address data for IP over Ethernet.\n",
"type": "object",
"anyOf": [{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [{
"required": [
"fixedAddresses"
]
},
{
"required": [
"numDynamicAddresses"
]
},
{
"required": [
"ipAddressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"fixedAddresses": {
"description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"numDynamicAddresses": {
"description": "Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "integer"
},
"addressRange": {
"description": "An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"extManagedVirtualLinkInfo": {
"description": "External virtual links the VNF instance is connected to. 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.5).\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"networkResource"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"networkResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"vnfLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpInstanceType": {
"description": "Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: VNFC_CP: The link port is connected to a VNFC CP EXT_CP: The link port is associated to an external CP.\n",
"type": "string",
"enum": [
"VNFC_CP",
"EXT_CP"
]
}
}
}
}
}
}
},
"monitoringParameters": {
"description": "Active monitoring parameters.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"performanceMetric"
],
"properties": {
"id": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"name": {
"description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
"type": "string"
},
"performanceMetric": {
"description": "Performance metric that is monitored. This attribute shall contain the related \"Measurement Name\" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.\n",
"type": "string"
}
}
}
},
"localizationLanguage": {
"description": "Information about localization language of the VNF (includes e.g. strings in the VNFD). The localization languages supported by a VNF can be declared in the VNFD, and localization language selection can take place at instantiation time. The value shall comply with the format defined in IETF RFC 5646.\n",
"type": "string"
},
"vnfcResourceInfo": {
"description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
"type": "object",
"required": [
"id",
"vduId",
"computeResource",
"vnfcCpInfo"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"computeResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"storageResourceIds": {
"description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfcCpInfo": {
"description": "All the CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is exposed as an external CP of the VNF instance or is connected to an external CP of the VNF instance. A VNFC CP is \"connected to\" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. A VNFC CP is \"exposed as\" an external CP if it is connected directly to an external VL. May be present otherwise.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"cpdId"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfExtCpId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Network protocol information for this CP. May be omitted if the VNFC CP is exposed as an external CP. The information can be omitted because it is already available as part of the external CP information.\n",
"type": "array",
"items": {
"description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents information about a network address that has been assigned.\n",
"type": "object",
"anyOf": [{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [{
"required": [
"addresses"
]
},
{
"required": [
"addressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet. At least one of \"macAddress\" or \"ipAddresses\" shall be present.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"addresses": {
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
},
"vnfLinkPortId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"vnfVirtualLinkResourceInfo": {
"description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"networkResource",
"vnfLinkPorts"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"networkResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfLinkPorts": {
"description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpInstanceType": {
"description": "Type of the CP instance that is identified by cpInstanceId. Shall be present if \"cpInstanceId\" is present, and shall be absent otherwise. Permitted values: VNFC_CP: The link port is connected to a VNFC CP EXT_CP: The link port is associated to an external CP.\n",
"type": "string",
"enum": [
"VNFC_CP",
"EXT_CP"
]
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"vnfVirtualStorageResourceInfo": {
"description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
"type": "array",
"items": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
"type": "object",
"required": [
"id",
"virtualStorageDescId",
"storageResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"virtualStorageDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"storageResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"reservationId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"vnfcInfo": {
"description": "Information about the VNFC instances.\n",
"type": "array",
"items": {
"description": "This type represents the information about a VNFC instance that is part of a VNF instance. It shall comply with the provisions defined in table 5.5.3.23-1.\n",
"type": "object",
"required": [
"id",
"vduId",
"vnfcState"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcResourceInfoId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcState": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"extensions": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"indicators": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"instantiate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"terminate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"scale": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"scaleToLevel": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"changeFlavour": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"heal": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"operate": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"changeExtConn": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"createSnapshot": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"revertToSnapshot": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
}
}
}
\ No newline at end of file
}
\ No newline at end of file
SOL002/VNFLifecycleManagement-API/schemas/vnfLcmOpOcc.schema.json
View file @ 29614667
{
"description": "This type represents a VNF lifecycle management operation occurrence.\n",
"type": "object",
"required": [
"id",
"operationState",
"stateEnteredTime",
"startTime",
"vnfInstanceId",
"operation",
"isAutomaticInvocation",
"isCancelPending"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"operationState": {
"description": "STARTING: The LCM operation is starting. PROCESSING: The LCM operation is currently in execution. COMPLETED: The LCM operation has been completed successfully. FAILED_TEMP: The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED: The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK: The LCM operation is currently being rolled back. ROLLED_BACK: The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n",
"type": "string",
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
"FAILED_TEMP",
"FAILED",
"ROLLING_BACK",
"ROLLED_BACK"
]
},
"stateEnteredTime": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"startTime": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"vnfInstanceId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"grantId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"operation": {
"description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. \n",
"type": "string",
"enum": [
"INSTANTIATE",
"SCALE",
"SCALE_TO_LEVEL",
"CHANGE_FLAVOUR",
"TERMINATE",
"HEAL",
"OPERATE",
"CHANGE_EXT_CONN",
"MODIFY_INFO"
]
},
"isAutomaticInvocation": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
},
"operationParams": {
"description": "Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation. The following mapping between operationType and the data type of this attribute shall apply: * INSTANTIATE: InstantiateVnfRequest * SCALE: ScaleVnfRequest * SCALE_TO_LEVEL: ScaleVnfToLevelRequest * CHANGE_FLAVOUR: ChangeVnfFlavourRequest * OPERATE: OperateVnfRequest * HEAL: HealVnfRequest * CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest * TERMINATE: TerminateVnfRequest * MODIFY_INFO: VnfInfoModifications\n",
"type": "object"
},
"isCancelPending": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
},
"cancelMode": {
"description": "Cancellation mode. GRACEFUL: If the VNF LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state, the VNFM shall not start any new resource management operation and shall wait for the ongoing resource management operations in the underlying system, typically the VIM, to finish execution or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. If the VNF LCM operation occurrence is in \"STARTING\" state, the VNFM shall not start any resource management operation and shall wait for the granting request to finish execution or time out. After that, the VNFM shall put the operation occurrence into the ROLLED_BACK state. FORCEFUL: If the VNF LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state, the VNFM shall not start any new resource management operation, shall cancel the ongoing resource management operations in the underlying system, typically the VIM, and shall wait for the cancellation to finish or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. If the VNF LCM operation occurrence is in \"STARTING\" state, the VNFM shall not start any resource management operation and put the operation occurrence into the ROLLED_BACK state.\n",
"type": "string",
"enum": [
"GRACEFUL",
"FORCEFUL"
]
},
"error": {
"description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
"type": "string",
"format": "URI"
}
"description": "This type represents a VNF lifecycle management operation occurrence. Shall be set to the value of the \"id\" attribute in the \"Grant\" representing the associated \"Individual Grant\", if such grant exists.\n",
"type": "object",
"oneOf": [
{
"required": [
"changedInfo"
]
},
{
"required": [
"modificationsTriggeredByVnfPkgChange"
]
}
],
"required": [
"id",
"operationState",
"stateEnteredTime",
"startTime",
"vnfInstanceId",
"operation",
"isAutomaticInvocation",
"isCancelPending"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"operationState": {
"description": "STARTING: The LCM operation is starting. PROCESSING: The LCM operation is currently in execution. COMPLETED: The LCM operation has been completed successfully. FAILED_TEMP: The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED: The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK: The LCM operation is currently being rolled back. ROLLED_BACK: The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n",
"type": "string",
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
"FAILED_TEMP",
"FAILED",
"ROLLING_BACK",
"ROLLED_BACK"
]
},
"stateEnteredTime": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"startTime": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"vnfInstanceId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"grantId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"operation": {
"description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. CREATE_SNAPSHOT | Represents the \"Create VNF Snapshot\" LCM operation. REVERT_TO_SNAPSHOT | Represents the “Revert-To VNF Snapshot\" LCM operation. CHANGE_VNFPKG | Represents the \"Change current VNF package\" LCM operation.\n",
"type": "string",
"enum": [
"INSTANTIATE",
"SCALE",
"SCALE_TO_LEVEL",
"CHANGE_FLAVOUR",
"TERMINATE",
"HEAL",
"OPERATE",
"CHANGE_EXT_CONN",
"MODIFY_INFO",
"CREATE_SNAPSHOT",
"REVERT_TO_SNAPSHOT",
"CHANGE_VNFPKG"
]
},
"isAutomaticInvocation": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
},
"operationParams": {
"description": "Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation. The following mapping between operationType and the data type of this attribute shall apply: * INSTANTIATE: InstantiateVnfRequest * SCALE: ScaleVnfRequest * SCALE_TO_LEVEL: ScaleVnfToLevelRequest * CHANGE_FLAVOUR: ChangeVnfFlavourRequest * OPERATE: OperateVnfRequest * HEAL: HealVnfRequest * CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest * TERMINATE: TerminateVnfRequest * MODIFY_INFO: VnfInfoModifications * CREATE_SNAPSHOT: CreateVnfSnapshotRequest * REVERT_TO_SNAPSHOT: RevertToVnfSnapshotRequest * CHANGE_VNFPKG: ChangeCurrentVnfPkgRequest\n",
"type": "object"
},
"isCancelPending": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
},
"cancelMode": {
"description": "Cancellation mode. GRACEFUL: If the VNF LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state, the VNFM shall not start any new resource management operation and shall wait for the ongoing resource management operations in the underlying system, typically the VIM, to finish execution or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. If the VNF LCM operation occurrence is in \"STARTING\" state, the VNFM shall not start any resource management operation and shall wait for the granting request to finish execution or time out. After that, the VNFM shall put the operation occurrence into the ROLLED_BACK state. FORCEFUL: If the VNF LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state, the VNFM shall not start any new resource management operation, shall cancel the ongoing resource management operations in the underlying system, typically the VIM, and shall wait for the cancellation to finish or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. If the VNF LCM operation occurrence is in \"STARTING\" state, the VNFM shall not start any resource management operation and put the operation occurrence into the ROLLED_BACK state.\n",
"type": "string",
"enum": [
"GRACEFUL",
"FORCEFUL"
]
},
"error": {
"description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
"type": "string",
"format": "URI"
}
},
"resourceChanges": {
"description": "This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the LCM operation since its start, if applicable.\n",
"type": "object",
"properties": {
"affectedVnfcs": {
"description": "Information about VNFC instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary VNFCs.\n",
"type": "object",
"required": [
"id",
"vduId",
"changeType",
"computeResource"
],
"properties": {
"id": {
}
},
"resourceChanges": {
"description": "This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the LCM operation since its start, if applicable.\n",
"type": "object",
"properties": {
"affectedVnfcs": {
"description": "Information about VNFC instances that were affected during the lifecycle operation. This allows the API consumer to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary VNFCs.\n",
"type": "object",
"required": [
"id",
"vduId",
"changeType",
"computeResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVnfc structure exists as long as the temporary resource exists.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY"
]
},
"computeResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"affectedVnfcCpIds": {
"description": "Identifiers of CP(s) of the VNFC instance that were affected by the change. Shall be present for those affected CPs of the VNFC instance that are associated to an external CP of the VNF instance. May be present for further affected CPs of the VNFC instance.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
}
},
"addedStorageResourceIds": {
"description": "References to VirtualStorage resources that have been added. Each value refers to a VirtualStorageResourceInfo item in the VnfInstance that was added to the VNFC. It shall be provided if at least one storage resource was added to the VNFC.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVnfc structure exists as long as the temporary resource exists.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY"
]
},
"computeResource": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"affectedVnfcCpIds": {
"description": "Identifiers of CP(s) of the VNFC instance that were affected by the change. Shall be present for those affected CPs of the VNFC instance that are associated to an external CP of the VNF instance. May be present for further affected CPs of the VNFC instance.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
}
},
"removedStorageResourceIds": {
"description": "References to VirtualStorage resources that have been removed. The value contains the identifier of a VirtualStorageResourceInfo item that has been removed from the VNFC, and might no longer exist in the VnfInstance. It shall be provided if at least one storage resource was removed from the VNFC.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
}
},
"affectedVirtualLinks": {
"description": "Information about VL instances that were affected during the lifecycle operation. This allows the API consumer to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter. For a particular affected VL, there shall be as many \"AffectedVirtualLink\" entries as needed for signalling the different types of changes, i.e., one per virtual link and change type. For instance, in the case of signaling affected VL instances involving the addition of a particular VL instance with links ports, one \"AffectedVirtualLink\" entry signals the addition of the VL by using the \"changeType\" attribute of \"AffectedVirtualLink\" structure equal to \"ADDED\", and another \"AffectedVirtualLink\" entry signals the addition of VNF link ports of the VL by using the \"changeType\" equal to \"LINK_PORT_ADDED\".\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary VLs, and added or removed VNF link ports.\n",
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"changeType",
"networkResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY * LINK_PORT_ADDED * LINK_PORT_REMOVED For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists. When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the \"networkResource\" attribute refers to the affected virtual link instance, not the link port instance. The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the \"vnfLinkPortIds\" attribute.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY",
"LINK_PORT_ADDED",
"LINK_PORT_REMOVED"
]
},
"networkResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
},
"addedStorageResourceIds": {
"description": "References to VirtualStorage resources that have been added. Each value refers to a VirtualStorageResourceInfo item in the VnfInstance that was added to the VNFC. It shall be provided if at least one storage resource was added to the VNFC.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
}
},
"vnfLinkPortIds": {
"description": "Identifiers of the link ports of the affected VL (reference to the vnfLinkPortInfo) related to the change. Each identifier references a \"VnfLinkPortInfo\" structure. Shall be set when changeType is equal to \"LINK_PORT_ADDED\" or \"LINK_PORT_REMOVED\", and the related “VnfLinkPortInfo” structures are present (case \"added\") or have been present (case \"removed\") in the “VnfVirtualLinkResourceInfo” or \"ExtManagedVirtualLinkInfo\" structures that are represented by the \"vnfVirtualLinkResourceInfo\" or \"extManagedVirtualLinkInfo\" attribute in the \"VnfInstance\" structure. When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the \"networkResource\" attribute refers to the affected virtual link instance, not the link port instance. The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the \"vnfLinkPortIds\" attribute.\n",
"type": "array",
"items": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"affectedExtLinkPorts": {
"description": "Information about external VNF link ports that were affected during the lifecycle operation. This allows the API consumer to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"type": "array",
"items": {
"description": "This type provides information about added and deleted external link ports (link ports attached to external virtual links).\n",
"type": "object",
"required": [
"id",
"changeType",
"extCpInstanceId",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: -\tADDED -\tREMOVED\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED"
]
},
"extCpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
},
"removedStorageResourceIds": {
"description": "References to VirtualStorage resources that have been removed. The value contains the identifier of a VirtualStorageResourceInfo item that has been removed from the VNFC, and might no longer exist in the VnfInstance. It shall be provided if at least one storage resource was removed from the VNFC.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
}
}
}
}
},
"affectedVirtualStorages": {
"description": "Information about virtualised storage instances that were affected during the lifecycle operation. This allows the API consumer to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary virtual storage resources.\n",
"type": "object",
"required": [
"id",
"virtualStorageDescId",
"changeType",
"storageResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"virtualStorageDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVirtualStorage structure exists as long as the temporary resource exists.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY"
]
},
"storageResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
}
}
},
"changedInfo": {
"description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"VnfInfoModificationRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly e.g. when modifying the referenced VNF package.\n",
"type": "object",
"properties": {
"vnfInstanceName": {
"description": "If present, this attribute signals modifications of the \"vnfInstanceName\" attribute in \"VnfInstance\".\n",
"type": "string"
},
"vnfInstanceDescription": {
"description": "If present, this attribute signals modifications of the \"vnfInstanceDescription\" attribute in \"VnfInstance\".\n",
"type": "string"
},
"vnfConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"extensions": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "If present, this attribute signals modifications of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId” attribute.\n",
"type": "string"
},
"vnfProductName": {
"description": "If present, this attribute signals modifications of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId” attribute.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfcInfoModifications": {
"description": "If present, this attribute signals modifications of certain entries in the \"vnfcInfo\" attribute array in the \"instantiatedVnfInfo\" attribute of \"VnfInstance\", as defined in clause 5.5.2.12\n",
"type": "array",
"items": {
"description": "This type represents modifications of an entry in an array of \"VnfcInfo\" objects. It shall comply with the provisions defined in table 5.5.3.24-1.\n",
"type": "object",
"required": [
"id",
"vnfcConfigurableProperties"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
}
}
},
"changedExtConnectivity": {
"description": "Information about changed external connectivity, if applicable. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle",
"currentVnfExtCpData"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"affectedVirtualLinks": {
"description": "Information about VL instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"extLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary VLs.\n",
"description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"changeType",
"networkResource"
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY * LINK_PORT_ADDED * LINK_PORT_REMOVED For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY",
"LINK_PORT_ADDED",
"LINK_PORT_REMOVED"
]
},
"networkResource": {
"resourceHandle": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
......@@ -265,316 +575,339 @@
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
},
"affectedVirtualStorages": {
"description": "Information about virtualised storage instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"currentVnfExtCpData": {
"description": "Allows the API consumer to read the current CP configuration information for the connection of external CPs to the external virtual link. This attribute reflects the current configuration information that has resulted from merging into this attribute the \"VnfExtCpData\" information which was passed as part of the \"ExtVirtualLinkData\" structure in the input of the most recent VNF LCM operation such as \"InstantiateVnfRequest\", \"ChangeExtVnfConnectivityRequest\", \"ChangeVnfFlavourRequest\" or \"ChangeCurrentVnfPkgRequest\", or has been provided by the NFVO during the granting procedure. If applying such change results in an empty list of \"currentVnfExtCpData\" structure instances, the affected instance of \"ExtVirtualLinkInfo\" shall be removed from its parent data structure.\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary virtual storage resources.\n",
"description": "This type represents configuration information for external CPs created from a CPD.\n",
"type": "object",
"required": [
"id",
"virtualStorageDescId",
"changeType",
"storageResource"
"cpdId"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"virtualStorageDescId": {
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVirtualStorage structure exists as long as the temporary resource exists.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY"
]
},
"storageResource": {
"required": [
"vimConnectionId",
"resourceId"
],
"cpConfig": {
"description": "Map of instance data that need to be configured on the CP instances created from the respective CPD. The key of the map which identifies the individual VnfExtCpConfig entries is managed by the API consumer. The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396). Within one VNF instance, all VNFC instances created from a particular VDU have the same external connectivity. Thus, given a particular value of the “cpdId” attribute, there shall be one “cpConfig” entry for each VNFC instance that has been or can be created from a VDU which includes a CPD identified by the “cpdId” attribute. If the cpConfig represents a subport in a trunk, all “cpConfig” entries in this list shall have the same segmentationId, which means they are connected to the same set of external VLs via the trunk. The map entry value shall be set to \"null\" in order to delete a \"VnfExtCpConfig\" entry identified by a particular key value from the map, i.e. for the disconnection of an existing external CP instance addressed by cpInstanceId in the deleted map entry from a particular external virtual link, and deletion of that instance in case it represents a subport. Deleting the last key from the map removes the affected instance of the \"VnfExtCpData\" structure from its parent data structure.\n",
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
}
}
},
"changedInfo": {
"description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"VnfInfoModificationRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly e.g. when modifying the referenced VNF package.\n",
"type": "object",
"properties": {
"vnfInstanceName": {
"description": "If present, this attribute signals modifications of the \"vnfInstanceName\" attribute in \"VnfInstance\".\n",
"type": "string"
},
"vnfInstanceDescription": {
"description": "If present, this attribute signals modifications of the \"vnfInstanceDescription\" attribute in \"VnfInstance\".\n",
"type": "string"
},
"vnfConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"extensions": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "If present, this attribute signals modifications of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId” attribute.\n",
"type": "string"
},
"vnfProductName": {
"description": "If present, this attribute signals modifications of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId” attribute.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
}
}
},
"changedExtConnectivity": {
"description": "Information about changed external connectivity, if applicable. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"extLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"vimConnectionId",
"resourceId"
"additionalProperties": {
"description": "This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n",
"anyOf": [
{
"required": [
"linkPortId"
]
},
{
"required": [
"cpProtocolData"
]
}
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"parentCpConfigId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"linkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
"cpProtocolData": {
"description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": 1) Void 2) At least one of the \"linkPortId\" and \"cpProtocolData\" attributes \n shall be present for an external CP instance representing a subport \n that is to be created, or an external CP instance that is to be created \n by creating the corresponding VNFC or VNF instance during the current or \n a subsequent LCM operation, or for an existing external CP instance \n that is to be re-configured or added to a particular external virtual link.\n3) If the \"linkPortId\" attribute is absent, the VNFM shall create a\n link port.\n4) If the \"cpProtocolData\" attribute is absent, the \"linkPortId\"\n attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n5) If both \"cpProtocolData\" and \"linkportId\" are provided, the API\n consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n",
"type": "array",
"items": {
"description": "This type represents network protocol data.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "Identifier of layer(s) and protocol(s). This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents network address data for IP over Ethernet.\n",
"type": "object",
"anyOf": [
{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [
{
"required": [
"fixedAddresses"
]
},
{
"required": [
"numDynamicAddresses"
]
},
{
"required": [
"ipAddressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"fixedAddresses": {
"description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"numDynamicAddresses": {
"description": "Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "integer"
},
"addressRange": {
"description": "An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
}
}
}
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self",
"vnfInstance"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"modificationsTriggeredByVnfPkgChange": {
"description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource when changing the current VNF package. The attributes that can be included consist of those requested to be modified explicitly in the \"ChangeCurrentVnfPkgRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly during the operation.\n",
"type": "object",
"properties": {
"vnfConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"extensions": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "If present, this attribute signals the new value of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfdId\" attribute) was modified implicitly during the related operation, and contains a copy of the value of he related attribute from the VNFD in the VNF Package identified by the \"vnfdId\" attribute.\n",
"type": "string"
},
"vnfProductName": {
"description": "If present, this attribute signals the new value of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfdId\" attribute) was modified implicitly during the related operation, and contains a copy of the value of he related attribute from the VNFD in the VNF Package identified by the \"vnfdId\" attribute.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
}
}
},
"vnfSnapshotInfoId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self",
"vnfInstance"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
},
"vnfInstance": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"vnfInstance": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
},
"grant": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"grant": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
},
"cancel": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"cancel": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
},
"retry": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"retry": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
},
"rollback": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"rollback": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
},
"fail": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"fail": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"vnfSnapshot": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
\ No newline at end of file
}
}
\ No newline at end of file
SOL002/VNFLifecycleManagement-API/schemas/vnfLcmOpOccs.schema.json
View file @ 29614667
{
"type": "array",
"items": {
"description": "This type represents a VNF lifecycle management operation occurrence.\n",
"type": "object",
"required": [
"id",
"operationState",
"stateEnteredTime",
"startTime",
"vnfInstanceId",
"operation",
"isAutomaticInvocation",
"isCancelPending"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"operationState": {
"description": "STARTING: The LCM operation is starting. PROCESSING: The LCM operation is currently in execution. COMPLETED: The LCM operation has been completed successfully. FAILED_TEMP: The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED: The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK: The LCM operation is currently being rolled back. ROLLED_BACK: The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n",
"type": "string",
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
"FAILED_TEMP",
"FAILED",
"ROLLING_BACK",
"ROLLED_BACK"
]
},
"stateEnteredTime": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"startTime": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"vnfInstanceId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"grantId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"operation": {
"description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. \n",
"type": "string",
"enum": [
"INSTANTIATE",
"SCALE",
"SCALE_TO_LEVEL",
"CHANGE_FLAVOUR",
"TERMINATE",
"HEAL",
"OPERATE",
"CHANGE_EXT_CONN",
"MODIFY_INFO"
]
},
"isAutomaticInvocation": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
},
"operationParams": {
"description": "Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation. The following mapping between operationType and the data type of this attribute shall apply: * INSTANTIATE: InstantiateVnfRequest * SCALE: ScaleVnfRequest * SCALE_TO_LEVEL: ScaleVnfToLevelRequest * CHANGE_FLAVOUR: ChangeVnfFlavourRequest * OPERATE: OperateVnfRequest * HEAL: HealVnfRequest * CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest * TERMINATE: TerminateVnfRequest * MODIFY_INFO: VnfInfoModifications\n",
"type": "object"
},
"isCancelPending": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
},
"cancelMode": {
"description": "Cancellation mode. GRACEFUL: If the VNF LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state, the VNFM shall not start any new resource management operation and shall wait for the ongoing resource management operations in the underlying system, typically the VIM, to finish execution or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. If the VNF LCM operation occurrence is in \"STARTING\" state, the VNFM shall not start any resource management operation and shall wait for the granting request to finish execution or time out. After that, the VNFM shall put the operation occurrence into the ROLLED_BACK state. FORCEFUL: If the VNF LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state, the VNFM shall not start any new resource management operation, shall cancel the ongoing resource management operations in the underlying system, typically the VIM, and shall wait for the cancellation to finish or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. If the VNF LCM operation occurrence is in \"STARTING\" state, the VNFM shall not start any resource management operation and put the operation occurrence into the ROLLED_BACK state.\n",
"type": "string",
"enum": [
"GRACEFUL",
"FORCEFUL"
]
},
"error": {
"description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
"type": "string",
"format": "URI"
}
}
},
"resourceChanges": {
"description": "This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the LCM operation since its start, if applicable.\n",
"type": "object",
"properties": {
"affectedVnfcs": {
"description": "Information about VNFC instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary VNFCs.\n",
"type": "object",
"required": [
"id",
"vduId",
"changeType",
"computeResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVnfc structure exists as long as the temporary resource exists.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY"
]
},
"computeResource": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"affectedVnfcCpIds": {
"description": "Identifiers of CP(s) of the VNFC instance that were affected by the change. Shall be present for those affected CPs of the VNFC instance that are associated to an external CP of the VNF instance. May be present for further affected CPs of the VNFC instance.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
},
"addedStorageResourceIds": {
"description": "References to VirtualStorage resources that have been added. Each value refers to a VirtualStorageResourceInfo item in the VnfInstance that was added to the VNFC. It shall be provided if at least one storage resource was added to the VNFC.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
},
"removedStorageResourceIds": {
"description": "References to VirtualStorage resources that have been removed. The value contains the identifier of a VirtualStorageResourceInfo item that has been removed from the VNFC, and might no longer exist in the VnfInstance. It shall be provided if at least one storage resource was removed from the VNFC.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
}
},
"affectedVirtualLinks": {
"description": "Information about VL instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary VLs.\n",
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"changeType",
"networkResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY * LINK_PORT_ADDED * LINK_PORT_REMOVED For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY",
"LINK_PORT_ADDED",
"LINK_PORT_REMOVED"
]
},
"networkResource": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"affectedVirtualStorages": {
"description": "Information about virtualised storage instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary virtual storage resources.\n",
"type": "object",
"required": [
"id",
"virtualStorageDescId",
"changeType",
"storageResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"virtualStorageDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVirtualStorage structure exists as long as the temporary resource exists.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY"
]
},
"storageResource": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
}
}
},
"changedInfo": {
"description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"VnfInfoModificationRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly e.g. when modifying the referenced VNF package.\n",
"type": "object",
"properties": {
"vnfInstanceName": {
"description": "If present, this attribute signals modifications of the \"vnfInstanceName\" attribute in \"VnfInstance\".\n",
"type": "string"
},
"vnfInstanceDescription": {
"description": "If present, this attribute signals modifications of the \"vnfInstanceDescription\" attribute in \"VnfInstance\".\n",
"type": "string"
},
"vnfConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"extensions": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "If present, this attribute signals modifications of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId” attribute.\n",
"type": "string"
},
"vnfProductName": {
"description": "If present, this attribute signals modifications of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId” attribute.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
}
}
},
"changedExtConnectivity": {
"description": "Information about changed external connectivity, if applicable. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"extLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"vimConnectionId",
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
}
}
}
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self",
"vnfInstance"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"vnfInstance": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"grant": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"cancel": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"retry": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"rollback": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"fail": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
}
"items":
{
"description": "This type represents a VNF lifecycle management operation occurrence. Shall be set to the value of the \"id\" attribute in the \"Grant\" representing the associated \"Individual Grant\", if such grant exists.\n",
"type": "object",
"oneOf": [{
"required": [
"changedInfo"
]
},
{
"required": [
"modificationsTriggeredByVnfPkgChange"
]
}
],
"required": [
"id",
"operationState",
"stateEnteredTime",
"startTime",
"vnfInstanceId",
"operation",
"isAutomaticInvocation",
"isCancelPending"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"operationState": {
"description": "STARTING: The LCM operation is starting. PROCESSING: The LCM operation is currently in execution. COMPLETED: The LCM operation has been completed successfully. FAILED_TEMP: The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED: The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK: The LCM operation is currently being rolled back. ROLLED_BACK: The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n",
"type": "string",
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
"FAILED_TEMP",
"FAILED",
"ROLLING_BACK",
"ROLLED_BACK"
]
},
"stateEnteredTime": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"startTime": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"vnfInstanceId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"grantId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"operation": {
"description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. CREATE_SNAPSHOT | Represents the \"Create VNF Snapshot\" LCM operation. REVERT_TO_SNAPSHOT | Represents the “Revert-To VNF Snapshot\" LCM operation. CHANGE_VNFPKG | Represents the \"Change current VNF package\" LCM operation.\n",
"type": "string",
"enum": [
"INSTANTIATE",
"SCALE",
"SCALE_TO_LEVEL",
"CHANGE_FLAVOUR",
"TERMINATE",
"HEAL",
"OPERATE",
"CHANGE_EXT_CONN",
"MODIFY_INFO",
"CREATE_SNAPSHOT",
"REVERT_TO_SNAPSHOT",
"CHANGE_VNFPKG"
]
},
"isAutomaticInvocation": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
},
"operationParams": {
"description": "Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation. The following mapping between operationType and the data type of this attribute shall apply: * INSTANTIATE: InstantiateVnfRequest * SCALE: ScaleVnfRequest * SCALE_TO_LEVEL: ScaleVnfToLevelRequest * CHANGE_FLAVOUR: ChangeVnfFlavourRequest * OPERATE: OperateVnfRequest * HEAL: HealVnfRequest * CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest * TERMINATE: TerminateVnfRequest * MODIFY_INFO: VnfInfoModifications * CREATE_SNAPSHOT: CreateVnfSnapshotRequest * REVERT_TO_SNAPSHOT: RevertToVnfSnapshotRequest * CHANGE_VNFPKG: ChangeCurrentVnfPkgRequest\n",
"type": "object"
},
"isCancelPending": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
},
"cancelMode": {
"description": "Cancellation mode. GRACEFUL: If the VNF LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state, the VNFM shall not start any new resource management operation and shall wait for the ongoing resource management operations in the underlying system, typically the VIM, to finish execution or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. If the VNF LCM operation occurrence is in \"STARTING\" state, the VNFM shall not start any resource management operation and shall wait for the granting request to finish execution or time out. After that, the VNFM shall put the operation occurrence into the ROLLED_BACK state. FORCEFUL: If the VNF LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state, the VNFM shall not start any new resource management operation, shall cancel the ongoing resource management operations in the underlying system, typically the VIM, and shall wait for the cancellation to finish or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. If the VNF LCM operation occurrence is in \"STARTING\" state, the VNFM shall not start any resource management operation and put the operation occurrence into the ROLLED_BACK state.\n",
"type": "string",
"enum": [
"GRACEFUL",
"FORCEFUL"
]
},
"error": {
"description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
"type": "string",
"format": "URI"
}
}
},
"resourceChanges": {
"description": "This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the LCM operation since its start, if applicable.\n",
"type": "object",
"properties": {
"affectedVnfcs": {
"description": "Information about VNFC instances that were affected during the lifecycle operation. This allows the API consumer to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary VNFCs.\n",
"type": "object",
"required": [
"id",
"vduId",
"changeType",
"computeResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vduId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVnfc structure exists as long as the temporary resource exists.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY"
]
},
"computeResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"affectedVnfcCpIds": {
"description": "Identifiers of CP(s) of the VNFC instance that were affected by the change. Shall be present for those affected CPs of the VNFC instance that are associated to an external CP of the VNF instance. May be present for further affected CPs of the VNFC instance.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
},
"addedStorageResourceIds": {
"description": "References to VirtualStorage resources that have been added. Each value refers to a VirtualStorageResourceInfo item in the VnfInstance that was added to the VNFC. It shall be provided if at least one storage resource was added to the VNFC.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
},
"removedStorageResourceIds": {
"description": "References to VirtualStorage resources that have been removed. The value contains the identifier of a VirtualStorageResourceInfo item that has been removed from the VNFC, and might no longer exist in the VnfInstance. It shall be provided if at least one storage resource was removed from the VNFC.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
}
},
"affectedVirtualLinks": {
"description": "Information about VL instances that were affected during the lifecycle operation. This allows the API consumer to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter. For a particular affected VL, there shall be as many \"AffectedVirtualLink\" entries as needed for signalling the different types of changes, i.e., one per virtual link and change type. For instance, in the case of signaling affected VL instances involving the addition of a particular VL instance with links ports, one \"AffectedVirtualLink\" entry signals the addition of the VL by using the \"changeType\" attribute of \"AffectedVirtualLink\" structure equal to \"ADDED\", and another \"AffectedVirtualLink\" entry signals the addition of VNF link ports of the VL by using the \"changeType\" equal to \"LINK_PORT_ADDED\".\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary VLs, and added or removed VNF link ports.\n",
"type": "object",
"required": [
"id",
"vnfVirtualLinkDescId",
"changeType",
"networkResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfVirtualLinkDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY * LINK_PORT_ADDED * LINK_PORT_REMOVED For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists. When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the \"networkResource\" attribute refers to the affected virtual link instance, not the link port instance. The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the \"vnfLinkPortIds\" attribute.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY",
"LINK_PORT_ADDED",
"LINK_PORT_REMOVED"
]
},
"networkResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"vnfLinkPortIds": {
"description": "Identifiers of the link ports of the affected VL (reference to the vnfLinkPortInfo) related to the change. Each identifier references a \"VnfLinkPortInfo\" structure. Shall be set when changeType is equal to \"LINK_PORT_ADDED\" or \"LINK_PORT_REMOVED\", and the related “VnfLinkPortInfo” structures are present (case \"added\") or have been present (case \"removed\") in the “VnfVirtualLinkResourceInfo” or \"ExtManagedVirtualLinkInfo\" structures that are represented by the \"vnfVirtualLinkResourceInfo\" or \"extManagedVirtualLinkInfo\" attribute in the \"VnfInstance\" structure. When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the \"networkResource\" attribute refers to the affected virtual link instance, not the link port instance. The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the \"vnfLinkPortIds\" attribute.\n",
"type": "array",
"items": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"affectedExtLinkPorts": {
"description": "Information about external VNF link ports that were affected during the lifecycle operation. This allows the API consumer to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"type": "array",
"items": {
"description": "This type provides information about added and deleted external link ports (link ports attached to external virtual links).\n",
"type": "object",
"required": [
"id",
"changeType",
"extCpInstanceId",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: -\tADDED -\tREMOVED\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED"
]
},
"extCpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
}
}
}
},
"affectedVirtualStorages": {
"description": "Information about virtualised storage instances that were affected during the lifecycle operation. This allows the API consumer to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary virtual storage resources.\n",
"type": "object",
"required": [
"id",
"virtualStorageDescId",
"changeType",
"storageResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"virtualStorageDescId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVirtualStorage structure exists as long as the temporary resource exists.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY"
]
},
"storageResource": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
}
}
},
"changedInfo": {
"description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"VnfInfoModificationRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly e.g. when modifying the referenced VNF package.\n",
"type": "object",
"properties": {
"vnfInstanceName": {
"description": "If present, this attribute signals modifications of the \"vnfInstanceName\" attribute in \"VnfInstance\".\n",
"type": "string"
},
"vnfInstanceDescription": {
"description": "If present, this attribute signals modifications of the \"vnfInstanceDescription\" attribute in \"VnfInstance\".\n",
"type": "string"
},
"vnfConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"extensions": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "If present, this attribute signals modifications of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId” attribute.\n",
"type": "string"
},
"vnfProductName": {
"description": "If present, this attribute signals modifications of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId” attribute.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfcInfoModifications": {
"description": "If present, this attribute signals modifications of certain entries in the \"vnfcInfo\" attribute array in the \"instantiatedVnfInfo\" attribute of \"VnfInstance\", as defined in clause 5.5.2.12\n",
"type": "array",
"items": {
"description": "This type represents modifications of an entry in an array of \"VnfcInfo\" objects. It shall comply with the provisions defined in table 5.5.3.24-1.\n",
"type": "object",
"required": [
"id",
"vnfcConfigurableProperties"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"vnfcConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
}
}
},
"changedExtConnectivity": {
"description": "Information about changed external connectivity, if applicable. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle",
"currentVnfExtCpData"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"extLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"required": [
"resourceId"
],
"type": "object",
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
"properties": {
"vimConnectionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003).\n",
"type": "string"
}
}
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
},
"currentVnfExtCpData": {
"description": "Allows the API consumer to read the current CP configuration information for the connection of external CPs to the external virtual link. This attribute reflects the current configuration information that has resulted from merging into this attribute the \"VnfExtCpData\" information which was passed as part of the \"ExtVirtualLinkData\" structure in the input of the most recent VNF LCM operation such as \"InstantiateVnfRequest\", \"ChangeExtVnfConnectivityRequest\", \"ChangeVnfFlavourRequest\" or \"ChangeCurrentVnfPkgRequest\", or has been provided by the NFVO during the granting procedure. If applying such change results in an empty list of \"currentVnfExtCpData\" structure instances, the affected instance of \"ExtVirtualLinkInfo\" shall be removed from its parent data structure.\n",
"type": "array",
"items": {
"description": "This type represents configuration information for external CPs created from a CPD.\n",
"type": "object",
"required": [
"cpdId"
],
"properties": {
"cpdId": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"cpConfig": {
"description": "Map of instance data that need to be configured on the CP instances created from the respective CPD. The key of the map which identifies the individual VnfExtCpConfig entries is managed by the API consumer. The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396). Within one VNF instance, all VNFC instances created from a particular VDU have the same external connectivity. Thus, given a particular value of the “cpdId” attribute, there shall be one “cpConfig” entry for each VNFC instance that has been or can be created from a VDU which includes a CPD identified by the “cpdId” attribute. If the cpConfig represents a subport in a trunk, all “cpConfig” entries in this list shall have the same segmentationId, which means they are connected to the same set of external VLs via the trunk. The map entry value shall be set to \"null\" in order to delete a \"VnfExtCpConfig\" entry identified by a particular key value from the map, i.e. for the disconnection of an existing external CP instance addressed by cpInstanceId in the deleted map entry from a particular external virtual link, and deletion of that instance in case it represents a subport. Deleting the last key from the map removes the affected instance of the \"VnfExtCpData\" structure from its parent data structure.\n",
"type": "object",
"additionalProperties": {
"description": "This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n",
"anyOf": [{
"required": [
"linkPortId"
]
},
{
"required": [
"cpProtocolData"
]
}
],
"type": "object",
"properties": {
"parentCpConfigId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"linkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"cpProtocolData": {
"description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": 1) Void 2) At least one of the \"linkPortId\" and \"cpProtocolData\" attributes \n shall be present for an external CP instance representing a subport \n that is to be created, or an external CP instance that is to be created \n by creating the corresponding VNFC or VNF instance during the current or \n a subsequent LCM operation, or for an existing external CP instance \n that is to be re-configured or added to a particular external virtual link.\n3) If the \"linkPortId\" attribute is absent, the VNFM shall create a\n link port.\n4) If the \"cpProtocolData\" attribute is absent, the \"linkPortId\"\n attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n5) If both \"cpProtocolData\" and \"linkportId\" are provided, the API\n consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n",
"type": "array",
"items": {
"description": "This type represents network protocol data.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "Identifier of layer(s) and protocol(s). This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents network address data for IP over Ethernet.\n",
"type": "object",
"anyOf": [{
"required": [
"macAddress"
]
},
{
"required": [
"ipAddresses"
]
}
],
"oneOf": [{
"required": [
"fixedAddresses"
]
},
{
"required": [
"numDynamicAddresses"
]
},
{
"required": [
"ipAddressRange"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"fixedAddresses": {
"description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"numDynamicAddresses": {
"description": "Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "integer"
},
"addressRange": {
"description": "An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"modificationsTriggeredByVnfPkgChange": {
"description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource when changing the current VNF package. The attributes that can be included consist of those requested to be modified explicitly in the \"ChangeCurrentVnfPkgRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly during the operation.\n",
"type": "object",
"properties": {
"vnfConfigurableProperties": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"metadata": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"extensions": {
"description": "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 keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "If present, this attribute signals the new value of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfdId\" attribute) was modified implicitly during the related operation, and contains a copy of the value of he related attribute from the VNFD in the VNF Package identified by the \"vnfdId\" attribute.\n",
"type": "string"
},
"vnfProductName": {
"description": "If present, this attribute signals the new value of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfdId\" attribute) was modified implicitly during the related operation, and contains a copy of the value of he related attribute from the VNFD in the VNF Package identified by the \"vnfdId\" attribute.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
}
}
},
"vnfSnapshotInfoId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": [
"self",
"vnfInstance"
],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"vnfInstance": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"grant": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"cancel": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"retry": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"rollback": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"fail": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"vnfSnapshot": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
}
}
\ No newline at end of file
SOL002/VNFPerformanceManagement-API/ApiVersion.robot
View file @ 29614667
......@@ -11,7 +11,7 @@ POST API Version - Method not implemented
... Test title: POST API version - Method not implemented
... Test objective: The objective is to test that POST method is not implemented
... Pre-conditions: none
... Reference: Clause 9.3.3.3.1 - ETSI GS NFV-SOL 013 v2.7.1
... Reference: Clause 9.3.3.3.1 - ETSI GS NFV-SOL 013 v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -23,7 +23,7 @@ GET API Version
... Test title: GET API Version
... Test objective: The objective is to test that GET method successfully return ApiVersionInformation
... Pre-conditions: none
... Reference: Clause 9.3.3.3.2 - ETSI GS NFV-SOL 013 v2.7.1
... Reference: Clause 9.3.3.3.2 - ETSI GS NFV-SOL 013 v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -36,7 +36,7 @@ PUT API Version - Method not implemented
... Test title: PUT API Version - Method not implemented
... Test objective: The objective is to test that PUT method is not implemented
... Pre-conditions: none
... Reference: Clause 9.3.3.3.3 - ETSI GS NFV-SOL 013 v2.7.1
... Reference: Clause 9.3.3.3.3 - ETSI GS NFV-SOL 013 v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -48,7 +48,7 @@ PATCH API Version - Method not implemented
... Test title: PATCH API Version - Method not implemented
... Test objective: The objective is to test that PATCH method is not implemented
... Pre-conditions: none
... Reference: Clause 9.3.3.3.4 - ETSI GS NFV-SOL 013 v2.7.1
... Reference: Clause 9.3.3.3.4 - ETSI GS NFV-SOL 013 v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -60,7 +60,7 @@ DELETE API Version - Method not implemented
... Test title: DELETE API Version - Method not implemented
... Test objective: The objective is to test that DELETE method is not implemented
... Pre-conditions: none
... Reference: Clause 9.3.3.3.5 - ETSI GS NFV-SOL 013 v2.7.1
... Reference: Clause 9.3.3.3.5 - ETSI GS NFV-SOL 013 v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -72,7 +72,7 @@ POST API Version with apiMajorVerion - Method not implemented
... Test title: POST API version with apiMajorVerion - Method not implemented
... Test objective: The objective is to test that POST method is not implemented
... Pre-conditions: none
... Reference: Clause 9.3.3.3.1 - ETSI GS NFV-SOL 013 v2.7.1
... Reference: Clause 9.3.3.3.1 - ETSI GS NFV-SOL 013 v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -84,7 +84,7 @@ GET API Version with apiMajorVerion
... Test title: GET API Version with apiMajorVerion
... Test objective: The objective is to test that GET method successfully return ApiVersionInformation
... Pre-conditions: none
... Reference: Clause 9.3.3.3.2 - ETSI GS NFV-SOL 013 v2.7.1
... Reference: Clause 9.3.3.3.2 - ETSI GS NFV-SOL 013 v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -97,7 +97,7 @@ PUT API Version with apiMajorVerion - Method not implemented
... Test title: PUT API Version with apiMajorVerion - Method not implemented
... Test objective: The objective is to test that PUT method is not implemented
... Pre-conditions: none
... Reference: Clause 9.3.3.3.3 - ETSI GS NFV-SOL 013 v2.7.1
... Reference: Clause 9.3.3.3.3 - ETSI GS NFV-SOL 013 v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -109,7 +109,7 @@ PATCH API Version with apiMajorVerion - Method not implemented
... Test title: PATCH API Version with apiMajorVerion - Method not implemented
... Test objective: The objective is to test that PATCH method is not implemented
... Pre-conditions: none
... Reference: Clause 9.3.3.3.4 - ETSI GS NFV-SOL 013 v2.7.1
... Reference: Clause 9.3.3.3.4 - ETSI GS NFV-SOL 013 v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -121,7 +121,7 @@ DELETE API Version with apiMajorVerion - Method not implemented
... Test title: DELETE API Version with apiMajorVerion - Method not implemented
... Test objective: The objective is to test that DELETE method is not implemented
... Pre-conditions: none
... Reference: Clause 9.3.3.3.5 - ETSI GS NFV-SOL 013 v2.7.1
... Reference: Clause 9.3.3.3.5 - ETSI GS NFV-SOL 013 v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......
SOL002/VNFPerformanceManagement-API/IndividualPmJob.robot
View file @ 29614667
......@@ -5,6 +5,7 @@ Library JSONLibrary
Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT} ssl_verify=false
Library OperatingSystem
Library DependencyLibrary
Library String
*** Test Cases ***
GET individual VNF Performance Job
......@@ -12,7 +13,7 @@ GET individual VNF Performance Job
... Test title: Get individual VNF Performance Job
... Test objective: The objective is to test the retrieval of an individual VNF performance monitoring job and perform a JSON schema and content validation of the collected job data structure
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNFM.
... Reference: Clause 6.4.3.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.3.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -26,7 +27,7 @@ GET individual VNF Performance Job with invalid resource identifier
... Test title: Get individual VNF Performance Job with invalid resource identifier
... Test objective: The objective is to test that the retrieval of an individual VNF performance monitoring job fails when using an invalid resource identifier, and perform the JSON schema validation of the failed operation HTTP response
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNFM.
... Reference: Clause 6.4.3.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.3.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -39,7 +40,7 @@ DELETE Individual VNF Performance Job
... Test title: Delete Individual VNF Performance Job
... Test objective: The objective is to test the deletion of an individual VNF performance monitoring job
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNFM.
... Reference: Clause 6.4.3.3.5 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.3.3.5 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: The VNF Performance Job is no more available in the VNFM
......@@ -52,7 +53,7 @@ DELETE Individual VNF Performance Job with invalid resource identifier
... Test title: Delete individual VNF Performance Job with invalid resource identifier
... Test objective: The objective is to test that the deletion of an individual VNF performance monitoring job fails when using an invalid resource identifier, and perform the JSON schema validation of the failed operation HTTP response
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNFM.
... Reference: Clause 6.4.3.3.5 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.3.3.5 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -65,7 +66,7 @@ POST Individual VNF Performance Job - Method not implemented
... Test title: POST Individual VNF Performance Job - method not implemented
... Test objective: The objective is to test that POST method is not allowed to create a new VNF Performance Monitoring Job
... Pre-conditions: none
... Reference: Clause 6.4.3.3.1 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.3.3.1 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -77,7 +78,7 @@ PUT Individual VNF Performance Job - Method not implemented
... Test title: PUT Individual VNF Performance Job - method not implemented
... Test objective: The objective is to test that PUT method is not allowed to update an existing VNF Performance Monitoring Job
... Pre-conditions: none
... Reference: Clause 6.4.3.3.3 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.3.3.3 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -89,7 +90,7 @@ PATCH Individual VNF Performance Job
... Test title: PATCH Individual VNF Performance Job
... Test objective: The objective is to test that PATCH method allows to modify an exsisting individual PM job resource.
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNFM.
... Reference: Clause 6.4.3.3.4 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.3.3.4 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -102,7 +103,7 @@ PATCH Individual VNF Performance Job - Precondition failed
... Test title: PATCH Individual VNF Performance Job - Precondition failed
... Test objective: The objective is to attempt to Modify an individual alarm resource, where the precondition was not met
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNFM.
... Reference: Clause 6.4.3.3.4 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.3.3.4 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: The VNF Performance Job is not modified by the operation
......@@ -111,6 +112,19 @@ PATCH Individual VNF Performance Job - Precondition failed
Check HTTP Response Body Json Schema Is ProblemDetails
Check Postcondition VNF Performance Job is Unmodified (Implicit)
PATCH Individual VNF Performance Job - UNPROCESSIBLE ENTITY
[Documentation] Test ID: 6.3.3.2.9
... Test title: PATCH Individual VNF Performance Job - UNPROCESSIBLE ENTITY
... Test objective: The objective is to test that PATCH method cannot modify an exsisting individual PM job resource when the callback URI provided in the Request body is unreachable by the VNFM.
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNFM.
... Reference: Clause 6.4.3.3.4 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: The VNFM cannot reach the Notification endpoint.
... Post-Conditions: none
Send Patch request for individual VNF Performance Job with Unreachable Callback URI
Check HTTP Response Status Code Is 422
Check HTTP Response Body Json Schema Is ProblemDetails
*** Keywords ***
GET individual VNF Performance Job
Log Trying to get a Pm Job present in the NFVO Catalogue
......@@ -165,9 +179,20 @@ Send Put request for individual VNF Performance Job
Send Patch request for individual VNF Performance Job
Set Headers {"Accept":"${ACCEPT_JSON}"}
Set Headers {"Content-Type": "${CONTENT_TYPE_JSON}"}
Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"}
Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"}
${template}= Get File jsons/PMJobModification.json
${body}= Format String ${template} callback_uri=${new_callback_uri}:${callback_port}
PATCH ${apiRoot}/${apiName}/${apiMajorVersion}/pm_jobs/${pmJobId} ${body}
${output}= Output response
Set Suite Variable ${response} ${output}
Send Patch request for individual VNF Performance Job with Unreachable Callback URI
Set Headers {"Accept":"${ACCEPT_JSON}"}
Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"}
Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"}
${body}= Get File jsons/PMJobModification.json
${template}= Get File jsons/PMJobModification.json
${body}= Format String ${template} callback_uri=${unreachable_callback_uri}
PATCH ${apiRoot}/${apiName}/${apiMajorVersion}/pm_jobs/${pmJobId} ${body}
${output}= Output response
Set Suite Variable ${response} ${output}
......
SOL002/VNFPerformanceManagement-API/IndividualReport.robot
View file @ 29614667
......@@ -10,7 +10,7 @@ Get Individual Performance Report
... Test title: Get Individual Performance Report
... Test objective: The objective is to test the retrieval of an individual VNF performance report associated to a monitoring job and perform a JSON schema validation of the collected report data structure
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance reports are set for a monitoring job in the VNFM.
... Reference: Clause 6.4.4.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.4.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -23,7 +23,7 @@ Get Individual Performance Report with invalid resource endpoint
... Test title: Get Individual Performance Report with invalid resource endpoint
... Test objective: The objective is to test that the retrieval of an individual VNF performance report associated to a monitoring job fails when using an invalid resource endpoint
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance reports are set for a monitoring job in the VNFM.
... Reference: Clause 6.4.4.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.4.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -36,7 +36,7 @@ POST Individual Performance Report - Method not implemented
... Test title: POST Individual Performance Report - Method not implemented
... Test objective: The objective is to test that POST method is not allowed to create a new VNF performance report within a monitoring job
... Pre-conditions: none
... Reference: Clause 6.4.4.3.1 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.4.3.1 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -48,7 +48,7 @@ PUT Individual Performance Report - Method not implemented
... Test title: PUT Individual Performance Report - Method not implemented
... Test objective: The objective is to test that PUT method is not allowed to update an existing VNF performance report within a monitoring job
... Pre-conditions: none
... Reference: Clause 6.4.4.3.3 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.4.3.3 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -60,7 +60,7 @@ PATCH Individual Performance Report - Method not implemented
... Test title: PATCH Individual Performance Report - Method not implemented
... Test objective: The objective is to test that PATCH method is not allowed to modify an existing VNF performance report within a monitoring job
... Pre-conditions: none
... Reference: Clause 6.4.4.3.4 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.4.3.4 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -72,7 +72,7 @@ DELETE Individual Performance Report - Method not implemented
... Test title: DELETE Individual Performance Report - Method not implemented
... Test objective: The objective is to test that DELETE method is not allowed to delete an existing VNF performance report within a monitoring job
... Pre-conditions: none
... Reference: Clause 6.4.4.3.5 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.4.3.5 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......
SOL002/VNFPerformanceManagement-API/IndividualThreshold.robot
View file @ 29614667
......@@ -4,6 +4,7 @@ Resource environment/variables.txt # Generic Parameters
Library JSONLibrary
Library REST ${VNFM_SCHEMA}://${VNFM_HOST}:${VNFM_PORT} ssl_verify=false
Library OperatingSystem
Library String
*** Test Cases ***
GET Individual Threshold
......@@ -11,7 +12,7 @@ GET Individual Threshold
... Test title: GET Individual Threshold
... Test objective: The objective is to test the retrieval of an individual VNF performance threshold and perform a JSON schema and content validation of the collected threshold data structure
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance thresholds are set in the VNFM.
... Reference: Clause 6.4.6.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.6.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -25,7 +26,7 @@ GET Individual Threshold with invalid resource identifier
... Test title: GET Individual Threshold with invalid resource identifier
... Test objective: The objective is to test that the retrieval of an individual VNF performance threshold fails when using an invalid resource identifier
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNFM.
... Reference: Clause 6.4.6.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.6.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -38,7 +39,7 @@ DELETE Individual Threshold
... Test title: DELETE Individual Threshold
... Test objective: The objective is to test the deletion of an individual VNF performance threshold
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance thresholds are set in the VNFM.
... Reference: Clause 6.4.6.3.5 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.6.3.5 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: The VNF Performance Threshold is not available anymore in the VNFM
......@@ -51,7 +52,7 @@ DELETE Individual Threshold with invalid resource identifier
... Test title: DELETE Individual Threshold with invalid resource identifier
... Test objective: The objective is to test the deletion of an individual VNF performance threshold
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance thresholds are set in the VNFM.
... Reference: Clause 6.4.6.3.5 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.6.3.5 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -64,7 +65,7 @@ POST Individual Threshold - Method not implemented
... Test title: POST Individual Threshold - Method not implemented
... Test objective: The objective is to test that POST method is not allowed to create a new VNF Performance Threshold
... Pre-conditions: none
... Reference: Clause 6.4.6.3.1 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.6.3.1 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: The VNF Performance Threshold is not created on the VNFM
......@@ -76,7 +77,7 @@ PUT Individual Threshold - Method not implemented
... Test title: PUT Individual Threshold - Method not implemented
... Test objective: The objective is to test that PUT method is not allowed to update an existing VNF Performance threshold
... Pre-conditions: none
... Reference: Clause 6.4.6.3.3 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.6.3.3 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -88,7 +89,7 @@ PATCH Individual Threshold
... Test title: PATCH Individual Threshold
... Test objective: The objective is to test that PATCH method allows to modify an Individual threshold resource.
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance thresholds are set in the VNFM.
... Reference: Clause 6.4.6.3.4 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.6.3.4 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: The VNF Performance Threshold is not modified by the operation
......@@ -101,7 +102,7 @@ PATCH Individual Threshold - Precondition failed
... Test title: PATCH Individual Threshold - Preconition failed
... Test objective: The objective is to attempt to modify an individual threshold resource, where the precondition was not met.
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNFM.
... Reference: Clause 6.4.6.3.4 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.6.3.4 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: The VNF Performance Job is not modified by the operation
......@@ -109,6 +110,20 @@ PATCH Individual Threshold - Precondition failed
Check HTTP Response Status Code Is 412
Check HTTP Response Body Json Schema Is ProblemDetails
Check Postcondition VNF Performance Threshold is Unmodified (Implicit)
PATCH Individual Threshold - Unprocessible Entity
[Documentation] Test ID: 6.3.3.5.9
... Test title: PATCH Individual Threshold - Unprocessible Entity
... Test objective: The objective is to test that PATCH method cannot modify an exsisting individual PM job resource when the callback URI provided in the Request body is unreachable by the VNFM.
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance thresholds are set in the VNFM.
... Reference: Clause 6.4.6.3.4 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: The VNFM cannot reach the Notification endpoint.
... Post-Conditions: The VNF Performance Threshold is not modified by the operation
Send Patch request for individual VNF Performance Threshold with Unreachable Callback URI
Check HTTP Response Status Code Is 422
Check HTTP Response Body Json Schema Is ProblemDetails
Check Postcondition VNF Performance Threshold is Unmodified (Implicit)
*** Keywords ***
GET Individual VNF Performance Threshold
......@@ -142,31 +157,43 @@ Send Delete request for individual VNF Performance Threshold with invalid resour
Set Suite Variable ${response} ${output}
Send Post request for individual VNF Performance Threshold
Log Trying to create new threshold
Log Trying to perform a POST. This method should not be supported.
Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"}
POST ${apiRoot}/${apiName}/${apiMajorVersion}/thresholds/${newThresholdId}
${output}= Output response
Set Suite Variable ${response} ${output}
Send Put request for individual VNF Performance Threshold
Log Trying to PUT threshold
Log Trying to perform a PUT. This method should not be supported.
Set Headers {"Accept": "${ACCEPT_JSON}"}
Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"}
PUT ${apiRoot}/${apiName}/${apiMajorVersion}/thresholds/${thresholdId}
${output}= Output response
Set Suite Variable ${response} ${output}
Send Patch request for individual VNF Performance Threshold
Set Headers {"Accept":"${ACCEPT_JSON}"}
Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"}
Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"}
GET ${apiRoot}/${apiName}/${apiMajorVersion}/thresholds/${thresholdId}
${origOutput}= Output response
Set Suite Variable ${origResponse} ${origOutput}
PUT ${apiRoot}/${apiName}/${apiMajorVersion}/thresholds/${thresholdId}
${template}= Get File jsons/ThresholdModification.json
${body}= Format String ${template} callback_uri=${new_callback_uri}:${callback_port}
PATCH ${apiRoot}/${apiName}/${apiMajorVersion}/thresholds/${thresholdId} ${body}
${output}= Output response
Set Suite Variable ${response} ${output}
Send Patch request for individual VNF Performance Threshold
Log Trying to PUT threshold
Set Headers {"Accept": "${ACCEPT_JSON}"}
Send Patch request for individual VNF Performance Threshold with Unreachable Callback URI
Set Headers {"Accept":"${ACCEPT_JSON}"}
Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"}
Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"}
GET ${apiRoot}/${apiName}/${apiMajorVersion}/thresholds/${thresholdId}
${origOutput}= Output response
Set Suite Variable ${origResponse} ${origOutput}
PATCH ${apiRoot}/${apiName}/${apiMajorVersion}/thresholds/${thresholdId}
${template}= Get File jsons/ThresholdModification.json
${body}= Format String ${template} callback_uri=${unreachable_callback_uri}
PATCH ${apiRoot}/${apiName}/${apiMajorVersion}/thresholds/${thresholdId} ${body}
${output}= Output response
Set Suite Variable ${response} ${output}
......
SOL002/VNFPerformanceManagement-API/NotificationConsumer.robot
View file @ 29614667
......@@ -13,7 +13,7 @@ VNF Performance Information Availability Notification
... Test title: VNF Performance Information Availability Notification
... Test objective: The objective is to test that VNF Performance Information Availability Notification is delivered with success to the notification consumer
... Pre-conditions: A VNF performance job is created, and a subscription for information availability notifications is available in the VNFM.
... Reference: Clause 6.4.9.3.1 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.9.3.1 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_Notif_Endpoint
... Applicability: none
... Post-Conditions: none
......@@ -25,7 +25,7 @@ VNF Threshold Crossed Notification
... Test title: VNF Threshold Crossed Notification
... Test objective: The objective is to test that VNF Threshold Crossed Notification is delivered with success to the notification consumer
... Pre-conditions: A VNF performance job is created, and a subscription for Threshold Crossed Notification is available in the VNFM.
... Reference: Clause 6.4.9.3.1 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.9.3.1 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_Notif_Endpoint
... Applicability: none
... Post-Conditions: none
......
SOL002/VNFPerformanceManagement-API/PMJobs.robot
View file @ 29614667
......@@ -12,7 +12,7 @@ GET all VNF Performance Monitoring Jobs
... Test title: GET all VNF Performance Monitoring Jobs
... Test objective: The objective is to test the retrieval of all the available VNF performance monitoring jobs and perform a JSON schema and content validation of the collected jobs data structure
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNF.
... Reference: Clause 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -25,7 +25,7 @@ GET VNF Performance Monitoring Jobs with attribute-based filter
... Test title: GET all VNF Performance Monitoring Jobs with attribute-based filter
... Test objective: The objective is to test the retrieval of VNF performance monitoring jobs using attribute-based filter, perform a JSON schema validation of the collected jobs data structure, and verify that the retrieved information matches the issued attribute-based filter
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNF.
... Reference: Clause 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -39,7 +39,7 @@ GET all VNF Performance Monitoring Jobs with all_fields attribute selector
... Test title: GET all VNF Performance Monitoring Jobs with all_fields attribute selector
... Test objective: The objective is to test the retrieval of all VNF performance monitoring jobs all_fields attribute selector, perform a JSON schema validation of the collected jobs data structure, and verify that the retrieved information matches the issued all_fileds selector
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNF.
... Reference: Clause 4.3.3.2.1, 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 4.3.3.2.1, 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -53,7 +53,7 @@ GET all VNF Performance Monitoring Jobs with exclude_default attribute selector
... Test title: GET all VNF Performance Monitoring Jobs with exclude_default attribute selector
... Test objective: The objective is to test the retrieval of all VNF performance monitoring jobs exclude_default attribute selector, perform a JSON schema validation of the collected jobs data structure, and verify that the retrieved information matches the issued exclude_default selector
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNF.
... Reference: Clause 4.3.3.2.1, 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 4.3.3.2.1, 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -67,7 +67,7 @@ GET all VNF Performance Monitoring Jobs with fields attribute selector
... Test title: GET all VNF Performance Monitoring Jobs with fields attribute selector
... Test objective: The objective is to test the retrieval of all VNF performance monitoring jobs fields attribute selector, perform a JSON schema validation of the collected jobs data structure, and verify that the retrieved information matches the issued fields selector
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNF.
... Reference: Clause 4.3.3.2.1, 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 4.3.3.2.1, 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: The VNFM supports the use of exclude_fields attribute selector
... Post-Conditions: none
......@@ -81,7 +81,7 @@ GET all VNF Performance Monitoring Jobs with exclude_fields attribute selector
... Test title: GET all VNF Performance Monitoring Jobs with exclude_fields attribute selector
... Test objective: The objective is to test the retrieval of all VNF performance monitoring jobs exclude_fields attribute selector, perform a JSON schema validation of the collected jobs data structure, and verify that the retrieved information matches the issued exclude_fields selector
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNF.
... Reference: Clause 4.3.3.2.1, 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 4.3.3.2.1, 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: The VNFM supports the use of exclude_fields attribute selector
... Post-Conditions: none
......@@ -95,7 +95,7 @@ GET VNF Performance Monitoring Jobs with invalid attribute-based filter
... Test title: GET VNF Performance Monitoring Jobs with invalid attribute-based filter
... Test objective: The objective is to test that the retrieval of VNF performance monitoring jobs fails when using invalid attribute-based filter, and perform the JSON schema validation of the failed operation HTTP response
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNF.
... Reference: Clause 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -108,7 +108,7 @@ GET VNF Performance Monitoring Jobs with invalid resource endpoint
... Test title: GET VNF Performance Monitoring Jobs with invalid resource endpoint
... Test objective: The objective is to test that the retrieval of VNF performance monitoring jobs fails when using invalid resource endpoint, and perform the JSON schema validation of the failed operation HTTP response
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNF.
... Reference: Clause 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -116,12 +116,12 @@ GET VNF Performance Monitoring Jobs with invalid resource endpoint
Check HTTP Response Status Code Is 400
Check HTTP Response Body Json Schema Is ProblemDetails
Create new VNF Performance Monitoring Job
POST Create new VNF Performance Monitoring Job - SUCCESSFUL
[Documentation] Test ID: 6.3.3.1.9
... Test title: Create a new VNF Performance Monitoring Job
... Test objective: The objective is to test the creation of a new VNF performance monitoring job and perform the JSON schema validation of the returned job data structure
... Test title: POST Create a new VNF Performance Monitoring Job - SUCCESSFUL
... Test objective: The objective is to test that the POST method creates a new VNF performance monitoring job and perform the JSON schema validation of the returned job data structure
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNF.
... Reference: Clause 6.4.2.3.1 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.2.3.1 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: The VNF Performance Job is successfully created on the VNFM
......@@ -135,7 +135,7 @@ PUT all VNF Performance Monitoring Jobs - Method not implemented
... Test title: PUT all VNF Performance Monitoring Jobs - Method not implemented
... Test objective: The objective is to test that PUT method is not allowed to modify VNF Performance Monitoring Jobs
... Pre-conditions: none
... Reference: Clause 6.4.2.3.3 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.2.3.3 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VE
... Applicability: none
... Post-Conditions: none
......@@ -147,7 +147,7 @@ PATCH all VNF Performance Monitoring Jobs - Method not implemented
... Test title: PATCH all VNF Performance Monitoring Jobs - Method not implemented
... Test objective: The objective is to test that PATCH method is not allowed to update VNF Performance Monitoring Jobs
... Pre-conditions: none
... Reference: Clause 6.4.2.3.3 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.2.3.3 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VE
... Applicability: none
... Post-Conditions: none
......@@ -159,7 +159,7 @@ DELETE all VNF Performance Monitoring Jobs - Method not implemented
... Test title: DELETE all VNF Performance Monitoring Jobs - Method not implemented
... Test objective: The objective is to test that DELETE method is not allowed to update VNF Performance Monitoring Jobs
... Pre-conditions: none
... Reference: Clause 6.4.2.3.3 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.2.3.3 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VE
... Applicability: none
... Post-Conditions: none
......@@ -171,7 +171,7 @@ GET VNF Performance Monitoring Jobs to get Paged Response
... Test title: GET VNF Performance Monitoring Jobs to get Paged Response
... Test objective: The objective is to test the retrieval of VNF performance monitoring jobs to get Paged response.
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNF.
... Reference: Clause 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -184,7 +184,7 @@ GET VNF Performance Monitoring Jobs for Bad Request Response too big
... Test title: GET VNF Performance Monitoring Jobs for Bad Request Response too big
... Test objective: The objective is to test that GET method fail retrieving status information about VNF Performance Monitoring when Response is too big, and perform the JSON schema validation of the failed operation HTTP response
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNF.
... Reference: Clause 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -197,13 +197,27 @@ GET all VNF Performance Monitoring Jobs with exclude_default and fields attribut
... Test title: GET all VNF Performance Monitoring Jobs with exclude_default and fields attribute selector
... Test objective: The objective is to test the retrieval of all VNF performance monitoring jobs with exclude_default and fields attribute selector, perform a JSON schema validation of the collected jobs data structure, and verify that the retrieved information matches the issued exclude_default selector
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNF.
... Reference: Clause 4.3.3.2.1, 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 4.3.3.2.1, 6.4.2.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
GET VNF Performance Monitoring Jobs with exclude_default and fields attribute selector
Check HTTP Response Status Code Is 200
Check HTTP Response Body Json Schema Is PmJobs
POST Create new VNF Performance Monitoring Job - UNPROCESSIBLE ENTITY
[Documentation] Test ID: 6.3.3.1.16
... Test title: POST Create a new VNF Performance Monitoring Job - UNPROCESSIBLE ENTITY
... Test objective: The objective is to test that the POST method cannot create a new VNF performance monitoring job when the callback URI provided in the Request body is unreachable by the VNFM.
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance jobs are set in the VNF.
... Reference: Clause 6.4.2.3.1 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: The VNFM cannot reach the Notification endpoint.
... Post-Conditions: none
Send Post Request Create new VNF Performance Monitoring Job with Unreachable Callback URI
Check HTTP Response Status Code Is 422
Check HTTP Response Body Json Schema Is ProblemDetails
*** Keywords ***
GET all VNF Performance Monitoring Jobs
Log Trying to get all PM Jobs present in the VNFM
......@@ -290,6 +304,17 @@ Send Post Request Create new VNF Performance Monitoring Job
${output}= Output response
Set Suite Variable ${response} ${output}
Send Post Request Create new VNF Performance Monitoring Job with Unreachable Callback URI
Log Creating a new PM Job
Set Headers {"Accept": "${ACCEPT_JSON}"}
Set Headers {"Content-Type": "${CONTENT_TYPE_JSON}"}
Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"}
${template}= Get File jsons/CreatePmJobRequest.json
${body}= Format String ${template} objectInstanceIds=${objectInstanceIds} callback_uri=${unreachable_callback_uri}:${callback_port}
POST ${apiRoot}/${apiName}/${apiMajorVersion}/pm_jobs ${body}
${output}= Output response
Set Suite Variable ${response} ${output}
Send PUT Request for all VNF Performance Monitoring Jobs
Log Trying to perform a PUT. This method should not be implemented
Set Headers {"Accept": "${ACCEPT_JSON}"}
......
SOL002/VNFPerformanceManagement-API/Thresholds.robot
View file @ 29614667
......@@ -12,7 +12,7 @@ GET All Performance Thresholds
... Test title: GET All Performance Thresholds
... Test objective: The objective is to test the retrieval of all the available VNF performance thresholds and perform a JSON schema validation of the collected thresholds data structure
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance thresholds are set in the VNFM.
... Reference: Clause 6.4.5.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.5.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -25,7 +25,7 @@ GET Performance Thresholds with attribute-based filter
... Test title: GET Performance Thresholds with attribute-based filter
... Test objective: The objective is to test the retrieval of all the available VNF performance thresholds when using attribute-based filters, perform a JSON schema validation of the collected thresholds data structure, and verify that the retrieved information matches the issued attribute-based filter
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance thresholds are set in the VNFM.
... Reference: Clause 6.4.5.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.5.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -39,7 +39,7 @@ GET Performance Thresholds with invalid attribute-based filter
... Test title: GET Performance Thresholds with invalid attribute-based filter
... Test objective: The objective is to test that the retrieval of VNF performance thresholds fails when using invalid attribute-based filter, and perform the JSON schema validation of the failed operation HTTP response
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance thresholds are set in the VNFM.
... Reference: Clause 6.4.5.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.5.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -52,7 +52,7 @@ GET Performance Thresholds with invalid resource endpoint
... Test title: GET Performance Thresholds with invalid resource endpoint
... Test objective: The objective is to test that the retrieval of VNF performance thresholds fails when using invalid resource endpoint, and perform the JSON schema validation of the failed operation HTTP response
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance thresholds are set in the VNFM.
... Reference: Clause 6.4.5.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.5.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -60,12 +60,12 @@ GET Performance Thresholds with invalid resource endpoint
Check HTTP Response Status Code Is 400
Check HTTP Response Body Json Schema Is ProblemDetails
Create new Performance Threshold
POST Create new Performance Threshold
[Documentation] Test ID: 6.3.3.4.5
... Test title: Create new Performance Threshold
... Test objective: The objective is to test the creation of a new VNF performance threshold and perform the JSON schema validation of the returned threshold data structure
... Test title: POST Create new Performance Threshold
... Test objective: The objective is to test that the POST method creates a new VNF performance threshold and perform the JSON schema validation of the returned threshold data structure
... Pre-conditions: A VNF instance is instantiated.
... Reference: Clause 6.4.5.3.1 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.5.3.1 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: The VNF Performance Threshold is successfully created on the VNFM
......@@ -80,7 +80,7 @@ PUT Performance Thresholds - Method not implemented
... Test title: PUT Performance Thresholds - Method not implemented
... Test objective: The objective is to test that PUT method is not allowed to modify VNF Performance Thresholds
... Pre-conditions: none
... Reference: Clause 6.4.5.3.3 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.5.3.3 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -92,7 +92,7 @@ PATCH Performance Thresholds - Method not implemented
... Test title: PATCH Performance Thresholds - Method not implemented
... Test objective: The objective is to test that PATCH method is not allowed to modify VNF Performance Thresholds
... Pre-conditions: none
... Reference: Clause 6.4.5.3.4 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.5.3.4 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -104,7 +104,7 @@ DELETE Performance Thresholds - Method not implemented
... Test title: DELETE Performance Thresholds - Method not implemented
... Test objective: The objective is to test that DELETE method is not allowed to update VNF Performance Thresholds
... Pre-conditions: none
... Reference: Clause 6.4.5.3.5 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.5.3.5 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -116,7 +116,7 @@ GET Performance Thresholds with Paged Response
... Test title: GET Performance Thresholds with Paged Response
... Test objective: The objective is to test the retrieval of all the available VNF performance thresholds with Paged response
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance thresholds are set in the VNFM.
... Reference: Clause 6.4.5.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.5.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -129,7 +129,7 @@ GET Performance Thresholds for Bad Request Response too big
... Test title: GET Performance Thresholds for Bad Request Response too big
... Test objective: The objective is to test that the retrieval of VNF performance thresholds fails when response is too big, and perform the JSON schema validation of the failed operation HTTP response
... Pre-conditions: A VNF instance is instantiated. One or more VNF performance thresholds are set in the VNFM.
... Reference: Clause 6.4.5.3.2 - ETSI GS NFV-SOL 002 [2] v2.7.1
... Reference: Clause 6.4.5.3.2 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: none
... Post-Conditions: none
......@@ -137,6 +137,20 @@ GET Performance Thresholds for Bad Request Response too big
Check HTTP Response Status Code Is 400
Check HTTP Response Body Json Schema Is ProblemDetails
POST Create new Performance Threshold - UNPROCESSIBLE ENTITY
[Documentation] Test ID: 6.3.3.4.11
... Test title: POST Create new Performance Threshold
... Test objective: The objective is to test that the POST method does not create a new VNF performance threshold when the callback URI provided in the Request body is unreachable by the VNFM.
... Pre-conditions: A VNF instance is instantiated.
... Reference: Clause 6.4.5.3.1 - ETSI GS NFV-SOL 002 [2] v3.3.1
... Config ID: Config_prod_VNFM
... Applicability: The VNFM cannot reach the Notification endpoint.
... Post-Conditions: none
Send Post Request Create new Performance Threshold with Unreachable Callback URI
Check HTTP Response Status Code Is 422
Check HTTP Response Body Json Schema Is ProblemDetails
*** Keywords ***
GET all Performance Thresholds
Log Trying to get all thresholds present in the VNFM
......@@ -181,6 +195,17 @@ Send Post Request Create new Performance Threshold
${output}= Output response
Set Suite Variable ${response} ${output}
Send Post Request Create new Performance Threshold with Unreachable Callback URI
Log Creating a new THreshold
Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"}
Set Headers {"Accept": "${ACCEPT_JSON}"}
Set Headers {"Content-Type": "${CONTENT_TYPE_JSON}"}
${template}= Get File jsons/CreateThresholdRequest.json
${body}= Format String ${template} objectInstanceIds=${objectInstanceIds} callback_uri=${unreachable_callback_uri}:${callback_port}
POST ${apiRoot}/${apiName}/${apiMajorVersion}/thresholds ${body}
${output}= Output response
Set Suite Variable ${response} ${output}
Send PUT Request for all Performance Thresholds
Log PUT THresholds
Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"}
......
SOL002/VNFPerformanceManagement-API/environment/variables.txt
View file @ 29614667
......@@ -9,6 +9,7 @@ ${apiName} vnfpm
${CONTENT_TYPE_JSON} application/json
${CONTENT_TYPE_PATCH} application/merge-patch+json
${ACCEPT_JSON} application/json
${NEG_AUTHORIZATION} Bearer negativetoken
${FIELD_USAGE} 1
......@@ -18,6 +19,8 @@ ${AUTH_USAGE} 1
${VNFM_DUPLICATION} 1
${VNFM_CHECKS_NOTIF_ENDPOINT} 1
${callback_uri} http://localhost
${unreachable_callback_uri} http://not-reachable-uri
${new_callback_uri} http://newcallbackuri-for-PMJobModifications
${callback_port} 9091
${callback_endpoint} /endpoint
${callback_endpoint_error} /endpoint_404
......
SOL002/VNFPerformanceManagement-API/jsons/CreateThresholdRequest.json
View file @ 29614667
{{
"objectType": "",
"objectInstanceIds" : "{objectInstanceIds}",
"criteria" : {{
"performanceMetric": "cpu_util",
......