diff --git a/GS_NFV-SOL_026.md b/GS_NFV-SOL_026.md
index dc9fda5affda10f4917b7d459f789723db1f180a..8198a17cd2a687cbc43c6bd9f3e8e4c61196a1c1 100644
--- a/GS_NFV-SOL_026.md
+++ b/GS_NFV-SOL_026.md
@@ -1,5 +1,5 @@
---
-Title: Network Functions Virtualisation (NFV); Protocols and Data Models; Specification of protocol and data model solutions for PIM services
+Title: Network Functions Virtualisation (NFV);
Protocols and Data Models;
Specification of protocol and data model solutions for PIM services
Spec Number: NFV-SOL 026
Version: v0.0.9
Date: 2025-11
@@ -11,15 +11,11 @@ Long ISG Name: Network Functions Virtualisation
Short ISG Name: NFV
---
-# Contents
-
-
-
# Intellectual Property Rights
Essential patents
-IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The declarations pertaining to these essential IPRs, if any, are publicly available for **ETSI members and non-members** , and can be found in ETSI SR 000 314: _"Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in respect of ETSI standards"_ , which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web server ([https://ipr.etsi.org](https://ipr.etsi.org)).
+IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The declarations pertaining to these essential IPRs, if any, are publicly available for **ETSI members and non-members** , and can be found in ETSI SR 000 314: _\"Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in respect of ETSI standards\"_ , which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web server ([https://ipr.etsi.org](https://ipr.etsi.org)).
Pursuant to the ETSI Directives including the ETSI IPR Policy, no investigation regarding the essentiality of IPRs, including IPR searches, has been carried out by ETSI. No guarantee can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web server) which are, or may be, or may become, essential to the present document.
@@ -35,9 +31,9 @@ This Group Specification (GS) has been produced by ETSI Industry Specification G
# Modal verbs terminology
-In the present document "**shall** ", "**shall not** ", "**should** ", "**should not** ", "**may** ", "**need not** ", "**will** ", "**will not** ", "**can** " and "**cannot** " are to be interpreted as described in clause 3.2 of the [ETSI Drafting Rules](ETSI Drafting Rules) (Verbal forms for the expression of provisions).
+In the present document \"**shall** \", \"**shall not** \", \"**should** \", \"**should not** \", \"**may** \", \"**need not** \", \"**will** \", \"**will not** \", \"**can** \" and \"**cannot** \" are to be interpreted as described in clause 3.2 of the [ETSI Drafting Rules](ETSI Drafting Rules) (Verbal forms for the expression of provisions).
-"**must** " and "**must not** " are **NOT** allowed in ETSI deliverables except when used in direct citation.
+\"**must** \" and \"**must not**\" are **NOT** allowed in ETSI deliverables except when used in direct citation.
@@ -57,9 +53,11 @@ Referenced documents which are not found to be publicly available in the expecte
The following referenced documents are necessary for the application of the present document.
-- [1] ETSI GS NFV-IFA 053: "Network Functions Virtualisation (NFV) Release 5; Management and Orchestration; Requirements and interface specification for Physical Infrastructure Management".
-- [2] [DMTF® DSP0266](DMTF® DSP0266): "Redfish Specification", v1.22.0.
-- [3] [DMTF® DSP0268](DMTF® DSP0268): "Redfish Data Model Specification", v2025.1.
+[1] ETSI GS NFV-IFA 053: \"Network Functions Virtualisation (NFV) Release 5; Management and Orchestration; Requirements and interface specification for Physical Infrastructure Management\".
+
+[2] [DMTF® DSP0266](DMTF® DSP0266): \"Redfish Specification\", v1.22.0.
+
+[3] [DMTF® DSP0268](DMTF® DSP0268): \"Redfish Data Model Specification\", v2025.1.
## 2.2 Informative references
@@ -69,8 +67,9 @@ References are either specific (identified by date of publication and/or edition
The following referenced documents may be useful in implementing an ETSI deliverable or add to the reader's understanding, but are not required for conformance to the present document.
-- [i.1] ETSI GR NFV 003: "Network Functions Virtualisation (NFV); Terminology for Main Concepts in NFV".
-- [i.2] ETSI GS NFV-IFA 010: "Network Functions Virtualisation (NFV) Release 5; Management and Orchestration; Functional requirements specification".
+[i.1] ETSI GR NFV 003: \"Network Functions Virtualisation (NFV); Terminology for Main Concepts in NFV\".
+
+[i.2] ETSI GS NFV-IFA 010: \"Network Functions Virtualisation (NFV) Release 5; Management and Orchestration; Functional requirements specification\".
# 3 Definition of terms, symbols and abbreviations
@@ -78,7 +77,7 @@ The following referenced documents may be useful in implementing an ETSI deliver
For the purposes of the present document, the terms given in ETSI GR NFV 003 [\[i.1\]](#_ref_i.1) and the following apply:
-> NOTE: A term defined in the present document takes precedence over the definition of the same term, if any, in ETSI GR NFV 003 [\[i.1\]](#_ref_i.1).
+> NOTE: A term defined in the present document takes precedence over the definition of the same term, if any, in ETSI GR NFV 003 [\[i.1\]](#_ref_i.1).
## 3.2 Symbols
@@ -94,18 +93,18 @@ For the purposes of the present document, the abbreviations given in ETSI GR NFV
# 4 Overview
-Editor's Note: This clause will provide overview of PIM function, PIM services and service interfaces.
+Editor's Note: This clause will provide overview of PIM function, PIM services and service interfaces.
## 4.1 Summary of ETSI GS NFV-IFA 053
ETSI GS NFV-IFA 053 [\[1\]](#_ref_1) specifies requirements related to physical infrastructure management services provided by the PIM function. Service interfaces related to following management aspects are produced by the PIM:
-1. Physical resource provisioning and lifecycle management.
-2. Physical resource inventory management.
-3. Physical resource topology management.
-4. Physical resource performance management.
-5. Physical resource fault management.
-6. Physical resource log management.
+1. Physical resource provisioning and lifecycle management.
+2. Physical resource inventory management.
+3. Physical resource topology management.
+4. Physical resource performance management.
+5. Physical resource fault management.
+6. Physical resource log management.
Provisioning and lifecycle management service interface produced by the PIM enables consumers to set up and provision physical resources, including composed physical resources that comprise of multiple physical resources. It also enables physical resource lifecycle management operations including creation, update, querying and deletion of corresponding managed objects related to physical resources that are managed by the PIM. Furthermore, this service interface supports sending notifications to the subscribed consumers about changes related to physical resources.
Inventory management service interface is produced by the PIM, and it enables consumers to query and update inventory information related to physical resources in the NFVI. The service interface also supports providing notifications to subscribed consumers regarding any changes in the inventory information.
@@ -146,7 +145,7 @@ The present clause provides an overview of Redfish® interface specification
- 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.
+Editor's Note: The above list to be updated if other PIM service interfaces can be profiled to the Redfish® interface.
The overview consists of the high-level API structure of the Redfish interface [\[2\]](#_ref_2) and its supported data model for the protocol and data model specification of relevant PIM service interfaces, respectively.
@@ -167,7 +166,7 @@ The basic resource structure of Redfish® interface [\[2\]](#_ref_2) can be g
- /redfish/v1/{resource}/{resource}/.../{resource}; where {resource} can be {collection resource}/{resource} or {resource}.
- Redfish® managed resources can have further child resources, which can be accessed by their individual URIs as shown in the URI patterns above. Possible URI paths for a particular Redfish® data model are specified in the Redfish® data model specification [\[3\]](#_ref_3) for each object. The Redfish® service also offers multiple sub-services, such as, Account Service, Task Service, Composition Service etc. These services and their corresponding resources are also accessible via respective URIs as illustrated in above URI patterns.
-> NOTE: The Redfish® services, e.g., Task Service, Event Service, etc., are essentially Redfish® resources with their schema defined in the Redfish® data model specification [\[3\]](#_ref_3).
+> NOTE: The Redfish® services, e.g., Task Service, Event Service, etc., are essentially Redfish® resources with their schema defined in the Redfish® data model specification [\[3\]](#_ref_3).
Redfish® interface [\[2\]](#_ref_2) enables clients to perform basic CRUD operations on Redfish® resources. Standard HTTP methods like POST, GET, PUT, PATCH and DELETE are used to perform these CRUD operations. Some specific resources also support additional non-CRUD operations, like performing actions on those resources, e.g., restarting a computer system. HTTP POST method is used to perform such actions.
@@ -204,7 +203,7 @@ Data objects and their relevant Redfish® counterpart objects, which are comm
## 5.2 Common data objects
-Editor's Note: If some further objects are identified to be common between multiple PIM service interfaces, those can be specified here to avoid duplication.
+Editor's Note: If some further objects are identified to be common between multiple PIM service interfaces, those can be specified here to avoid duplication.
### 5.2.1 Subscription
@@ -248,7 +247,7 @@ Table 5.3.1-1 lists down the Redfish® objects that map to the physical resou
|-|-|-|
|ComputerSystem|/redfish/v1/Systems/{ComputerSystemId}|Represents a computer system managed by the Redfish® service. Details of its subsystems, such as memory, CPU, storage and network devices are also contained within this resource representation.|
-Editor's Note: The above list to be updated if more relevant Redfish® objects are identified to be mapped against the IFA053 PhysicalResourceInfo object.
+Editor's Note: The above list to be updated if more relevant Redfish® objects are identified to be mapped against the IFA053 PhysicalResourceInfo object.
### 5.3.2 Resource zone object
@@ -321,7 +320,7 @@ The operations supported over this service interface are the following:
## 6.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 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:
@@ -329,7 +328,7 @@ The corresponding Redfish® API roots are specified below:
- /redfish/v1/EventService/Subscriptions
- /redfish/v1/TaskService/TaskMonitors
-Editor's Note: Creation of composed physical system via composition service needs further study. Appropriate endpoints for creating a composed system via composition service URI can be added later if required. Although, clause 15 of Redfish interface specification [\[2\]](#_ref_2) suggests that the same /redfish/v1/Systems endpoint may be used even for creating composed systems. The CompositionService is used for creating a composed system. Once composed that system would appears in the same Systems collection resource.
+Editor's Note: Creation of composed physical system via composition service needs further study. Appropriate endpoints for creating a composed system via composition service URI can be added later if required. Although, clause 15 of Redfish interface specification [\[2\]](#_ref_2) suggests that the same /redfish/v1/Systems endpoint may be used even for creating composed systems. The CompositionService is used for creating a composed system. Once composed that system would appears in the same Systems collection resource.
## 6.3 Resource structure and HTTP methods
@@ -349,7 +348,7 @@ Figures 6.3-1, 6.3-2 and 6.3-3 show resource structures of the Redfish® API
Table 6.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 6.3-1 shall be supported by the PIM. The HTTP methods marked as "CM" (conditional mandatory) shall be supported by the PIM depending on the corresponding condition. The HTTP methods marked as "O" (optional) in the "Cat" column may be optionally supported by the PIM.
+The HTTP methods marked as \"M\" (mandatory) in the \"Cat\" column of table 6.3-1 shall be supported by the PIM. The HTTP methods marked as \"CM\" (conditional mandatory) shall be supported by the PIM depending on the corresponding condition. The HTTP methods marked as \"O\" (optional) in the \"Cat\" column may be optionally supported by the PIM.
**Table 6.3-1: API Resources and HTTP methods of physical resource provisioning and lifecycle management service interface**
@@ -359,30 +358,30 @@ The HTTP methods marked as "M" (mandatory) in the "Cat" column of table 6.3-1 sh
+:================================+:========================================+:====================+:================+:====================================================================+
|Systems |/redfish/v1/Systems |GET |M |Get a collection of Computer Systems. |
| | +---------------------+-----------------+---------------------------------------------------------------------+
-| | |POST |M |Create a new "Individual Computer System" resource. |
+| | |POST |M |Create a new \"Individual Computer System\" resource. |
+---------------------------------+-----------------------------------------+---------------------+-----------------+---------------------------------------------------------------------+
-|Individual Computer System |/redfish/v1/Systems/{ComputerSystemId} |GET |M |Get information about the "Individual Computer System" resource. |
+|Individual Computer System |/redfish/v1/Systems/{ComputerSystemId} |GET |M |Get information about the \"Individual Computer System\" resource. |
| | +---------------------+-----------------+---------------------------------------------------------------------+
-| | |PATCH |M |Modify information of an "Individual Computer System" resource. |
+| | |PATCH |M |Modify information of an \"Individual Computer System\" resource. |
| | +---------------------+-----------------+---------------------------------------------------------------------+
-| | |PUT |O |Replace an "Individual Computer System" resource. |
+| | |PUT |O |Replace an \"Individual Computer System\" resource. |
| | +---------------------+-----------------+---------------------------------------------------------------------+
-| | |DELETE |M |Delete an "Individual Computer System" resource. |
+| | |DELETE |M |Delete an \"Individual Computer System\" resource. |
+---------------------------------+-----------------------------------------+---------------------+-----------------+---------------------------------------------------------------------+
-|Individual Computer System Action|/redfish/v1/Systems/{ComputerSystemId} |POST |M |Performs a qualified action on the "Individual |
-| |/Actions/ComputerSystem.{ActionName} | | |Computer System" resource. |
+|Individual Computer System Action|/redfish/v1/Systems/{ComputerSystemId} |POST |M |Performs a qualified action on the \"Individual |
+| |/Actions/ComputerSystem.{ActionName} | | |Computer System\" resource. |
+---------------------------------+-----------------------------------------+---------------------+-----------------+---------------------------------------------------------------------+
-|Subscriptions |/redfish/v1/EventService/Subscriptions |POST |M |Create a new "Individual Subscription" resource. |
+|Subscriptions |/redfish/v1/EventService/Subscriptions |POST |M |Create a new \"Individual Subscription\" resource. |
| | +---------------------+-----------------+---------------------------------------------------------------------+
| | |GET |M |Get the collection of all available subscriptions. |
+---------------------------------+-----------------------------------------+---------------------+-----------------+---------------------------------------------------------------------+
-|Individual Subscription |/redfish/v1/EventService/Subscriptions/ |GET |M |Get information about the "Individual Subscription" resource. |
+|Individual Subscription |/redfish/v1/EventService/Subscriptions/ |GET |M |Get information about the \"Individual Subscription\" resource. |
| |{SubscriptionId} +---------------------+-----------------+---------------------------------------------------------------------+
-| | |PATCH |M |Modify an "Individual Subscription" resource. |
+| | |PATCH |M |Modify an \"Individual Subscription\" resource. |
| | +---------------------+-----------------+---------------------------------------------------------------------+
-| | |PUT |O |Replace an "Individual Subscription" resource. |
+| | |PUT |O |Replace an \"Individual Subscription\" resource. |
| | +---------------------+-----------------+---------------------------------------------------------------------+
-| | |DELETE |M |Delete 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 1). |
+---------------------------------+-----------------------------------------+---------------------+-----------------+---------------------------------------------------------------------+
@@ -395,7 +394,7 @@ The HTTP methods marked as "M" (mandatory) in the "Cat" column of table 6.3-1 sh
|NOTE 1: 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.\ |
|NOTE 2: The URI of the task monitor is provided in the Location header of the HTTP response to the API consumer |
-|when the API producer returns a "202 Accepted" response. |
+|when the API producer returns a \"202 Accepted\" response. |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
## 6.4 Sequence diagrams (informative)
@@ -417,9 +416,9 @@ The creation of a Computer System resource, as illustrated in Figure 6.4.2-1, co
**Precondition:** None.
1. The API consumer sends a POST request to the Systems resource including a valid representation of the individual Computer System resource in the message content body.
-1. If the PIM supports asynchronous operations and creation of the computer system resource requires some time to process, the PIM returns a "202 Accepted" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
+1. If the PIM supports asynchronous operations and creation of the computer system resource requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
1. The PIM creates an individual Computer System resource.
-1. The PIM returns a "201 Created" response to the API consumer and includes in the message content body a representation of the created Computer System resource. The response also contains the URI of the newly created resource in the Location header.
+1. The PIM returns a \"201 Created\" response to the API consumer and includes in the message content body a representation of the created Computer System resource. The response also contains the URI of the newly created resource in the Location header.
**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the individual Computer System resource has been created.
@@ -438,9 +437,9 @@ The querying of information about one or more Computer System resources, as illu
**Precondition:** One or more individual Computer System resources have been created.
1. If the API consumer intends to get information about multiple Computer System resources, it sends a GET request to the Systems resource.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of a Computer System collection, containing information about all the individual Computer System resources that have been created.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of a Computer System collection, containing information about all the individual Computer System resources that have been created.
1. If the API consumer intends to get information about an individual Computer System resource, it sends a GET request to the Individual Computer System resource identified by its name in the URI.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of the individual Computer System resource.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the individual Computer System resource.
**Postcondition:** None.
@@ -460,9 +459,9 @@ The modification of an individual Computer System resource, as illustrated in Fi
**Precondition:** The individual Computer System resource has been previously created.
1. The API consumer sends a PATCH request to the Individual Computer System resource, including data structure in the message content body representing the modifiable properties to be modified in the individual computer system resource.
-1. If the PIM supports asynchronous operations and modification of the computer system resource requires some time to process, the PIM returns a "202 Accepted" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
+1. If the PIM supports asynchronous operations and modification of the computer system resource requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
1. The PIM modifies the Individual Computer System resource.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of the modified Computer System resource. Alternatively, the PIM can also return a "204 No Content" response to the API consumer indicating successful operation.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the modified Computer System resource. Alternatively, the PIM can also return a \"204 No Content\" response to the API consumer indicating successful operation.
**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the Individual Computer System resource has been modified.
@@ -481,9 +480,9 @@ The replacement of an individual Computer System resource, as illustrated in Fig
**Precondition:** The individual Computer System resource has been previously created.
1. The API consumer sends a PUT request to the Individual Computer System resource including a valid representation of the individual Computer System resource to be replaced in the message content body.
-1. If the PIM supports asynchronous operations and replacement of the computer system resource requires some time to process, the PIM returns a "202 Accepted" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
+1. If the PIM supports asynchronous operations and replacement of the computer system resource requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
1. The PIM replaces the Individual Computer System resource.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of the replaced Computer System resource. Alternatively, the PIM can also return a "204 No Content" response to the API consumer indicating successful operation.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the replaced Computer System resource. Alternatively, the PIM can also return a \"204 No Content\" response to the API consumer indicating successful operation.
**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the Individual Computer System resource has been replaced.
@@ -502,9 +501,9 @@ The deletion of an individual Computer System resource, as illustrated in Figure
**Precondition:** The individual Computer System resource has been previously created.
1. The API consumer sends a DELETE request to the Individual Computer System resource.
-1. If the PIM supports asynchronous operations and deletion of the computer system resource requires some time to process, the PIM returns a "202 Accepted" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
+1. If the PIM supports asynchronous operations and deletion of the computer system resource requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
1. The PIM deletes the individual Computer System resource.
-1. The PIM returns a "204 No Content " response to the API consumer indicating that the resource has been successfully deleted. Alternatively, the PIM can also return a "200 OK" response to the API consumer including a representation of the deleted Computer System resource in the message content body.
+1. The PIM returns a \"204 No Content\" response to the API consumer indicating that the resource has been successfully deleted. Alternatively, the PIM can also return a \"200 OK\" response to the API consumer including a representation of the deleted Computer System resource in the message content body.
**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the Individual Computer System resource has been deleted.
@@ -523,23 +522,23 @@ Performing of an action on an individual Computer System resource, as illustrate
**Precondition:** The individual Computer System resource has been previously created.
1. The API consumer sends a POST request to the Individual Computer System Action resource, indicating a valid action name that is supported by the individual Computer System in the URI. If applicable, the request body also contains parameters for the action.
-1. If the PIM supports asynchronous operations and the desired action requires some time to process, the PIM returns a "202 Accepted" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
+1. If the PIM supports asynchronous operations and the desired action requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
1. The PIM performs the desired action on the individual Computer System resource.
-1. If the desired action does not result in creation of a new resource, the PIM returns a "200 OK" response to the API consumer indicating that the action been performed successfully. The corresponding action response is provided in the response body.
-1. If the desired action results in creation of some new resource, the PIM returns a "201 Created" response to the API consumer indicating that the action been performed successfully. If applicable, action response is provided in the response body. The response also contains the URI of the newly created resource in the Location header.
-1. If the desired action does not result in creation of a new resource and the action's schema does not contain any action response, the PIM returns a "204 No Content" response to the API consumer indicating that the action been performed successfully.
+1. If the desired action does not result in creation of a new resource, the PIM returns a \"200 OK\" response to the API consumer indicating that the action been performed successfully. The corresponding action response is provided in the response body.
+1. If the desired action results in creation of some new resource, the PIM returns a \"201 Created\" response to the API consumer indicating that the action been performed successfully. If applicable, action response is provided in the response body. The response also contains the URI of the newly created resource in the Location header.
+1. If the desired action does not result in creation of a new resource and the action's schema does not contain any action response, the PIM returns a \"204 No Content\" response to the API consumer indicating that the action been performed successfully.
**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the desired action has been performed on the Individual Computer System resource.
**Error handling:** In case of failure, appropriate error information is provided in the response.
-## 6.5 Resources
+## 6.5 Resources
-### 6.5.1 Introduction
+### 6.5.1 Introduction
The present clause specifies API resources (endpoints) of the physical resource provisioning and lifecycle management service interface.
-### 6.5.2 Resource: Systems
+### 6.5.2 Resource: Systems
This resource represents computer systems as composed physical resources managed by the PIM and can be used to retrieve a collection of available computer system resources as well as to create an individual computer system resource.
@@ -560,8 +559,8 @@ The URI query parameters, request and response bodies, and response codes of the
| | | (computer systems) managed | |
| | |by the PIM. | |
| +---------------+---------------------------------+--------------------------------+
-| |POST |Creates a new "Individual |PimPrLcmMgt.001\ |
-| | |Computer System" resource, |PimPrLcmMgt.003 |
+| |POST |Creates a new \"Individual |PimPrLcmMgt.001\ |
+| | |Computer System\" resource, |PimPrLcmMgt.003 |
| | |representing a composed | |
| | |physical resource. | |
| | | | |
@@ -569,7 +568,7 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 6.3-1 for the full URI of this resource. |
+---------------------------------------------------------------------------------------------------------+
-### 6.5.3 Resource: Individual Computer System
+### 6.5.3 Resource: Individual Computer System
This resource represents an individual computer system as a composed physical resource managed by the PIM and can be used to query, update or delete an individual computer system resource.
@@ -598,7 +597,7 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 6.3-1 for the full URI of this resource. |
+-----------------------------------------------------------------------------------------------------------------------------------+
-### 6.5.4 Resource: Individual Computer System Action
+### 6.5.4 Resource: Individual Computer System Action
This resource can be used to perform an action on an individual computer system resource.
@@ -612,8 +611,8 @@ 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 ] |
+:====================================+:==============+:===========================================+:================================+
-|.../Systems/{ComputerSystemId} |POST |Performs an action on "Individual Computer |PimPrLcmMgt.001\ |
-|/Actions/ComputerSystem.{ActionName} | |System" resource,representing a composed |PimPrLcmMgt.003\ |
+|.../Systems/{ComputerSystemId} |POST |Performs an action on \"Individual Computer |PimPrLcmMgt.001\ |
+|/Actions/ComputerSystem.{ActionName} | |System\" resource,representing a composed |PimPrLcmMgt.003\ |
|(see note 1) | |physical resource (see note 2). |PimPrLcmMgt.004 |
+-------------------------------------+---------------+--------------------------------------------+---------------------------------+
|NOTE 1: Refer to Table 6.3-1 for the full URI of this resource.\ |
@@ -623,7 +622,7 @@ The URI query parameters, request and response bodies, and response codes of the
|e.g., Reset, Decommission, AddResourceBlock, SetDefaultBootOrder etc. |
+------------------------------------------------------------------------------------------------------------------------------------+
-### 6.5.5 Resource: Subscriptions
+### 6.5.5 Resource: Subscriptions
This resource represents the subscriptions related to physical resources managed by the PIM and can be used to retrieve a collection of already created subscription resources as well as to create a new individual subscription resource.
@@ -643,12 +642,12 @@ The URI query parameters, request and response bodies, and response codes of the
| | |and lifecycle management of physical | |
| | |resources managed by the PIM. | |
| +------------------+-------------------------------------------------+---------------------------------+
-| |POST |Creates a new "Individual Subscription" resource.|PimPrLcmMgt.005 |
+| |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
+### 6.5.6 Resource: Individual Subscription
This resource represents an individual subscription related to provisioning and lifecycle management of physical resources managed by the PIM, and can be used to query, update or delete the individual subscription resources.
@@ -676,7 +675,7 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 6.3-1 for the full URI of this resource. |
+-----------------------------------+---------------+----------------------------------------------+---------------------------------+
-### 6.5.7 Resource: Individual Task Monitor
+### 6.5.7 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.
@@ -698,13 +697,13 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 6.3-1 for the full URI of this resource. |
+-----------------------------------------------+---------------+-----------------------------------------+------------------------------+
-## 6.6 Data model
+## 6.6 Data model
The request and response data structures of the physical resource provisioning and lifecycle management service interface are defined in the Redfish® data model specification [\[3\]](#_ref_3).
# 7 Physical resource inventory management service interface
-Editor's Note: This clause will profile operations of physical resource inventory management service interface against relevant solution(s).
+Editor's Note: This clause will profile operations of physical resource inventory management service interface against relevant solution(s).
# 8 Physical resource topology management service interface
@@ -726,7 +725,7 @@ The operations supported over this service interface are the following:
## 8.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 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:
@@ -757,7 +756,7 @@ Figures 8.3-1, 8.3-2, 8.3-3 and 8.3-4 show resource structures of the Redfish&re
Table 8.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 8.3-1 shall be supported by the PIM. The HTTP methods marked as "CM" (conditional mandatory) shall be supported by the PIM depending on the corresponding condition. The HTTP methods marked as "O" (optional) in the "Cat" column may be optionally supported by the PIM.
+The HTTP methods marked as \"M\" (mandatory) in the \"Cat\" column of table 8.3-1 shall be supported by the PIM. The HTTP methods marked as \"CM\" (conditional mandatory) shall be supported by the PIM depending on the corresponding condition. The HTTP methods marked as \"O\" (optional) in the \"Cat\" column may be optionally supported by the PIM.
**Table 8.3-1: API Resources and HTTP methods of physical resource topology management service interface**
@@ -767,45 +766,45 @@ The HTTP methods marked as "M" (mandatory) in the "Cat" column of table 8.3-1 sh
+:========================+:================================+:================+:=========+:=========================================================+
|ResourceZones | /redfish/v1/CompositionService |GET |M |Get a collection of Resource Zones. |
| | /ResourceZones +-----------------+----------+----------------------------------------------------------+
-| | |POST |M |Create a new "Individual Resource |
-| | | | |Zone" resource. |
+| | |POST |M |Create a new \"Individual Resource |
+| | | | |Zone\" resource. |
+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
-|Individual Resource Zone | /redfish/v1/CompositionService\ |GET |M |Get information about the "Individual |
-| | | | | Resource Zone" resource. |
+|Individual Resource Zone | /redfish/v1/CompositionService\ |GET |M |Get information about the \"Individual |
+| | | | | Resource Zone\" resource. |
| | /ResourceZones/{ZoneId} +-----------------+----------+----------------------------------------------------------+
| | |PATCH |M |Modify information of an |
-| | | | |"Individual Resource Zone" resource. |
+| | | | |\"Individual Resource Zone\" resource. |
| | +-----------------+----------+----------------------------------------------------------+
-| | |PUT |O |Replace an "Individual Resource Zone" resource. |
+| | |PUT |O |Replace an \"Individual Resource Zone\" resource. |
| | +-----------------+----------+----------------------------------------------------------+
-| | |DELETE |M |Delete an "Individual Resource Zone" resource. |
+| | |DELETE |M |Delete an \"Individual Resource Zone\" resource. |
+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
|Resource Blocks |/redfish/v1/CompositionService\ |GET |M |Get a collection of Resource Zones. |
| |/ResourceBlocks +-----------------+----------+----------------------------------------------------------+
-| | |POST |M |Create a new "Individual Resource Block" resource. |
+| | |POST |M |Create a new \"Individual Resource Block\" resource. |
+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
|Individual Resource Block|/redfish/v1/CompositionService\ |GET |M |Get information about the |
-| | | | |"Individual Resource Block" resource. |
+| | | | |\"Individual Resource Block\" resource. |
| |/ResourceBlocks/{ResourceBlockId}+-----------------+----------+----------------------------------------------------------+
| | |PATCH |M |Modify information of an |
-| | | | |"Individual Resource Block" resource. |
+| | | | |\"Individual Resource Block\" resource. |
| | +-----------------+----------+----------------------------------------------------------+
-| | |PUT |O |Replace an "Individual Resource Block" resource. |
+| | |PUT |O |Replace an \"Individual Resource Block\" resource. |
| | +-----------------+----------+----------------------------------------------------------+
-| | |DELETE |M |Delete an "Individual Resource Block" resource. |
+| | |DELETE |M |Delete an \"Individual Resource Block\" resource. |
+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
-|Subscriptions |/redfish/v1/EventService |POST |M |Create a new "Individual Subscription" resource. |
+|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. |
+| |/Subscriptions/{SubscriptionId} | | |\"Individual Subscription\" resource. |
| | +-----------------+----------+----------------------------------------------------------+
-| | |PATCH |M |Modify an "Individual Subscription" resource. |
+| | |PATCH |M |Modify an \"Individual Subscription\" resource. |
| | +-----------------+----------+----------------------------------------------------------+
-| | |PUT |O |Replace an "Individual Subscription" resource. |
+| | |PUT |O |Replace an \"Individual Subscription\" resource. |
| | +-----------------+----------+----------------------------------------------------------+
-| | |DELETE |M |Delete 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 1). |
@@ -821,12 +820,12 @@ The HTTP methods marked as "M" (mandatory) in the "Cat" column of table 8.3-1 sh
|is used by the API producer to send notifications to the API consumer. |
|This resource is not produced by the API producer.\ |
|NOTE 2: The URI of the task monitor is provided in the Location header |
-|of the HTTP response to the API consumer when the API producer returns a "202 Accepted" response. |
+|of the HTTP response to the API consumer when the API producer returns a \"202 Accepted\" response. |
+---------------------------------------------------------------------------------------------------------------------------------------------------+
-## 8.4 Sequence diagrams (informative)
+## 8.4 Sequence diagrams (informative)
-### 8.4.1 Introduction
+### 8.4.1 Introduction
The sequence diagrams provided in the subsequent sub-clauses are generalized to indicate management of a general topology object, which refers to both the resource zone and physical resource pool objects specified in clause 5 of the present document.
@@ -834,7 +833,7 @@ The diagrams and their description contain placeholders such as <topology obj
Flows related to task monitoring, subscription management and notifications are described in Annex A of the present document.
-### 8.4.2 Creation of a topology object
+### 8.4.2 Creation of a topology object
This clause describes a sequence for creating an individual resource corresponding to a topology management object.
@@ -847,15 +846,15 @@ The creation of a topology object, as illustrated in Figure 8.4.2-1, consists of
**Precondition:** None.
1. The API consumer sends a POST request to the <topology object collection URI> including a valid <topology object> representation in the message content body.
-1. If the PIM supports asynchronous operations and creation of the topology object resource requires some time to process, the PIM returns a "202 Accepted" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
+1. If the PIM supports asynchronous operations and creation of the topology object resource requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
1. The PIM creates an individual topology object.
-1. The PIM returns a "201 Created" response to the API consumer and includes in the message content body a representation of the created topology object. The response also contains the URI of the newly created topology object in the Location header.
+1. The PIM returns a \"201 Created\" response to the API consumer and includes in the message content body a representation of the created topology object. The response also contains the URI of the newly created topology object in the Location header.
**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the individual topology object has been created.
**Error handling:** In case of failure, appropriate error information is provided in the response.
-### 8.4.3 Querying information about topology objects
+### 8.4.3 Querying information about topology objects
This clause describes the sequences for querying information about both multiple and individual topology management objects.
@@ -868,15 +867,15 @@ The querying of information about one or more topology objects, as illustrated i
**Precondition:** One or more individual topology objects have previously been created.
1. If the API consumer intends to get information about multiple topology objects, it sends a GET request to the appropriate <topology object collection URI>.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of a <topology object collection>, containing information about all the individual topology objects that have been created.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of a <topology object collection>, containing information about all the individual topology objects that have been created.
1. If the API consumer intends to get information about an individual topology object, it sends a GET request to the appropriate <topology object URI>.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of the individual topology object.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the individual topology object.
**Postcondition:** None.
**Error handling:** In case of failure, appropriate error information is provided in the response.
-### 8.4.4 Modifying a topology object
+### 8.4.4 Modifying a topology object
This clause describes a sequence for modifying an individual topology object.
@@ -890,15 +889,15 @@ The modification of a topology object, as illustrated in Figure 8.4.4-1, consist
**Precondition:** The individual topology object has been previously created.
1. The API consumer sends a PATCH request to the <topology object URI>, including data structure in the message content body representing the modifiable properties to be modified in the individual topology object.
-1. If the PIM supports asynchronous operations and modification of the topology object requires some time to process, the PIM returns a "202 Accepted" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
+1. If the PIM supports asynchronous operations and modification of the topology object requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
1. The PIM modifies the individual topology object.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of the modified topology object. Alternatively, the PIM can also return a "204 No Content" response to the API consumer indicating successful operation.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the modified topology object. Alternatively, the PIM can also return a \"204 No Content\" response to the API consumer indicating successful operation.
**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the individual topology object has been modified.
**Error handling:** In case of failure, appropriate error information is provided in the response.
-### 8.4.5 Replacing a topology object
+### 8.4.5 Replacing a topology object
This clause describes a sequence for replacing an individual topology object.
@@ -911,15 +910,15 @@ The replacement of an individual topology object, as illustrated in Figure 8.4.5
**Precondition:** The individual topology object has been previously created.
1. The API consumer sends a PUT request to the <topology object URI> including a valid representation of the individual topology object to be replaced in the message content body.
-1. If the PIM supports asynchronous operations and replacement of the topology object requires some time to process, the PIM returns a "202 Accepted" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
+1. If the PIM supports asynchronous operations and replacement of the topology object requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
1. The PIM replaces the individual topology object.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of the replaced topology object. Alternatively, the PIM can also return a "204 No Content" response to the API consumer indicating successful operation.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the replaced topology object. Alternatively, the PIM can also return a \"204 No Content\" response to the API consumer indicating successful operation.
**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the individual topology object has been replaced.
**Error handling:** In case of failure, appropriate error information is provided in the response.
-### 8.4.6 Deleting a topology object
+### 8.4.6 Deleting a topology object
This clause describes a sequence for deleting an individual topology object.
@@ -932,21 +931,21 @@ The deletion of an individual topology object, as illustrated in Figure 8.4.6-1,
**Precondition:** The individual topology object has been previously created.
1. The API consumer sends a DELETE request to the <topology object URI>.
-1. If the PIM supports asynchronous operations and deletion of the topology object requires some time to process, the PIM returns a "202 Accepted" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
+1. If the PIM supports asynchronous operations and deletion of the topology object requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
1. The PIM deletes the individual topology object.
-1. The PIM returns a "204 No Content " response to the API consumer indicating that the topology object has been successfully deleted. Alternatively, the PIM can also return a "200 OK" response to the API consumer including a representation of the deleted topology object in the message content body.
+1. The PIM returns a \"204 No Content\" response to the API consumer indicating that the topology object has been successfully deleted. Alternatively, the PIM can also return a \"200 OK\" response to the API consumer including a representation of the deleted topology object in the message content body.
**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the individual topology object has been deleted.
**Error handling:** In case of failure, appropriate error information is provided in the response.
-## 8.5 Resources
+## 8.5 Resources
-### 8.5.1 Introduction
+### 8.5.1 Introduction
The present clause specifies API resources (endpoints) of the physical resource topology management service interface.
-### 8.5.2 Resource: Resource Zones
+### 8.5.2 Resource: Resource Zones
This resource represents the resource zones within the NFVI managed by the PIM and can be used to retrieve a collection of available resource zones as well as to create an individual resource zone resource.
@@ -956,20 +955,20 @@ The URI query parameters, request and response bodies, and response codes of the
**Table 8.5.2-1: Resource Zones resource methods mapped against PIM service interface requirements**
-+----------------------------+---------------+---------------------------------------------------+---------------------------------+
-|Resource URI |HTTP Method |Meaning |Requirement identifier from\ |
-| | | |ETSI GS NFV-IFA 053 [ 1 ] |
-+:===========================+:==============+:==================================================+:================================+
-|.../ResourceZones (see note)|GET |Lists a collection of available resource zones.\ |PimPrTmMgt.001\ |
-| | |Retrieves physical topology information of |PimPrTmMgt.004 |
-| | |the physical resources managed by the PIM. | |
-| +---------------+---------------------------------------------------+---------------------------------+
-| |POST |Creates a new "Individual Resource Zone" resource. |PimPrTmMgt.004 |
-+----------------------------+---------------+---------------------------------------------------+---------------------------------+
-|NOTE: Refer to Table 8.3-1 for the full URI of this resource. |
-+----------------------------+---------------+---------------------------------------------------+---------------------------------+
-
-### 8.5.3 Resource: Individual Resource Zone
++----------------------------+---------------+-----------------------------------------------------+---------------------------------+
+|Resource URI |HTTP Method |Meaning |Requirement identifier from\ |
+| | | |ETSI GS NFV-IFA 053 [ 1 ] |
++:===========================+:==============+:====================================================+:================================+
+|.../ResourceZones (see note)|GET |Lists a collection of available resource zones.\ |PimPrTmMgt.001\ |
+| | |Retrieves physical topology information of |PimPrTmMgt.004 |
+| | |the physical resources managed by the PIM. | |
+| +---------------+-----------------------------------------------------+---------------------------------+
+| |POST |Creates a new \"Individual Resource Zone\" resource. |PimPrTmMgt.004 |
++----------------------------+---------------+-----------------------------------------------------+---------------------------------+
+|NOTE: Refer to Table 8.3-1 for the full URI of this resource. |
++----------------------------+---------------+-----------------------------------------------------+---------------------------------+
+
+### 8.5.3 Resource: Individual Resource Zone
This resource represents an individual resource zone within the NFVI containing physical resources managed by the PIM and can be used to query, update or delete an individual resource zone resource.
@@ -997,7 +996,7 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 8.3-1 for the full URI of this resource. |
+-------------------------------------+---------------+-----------------------------------------------+---------------------------------+
-### 8.5.4 Resource: Resource Blocks
+### 8.5.4 Resource: Resource Blocks
This resource represents the resource blocks corresponding to logical groupings of physical resources managed by the PIM and can be used to retrieve a collection of available resource blocks as well as to create an individual resource block resource.
@@ -1015,13 +1014,13 @@ The URI query parameters, request and response bodies, and response codes of the
| | |Retrieves logical topology information of |PimPrTmMgt.004 |
| | |the physical resources managed by the PIM.| |
| +---------------+------------------------------------------+---------------------------------+
-| |POST |Creates a new "Individual |PimPrTmMgt.004 |
-| | | Resource Block" resource. | |
+| |POST |Creates a new \"Individual |PimPrTmMgt.004 |
+| | | Resource Block\" resource. | |
+-----------------------------+---------------+------------------------------------------+---------------------------------+
|NOTE: Refer to Table 8.3-1 for the full URI of this resource. |
+-----------------------------+---------------+------------------------------------------+---------------------------------+
-### 8.5.5 Resource: Individual Resource Block
+### 8.5.5 Resource: Individual Resource Block
This resource represents an individual resource block representing a logical grouping of physical resources within the NFVI and can be used to query, update or delete an individual resource block resource.
@@ -1049,7 +1048,7 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 8.3-1 for the full URI of this resource. |
+----------------------------------------------------+------------------------------------------------+---------------------------------+
-### 8.5.6 Resource: Subscriptions
+### 8.5.6 Resource: Subscriptions
This resource represents subscriptions related to topology 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.
@@ -1059,22 +1058,22 @@ The URI query parameters, request and response bodies, and response codes of the
**Table 8.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. |PimPrTmMgt.003 |
-|(see note) | |Retrieves information about the | |
-| | |created subscriptions related to | |
-| | |to topology management of physical | |
-| | |resources managed by the PIM. | |
-| +---------------+-------------------------------------------------+---------------------------------+
-| |POST |Creates a new "Individual Subscription" resource.|PimPrTmMgt.003 |
-+------------------+---------------+-------------------------------------------------+---------------------------------+
-|NOTE: Refer to Table 8.3-1 for the full URI of this resource. |
-+----------------------------------------------------------------------------------------------------------------------+
-
-### 8.5.7 Resource: Individual Subscription
++------------------+---------------+---------------------------------------------------+---------------------------------+
+|Resource URI |HTTP Method |Meaning |Requirement identifier from\ |
+| | | |ETSI GS NFV-IFA 053 [ 1 ] |
++:=================+:==============+:==================================================+:================================+
+|.../Subscriptions |GET |Lists a collection of subscriptions. |PimPrTmMgt.003 |
+|(see note) | |Retrieves information about the | |
+| | |created subscriptions related to | |
+| | |to topology management of physical | |
+| | |resources managed by the PIM. | |
+| +---------------+---------------------------------------------------+---------------------------------+
+| |POST |Creates a new \"Individual Subscription\" resource.|PimPrTmMgt.003 |
++------------------+---------------+---------------------------------------------------+---------------------------------+
+|NOTE: Refer to Table 8.3-1 for the full URI of this resource. |
++------------------------------------------------------------------------------------------------------------------------+
+
+### 8.5.7 Resource: Individual Subscription
This resource represents an individual subscription related to topology management of physical resources managed by the PIM, and can be used to query, update or delete the individual subscription resources.
@@ -1102,7 +1101,7 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 8.3-1 for the full URI of this resource. |
+---------------------------------------------+---------------+----------------------------------------------+---------------------------------+
-### 8.5.8 Resource: Individual Task Monitor
+### 8.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.
@@ -1123,7 +1122,7 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 8.3-1 for the full URI of this resource. |
+---------------------------------------------------------------------------------------------------------------------------------------------------+
-## 8.6 Data model
+## 8.6 Data model
The request and response data structures of the physical resource topology management service interface are defined in the Redfish® data model specification [\[3\]](#_ref_3).
@@ -1145,7 +1144,7 @@ The operations supported over this service interface are the following:
## 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 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:
@@ -1176,8 +1175,8 @@ Figures 9.3-1, 9.3-2, 9.3-3 and 9.3-4 show resource structures of the Redfish&re
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. The HTTP methods marked as "CM" (conditional mandatory) shall be supported by the PIM depending on the corresponding condition.
-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. The HTTP methods marked as "CM" (conditional mandatory) shall be supported by the PIM depending on the corresponding condition.
+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. The HTTP methods marked as \"CM\" (conditional mandatory) shall be supported by the PIM depending on the corresponding condition.
+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. The HTTP methods marked as \"CM\" (conditional mandatory) shall be supported by the PIM depending on the corresponding condition.
**Table 9.3-1: API Resources and HTTP methods of physical resource performance management service interface**
@@ -1187,27 +1186,27 @@ The HTTP methods marked as "M" (mandatory) in the "Cat" column of table 9.3-1 sh
+:========================+:================================+:================+:=========+:=========================================================+
|PmJobs | /redfish/v1/TelemetryService\ |GET |M |Get a collection of PmJobs. |
| | /MetricReportDefinitions +-----------------+----------+----------------------------------------------------------+
-| | |POST |M |Create a new "IndividualPmJob" resource. |
+| | |POST |M |Create a new \"IndividualPmJob\" resource. |
+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
-|IndividualPmJob | /redfish/v1/TelemetryService\ |GET |M |Get information about the "IndividualPmJob" resource |
+|IndividualPmJob | /redfish/v1/TelemetryService\ |GET |M |Get information about the \"IndividualPmJob\" resource |
| |/MetricReportDefinitions\ +-----------------+----------+----------------------------------------------------------+
-| |{MetricReportDefinitionId} |PATCH |M |Modify information of an "IndividualPmJob" resource. |
+| |{MetricReportDefinitionId} |PATCH |M |Modify information of an \"IndividualPmJob\" resource. |
| | +-----------------+----------+----------------------------------------------------------+
-| | |PUT |O |Replace an "IndividualPmJob" resource. |
+| | |PUT |O |Replace an \"IndividualPmJob\" resource. |
| | +-----------------+----------+----------------------------------------------------------+
-| | |DELETE |M |Delete 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. |
+| | |POST |M |Create a new \"Individual Threshold\" resource. |
+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
-|Individual Threshold |/redfish/v1/TelemetryService\ |GET |M |Get information about an 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. |
+| | |PATCH |M |Modify an Individual Threshold\" resource. |
| | +-----------------+----------+----------------------------------------------------------+
-| | |PUT |O |Replace an Individual Threshold" resource. |
+| | |PUT |O |Replace an Individual Threshold\" resource. |
| | +-----------------+----------+----------------------------------------------------------+
-| | |DELETE |M |Delete an Individual Threshold" resource. |
+| | |DELETE |M |Delete an Individual Threshold\" resource. |
+-------------------------+---------------------------------+-----------------+----------+----------------------------------------------------------+
|Performance Reports |/redfish/v1/TelemetryService\ |GET |M |Retrieve a collection of PerformancReports. |
| |/MetricReports | | | |
@@ -1215,18 +1214,18 @@ The HTTP methods marked as "M" (mandatory) in the "Cat" column of table 9.3-1 sh
|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 |/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. |
+| |/Subscriptions/{SubscriptionId} | | |\"Individual Subscription\" resource. |
| | +-----------------+----------+----------------------------------------------------------+
-| | |PATCH |M |Modify an "Individual Subscription" resource. |
+| | |PATCH |M |Modify an \"Individual Subscription\" resource. |
| | +-----------------+----------+----------------------------------------------------------+
-| | |PUT |O |Replace an "Individual Subscription" resource. |
+| | |PUT |O |Replace an \"Individual Subscription\" resource. |
| | +-----------------+----------+----------------------------------------------------------+
-| | |DELETE |M |Delete 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 1). |
@@ -1247,18 +1246,18 @@ The HTTP methods marked as "M" (mandatory) in the "Cat" column of table 9.3-1 sh
|is used by the API producer to send notifications to the API consumer. |
|This resource is not produced by the API producer. |
|NOTE 2: See clause 9.4.8 for the flow related to the API consumers receiving |
-|performance reports asynchronously as notifications. . |
+|performance reports asynchronously as notifications. |
|NOTE 3: The URI of the task monitor is provided in the Location header |
-|of the HTTP response to the API consumer when the API producer returns a "202 Accepted" response. |
+|of the HTTP response to the API consumer when the API producer returns a \"202 Accepted\" response. |
|NOTE 2: See clause 9.4.8 for the flow related to the API consumers receiving |
-|performance reports asynchronously as notifications. . |
+|performance reports asynchronously as notifications. |
|NOTE 3: The URI of the task monitor is provided in the Location header |
-|of the HTTP response to the API consumer when the API producer returns a "202 Accepted" response. |
+|of the HTTP response to the API consumer when the API producer returns a \"202 Accepted\" response. |
+---------------------------------------------------------------------------------------------------------------------------------------------------+
-## 9.4 Sequence diagrams (informative)
+## 9.4 Sequence diagrams (informative)
-### 9.4.1 Introduction
+### 9.4.1 Introduction
The sequence diagrams provided in the subsequent sub-clauses are generalized to indicate management of a generic performance management (PM) related object, which refers to either PmJob or Threshold specified in clause 5 of the present document. These diagrams and their description contain placeholders such as <PM object collection URI>, <PM object URI> and <PM object>, which correspond to the appropriate resource URIs and PM-related objects specified in clauses 9.3 and 5.4 respectively.
@@ -1266,7 +1265,7 @@ Sequence diagrams related to retrieval of performance reports do not contain gen
Flows related to task monitoring, subscription management and notifications are described in Annex A of the present document.
-### 9.4.2 Creation of a PM object
+### 9.4.2 Creation of a PM object
This clause describes a sequence for creating an individual resource corresponding to a PM object.
@@ -1279,15 +1278,15 @@ The creation of a PM object, as illustrated in Figure 9.4.2-1, consists of the f
**Precondition:** None.
1. The API consumer sends a POST request to the <PM object collection URI> including a valid <PM object> representation in the message content body.
-1. If the PIM supports asynchronous operations and creation of the PM object resource requires some time to process, the PIM returns a "202 Accepted" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
+1. If the PIM supports asynchronous operations and creation of the PM object resource requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
1. The PIM creates an individual PM object.
-1. The PIM returns a "201 Created" response to the API consumer and includes in the message content body a representation of the created PM object. The response also contains the URI of the newly created PM object in the Location header.
+1. The PIM returns a \"201 Created\" response to the API consumer and includes in the message content body a representation of the created PM object. The response also contains the URI of the newly created PM object in the Location header.
**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the individual PM object has been created.
**Error handling:** In case of failure, appropriate error information is provided in the response.
-### 9.4.3 Querying information about PM objects
+### 9.4.3 Querying information about PM objects
This clause describes the sequences for querying information about multiple and individual PM objects.
@@ -1300,15 +1299,15 @@ The querying of information about one or more PM objects, as illustrated in Figu
**Precondition:** One or more individual PM objects have previously been created.
1. If the API consumer intends to get information about multiple PM objects, it sends a GET request to the <PM object collection URI>.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of a <PM object collection>, containing information about all the individual PM objects that have been created.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of a <PM object collection>, containing information about all the individual PM objects that have been created.
1. If the API consumer intends to get information about an individual PM object, it sends a GET request to the <PM object URI>.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of the individual PM object.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the individual PM object.
**Postcondition:** None.
**Error handling:** In case of failure, appropriate error information is provided in the response.
-### 9.4.4 Modifying a PM object
+### 9.4.4 Modifying a PM object
This clause describes a sequence for modifying an individual PM object.
@@ -1321,15 +1320,15 @@ The modification of a PM object, as illustrated in Figure 9.4.4-1, consists of t
**Precondition:** The individual PM object has been previously created.
1. The API consumer sends a PATCH request to the <PM object URI>, including data structure in the message content body representing the modifiable properties to be modified in the individual PM object.
-1. If the PIM supports asynchronous operations and modification of the PM object requires some time to process, the PIM returns a "202 Accepted" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
+1. If the PIM supports asynchronous operations and modification of the PM object requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
1. The PIM modifies the individual PM object.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of the modified PM object. Alternatively, the PIM can also return a "204 No Content" response to the API consumer indicating successful operation.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the modified PM object. Alternatively, the PIM can also return a \"204 No Content\" response to the API consumer indicating successful operation.
**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the individual PM object has been modified.
**Error handling:** In case of failure, appropriate error information is provided in the response.
-### 9.4.5 Replacing a PM object
+### 9.4.5 Replacing a PM object
This clause describes a sequence for replacing an individual PM object.
@@ -1342,15 +1341,15 @@ The replacement of an individual PM object, as illustrated in Figure 9.4.5-1, co
**Precondition:** The individual PM object has been previously created.
1. The API consumer sends a PUT request to the <PM object URI> including a valid representation of the individual PM object to be replaced in the message content body.
-1. If the PIM supports asynchronous operations and replacement of the PM object requires some time to process, the PIM returns a "202 Accepted" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
+1. If the PIM supports asynchronous operations and replacement of the PM object requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
1. The PIM replaces the individual PM object.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of the replaced PM object. Alternatively, the PIM can also return a "204 No Content" response to the API consumer indicating successful operation.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the replaced PM object. Alternatively, the PIM can also return a \"204 No Content\" response to the API consumer indicating successful operation.
**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the individual PM object has been replaced.
**Error handling:** In case of failure, appropriate error information is provided in the response.
-### 9.4.6 Deleting a PM object
+### 9.4.6 Deleting a PM object
This clause describes a sequence for deleting an individual PM object.
@@ -1363,15 +1362,15 @@ The deletion of an individual PM object, as illustrated in Figure 9.4.6-1, consi
**Precondition:** The individual PM object has been previously created.
1. The API consumer sends a DELETE request to the <PM object URI>.
-1. If the PIM supports asynchronous operations and deletion of the PM object requires some time to process, the PIM returns a "202 Accepted" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
+1. If the PIM supports asynchronous operations and deletion of the PM object requires some time to process, the PIM returns a \"202 Accepted\" response. The response also contains the URI of the associated Task Monitor in the Location header. The response body can optionally contain representation of the corresponding Task resource created by the PIM for this asynchronous operation.
1. The PIM deletes the individual PM object.
-1. The PIM returns a "204 No Content " response to the API consumer indicating that the PM object has been successfully deleted. Alternatively, the PIM can also return a "200 OK" response to the API consumer including a representation of the deleted PM object in the message content body.
+1. The PIM returns a \"204 No Content\" response to the API consumer indicating that the PM object has been successfully deleted. Alternatively, the PIM can also return a \"200 OK\" response to the API consumer including a representation of the deleted PM object in the message content body.
**Postcondition:** Upon successful completion of the synchronous operation or of the corresponding task in case of asynchronous operation, the individual PM object has been deleted.
**Error handling:** In case of failure, appropriate error information is provided in the response.
-### 9.4.7 Retrieving performance reports
+### 9.4.7 Retrieving performance reports
This clause describes the sequence for querying information about multiple and individual performance reports.
@@ -1384,9 +1383,9 @@ The querying of information about one or more performance reports, as illustrate
**Precondition:** One or more individual performance reports have previously been generated by the PIM.
1. If the API consumer intends to get information about multiple performance reports, it sends a GET request to the performance reports URI.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of a collection of performance reports, containing information about all the individual performance reports that have been generated.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of a collection of performance reports, containing information about all the individual performance reports that have been generated.
1. If the API consumer intends to get information about an individual performance report, it sends a GET request to the URI representing individual performance report.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of the individual performance report.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the individual performance report.
**Postcondition:** None.
@@ -1410,13 +1409,13 @@ The procedure consists of the following steps as illustrated in figure 9.4.8-1.
**Error handling:** None.
-## 9.5 Resources
+## 9.5 Resources
-### 9.5.1 Introduction
+### 9.5.1 Introduction
The present clause specifies API resources (endpoints) of the physical resource performance management service interface.
-### 9.5.2 Resource: PmJobs
+### 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.
@@ -1435,12 +1434,12 @@ The URI query parameters, request and response bodies, and response codes of the
| | |collecting metrics related to physical resources \ | |
| | |managed by the PIM. | |
| +---------------+---------------------------------------------------+---------------------------------+
-| |POST |Creates a new "Individual PmJob" resource. |PimPrPmMgt.003 |
+| |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
+### 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.
@@ -1468,7 +1467,7 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 9.3-1 for the full URI of this resource. |
+-------------------------------------+---------------+-----------------------------------------------+---------------------------------+
-### 9.5.4 Resource: Thresholds
+### 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.
@@ -1489,7 +1488,7 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 9.3-1 for the full URI of this resource. |
+-----------------------------+---------------+------------------------------------------+---------------------------------+
-### 9.5.5 Resource: Individual Threshold
+### 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.
@@ -1516,7 +1515,7 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 9.3-1 for the full URI of this resource. |
+----------------------------------------------------+------------------------------------------------+---------------------------------+
-### 9.5.6 Resource: Performance Reports
+### 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.
@@ -1536,7 +1535,7 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 9.3-1 for the full URI of this resource. |
+---------------------------------------------------------------------------------------------------------------------------------------------------+
-### 9.5.7 Resource: Individual Performance Report
+### 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.
@@ -1556,7 +1555,7 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 9.3-1 for the full URI of this resource. |
+---------------------------------------------------------------------------------------------------------------------------------------------------+
-### 9.5.8 Resource: Subscriptions
+### 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 asynchronously as notifications.
@@ -1584,7 +1583,7 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 9.3-1 for the full URI of this resource. |
+----------------------------------------------------------------------------------------------------------------------+
-### 9.5.9 Resource: Individual Subscription
+### 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.
@@ -1612,7 +1611,7 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 9.3-1 for the full URI of this resource. |
+---------------------------------------------+---------------+----------------------------------------------+---------------------------------+
-### 9.5.10 Resource: Individual Task Monitor
+### 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.
@@ -1633,17 +1632,17 @@ The URI query parameters, request and response bodies, and response codes of the
|NOTE: Refer to Table 9.3-1 for the full URI of this resource. |
+---------------------------------------------------------------------------------------------------------------------------------------------------+
-## 9.6 Data model
+## 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).
+Editor's Note: This clause will profile operations of physical resource fault management service interface against relevant solution(s).
# 11 Physical resource log management service interface
-Editor's Note: This clause will profile operations of physical resource log management service interface against relevant solution(s).
+Editor's Note: This clause will profile operations of physical resource log management service interface against relevant solution(s).
@@ -1669,20 +1668,20 @@ The procedure consists of the following steps as illustrated in figure A.2-1:
1. The API consumer sends a POST request to the Subscriptions resource including a valid representation of the individual Subscription resource in the message content body.
1. The PIM creates an individual Subscription resource.
-1. The PIM returns a "201 Created" response to the API consumer and includes in the message content body a representation of the created Subscription resource. The response also contains the URI of the newly created resource in the Location header.
+1. The PIM returns a \"201 Created\" response to the API consumer and includes in the message content body a representation of the created Subscription resource. The response also contains the URI of the newly created resource in the Location header.
1. If the API consumer intends to get information about multiple Subscription resources, it sends a GET request to the Subscriptions resource.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of a Subscriptions collection, containing information about all the individual Subscription resources that have been created.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of a Subscriptions collection, containing information about all the individual Subscription resources that have been created.
1. If the API consumer intends to get information about an individual Subscription resource, it sends a GET request to the Individual Subscription resource identified by its name in the URI.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of the individual Subscription resource.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the individual Subscription resource.
1. The API consumer sends a PATCH request to the Individual Subscription resource, including data structure in the message content body representing the modifiable properties to be modified in the Individual Subscription resource.
1. The PIM modifies the Individual Subscription resource.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of the modified Subscription resource. Alternatively, the PIM can also return a "204 No Content" response to the API consumer indicating successful operation.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the modified Subscription resource. Alternatively, the PIM can also return a \"204 No Content\" response to the API consumer indicating successful operation.
1. The API consumer sends a PUT request to the Individual Subscription resource including a valid representation of the individual Subscription resource to be replaced in the message content body.
1. The PIM replaces the Individual Subscription resource.
-1. The PIM returns a "200 OK" response to the API consumer and includes in the message content body a representation of the replaced Subscription resource. Alternatively, the PIM can also return a "204 No Content" response to the API consumer indicating successful operation.
+1. The PIM returns a \"200 OK\" response to the API consumer and includes in the message content body a representation of the replaced Subscription resource. Alternatively, the PIM can also return a \"204 No Content\" response to the API consumer indicating successful operation.
1. The API consumer sends a DELETE request to the Individual Subscription resource.
1. The PIM deletes the individual Subscription resource.
-1. The PIM returns a "204 No Content " response to the API consumer indicating that the resource has been successfully deleted. Alternatively, the PIM can also return a "200 OK" response to the API consumer including a representation of the deleted Subscription resource in the message content body.
+1. The PIM returns a \"204 No Content\" response to the API consumer indicating that the resource has been successfully deleted. Alternatively, the PIM can also return a \"200 OK\" response to the API consumer including a representation of the deleted Subscription resource in the message content body.
**Error handling:** The PIM rejects a subscription management request if the subscription representation in the creation or replacement request is not valid, or properties in the modify request are not modifiable, etc. In case of failure, appropriate error information is provided in the response.
@@ -1704,13 +1703,13 @@ The procedure consists of the following steps as illustrated in figure A.3-1.
**Error handling:** None.
-Editor's Note: To further check in Redfish interface specs and potentially with DMTF Redfish experts about the standard response (if any) from API consumer when it receives a notification from Redfish event service.
+Editor's Note: To further check in Redfish interface specs and potentially with DMTF Redfish experts about the standard response (if any) from API consumer when it receives a notification from Redfish event service.
## A.4 Flow of monitoring tasks related to asynchronous operations (polling method)
This clause describes the procedure for the API consumer to monitor tasks related to asynchronous operations that the PIM has been performing upon receiving a valid request for that operation from the API consumer.
-The following sequence refers to the "polling method" where the API consumer periodically polls the Task Monitor resource for monitoring the status of an asynchronous operation.
+The following sequence refers to the \"polling method\" where the API consumer periodically polls the Task Monitor resource for monitoring the status of an asynchronous operation.
@@ -1718,10 +1717,10 @@ The following sequence refers to the "polling method" where the API consumer per
The procedure consists of the following steps as illustrated in figure A.4-1.
-**Precondition:** The API consumer has received a "202 Accepted" response from the PIM along with the URI for the Task Monitor resource in the Location header of the response.
+**Precondition:** The API consumer has received a \"202 Accepted\" response from the PIM along with the URI for the Task Monitor resource in the Location header of the response.
1. The API consumer sends a GET request to the Individual Task Monitor resource identified by its URI that the consumer has previously received from the API producer in response to the asynchronous operation request.
-1. If the PIM is performing the task associated with the requested operation, the API consumer receives the "202 Accepted" response from the PIM.
+1. If the PIM is performing the task associated with the requested operation, the API consumer receives the \"202 Accepted\" response from the PIM.
1. Once the asynchronous operation has been completed successfully, the PIM updates the task state in the corresponding Task resource that is managed by the Task Service.
1. The PIM sends the response to the API consumer with appropriate status code, headers and response body that would have been sent as a synchronous response to the requested operation.
@@ -1733,7 +1732,7 @@ The procedure consists of the following steps as illustrated in figure A.4-1.
This clause describes the procedure for the API consumer to monitor tasks related to asynchronous operations that the PIM has been performing upon receiving a valid request for that operation from the API consumer.
-The following sequence refers to the "subscribe/notify method" where the API consumer subscribes to state changes in the Task resource associated with the ongoing asynchronous operation. Once the API consumer gets notified about the completion of said Task, it accesses the corresponding Task Monitor resource to get the result of the asynchronous operation.
+The following sequence refers to the \"subscribe/notify method\" where the API consumer subscribes to state changes in the Task resource associated with the ongoing asynchronous operation. Once the API consumer gets notified about the completion of said Task, it accesses the corresponding Task Monitor resource to get the result of the asynchronous operation.
@@ -1741,14 +1740,14 @@ The following sequence refers to the "subscribe/notify method" where the API con
The procedure consists of the following steps as illustrated in figure A.5-1.
-**Precondition:** The API consumer has received a "202 Accepted" response from the PIM along with the representation of the associated Task resource in the response body, and the URI for the Task Monitor resource in the Location header of the response.
+**Precondition:** The API consumer has received a \"202 Accepted\" response from the PIM along with the representation of the associated Task resource in the response body, and the URI for the Task Monitor resource in the Location header of the response.
1. The API consumer subscribes to get notified about completion of the task associated with asynchronous operation using the Redfish® Event Service.
1. The PIM creates the subscription.
1. The PIM sends the response to API consumer indicating successful subscription creation.
1. Once the asynchronous operation has been completed successfully, the PIM updates the task state in the corresponding Task resource that is managed by the Task Service.
1. The API consumer receives an event notification about completion of the task associated with the asynchronous operation.
-1. The API consumer sends a GET request to the Individual Task Monitor resource identified by its URI that the consumer has previously received from the PIM in the "202 Accepted" response to the asynchronous operation request (see precondition).
+1. The API consumer sends a GET request to the Individual Task Monitor resource identified by its URI that the consumer has previously received from the PIM in the \"202 Accepted\" response to the asynchronous operation request (see precondition).
1. The PIM sends the response to the API consumer with appropriate status code, headers and response body that would have been sent as a synchronous response to the requested operation.
**Postcondition:** None.
@@ -1770,20 +1769,20 @@ The procedure consists of the following steps as illustrated in figure A.5-1.
# Annex (informative): Change history
|Date|Version|Information about changes|
-|-|-|-|
+|:-|:-|:-|
|November 2024|V0.0.1|Initial skeleton of the GS.|
-|December 2024|V0.0.2|Implements following contributions:
NFVSOL(24)000448, NFVSOL(24)000449r1, NFVSOL(24)000456r1|
-|June 2025|V0.0.3|Implements following contributions:
NFVSOL(25)000181r3, NFVSOL(25)000218r1, NFVSOL(25)000192r1|
-|August 2025|V0.0.4|Implements following contributions:
NFVSOL(25)000260r2, NFVSOL(25)000261r1, NFVSOL(25)000274r1|
-|September 2025|V0.0.5|Implements following contributions:
NFVSOL(25)000300, NFVSOL(25)000301r1, NFVSOL(25)000302r1, NFVSOL(25)000311|
-|October 2025|V0.0.6|Implements following contributions:
NFVSOL(25)000335, NFVSOL(25)000336, NFVSOL(25)000337, NFVSOL(25)000338|
+|December 2024|V0.0.2|Implements following contributions:
NFVSOL(24)000448,
NFVSOL(24)000449r1,
NFVSOL(24)000456r1|
+|June 2025|V0.0.3|Implements following contributions:
NFVSOL(25)000181r3,
NFVSOL(25)000218r1,
NFVSOL(25)000192r1|
+|August 2025|V0.0.4|Implements following contributions:
NFVSOL(25)000260r2,
NFVSOL(25)000261r1,
NFVSOL(25)000274r1|
+|September 2025|V0.0.5|Implements following contributions:
NFVSOL(25)000300,
NFVSOL(25)000301r1,
NFVSOL(25)000302r1,
NFVSOL(25)000311|
+|October 2025|V0.0.6|Implements following contributions:
NFVSOL(25)000335,
NFVSOL(25)000336,
NFVSOL(25)000337,
NFVSOL(25)000338|
|November 2025|V0.0.7|The first version created using the SOL026 repository on ETSI Forge, no technical changes on top of v0.0.6|
-|November 2025|V0.0.8|Implements following contributions:
NFVSOL(25)000393, NFVSOL(25)000402, NFVSOL(25)000404|
-|November 2025|V0.0.9|Implements following contributions:
NFVSOL(25)000411r1, NFVSOL(25)000412|
+|November 2025|V0.0.8|Implements following contributions:
NFVSOL(25)000393,
NFVSOL(25)000402,
NFVSOL(25)000404|
+|November 2025|V0.0.9|Implements following contributions:
NFVSOL(25)000411r1,
NFVSOL(25)000412|
-## History
+# History
+-------------------------------------+
|Document history |