Merge branch 'NFVSOL(25)000460_SOL026_Clause_11_API_resources_and_data_model' into 'main' (c3d16767) · Commits · NFV - Network Functions Virtualisation / Specifications / GS NFV-SOL 026

GS_NFV-SOL_026.md

+190 −20

Original line number	Diff line number	Diff line
		@@ -660,20 +660,20 @@ The URI query parameters, request and response bodies, and response codes of the

		Table 6.5.5-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 Subscription resources.\ \|PimPrLcmMgt.005 \|
		\|(see note) \| \|Retrieves information about the created \| \|
		\| \| \|subscriptions related to provisioning \| \|
		\| \| \|and lifecycle management of physical \| \|
		\| \| \|resources managed by the PIM. \| \|
		\| +------------------+-------------------------------------------------+---------------------------------+
		\| +------------------+----------------------------------------------------+---------------------------------+
		\| \|POST \|Creates a new \"Individual Subscription\" resource. \|PimPrLcmMgt.005 \|
		+----------------------------+------------------+-------------------------------------------------+---------------------------------+
		+----------------------------+------------------+----------------------------------------------------+---------------------------------+
		\|NOTE: Refer to Table 6.3-1 for the full URI of this resource. \|
		+----------------------------+------------------+-------------------------------------------------+---------------------------------+
		+----------------------------+------------------+----------------------------------------------------+---------------------------------+

		### 6.5.6 Resource: Individual Subscription

		@@ -1747,11 +1747,181 @@ The corresponding Redfish® API roots are specified below:

		<mark>Editor's Note: This sub-clause will add sequence diagrams of operations supported over this service interface.</mark>

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

		# 11.6 Data model
		<mark>Editor's Note: This sub-clause will add data model of the service interface.</mark>
		### 11.5.1 Introduction

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

		### 11.5.2 Resource: LoggingJobs

		This API resource represents the logging jobs (LoggingJobs) created for collecting logs related to physical resources managed by the PIM. The API resource can be used to retrieve a collection of available LoggingJobs as well as to create an individual LoggingJob resource.

		Table 11.5.2-1 specifies the supported HTTP methods for this API 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 11.5.2-1: LoggingJobs resource methods mapped against PIM service interface requirements

		+-----------------------------+---------------+---------------------------------------------------+---------------------------------+
		\|Resource URI \|HTTP Method \|Meaning \|Requirement identifier from\ \|
		\| \| \| \|ETSI GS NFV-IFA 053 [ 1 ] \|
		+:============================+:==============+:==================================================+:================================+
		\|/redfish/v1/.../LogServices\ \|GET \|Lists a collection of available LoggingJobs.\ \|PimPrLmMgt.003 \|
		\|(see note) \| \|Retrieves logging management jobs created for \| \|
		\| \| \|collecting logs related to physical resources \ \| \|
		\| \| \|managed by the PIM. \| \|
		\| +---------------+---------------------------------------------------+---------------------------------+
		\| \|POST \|Creates a new \"Individual LoggingJob\" resource. \|PimPrLmMgt.003 \|
		+-----------------------------+---------------+---------------------------------------------------+---------------------------------+
		\|NOTE: Possible URI paths for the LogService resource are specified in the Redfish® data model specification [\[3\]](#_ref_3). \|
		+-----------------------------------------------------------------------------------------------------------------------------------+

		### 11.5.3 Resource: Individual LoggingJob

		This API resource represents an individual LoggingJob created for collecting of logs related to physical resources managed by the PIM. The API resource can be used to query, update or delete an individual LoggingJob resource.

		Table 11.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 <a href="#_ref_1">[1]</a>.

		The URI query parameters, request and response bodies, and response codes of the individual resource methods shall follow the provisions specified in Redfish® specification <a href="#_ref_2">[2]</a>.

		Table 11.5.3-1: Individual LoggingJob resource methods mapped against PIM service interface requirements

		+-------------------------------------+---------------+-----------------------------------------------+---------------------------------+
		\|Resource URI \|HTTP Method \|Meaning \|Requirement identifier from\ \|
		\| \| \| \|ETSI GS NFV-IFA 053 [ 1 ] \|
		+:====================================+:==============+:==============================================+:================================+
		\|/redfish/v1/.../LogServices \ \|GET \|Retrieves information about an \|PimPrLmMgt.003 \|
		\|/{LogServiceId} (see note) \| \|individual LoggingJob managed by the PIM. \| \|
		\| +---------------+-----------------------------------------------+---------------------------------+
		\| \|PUT \|Modifies the individual LoggingJob \|PimPrLmMgt.003 \|
		\| \| \|resource by replacing it whole. \| \|
		\| +---------------+-----------------------------------------------+---------------------------------+
		\| \|PATCH \|Modifies the individual LoggingJob \|PimPrLmMgt.003 \|
		\| \| \|resource by updating only a patch of it. \| \|
		\| +---------------+-----------------------------------------------+---------------------------------+
		\| \|DELETE \|Deletes the individual LoggingJob resource. \|PimPrLmMgt.003 \|
		+-------------------------------------+---------------+-----------------------------------------------+---------------------------------+
		\|NOTE: Possible URI paths for the LogService resource are specified in the Redfish® data model specification [\[3\]](#_ref_3). \|
		+-------------------------------------+---------------+-----------------------------------------------+---------------------------------+

		### 11.5.4 Resource: Logs

		This API resource represents logs collected by the PIM based on the LoggingJobs related to log collection of physical resources. The API resource can be used to retrieve multiple log entries that have been generated by the PIM.

		Table 11.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 11.5.4-1: Logs resource methods mapped against PIM service interface requirements

		+---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+
		\|Resource URI \|HTTP Method \|Meaning \| Requirement identifier from\ \|
		\| \| \| \| ETSI GS NFV-IFA 053 [ 1 ] \|
		+:============================================+:==============+:==================================================+:================================+
		\|/redfish/v1/.../LogServices/{LogServiceId}\ \|GET \|Retrieves a list of log entries generated \ \|PimPrLmMgt.004 \|
		\|/Entries (see note) \| \|by the PIM for a LoggingJob. \| \|
		+---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+
		\|NOTE: Possible URI paths for the LogService resource are specified in the Redfish® data model specification [\[3\]](#_ref_3). \|
		+---------------------------------------------------------------------------------------------------------------------------------------------------+

		### 11.5.5 Resource: Individual Log

		This API resource represents an individual log entry generated by the PIM against a LoggingJob created for collection of logs related to physical resources managed by the PIM. The API resource can be used to retrieve an individual log entry.

		Table 11.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 11.5.5-1: Individual Log resource methods mapped against PIM service interface requirements

		+---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+
		\|Resource URI \|HTTP Method \|Meaning \| Requirement identifier from\ \|
		\| \| \| \| ETSI GS NFV-IFA 053 [ 1 ] \|
		+:============================================+:==============+:==================================================+:================================+
		\|/redfish/v1/.../LogServices/{LogServiceId} \ \|GET \|Retrieves a single log entry generated by the \ \|PimPrLmMgt.004 \|
		\|/Entries/{EntryId} (see note) \| \|PIM for a LoggingJob. \| \|
		+---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+
		\|NOTE: Possible URI paths for the LogService resource are specified in the Redfish® data model specification [\[3\]](#_ref_3). \|
		+---------------------------------------------------------------------------------------------------------------------------------------------------+

		### 11.5.6 Resource: Subscriptions

		This resource represents subscriptions related to log 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 to receive a notification once the Redfish service has successfully collected logs (diagnostics data) in the respectiv message registry.

		Table 11.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 11.5.6-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. \|PimPrLmMgt.002 \|
		\|(see note) \| \|Retrieves information about the \| \|
		\| \| \|created subscriptions related to \| \|
		\| \| \|to log management of physical \| \|
		\| \| \|resources managed by the PIM. \| \|
		\| +---------------+-------------------------------------------------+---------------------------------+
		\| \|POST \|Creates a new Individual Subscription resource. \|PimPrLmMgt.002 \|
		+------------------+---------------+-------------------------------------------------+---------------------------------+
		\|NOTE: Refer to Table 11.3-1 for the full URI of this resource. \|
		+----------------------------------------------------------------------------------------------------------------------+

		### 11.5.7 Resource: Individual Subscription

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

		Table 11.5.7-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 11.5.7-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 \|PimPrLmMgt.002 \|
		\| \| \|subscription resource managed by the PIM. \| \|
		\| +---------------+----------------------------------------------+---------------------------------+
		\| \|PUT \|Modifies the individual subscription \|PimPrLmMgt.002 \|
		\| \| \|resource by replacing it whole. \| \|
		\| +---------------+----------------------------------------------+---------------------------------+
		\| \|PATCH \|Modifies the individual subscription \|PimPrLmMgt.002 \|
		\| \| \|resource by updating only a patch of it. \| \|
		\| +---------------+----------------------------------------------+---------------------------------+
		\| \|DELETE \|Deletes the individual subscription resource. \|PimPrLmMgt.002 \|
		+---------------------------------------------+---------------+----------------------------------------------+---------------------------------+
		\|NOTE: Refer to Table 11.3-1 for the full URI of this resource. \|
		+---------------------------------------------+---------------+----------------------------------------------+---------------------------------+

		### 11.5.8 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 11.5.8-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 11.5.8-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 \|PimPrLmMgt.002 \|
		\|(see note) \| \|related to physical resource log management \|PimPmLmMgt.003 \|
		\| \| \|once that operation has been completed. \| \|
		+---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+
		\|NOTE: Refer to Table 11.3-1 for the full URI of this resource. \|
		+---------------------------------------------------------------------------------------------------------------------------------------------------+


		## 11.6 Data model
		The request and response data structures of the physical resource log management service interface are defined in the Redfish® data model specification [\[3\]](#_ref_3).

		<br />

Admin message