From d6089c4863285cb8c070bbd547e7b43ccd53d317 Mon Sep 17 00:00:00 2001 From: hammadzf Date: Fri, 5 Dec 2025 23:41:58 +0900 Subject: [PATCH 1/3] add LM related objects and description for LM service interface --- GS_NFV-SOL_026.md | 51 +++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 47 insertions(+), 4 deletions(-) diff --git a/GS_NFV-SOL_026.md b/GS_NFV-SOL_026.md index 88c3e03..4031a86 100644 --- a/GS_NFV-SOL_026.md +++ b/GS_NFV-SOL_026.md @@ -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, -- Physical resource topology management service interface; and -- Physical resource performance management service interface. +- Physical resource topology management service interface, +- Physical resource performance management service interface; and +- Physical resource log management service interface. Editor's Note: The above list to be updated if other PIM service interfaces can be profiled to the Redfish® interface. @@ -301,6 +302,33 @@ Table 5.4.3-1 lists down the properties of Redfish® object that is mapped to |-|-|-| |MetricReport|/redfish/v1/TelemetryService/MetricReports/{MetricReportId}|Represents a set of collected metrics and their values as part of a performance report.| +## 5.5 Log management related objects + +### 5.5.1 LoggingJob + +Table 5.5.1-1 lists down the properties of Redfish® object that is mapped to the LoggingJob object. + +**Table 5.5.1-1: Redfish® resource object for LoggingJob** + +|Redfish® resource object|Redfish® resource URI|Redfish® resource object description| +|-|-|-| +|LogService|.../LogServices/{LogServiceId}|Represents a log service for a Redfish implementation and contains properties for monitoring and configuring a logging job.| + +Possible URI paths for the LogService object are specified in the Redfish® data model specification [\[3\]](#_ref_3). + +### 5.5.2 Log + +Table 5.5.2-1 lists down the properties of Redfish® object that is mapped to the Log object. + +**Table 5.5.2-1: Redfish® resource object for LoggingJob** + +|Redfish® resource object|Redfish® resource URI|Redfish® resource object description| +|-|-|-| +|LogEntry|.../LogServices/{LogServiceId}/Entries/{LogEntryId}|Represents the format of log collected by a log service in the Redfish implementation.| + +Possible URI paths for the LogEntry object are specified in the Redfish® data model specification [\[3\]](#_ref_3). + + # 6 Physical resource provisioning and lifecycle management service interface ## 6.1 Description @@ -1690,11 +1718,26 @@ The request and response data structures of the physical resource performance ma # 11.1 Description -Editor's Note: This sub-clause will add description of the service interface. +The physical resource log management service interface allows the API consumers to invoke log management 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, retrieve and delete Logging Jobs +- Retrieve information about Logs collected by Logging Jobs +- Subscribe to notifications related to log collection events +- Notify subscribers according to the subscriptions # 11.2 API version -Editor's Note: This sub-clause will add API version and API roots for the service interface. +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: + +- .../LogService +- /redfish/v1/EventService/Subscriptions + +> NOTE: The Redfish® LogService can be configured to collect logs for different kinds of Redfish® resources. The resource URI for the corresponding LogService varies accordingly. For example, the resource URI of a logging job configured for an individual ComputerSystem resource may look like /redfish/v1/Systems/{ComputerSystemId}/LogServices/{LogServiceId}. Therefore, the API root for the LogService listed above is kept generic on purpose. Full list of possible URI paths for the LogService are specified in the Redfish® data model specification [\[3\]](#_ref_3). +. # 11.3 Resource structure and HTTP methods -- GitLab From c3e1b1412b0405ee2d01973e649146172ea4d2d5 Mon Sep 17 00:00:00 2001 From: hammadzf Date: Mon, 8 Dec 2025 09:54:26 +0900 Subject: [PATCH 2/3] fix heading levels and API root for LogService --- GS_NFV-SOL_026.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/GS_NFV-SOL_026.md b/GS_NFV-SOL_026.md index 4031a86..4a7a700 100644 --- a/GS_NFV-SOL_026.md +++ b/GS_NFV-SOL_026.md @@ -1716,7 +1716,7 @@ The request and response data structures of the physical resource performance ma Editor's Note: This clause will profile operations of physical resource log management service interface against relevant solution(s). -# 11.1 Description +## 11.1 Description The physical resource log management service interface allows the API consumers to invoke log management 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. @@ -1727,13 +1727,13 @@ The operations supported over this service interface are the following: - Subscribe to notifications related to log collection events - Notify subscribers according to the subscriptions -# 11.2 API version +## 11.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: -- .../LogService +- /redfish/v1/.../LogService - /redfish/v1/EventService/Subscriptions > NOTE: The Redfish® LogService can be configured to collect logs for different kinds of Redfish® resources. The resource URI for the corresponding LogService varies accordingly. For example, the resource URI of a logging job configured for an individual ComputerSystem resource may look like /redfish/v1/Systems/{ComputerSystemId}/LogServices/{LogServiceId}. Therefore, the API root for the LogService listed above is kept generic on purpose. Full list of possible URI paths for the LogService are specified in the Redfish® data model specification [\[3\]](#_ref_3). -- GitLab From 86efd4560f586216fbe77b06790dc4ef2eb6d79b Mon Sep 17 00:00:00 2001 From: Hammad Zafar Date: Wed, 10 Dec 2025 00:20:17 +0000 Subject: [PATCH 3/3] fix API root URI in 11.2 --- GS_NFV-SOL_026.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GS_NFV-SOL_026.md b/GS_NFV-SOL_026.md index 4a7a700..75f83ce 100644 --- a/GS_NFV-SOL_026.md +++ b/GS_NFV-SOL_026.md @@ -1733,7 +1733,7 @@ The API {VERSION} for the profiled Redfish® interface [\[2\]](#_ref_2) shall The corresponding Redfish® API roots are specified below: -- /redfish/v1/.../LogService +- /redfish/v1/.../LogServices - /redfish/v1/EventService/Subscriptions > NOTE: The Redfish® LogService can be configured to collect logs for different kinds of Redfish® resources. The resource URI for the corresponding LogService varies accordingly. For example, the resource URI of a logging job configured for an individual ComputerSystem resource may look like /redfish/v1/Systems/{ComputerSystemId}/LogServices/{LogServiceId}. Therefore, the API root for the LogService listed above is kept generic on purpose. Full list of possible URI paths for the LogService are specified in the Redfish® data model specification [\[3\]](#_ref_3). -- GitLab