List nodes

GET

https://api.dsx-air.nvidia.com/api/v3/simulations/nodes/

GET

/api/v3/simulations/nodes/

curl https://api.dsx-air.nvidia.com/api/v3/simulations/nodes/ \
     -H "Authorization: Bearer <token>"

{
  "count": 123,
  "results": [
    {
      "id": "string",
      "created": "2024-01-15T09:30:00Z",
      "modified": "2024-01-15T09:30:00Z",
      "name": "string",
      "simulation": "string",
      "image": "string",
      "category": "SERVER",
      "state": "INACTIVE",
      "status_from_worker": "string",
      "split_options": null,
      "cloud_init": {
        "user_data_name": "string",
        "meta_data_name": "string",
        "user_data": "string",
        "meta_data": "string"
      },
      "cpu": 1,
      "memory": 1,
      "storage": 1,
      "pos_x": 1,
      "pos_y": 1,
      "labels": {
        "group": "string",
        "model": "string",
        "sku": "string",
        "rack_name": "string",
        "rack_unit": 1,
        "scalable_unit": 1,
        "rail_index": 1,
        "data_hall": "string",
        "tray_index": 1,
        "role": "string",
        "pod": 1,
        "superspine_group": 1,
        "plane_id": 1
      },
      "metadata": "string",
      "advanced": {
        "nic_model": "virtio",
        "cpu_mode": "custom",
        "cpu_options": [
          "ssse3"
        ],
        "secureboot": false,
        "uefi": false,
        "boot": [
          "hd"
        ]
      },
      "cdrom": {
        "image": "string"
      },
      "storage_pci": {},
      "management_interfaces": {}
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

List nodes in a simulation.

Required scope: air:simulation_read (roles: air_org_admin, air_user)

Alternative: role air_trainee also grants access.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

categoryenumOptional

The Air specific category the node belongs to.

“ - None
SERVER - Server
SWITCH - Switch
OOB_SERVER - OOB Management Server
OOB_SWITCH - OOB Management Switch

The Air specific category the node belongs to. * `` - None * `SERVER` - Server * `SWITCH` - Switch * `OOB_SERVER` - OOB Management Server * `OOB_SWITCH` - OOB Management Switch

Allowed values:

imagestringOptionalformat: "uuid"

Lookup all nodes for a specific image.

labels__groupstringOptional

Filter by the group label.

labels__modelstringOptional

Filter by the model label.

labels__skustringOptional

Filter by the sku label.

limitintegerOptional

Number of results to return per page.

namestringOptional

offsetintegerOptional

The initial index from which to return the results.

orderingenumOptional

Order objects by field. Prefix with - for descending order.

searchstringOptional

Search by name, image_name, or category.

simulationstringOptionalformat: "uuid"

Lookup all nodes for a specific simulation

stateenumOptional

The state of the node w.r.t. the simulation life cycle.

INACTIVE - Inactive
BOOTING - Booting
ACTIVE - Active
SHUTTING_DOWN - Shutting down
ERROR - Error
REBUILDING - Rebuilding

The state of the node w.r.t. the simulation life cycle. * `INACTIVE` - Inactive * `BOOTING` - Booting * `ACTIVE` - Active * `SHUTTING_DOWN` - Shutting down * `ERROR` - Error * `REBUILDING` - Rebuilding

status_from_workerstringOptional

Response

countinteger

resultslist of objects

nextstring or nullOptionalformat: "uri"

previousstring or nullOptionalformat: "uri"

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error