NFVSOL(25)000457_SOL026_Clause_11_Physical_resource_log_management_service_interface

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.

<mark>Editor's Note: The above list to be updated if other PIM service interfaces can be profiled to the Redfish&reg; interface.</mark>

|-|-|-|

|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&reg; resource object for LoggingJob**<a name="table_5.5.1-1"></a>

|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&reg; resource object for LoggingJob**<a name="table_5.5.2-1"></a>

|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

<mark>Editor's Note:    This clause will profile operations of physical resource log management service interface against relevant solution(s).</mark>

# 11.1 Description

## 11.1 Description

<mark>Editor's Note:    This sub-clause will add description of the service interface.</mark>

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.

# 11.2 API version

The operations supported over this service interface are the following:

<mark>Editor's Note:    This sub-clause will add API version and API roots for the service interface.</mark>

- 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

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/.../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).

.

# 11.3 Resource structure and HTTP methods