Machine

Retrieve all Machine Capabilities

Changed on

Get all distinct Machine Capabilities across all Machines

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

get/v2/org/{org}/nico/machine-capability

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/machine-capability
  • Auth
    HTTP bearer

Query parameters

siteIdstring required

Filter Capabilities by Machines from a particular Site

hasInstanceTypeboolean

Filter Capabilities by Machines that have an Instance Type

typestring

Filter Capabilities by Type

namestring

Filter Capabilities by Name

frequencystring

Filter Capabilities by Frequency value

capacitystring

Filter Capabilities by Capacity value

vendorstring

Filter Capabilities by Vendor

inactiveDevicesstring

Filter Capabilities by Inactive Devices value. Since the value is an array, multiple query parameters should be specified in the correct order. For example, to filter for [1, 3], specify inactiveDevices=1&inactiveDevices=3

countstring

Filter Capabilities by Count

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'TYPE_ASC' | 'TYPE_DESC'

Ordering for pagination query. TYPE_ASC orders capability type ascending and TYPE_DESC orders it descending. Defaults to TYPE_ASC. Ties are ordered by name, frequency, capacity, vendor, count, deviceType, inactiveDevices, and internal ID, all ascending with null values last.

Response

OK

type'CPU' | 'Memory' | 'Storage' | 'Network' | 'GPU' | 'InfiniBand' | 'DPU'

Type of the Capability

namestring

Name of the Capability component

frequencystring nullable

Frequency of the Capability component, if available

coresinteger nullable

Number of Cores in the Capability component, if applicable

threadsinteger nullable

Number of Threads in the Capability component, if applicable

capacitystring nullable

Capacity of the Capability component, if applicable

vendorstring nullable

Vendor of the Capability component, if available

hardwareRevisionstring nullable

Hardware revision of the Capability component, if available

inactiveDevicesinteger[]

A list of inactive devices

countinteger nullable

Count of the Capability component

deviceTypestring nullable

Device Type of the Capability component, if available

Example response

[
  {
    "type": "CPU",
    "name": "Intel(R) Xeon(R) Gold 6354 CPU @ 3.00GHz",
    "frequency": "3.0GHz",
    "cores": 18,
    "threads": 36,
    "count": 2
  }
]

Changes

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

  • 78f3b35615a5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status