From c2e71f70ee4d9a5290692c19b6135c8b748bca73 Mon Sep 17 00:00:00 2001 From: hammadzf Date: Tue, 25 Nov 2025 15:03:05 +0100 Subject: [PATCH 1/2] add API resources --- GS_NFV-SOL_026.md | 231 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 229 insertions(+), 2 deletions(-) diff --git a/GS_NFV-SOL_026.md b/GS_NFV-SOL_026.md index 239f369..dd310df 100644 --- a/GS_NFV-SOL_026.md +++ b/GS_NFV-SOL_026.md @@ -683,7 +683,7 @@ Table 6.5.7-1 specifies the supported HTTP methods for this resource and maps th 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 6.5.7-1: Individual Subscription resource methods mapped against PIM service interface requirements** +**Table 6.5.7-1: Individual Task Monitor resource methods mapped against PIM service interface requirements** +-----------------------------------------------+---------------+-----------------------------------------+------------------------------+ |Resource URI |HTTP Method |Meaning |Requirement identifier from\ | @@ -1108,7 +1108,7 @@ Table 8.5.8-1 specifies the supported HTTP methods for this resource and maps th 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 8.5.8-1: Individual Subscription resource methods mapped against PIM service interface requirements** +**Table 8.5.8-1: Individual Task Monitor resource methods mapped against PIM service interface requirements** +---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+ |Resource URI |HTTP Method |Meaning | Requirement identifier from\ | @@ -1233,6 +1233,233 @@ The HTTP methods marked as "M" (mandatory) in the "Cat" column of table 9.3-1 sh |This resource is not produced by the API producer. | +---------------------------------------------------------------------------------------------------------------------------------------------------+ +## 9.5 Resources + +### 9.5.1 Introduction + +The present clause specifies API resources (endpoints) of the physical resource performance management service interface. + +### 9.5.2 Resource: PmJobs + +This API resource represents the performance management jobs (PmJobs) created for reporting of performance metrics related to physical resources managed by the PIM. The API resource can be used to retrieve a collection of available PmJobs as well as to create an individual PmJob resource. + +Table 9.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 9.5.2-1: PmJobs resource methods mapped against PIM service interface requirements** + ++----------------------------+---------------+---------------------------------------------------+---------------------------------+ +|Resource URI |HTTP Method |Meaning |Requirement identifier from\ | +| | | |ETSI GS NFV-IFA 053 [ 1 ] | ++:===========================+:==============+:==================================================+:================================+ +|.../MetricReportDefinitions\|GET |Lists a collection of available PmJobs.\ |PimPrPmMgt.003 | +|(see note) | |Retrieves performance management jobs created for | | +| | |collecting metrics related to physical resources \ | | +| | |managed by the PIM. | | +| +---------------+---------------------------------------------------+---------------------------------+ +| |POST |Creates a new "Individual PmJob" resource. |PimPrPmMgt.003 | ++----------------------------+---------------+---------------------------------------------------+---------------------------------+ +|NOTE: Refer to Table 9.3-1 for the full URI of this resource. | ++----------------------------+---------------+---------------------------------------------------+---------------------------------+ + +### 9.5.3 Resource: Individual PmJob + +This API resource represents an individual PmJob created for reporting of performance metrics related to physical resources managed by the PIM. The API resource can be used to query, update or delete an individual PmJob resource. + +Table 9.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]. + +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]. + +**Table 9.5.3-1: Individual PmJob resource methods mapped against PIM service interface requirements** + ++-------------------------------------+---------------+-----------------------------------------------+---------------------------------+ +|Resource URI |HTTP Method |Meaning |Requirement identifier from\ | +| | | |ETSI GS NFV-IFA 053 [ 1 ] | ++:====================================+:==============+:==============================================+:================================+ +|.../MetricReportDefinitions\ |GET |Retrieves information about an |PimPrPmMgt.003 | +|/{MetricReportDefinitionId}\ | |individual PmJob managed by the PIM. | | +|(see note) +---------------+-----------------------------------------------+---------------------------------+ +| |PUT |Modifies the individual PmJob |PimPrPmMgt.003 | +| | |resource by replacing it whole. | | +| +---------------+-----------------------------------------------+---------------------------------+ +| |PATCH |Modifies the individual PmJob |PimPrPmMgt.003 | +| | |resource by updating only a patch of it. | | +| +---------------+-----------------------------------------------+---------------------------------+ +| |DELETE |Deletes the individual PmJob resource. |PimPrPmMgt.003 | ++-------------------------------------+---------------+-----------------------------------------------+---------------------------------+ +|NOTE: Refer to Table 9.3-1 for the full URI of this resource. | ++-------------------------------------+---------------+-----------------------------------------------+---------------------------------+ + +### 9.5.4 Resource: Thresholds + +This API resource represents thresholds and triggers for metrics related to physical resources managed by the PIM. The API resource can be used to retrieve a collection of available thresholds as well as to create an individual threshold. + +Table 9.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 9.5.4-1: Thresholds resource methods mapped against PIM service interface requirements** + ++-----------------------------+---------------+------------------------------------------+---------------------------------+ +|Resource URI |HTTP Method |Meaning |Requirement identifier from\ | +| | | |ETSI GS NFV-IFA 053 [ 1 ] | ++:============================+:==============+:=========================================+:================================+ +|.../Triggers (see note) |GET |Lists available thresholds. |PimPrPmMgt.003 | +| +---------------+------------------------------------------+---------------------------------+ +| |POST |Creates a new threshold. |PimPrPmMgt.003 | ++-----------------------------+---------------+------------------------------------------+---------------------------------+ +|NOTE: Refer to Table 9.3-1 for the full URI of this resource. | ++-----------------------------+---------------+------------------------------------------+---------------------------------+ + +### 9.5.5 Resource: Individual Threshold + +This resource represents an individual threshold for metrics related to physical resources managed by the PIM. The API resource can be used to query, update or delete an individual threshold resource. + +Table 9.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 9.5.5-1: Individual Threshold resource methods mapped against PIM service interface requirements** + ++------------------------------------+---------------+------------------------------------------------+---------------------------------+ +|Resource URI |HTTP Method |Meaning |Requirement identifier from\ | +| | | |ETSI GS NFV-IFA 053 [ 1 ] | ++:===================================+:==============+:===============================================+:================================+ +|.../Triggers/{TriggerId} |GET |Retrieves an individual threshold. |PimPrPmMgt.003 | +| +---------------+------------------------------------------------+---------------------------------+ +| |PUT |Modifies the individual threshold |PimPrPmMgt.003 | +| | |resource by replacing it whole. | | +| +---------------+------------------------------------------------+---------------------------------+ +| |PATCH |Modifies the individual threshold |PimPrPmMgt.003 | +| | |resource by updating only a patch of it. | | +| +---------------+------------------------------------------------+---------------------------------+ +| |DELETE |Deletes the individual threshold resource. |PimPrPmMgt.003 | ++------------------------------------+---------------+------------------------------------------------+---------------------------------+ +|NOTE: Refer to Table 9.3-1 for the full URI of this resource. | ++----------------------------------------------------+------------------------------------------------+---------------------------------+ + +### 9.5.6 Resource: Performance Reports + +This API resource represents performance reports generated by the PIM based on the PmJobs related to metric collection of physical resources. The API resource can be used to retrieve multiple performance reports that have been generated by the PIM. + +Table 9.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 9.5.6-1: Performance Reports resource methods mapped against PIM service interface requirements** + ++---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+ +|Resource URI |HTTP Method |Meaning | Requirement identifier from\ | +| | | | ETSI GS NFV-IFA 053 [ 1 ] | ++:============================================+:==============+:==================================================+:================================+ +|.../MetricReports (see note) |GET |Retrieves a list of performance reports generated\ |PimPrPmMgt.001 | +| | |by the PIM. | | ++---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+ +|NOTE: Refer to Table 9.3-1 for the full URI of this resource. | ++---------------------------------------------------------------------------------------------------------------------------------------------------+ + +### 9.5.7 Resource: Individual Performance Report + +This API resource represents an individual performance report generated by the PIM related to metric collection of physical resources and can be used to retrieve an individual performance report. + +Table 9.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 9.5.7-1: Individual Performance Report resource methods mapped against PIM service interface requirements** + ++---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+ +|Resource URI |HTTP Method |Meaning | Requirement identifier from\ | +| | | | ETSI GS NFV-IFA 053 [ 1 ] | ++:============================================+:==============+:==================================================+:================================+ +|.../MetricReports/{MetricReportId} (see note)|GET |Retrieves an individual performance report\ |PimPrPmMgt.001 | +| | |generated by the PIM. | | ++---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+ +|NOTE: Refer to Table 9.3-1 for the full URI of this resource. | ++---------------------------------------------------------------------------------------------------------------------------------------------------+ + +### 9.5.8 Resource: Subscriptions + +This resource represents subscriptions related to performance 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 also be used to create a PmJob in the form of a subscription for receiving performance reports asynchronoulsy as notifications. + +Table 9.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 9.5.8-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. |PimPrPmMgt.004 | +|(see note) | |Retrieves information about the | | +| | |created subscriptions related to | | +| | |to performance management of physical | | +| | |resources managed by the PIM. | | +| +---------------+-------------------------------------------------+---------------------------------+ +| |POST |Creates a new Individual Subscription resource.\ |PimPrPmMgt.004\ | +| | |A subscription representing a PmJob can be \ |PimPrPmMgt.003 | +| | |created for retrieving performance reports \ | | +| | |asynchronously as notifications. | | ++------------------+---------------+-------------------------------------------------+---------------------------------+ +|NOTE: Refer to Table 9.3-1 for the full URI of this resource. | ++----------------------------------------------------------------------------------------------------------------------+ + +### 9.5.9 Resource: Individual Subscription + +This resource represents an individual subscription related to performance management of physical resources managed by the PIM, and can be used to query, update or delete the individual subscription resource. + +Table 9.5.9-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 9.5.9-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 |PimPrPmMgt.004 | +| | |subscription resource managed by the PIM. | | +| +---------------+----------------------------------------------+---------------------------------+ +| |PUT |Modifies the individual subscription |PimPrPmMgt.004 | +| | |resource by replacing it whole. | | +| +---------------+----------------------------------------------+---------------------------------+ +| |PATCH |Modifies the individual subscription |PimPrPmMgt.004 | +| | |resource by updating only a patch of it. | | +| +---------------+----------------------------------------------+---------------------------------+ +| |DELETE |Deletes the individual subscription resource. |PimPrPmMgt.004 | ++---------------------------------------------+---------------+----------------------------------------------+---------------------------------+ +|NOTE: Refer to Table 9.3-1 for the full URI of this resource. | ++---------------------------------------------+---------------+----------------------------------------------+---------------------------------+ + +### 9.5.10 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 9.5.10-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 9.5.10-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 |PimPrPmMgt.003 | +|(see note) | |related to physical resource performance management| | +| | |once that operation has been completed. | | ++---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+ +|NOTE: Refer to Table 9.3-1 for the full URI of this resource. | ++---------------------------------------------------------------------------------------------------------------------------------------------------+ + +## 9.6 Data model + +The request and response data structures of the physical resource performance management service interface are defined in the Redfish® data model specification [\[3\]](#_ref_3). + # 10 Physical resource fault management service interface Editor's Note: This clause will profile operations of physical resource fault management service interface against relevant solution(s). -- GitLab From 17ac008b29853db40deda1c4f85fb94fd714a697 Mon Sep 17 00:00:00 2001 From: Naum Spaseski Date: Thu, 27 Nov 2025 09:50:44 +0000 Subject: [PATCH 2/2] Corrected tables 9.5.2-1 and 9.5.3-1 --- GS_NFV-SOL_026.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/GS_NFV-SOL_026.md b/GS_NFV-SOL_026.md index dd310df..9e6dec0 100644 --- a/GS_NFV-SOL_026.md +++ b/GS_NFV-SOL_026.md @@ -1249,19 +1249,19 @@ The URI query parameters, request and response bodies, and response codes of the **Table 9.5.2-1: PmJobs resource methods mapped against PIM service interface requirements** -+----------------------------+---------------+---------------------------------------------------+---------------------------------+ -|Resource URI |HTTP Method |Meaning |Requirement identifier from\ | -| | | |ETSI GS NFV-IFA 053 [ 1 ] | -+:===========================+:==============+:==================================================+:================================+ -|.../MetricReportDefinitions\|GET |Lists a collection of available PmJobs.\ |PimPrPmMgt.003 | -|(see note) | |Retrieves performance management jobs created for | | -| | |collecting metrics related to physical resources \ | | -| | |managed by the PIM. | | -| +---------------+---------------------------------------------------+---------------------------------+ -| |POST |Creates a new "Individual PmJob" resource. |PimPrPmMgt.003 | -+----------------------------+---------------+---------------------------------------------------+---------------------------------+ -|NOTE: Refer to Table 9.3-1 for the full URI of this resource. | -+----------------------------+---------------+---------------------------------------------------+---------------------------------+ ++-----------------------------+---------------+---------------------------------------------------+---------------------------------+ +|Resource URI |HTTP Method |Meaning |Requirement identifier from\ | +| | | |ETSI GS NFV-IFA 053 [ 1 ] | ++:============================+:==============+:==================================================+:================================+ +|.../MetricReportDefinitions\ |GET |Lists a collection of available PmJobs.\ |PimPrPmMgt.003 | +|(see note) | |Retrieves performance management jobs created for | | +| | |collecting metrics related to physical resources \ | | +| | |managed by the PIM. | | +| +---------------+---------------------------------------------------+---------------------------------+ +| |POST |Creates a new "Individual PmJob" resource. |PimPrPmMgt.003 | ++-----------------------------+---------------+---------------------------------------------------+---------------------------------+ +|NOTE: Refer to Table 9.3-1 for the full URI of this resource. | ++-----------------------------------------------------------------------------------------------------------------------------------+ ### 9.5.3 Resource: Individual PmJob @@ -1277,7 +1277,7 @@ The URI query parameters, request and response bodies, and response codes of the |Resource URI |HTTP Method |Meaning |Requirement identifier from\ | | | | |ETSI GS NFV-IFA 053 [ 1 ] | +:====================================+:==============+:==============================================+:================================+ -|.../MetricReportDefinitions\ |GET |Retrieves information about an |PimPrPmMgt.003 | +|.../MetricReportDefinitions\ |GET |Retrieves information about an |PimPrPmMgt.003 | |/{MetricReportDefinitionId}\ | |individual PmJob managed by the PIM. | | |(see note) +---------------+-----------------------------------------------+---------------------------------+ | |PUT |Modifies the individual PmJob |PimPrPmMgt.003 | -- GitLab