Merge branch 'NFVSOL(26)000074_SOL026_Clause_7_API_resources_and_data_model' into 'main' (08646a4e) · Commits · NFV - Network Functions Virtualisation / Specifications / GS NFV-SOL 026

GS_NFV-SOL_026.md

+127 −2

Original line number	Original line	Diff line number	Diff line
	@@ -952,10 +952,135 @@ The replacement of an individual inventory object, as illustrated in Figure 7.4.
	Error handling: In case of failure, appropriate error information is provided in the response.		Error handling: In case of failure, appropriate error information is provided in the response.

	## 7.5 Resources		## 7.5 Resources
	<mark>Editor's Note: This sub-clause will add API resources of the service interface.</mark>
			### 7.5.1 Introduction

			The present clause specifies API resources (endpoints) of the physical resource inventory management service interface.

			### 7.5.2 Resource: InventoryObjectCollection

			This resource represents a collection of physical resource inventory objects of the same kind, e.g., a chassis collection, systems collection, cables collection, software inventory collection, etc. The API resource can be used to retrieve a collection of physical resource inventory objects that are managed by the PIM.

			Table 7.5.2-1 specifies the supported HTTP methods for this resource and maps them against the PIM service interface requirements as specified in ETSI GS NFV-IFA 053 [\[1\]](#_ref_1).

			The URI query parameters, request and response bodies, and response codes of the individual resource methods shall follow the provisions specified in Redfish® specification [\[2\]](#_ref_2).

			Table 7.5.2-1: InventoryObjectCollection resource methods mapped against PIM service interface requirements

			+--------------------------------+---------------+-------------------------------------------------+---------------------------------+
			\|Resource URI \|HTTP Method \|Meaning \|Requirement identifier from\ \|
			\| \| \| \|ETSI GS NFV-IFA 053 [ 1 ] \|
			+:===============================+:==============+:================================================+:================================+
			\|.../{InventoryObjectCollection} \|GET \|Get a collection of inventory objects \|PimPrImMgt.001 \|
			\|(see note) \| \|Retrieves information about the \| \|
			\| \| \|inventory of physical resources within \| \|
			\| \| \|an NFVI managed by the PIM \| \|
			\|--------------------------------+---------------+-------------------------------------------------+---------------------------------+
			\|NOTE: Refer to Table 7.3-1 for the full URI of this resource. \|
			+------------------------------------------------------------------------------------------------------------------------------------+

			### 7.5.3 Resource: IndividualInventoryObject

			This resource represents an individual physical resource inventory object managed by the PIM, and can be used to query or update the individual object.

			Table 7.5.3-1 specifies the supported HTTP methods for this resource and maps them against the PIM service interface requirements as specified in ETSI GS NFV-IFA 053 [\[1\]](#_ref_1).

			The URI query parameters, request and response bodies, and response codes of the individual resource methods shall follow the provisions specified in Redfish® specification [\[2\]](#_ref_2).

			Table 7.5.3-1: IndividualInventoryObject resource methods mapped against PIM service interface requirements

			+--------------------------------+---------------+-------------------------------------------------+---------------------------------+
			\|Resource URI \|HTTP Method \|Meaning \|Requirement identifier from\ \|
			\| \| \| \|ETSI GS NFV-IFA 053 [ 1 ] \|
			+:===============================+:==============+:================================================+:================================+
			\|.../{InventoryObjectCollection} \|GET \|Retrieves information about the individual \|PimPrImMgt.001 \|
			\|/{IndividualInventoryObject} \| \|physical resource inventory object \| \|
			\|(see note) +---------------+-------------------------------------------------+---------------------------------+
			\| \|PUT \|Modifies the individual inventory object \|PimPrImMgt.004 \|
			\| \| \|by replacing it whole. \| \|
			\| +---------------+-------------------------------------------------+---------------------------------+
			\| \|PATCH \|Modifies the individual inventory object \|PimPrImMgt.004 \|
			\| \| \|by updating only a patch of it. \| \|
			\|--------------------------------+---------------+-------------------------------------------------+---------------------------------+
			\|NOTE: Refer to Table 7.3-1 for the full URI of this resource. \|
			+------------------------------------------------------------------------------------------------------------------------------------+

			### 7.5.4 Resource: Subscriptions

			This resource represents subscriptions related to inventory management of physical resources and can be used to retrieve a collection of already created subscription resources as well as to create a new individual subscription resource. This resource can be used to create a subscription for receiving notifications about any changes in the inventory information of physical resources.

			Table 7.5.4-1 specifies the supported HTTP methods for this resource and maps them against the PIM service interface requirements as specified in ETSI GS NFV-IFA 053 [\[1\]](#_ref_1).

			The URI query parameters, request and response bodies, and response codes of the individual resource methods shall follow the provisions specified in Redfish® specification [\[2\]](#_ref_2).

			Table 7.5.4-1: Subscriptions resource methods mapped against PIM service interface requirements

			+------------------+---------------+-------------------------------------------------+---------------------------------+
			\|Resource URI \|HTTP Method \|Meaning \|Requirement identifier from\ \|
			\| \| \| \|ETSI GS NFV-IFA 053 [ 1 ] \|
			+:=================+:==============+:================================================+:================================+
			\|.../Subscriptions \|GET \|Lists a collection of subscriptions. \|PimPrImMgt.003 \|
			\|(see note) \| \|Retrieves information about the \| \|
			\| \| \|created subscriptions related to \| \|
			\| \| \|to inventory management of physical \| \|
			\| \| \|resources managed by the PIM. \| \|
			\| +---------------+-------------------------------------------------+---------------------------------+
			\| \|POST \|Creates a new Individual Subscription resource. \|PimPrImMgt.003 \|
			+------------------+---------------+-------------------------------------------------+---------------------------------+
			\|NOTE: Refer to Table 7.3-1 for the full URI of this resource. \|
			+----------------------------------------------------------------------------------------------------------------------+

			### 7.5.5 Resource: Individual Subscription

			This resource represents an individual subscription related to inventory management of physical resources managed by the PIM, and can be used to query, update or delete the individual subscription resource.

			Table 7.5.5-1 specifies the supported HTTP methods for this resource and maps them against the PIM service interface requirements as specified in ETSI GS NFV-IFA 053 [\[1\]](#_ref_1).

			The URI query parameters, request and response bodies, and response codes of the individual resource methods shall follow the provisions specified in Redfish® specification [\[2\]](#_ref_2).

			Table 7.5.5-1: Individual Subscription resource methods mapped against PIM service interface requirements

			+---------------------------------------------+---------------+----------------------------------------------+---------------------------------+
			\|Resource URI \|HTTP Method \|Meaning \|Requirement identifier from\ \|
			\| \| \| \|ETSI GS NFV-IFA 053 [ 1 ] \|
			+:============================================+:==============+:=============================================+:================================+
			\|.../Subscriptions/{SubscriptionId} (see note)\|GET \|Retrieves information about an individual \|PimPrImMgt.003 \|
			\| \| \|subscription resource managed by the PIM. \| \|
			\| +---------------+----------------------------------------------+---------------------------------+
			\| \|PUT \|Modifies the individual subscription \|PimPrImMgt.003 \|
			\| \| \|resource by replacing it whole. \| \|
			\| +---------------+----------------------------------------------+---------------------------------+
			\| \|PATCH \|Modifies the individual subscription \|PimPrImMgt.003 \|
			\| \| \|resource by updating only a patch of it. \| \|
			\| +---------------+----------------------------------------------+---------------------------------+
			\| \|DELETE \|Deletes the individual subscription resource. \|PimPrImMgt.003 \|
			+---------------------------------------------+---------------+----------------------------------------------+---------------------------------+
			\|NOTE: Refer to Table 7.3-1 for the full URI of this resource. \|
			+---------------------------------------------+---------------+----------------------------------------------+---------------------------------+

			### 7.5.6 Resource: Individual Task Monitor

			This resource represents an individual task monitor for an asynchronous operation being performed by the PIM and can be used by the API consumer to monitor the progress of an asynchronous operation as well as receive the result of the requested operation once the corresponding task has been completed.

			Table 7.5.6-1 specifies the supported HTTP methods for this resource and maps them against the PIM service interface requirements as specified in ETSI GS NFV-IFA 053 [\[1\]](#_ref_1).

			The URI query parameters, request and response bodies, and response codes of the individual resource methods shall follow the provisions specified in Redfish® specification [\[2\]](#_ref_2).

			Table 7.5.6-1: Individual Task Monitor resource methods mapped against PIM service interface requirements

			+---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+
			\|Resource URI \|HTTP Method \|Meaning \| Requirement identifier from\ \|
			\| \| \| \| ETSI GS NFV-IFA 053 [ 1 ] \|
			+:============================================+:==============+:==================================================+:================================+
			\|.../TaskService/TaskMonitors/{TaskMonitorId} \|GET \|Retrieves result of an asynchronous operation \|PimPrImMgt.003 \|
			\|(see note) \| \|related to physical resource log management \|PimPrImMgt.004 \|
			\| \| \|once that operation has been completed. \| \|
			+---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+
			\|NOTE: Refer to Table 7.3-1 for the full URI of this resource. \|
			+---------------------------------------------------------------------------------------------------------------------------------------------------+

	## 7.6 Data model		## 7.6 Data model
	<mark>Editor's Note: This sub-clause will add data model of the service interface.</mark>		The request and response data structures of the physical resource inventory management service interface are defined in the Redfish® data model specification [\[3\]](#_ref_3).

	# 8 Physical resource topology management service interface		# 8 Physical resource topology management service interface