NFVSOL(25)000404_SOL026_Clause_9_Physical_resource_performance_management_service_interface (a0a556d3) · Commits · NFV - Network Functions Virtualisation / Specifications / GS NFV-SOL 026

GS_NFV-SOL_026.md

+108 −3

Original line number	Diff line number	Diff line
		@@ -142,8 +142,9 @@ According to ETSI GS NFV-IFA 010 [\[i.2\]](#_ref_i.2), more detailed information

		The present clause provides an overview of Redfish® interface specification [\[2\]](#_ref_2), which is the profiled solution for the following physical resource management service interfaces produced by the PIM as specified in ETSI GS NFV-IFA 053 [\[1\]](#_ref_1):

		- Physical resource provisioning and lifecycle management service interface; and
		- Physical resource topology management service interface.
		- Physical resource provisioning and lifecycle management service interface,
		- Physical resource topology management service interface; and
		- Physical resource performance management service interface.

		Editor's Note: The above list to be updated if other PIM service interfaces can be profiled to the Redfish® interface.

		@@ -1094,7 +1095,111 @@ The request and response data structures of the physical resource topology manag

		# 9 Physical resource performance management service interface

		Editor's Note: This clause will profile operations of physical resource performance management service interface against relevant solution(s).
		## 9.1 Description

		The physical resource performance management service interface allows the API consumers to invoke performance management (PM) operations related to physical resources. The Redfish® interface [\[2\]](#_ref_2) endpoints profiled for this service interface allow consumers to manage API resources that are applicable for this service interface.

		The operations supported over this service interface are the following:

		- Create, update and delete a PM Job
		- Retrieve PM Jobs
		- Create, update and delete a Threshold
		- Retrieve Thresholds
		- Retrieve Performance Reports
		- Subscribe to notifications related to performance reporting events
		- Notify subscribers according to the subscriptions

		## 9.2 API version

		The API {VERSION} for the profiled Redfish® interface [\[2\]](#_ref_2) shall be set to "v1". Details about the API structure of the Redfish® interface [\[2\]](#_ref_2) are provided in clause 4.3.2 of the present document.

		The corresponding Redfish® API roots are specified below:

		- /redfish/v1/TelemetryService/MetricReportDefinitions
		- /redfish/v1/TelemetryService/Triggers
		- /redfish/v1/TelemetryService/MetricReports
		- /redfish/v1/EventService/Subscriptions

		## 9.3 Resource structure and HTTP methods

		Figures 9.3-1, 9.3-2, 9.3-3 and 9.3-4 show resource structures of the Redfish® API [\[2\]](#_ref_2) resources that are applicable for the physical resource performance management service interface.

		![Figure 9.3-1: API resource structure of PmJob resource for the physical resource performance management service interface](media/image22.png)

		Figure 9.3-1: API resource structure of PmJob resource for the physical resource performance management service interface

		![Figure 9.3-2: API resource structure of Threshold resource for the physical resource performance management service interface](media/image23.png)

		Figure 9.3-2: API resource structure of Threshold resource for the physical resource performance management service interface

		![Figure 9.3-3: API resource structure of PerformanceReport resource for the physical resource performance management service interface](media/image24.png)

		Figure 9.3-3: API resource structure of PerformanceReport resource for the physical resource performance management service interface

		![Figure 9.3-4: API resource structure of Subscription resource for physical resource performance management service interface](media/image3.png)

		Figure 9.3-4: API resource structure of Subscription resource for physical resource performance management service interface

		Table 9.3-1 lists the API resources, and the applicable HTTP methods for each resource endpoint.

		The HTTP methods marked as "M" (mandatory) in the "Cat" column of table 9.3-1 shall be supported by the PIM. The HTTP methods marked as "O" (optional) in the "Cat" column may be optionally supported by the PIM.

		Table 9.3-1: API Resources and HTTP methods of physical resource performance management service interface<a name="table_9.3-1"></a>

		+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
		\|Resource name \|Resource URI \|HTTP\ \|Cat \|Meaning \|
		\| \| \|Method \| \| \|
		+:========================+:================================+:================+:=========+:=========================================================+
		\|PmJobs \| /redfish/v1/TelemetryService\ \|GET \|M \|Get a collection of PmJobs. \|
		\| \| /MetricReportDefinitions +-----------------+----------+----------------------------------------------------------+
		\| \| \|POST \|M \|Create a new "IndividualPmJob" resource. \|
		+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
		\|IndividualPmJob \| /redfish/v1/TelemetryService\ \|GET \|M \|Get information about the "IndividualPmJob" resource \|
		\| \|/MetricReportDefinitions\ +-----------------+----------+----------------------------------------------------------+
		\| \|{MetricReportDefinitionId} \|PATCH \|M \|Modify information of an "IndividualPmJob" resource. \|
		\| \| +-----------------+----------+----------------------------------------------------------+
		\| \| \|PUT \|O \|Replace an "IndividualPmJob" resource. \|
		\| \| +-----------------+----------+----------------------------------------------------------+
		\| \| \|DELETE \|M \|Delete an "IndividualPmJob" resource. \|
		+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
		\|Thresholds \| /redfish/v1/TelemetryService\ \|GET \|M \|Get a collection of Threshold resource. \|
		\| \| /Triggers +-----------------+----------+----------------------------------------------------------+
		\| \| \|POST \|M \|Create a new "Individual Threshold" resource. \|
		+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
		\|Individual Threshold \|/redfish/v1/TelemetryService\ \|GET \|M \|Get information about an Individual Threshold" resource. \|
		\| \|/Triggers/{TriggerId} +-----------------+----------+----------------------------------------------------------+
		\| \| \|PATCH \|M \|Modify an Individual Threshold" resource. \|
		\| \| +-----------------+----------+----------------------------------------------------------+
		\| \| \|PUT \|O \|Replace an Individual Threshold" resource. \|
		\| \| +-----------------+----------+----------------------------------------------------------+
		\| \| \|DELETE \|M \|Delete an Individual Threshold" resource. \|
		+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
		\|Performance Reports \|/redfish/v1/TelemetryService\ \|GET \|M \|Retrieve a collection of PerformancReports. \|
		\| \|/MetricReports \| \| \| \|
		+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
		\|Individual Performance\ \|/redfish/v1/TelemetryService\ \|GET \|M \|Retrieve an individual PerformancReport resource. \|
		\|Report \|/MetricReports/{MetricReportId} \| \| \| \|
		+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
		\|Subscriptions \|/redfish/v1/EventService\ \|POST \|M \|Create a new "Individual Subscription" resource. \|
		\| \|/Subscriptions +-----------------+----------+----------------------------------------------------------+
		\| \| \|GET \|M \|Get the collection of all available subscriptions. \|
		+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
		\|Individual Subscription \|/redfish/v1/EventService\ \|GET \|M \|Get information about the \|
		\| \|/Subscriptions/{SubscriptionId} \| \| \|"Individual Subscription" resource. \|
		\| \| +-----------------+----------+----------------------------------------------------------+
		\| \| \|PATCH \|M \|Modify an "Individual Subscription" resource. \|
		\| \| +-----------------+----------+----------------------------------------------------------+
		\| \| \|PUT \|O \|Replace an "Individual Subscription" resource. \|
		\| \| +-----------------+----------+----------------------------------------------------------+
		\| \| \|DELETE \|M \|Delete an "Individual Subscription" resource. \|
		+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
		\|Notification endpoint \|{NotificationTargetURI} \|POST \|M \|Send a notification related to \|
		\| \| \| \| \|a subscribed event (see note). \|
		+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
		\|NOTE: Notification endpoint resource and the corresponding NotficiationTargetURI \|
		\|is used by the API producer to send notifications to the API consumer. \|
		\|This resource is not produced by the API producer. \|
		+---------------------------------------------------------------------------------------------------------------------------------------------------+

		# 10 Physical resource fault management service interface

media/image22.png

0 → 100644

+3.95 KiB

Loading image diff...

media/image23.png

0 → 100644

+3.05 KiB

Loading image diff...

media/image24.png

0 → 100644

+3.39 KiB

Loading image diff...

Admin message