Retrieval of PVU and RVU node reports

You use the GET operation on the reports/pvusubcapnodes|pvufullcapnodes|rvusubcapnodes|rvufullcapnodes elements to request information about processor value unit (PVU) and resource value unit (RVU) node reports.

An icon representing a user. You must have the View License Metrics permission to perform this task.

Table 1. Operation descriptions

The table consists of two columns and 15 rows. For the eleventh row there are two levels.
Operation details Description
Operation
  • GET/reports/pvusubcapnodes
  • GET/reports/pvufullcapnodes
  • GET/reports/rvusubcapnodes
  • GET/reports/rvufullcapnodes
Purpose Returns a list of PVU or RVU full capacity or subcapacity node reports.
HTTP method GET
Resource URI
  • https://server_host_name:port_number/api/sam/reports/pvusubcapnodes
  • https://server_host_name:port_number/api/sam/reports/pvufullcapnodes
  • https://server_host_name:port_number/api/sam/reports/rvusubcapnodes
  • https://server_host_name:port_number/api/sam/reports/rvufullcapnodes
URL link relation n/a
URL query parameters For a list of applicable query parameters, see: Query parameters.
Request headers
Header
Accept-Language (optional)
Values
en-US (only English is supported)

Used to negotiate the language of the response. If this header is not specified, the content is returned in the server language.
Request payload n/a
Request Content-Type
  • Application/json
Response headers
Header
Content-Type
Values
Application/json

Specifies the content type of the response.
Header
Content-Language
Values
en-US, …

Specifies the language of the response content. If this header is not specified, the content is returned in the server language.
Response payload reports element
Response Content-Type
  • Application/json
Normal HTTP response codes
  • 200 – OK
Error HTTP response codes
  • 400 – “Bad Request" if a query parameter contains errors or is missing
  • 401 – “Unauthorized" if the user is not authorized to perform the operation

Message body includes an error message with details.

Query parameters

You can use query parameters to narrow down the results of your search. The following table presents query parameters that you can use for the reports/pvusubcapnodes|pvufullcapnodes|rvusubcapnodes|rvufullcapnodes elements.

Table 2. Query parameters for retrieving PVU and RVU subcapacity and full capacity reports

The table consists of four columns and 11 rows.
Parameter Description Required Value
criteria Filtering criteria, expressed in the following format: 
<connector>:[[<input parameter>,
<operator>,<value>,....]]
For example: 
criteria=and:[[nodename,=,TAG1]]
For the list of input parameters, see: Filtering parameters. 		No
enddate The query end date. Yes Date in the YYYY-MM-DD format
format Returns data in JSON format. Yes json
limit The number of rows to be returned. No Numeric Default: 50
offset The number of the first row of data to be returned. No Numeric Default: 0
order[] The parameter can be used to sort the results. The format is:
order[]=<column>+<dir>
where:
  • <column> is the column name
  • <dir> is the direction of the sort. The valid values are asc (ascending) and desc (descending).
For example: 
order[]=processors+asc
Restriction: You can specify only one sort parameter.
 No
productid The identifier of the product.

Use the GET operation on the swinventory/products element to get product identifiers.

 Yes Numeric
quantity The quantity of PVU or RVU licenses used by the product.

Use the GET operation on the reports/metrics element to get the quantity of PVUs or RVUs used.

 Yes Numeric
reportgroupid Identifier of the report group to which the computer that has the software installed belongs. No Numeric Default: 1
startdate The query start date. Yes Date in the YYYY-MM-DD format
token A unique user authentication identifier. Yes Alphanumeric

Filtering parameters

The following table describes extra filtering input parameters. The response output uses the same information items as the input parameters.

Table 3. Input parameters and response output

The table consists of three columns and 10 rows.
Filtering parameter Description Value
comment The comment code that is returned from the server. It contains information that is related to nodes. The following is a list of possible values:
  • 0 - No comment
  • 1 - Incomplete virtualization hierarchy
  • 2 - All instances are excluded
Restriction: The comment cannot be used to filter or sort your search results.
 Numeric
cores The CPU core full capacity or CPU core subcapacity. Numeric
coreslimit The limit of the CPU core subcapacity. The parameter is applicable only to subcapacity reports. Numeric
nodeid The identifier of the node (server) that hosts the product. Numeric
nodename The name of the node (server) that hosts the product. String
processor The name of the processor that is available to the product. String
pvus PVU only. The quantity of used licenses. Numeric
pvuslimit PVU only. The limit of PVU subcapacity. The parameter is applicable only to subcapacity reports. Numeric
reportgroupid Identifier of the report group to which the computer that has the software installed belongs. Numeric

Example commands

The following list shows example commands.
  • http://localhost:9080/api/sam/reports/rvusubcapnodes?token=
7adc3efb175e2bc0f4484bdd2efca54a8fa04623?&format=json&enddate=2013-04-26
&startdate=2013-01-15&productid=1&quantity=900
  • http://localhost:9080/api/sam/reports/pvufullcapnodes?token=
7adc3efb175e2bc0f4484bdd2efca54a8fa04623&format=json&enddate=2013-04-26
&startdate=2013-01-15&productid=4&quantity=2800

Example HTTP conversation

Request
GET /ibm/sua/api/sam/reports/rvusubcapnodes?token=
7adc3efb175e2bc0f4484bdd2efca54a8fa04623?&format=json&enddate=2013-04-26
&startdate=2013-01-15&productid=1&quantity=900 HTTP/1.1
Host: localhost:9080 
Accept: application/json 
Accept-Language: en-US
Response header
HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US
Response body (JSON) for RVU subcapacity
[
{ "reportgroupid":1,
  "coreslimit":1,
  "nodename":"IBM 8676 KBRD742",
  "comment":0,
  "processor":"Intel(R) Xeon(R) or Pentium(R) Single-core All Existing",
  "cores":1,
  "nodeid":4}
]
Response body (JSON) for PVU full capacity
[
{ "reportgroupid":1,
  "coreslimit":1,
  "nodename":"IBM 8676 KBRD742",
  "comment":0,
  "processor":"Intel(R) Xeon(R) or Pentium(R) Single-core All Existing",
  "cores":1,
  "nodeid":4}
]