Gets inventory information about the systems and the partitions that are tagged in an EP 2.0 pool.
Resource Information
| Response formats | JSON |
| Requires authentication? | Yes |
| Rate limited? | All API calls are automatically rate limited to a maximum of 10 calls per second. |
Request Syntax
GET /v1/ep/inventory/tags
URI Request Parameters
The request uses the following URI parameters:
| Parameter | Required? | Description |
| tag_name | Optional | The tag name. The available tag names are returned if you do not specify a tag name. |
Request headers
Authenticate the API by completing the following steps:
- Set your client ID value in the X-CMC-Client-Id header in every request.
- Set the client secret value in the X-CMC-Client-Secret header in every request.
To form the CMC API full URL, append the relative path of the endpoint you want to use to the Base URL.
Example: https://<portal-url>/api/public/v1/ep/inventory/tags/{tag_name}
Request body
This request does not have a request body.
Response Syntax and Description
To review the response schema and for information about the parameters, see Response schema and parameter description for v1/ep/inventory/tags.
Errors
The following errors are the common errors for this API:
NotFoundException
The requested resource is not found. Make sure that the request URI is correct.
HTTP Status Code: 404
TooManyRequestsException
The request has reached its throttling limit. Retry after the specified time.
HTTP Status Code: 429
UnauthorizedException
The request is denied because the caller has insufficient permissions.
HTTP Status Code: 401
Sample Requests
Review the following examples to understand how the API request and response work.
Request for all tags
GET /api/public/v1/ep/inventory/tags HTTP/1.1
Host: xxxxxxxxxxxx.powercmc.com
x-cmc-client-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
x-cmc-client-secret: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Request for the Test tag
GET /api/public/v1/ep/inventory/tags/Test HTTP/1.1
Host: xxxxxxxxxxxx.powercmc.com
x-cmc-client-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
x-cmc-client-secret: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Sample Response
The following response is a sample response for the Test tag.
{
"Tags": [
{
"ID": "xxxxxxxx",
"Name": "Test",
"Systems": [
{
"UUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"MTMS": {
"MachineType": "9009",
"Model": "22A",
"SerialNumber": "xxxxxxx"
},
"Name": "xxxxxxxx",
"State": "operating",
"PoolID": "xxxx",
"PoolName": "xxxxxxxx",
"BaseCores": {
"BaseAnyOSCores": 1,
"BaseRHELCoreOSCores": 1,
"BaseSLESCores": 1,
"BaseAIXCores": 6,
"BaseIBMiCores": 3,
"BaseLinuxVIOSCores": 0
},
"BaseLicensedProgramsCores": {
"BasePowerHAEnterprise": 6,
"BasePowerHAIBMiMedium": 0,
"BasePowerHAIBMiSmall": 1,
"BasePowerHAStandard": 0
},
"BaseMemory": 256,
"ProcessorConfiguration": {
"AvailableProcessorUnits": 2.35,
"InstalledProcessorUnits": 8
},
"MemoryConfiguration": {
"AvailableMemory": 123,
"InstalledMemory": 256,
"MemoryUsedByHypervisor": 10
},
"PartitionCount": 54,
"ManagingHMCs": [
{
"HmcName": "xxxxxxxx",
"State": "Active"
}
]
}
],
"Partitions": [
{
"UUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"ID": "48",
"Name": "xxxxxxxx",
"State": "running",
"AssociatedSystemUUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"OSType": "RHEL",
"OSVersion": "Linux/Red Hat Enterprise Linux 4.18.0-147.el8.ppc64le 8.1 (Ootpa)",
"ProcessorConfiguration": {
"ProcessorMode": "shared",
"AllocatedVirtualProcessors": 1,
"CurrentProcessingUnits": 0.05
},
"CurrentMemory": "2048"
}
]
}
]
}
Comments
0 comments
Please sign in to leave a comment.