update response body schemas as per SOL 003 version 5.1.1 (9ce95381) · Commits · NFV - Network Functions Virtualisation / api-tests

SOL003/VNFFaultManagement-API/schemas/Alarms.schema.json

+3 −3

Original line number	Diff line number	Diff line
		@@ -149,11 +149,11 @@
		]
		},
		"faultType": {
		"description": "Additional information to clarify the type of the fault. If the alarm is related to changes in the state of virtualised resources due to NFVI operation and maintenance, this attribute shall be set to \"NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE\".\n",
		"description": "Additional information to clarify the type of the fault. Valid values applicable to specific Alarms are specified as \"Alarm definition identifier\" values of the Alarm applicable to Or-Vnfm reference point, as defined in clause 7.3 of ETSI GS NFV-IFA 045 [13]. If the alarm is related to changes in the state of virtualised resources due to NFVI operation and maintenance, this attribute shall be set to \"NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE\".\n",
		"type": "string"
		},
		"probableCause": {
		"description": "Information about the probable cause of the fault. If the attribute \"faultType\" has the value “NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE”, the permitted values are: \n - \"NFVI_COMPONENT_MAINTENANCE\": Maintenance of NFVI components, e.g. \n physical maintenance/repair, hypervisor software updates, etc.\n - \"NFVI_COMPONENT_EVACUATION\": Evacuation of physical hosts.\n - \"NFVI_COMPONENT_OPTIMIZATION\": Operation and management of NFVI resources, e.g.\n to support energy efficiency or resource usage.\n",
		"description": "Information about the probable cause of the fault. Valid values applicable to specific Alarms are specified as \"Probable cause\" values of the Alarm applicable to Or-Vnfm reference point, as defined in clause 7.3 of ETSI GS NFV-IFA 045 [13]. If the attribute \"faultType\" has the value ΓÇ£NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGEΓÇ¥, the permitted values are: \n - \"NFVI_COMPONENT_MAINTENANCE\": Maintenance of NFVI components, e.g. \n physical maintenance/repair, hypervisor software updates, etc.\n - \"NFVI_COMPONENT_EVACUATION\": Evacuation of physical hosts.\n - \"NFVI_COMPONENT_OPTIMIZATION\": Operation and management of NFVI resources, e.g.\n to support energy efficiency or resource usage.\n",
		"type": "string"
		},
		"isRootCause": {
		@@ -169,7 +169,7 @@
		}
		},
		"faultDetails": {
		"description": "Provides additional information about the fault. See notes 1 and 2.\n",
		"description": "Provides additional information about the fault. See notes 1 and 2. Valid values applicable to specific Alarms are specified as \"Fault details\" values of the Alarm applicable to Or-Vnfm reference point, as defined in clause 7.3 of ETSI GS NFV-IFA 045 [13].\n",
		"type": "array",
		"items": {
		"type": "string"

SOL003/VNFFaultManagement-API/schemas/FmSubscription.schema.json

+47 −0

Original line number	Diff line number	Diff line
		@@ -199,6 +199,53 @@
		"description": "String formatted according to IETF RFC 3986.\n",
		"type": "string"
		},
		"fmConnection": {
		"description": "An access information and interface information to monitor the FM of VNF instance by the VNFM. This can include for instance certain interface endpoint URI together with necessary credentials to access it.\n",
		"type": "array",
		"items": {
		"description": "The MonitoringConnection shall follow the indications provided.\n* NOTE: The VNFM can be made aware of monitoring connection information, \n including their identifiers to be used by configuration means outside the scope of the \n present document (e.g. using relevant NFV-MANO management APIs as defined in \n ETSI GS NFV-SOL 009 [i.18]).\n",
		"type": "object",
		"required": [
		"id",
		"monitoringType"
		],
		"properties": {
		"id": {
		"description": "An identifier with the intention of being globally unique.\n",
		"type": "string"
		},
		"monitoringType": {
		"description": "Type of monitoring way.\n",
		"type": "string",
		"enum": [
		"VIM_CISM",
		"EXTERNAL",
		"PAAS"
		]
		},
		"vimId": {
		"description": "An identifier with the intention of being globally unique.\n",
		"type": "string"
		},
		"paasServiceId": {
		"description": "An identifier with the intention of being globally unique.\n",
		"type": "string"
		},
		"interfaceInfo": {
		"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"
		},
		"accessInfo": {
		"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"
		},
		"extra": {
		"description": "A string defined in IETF RFC 8259.\n",
		"type": "string"
		}
		}
		}
		},
		"_links": {
		"description": "Links for this resource.\n",
		"type": "object",

SOL003/VNFFaultManagement-API/schemas/FmSubscriptions.schema.json

+47 −0

Original line number	Diff line number	Diff line
		@@ -201,6 +201,53 @@
		"description": "String formatted according to IETF RFC 3986.\n",
		"type": "string"
		},
		"fmConnection": {
		"description": "An access information and interface information to monitor the FM of VNF instance by the VNFM. This can include for instance certain interface endpoint URI together with necessary credentials to access it.\n",
		"type": "array",
		"items": {
		"description": "The MonitoringConnection shall follow the indications provided.\n* NOTE: The VNFM can be made aware of monitoring connection information, \n including their identifiers to be used by configuration means outside the scope of the \n present document (e.g. using relevant NFV-MANO management APIs as defined in \n ETSI GS NFV-SOL 009 [i.18]).\n",
		"type": "object",
		"required": [
		"id",
		"monitoringType"
		],
		"properties": {
		"id": {
		"description": "An identifier with the intention of being globally unique.\n",
		"type": "string"
		},
		"monitoringType": {
		"description": "Type of monitoring way.\n",
		"type": "string",
		"enum": [
		"VIM_CISM",
		"EXTERNAL",
		"PAAS"
		]
		},
		"vimId": {
		"description": "An identifier with the intention of being globally unique.\n",
		"type": "string"
		},
		"paasServiceId": {
		"description": "An identifier with the intention of being globally unique.\n",
		"type": "string"
		},
		"interfaceInfo": {
		"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"
		},
		"accessInfo": {
		"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"
		},
		"extra": {
		"description": "A string defined in IETF RFC 8259.\n",
		"type": "string"
		}
		}
		}
		},
		"_links": {
		"description": "Links for this resource.\n",
		"type": "object",

SOL003/VNFFaultManagement-API/schemas/alarm.schema.json

+3 −3

Original line number	Diff line number	Diff line
		@@ -145,11 +145,11 @@
		]
		},
		"faultType": {
		"description": "Additional information to clarify the type of the fault. If the alarm is related to changes in the state of virtualised resources due to NFVI operation and maintenance, this attribute shall be set to \"NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE\".\n",
		"description": "Additional information to clarify the type of the fault. Valid values applicable to specific Alarms are specified as \"Alarm definition identifier\" values of the Alarm applicable to Or-Vnfm reference point, as defined in clause 7.3 of ETSI GS NFV-IFA 045 [13]. If the alarm is related to changes in the state of virtualised resources due to NFVI operation and maintenance, this attribute shall be set to \"NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE\".\n",
		"type": "string"
		},
		"probableCause": {
		"description": "Information about the probable cause of the fault. If the attribute \"faultType\" has the value “NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE”, the permitted values are: \n - \"NFVI_COMPONENT_MAINTENANCE\": Maintenance of NFVI components, e.g. \n physical maintenance/repair, hypervisor software updates, etc.\n - \"NFVI_COMPONENT_EVACUATION\": Evacuation of physical hosts.\n - \"NFVI_COMPONENT_OPTIMIZATION\": Operation and management of NFVI resources, e.g.\n to support energy efficiency or resource usage.\n",
		"description": "Information about the probable cause of the fault. Valid values applicable to specific Alarms are specified as \"Probable cause\" values of the Alarm applicable to Or-Vnfm reference point, as defined in clause 7.3 of ETSI GS NFV-IFA 045 [13]. If the attribute \"faultType\" has the value ΓÇ£NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGEΓÇ¥, the permitted values are: \n - \"NFVI_COMPONENT_MAINTENANCE\": Maintenance of NFVI components, e.g. \n physical maintenance/repair, hypervisor software updates, etc.\n - \"NFVI_COMPONENT_EVACUATION\": Evacuation of physical hosts.\n - \"NFVI_COMPONENT_OPTIMIZATION\": Operation and management of NFVI resources, e.g.\n to support energy efficiency or resource usage.\n",
		"type": "string"
		},
		"isRootCause": {
		@@ -165,7 +165,7 @@
		}
		},
		"faultDetails": {
		"description": "Provides additional information about the fault. See notes 1 and 2.\n",
		"description": "Provides additional information about the fault. See notes 1 and 2. Valid values applicable to specific Alarms are specified as \"Fault details\" values of the Alarm applicable to Or-Vnfm reference point, as defined in clause 7.3 of ETSI GS NFV-IFA 045 [13].\n",
		"type": "array",
		"items": {
		"type": "string"

SOL003/VNFFaultManagement-API/schemas/alarmNotification.schema.json

+3 −3

Original line number	Diff line number	Diff line
		@@ -177,11 +177,11 @@
		]
		},
		"faultType": {
		"description": "Additional information to clarify the type of the fault. If the alarm is related to changes in the state of virtualised resources due to NFVI operation and maintenance, this attribute shall be set to \"NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE\".\n",
		"description": "Additional information to clarify the type of the fault. Valid values applicable to specific Alarms are specified as \"Alarm definition identifier\" values of the Alarm applicable to Or-Vnfm reference point, as defined in clause 7.3 of ETSI GS NFV-IFA 045 [13]. If the alarm is related to changes in the state of virtualised resources due to NFVI operation and maintenance, this attribute shall be set to \"NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE\".\n",
		"type": "string"
		},
		"probableCause": {
		"description": "Information about the probable cause of the fault. If the attribute \"faultType\" has the value “NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE”, the permitted values are: \n - \"NFVI_COMPONENT_MAINTENANCE\": Maintenance of NFVI components, e.g. \n physical maintenance/repair, hypervisor software updates, etc.\n - \"NFVI_COMPONENT_EVACUATION\": Evacuation of physical hosts.\n - \"NFVI_COMPONENT_OPTIMIZATION\": Operation and management of NFVI resources, e.g.\n to support energy efficiency or resource usage.\n",
		"description": "Information about the probable cause of the fault. Valid values applicable to specific Alarms are specified as \"Probable cause\" values of the Alarm applicable to Or-Vnfm reference point, as defined in clause 7.3 of ETSI GS NFV-IFA 045 [13]. If the attribute \"faultType\" has the value “NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE”, the permitted values are: \n - \"NFVI_COMPONENT_MAINTENANCE\": Maintenance of NFVI components, e.g. \n physical maintenance/repair, hypervisor software updates, etc.\n - \"NFVI_COMPONENT_EVACUATION\": Evacuation of physical hosts.\n - \"NFVI_COMPONENT_OPTIMIZATION\": Operation and management of NFVI resources, e.g.\n to support energy efficiency or resource usage.\n",
		"type": "string"
		},
		"isRootCause": {
		@@ -197,7 +197,7 @@
		}
		},
		"faultDetails": {
		"description": "Provides additional information about the fault. See notes 1 and 2.\n",
		"description": "Provides additional information about the fault. See notes 1 and 2. Valid values applicable to specific Alarms are specified as \"Fault details\" values of the Alarm applicable to Or-Vnfm reference point, as defined in clause 7.3 of ETSI GS NFV-IFA 045 [13].\n",
		"type": "array",
		"items": {
		"type": "string"