Retrieval of information related to logical partition capacity (v2)

Available from 9.2.12. You use the GET operation on the api/sam/v2/detailed_hw_lpars element to request information related to the logical partition and its CPU resources. The data retrieved by this API is not limited to LPARs on POWER. It includes data related to every supported virtualization technology.


User You must have the View Endpoints and View Hardware Inventory permission to use this API.

Resource URL


Resource information

Table 1. Resource information
Operation details Description
HTTP method GET
Request headers
Accept-Language (optional)
en-US (only English is supported)

Negotiates the language of the response. If the header is not specified, the content is returned in the server language.

Request format application/json
Response headers

Specifies the content type of the response.

en-US, …

Specifies the language of the response content. If the header is not specified, the content is returned in the server language.

Response payload LPARS element
Response format application/json
Response codes

200 – OK

500 – "Bad Request" if a query parameter contains errors or is missing

Schema description

To retrieve the list of all columns that are returned by this REST API together with their descriptions, use the following request.
GET api/sam/v2/schemas/detailed_hw_lpar.json?token=token

Available columns

The list of attributes related to the logical partition and its CPU resources.

The scan output contains a single instance of each attribute from this group.

Table 2. Columns with information about the logical partition and its CPU resources
Property Description Type
id Identifier of the record. Integer
computer_id Identifier of the computer as specified in the BigFix Inventory database. Integer
updated_at Date and time when the current information was imported to BigFix Inventory. String
lpar_capacity_in_cores The number of processor cores assigned to the partition. String
lpar_online_processor_count The number of active logical processors in the partition. Logical processors are the smallest CPU entities visible in the operating system, which are dividable and schedulable. Depending on the hardware platform, a logical processor might correspond to a chip, the core of a multi-core chip, or a hardware CPU thread on a multithreaded chip or core (provided that the feature is enabled). String
lpar_online_core_count The number of active cores in a logical partition. The core is active if any of the logical processors in the system is running on this core. String
lpar_online_package_count The number of active processor packages in the partition. The processor package is active if any of the logical processors in the system is running on this package. String

Related APIs

This API can be associated with the following API:

Query parameters

Table 3. Query parameters
Parameter Description Required Value
columns[] Specify which columns to retrieve. If you do not specify this parameter, only default columns are retrieved.
Example: Retrieve the computer id:
order Specify how to sort the returned data. The default direction for sorting columns is ascending. If you want to specify a descending sort, append desc to the column name.
Example: Order by computer ID descending:
URL?order[]=computer_id desc
limit Specify the number of rows to retrieve. If you omit this parameter, all rows are retrieved.
Example: Retrieve 100 records
Note: By default the limit parameter for this API is set to 100000.
offset Specify the number of rows to skip for retrieving results. You can use it together with the limit parameter to paginate results.
Example: Retrieve 50 records starting after record 150
token A unique user authentication identifier. You can retrieve it by using REST API for retrieving authentication token. You can also log in to BigFix Inventory, hover over the User icon User icon, and click Profile. Then, click Show token. Alphanumeric
criteria Retrieve records which match specific conditions. The parameter should have the following structure, written in one line:
<criteria> ::= <left-brace> <boolean-operator><colon> <left-bracket> 
<criterion> [{ <comma> <criterion> }...] <right-bracket> <right-brace>
<boolean-operator> ::= "and" | "or"
<criterion> ::= <criteria> | <left-bracket> <column> <comma> <operator> <comma> <value> <right-bracket>
<column> ::= <json-string>
<operator> ::= <json-string>
<value> ::= <json-array> | <json-string> | <json-numver> | <json-null>

For more information about operators, see: Common connectors and operators.

Example: retrieve computers with computer ID greater than 1000.
URL?criteria={"and":[["computer_id", ">", "1000"]]}

For columns that use the date and time values, you can retrieve data also for a period instead of a specific date. To do so, use last or next as <operator>, and then specify the time value in the following convention: PxD/PxW/PxM/PxY, where x is a number in the 1-999 range, and D, W, M, or Y is a designator that represents days, weeks, months, or years respectively.


Example conversation - default columns

GET api/sam/v2/detailed_hw_lpars?token=c77a88cfdde276de605c6fdee689b7961ddb93ef
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
Response body

Example conversation - selected columns

GET api/sam/v2/detailed_hw_lpars?columns[]=id
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
Response body