engines:get
rai engines:get [OPTIONS]
Gets details about a specified RelationalAI (RAI) engine.
Requires the eng_user
application role.
Options
Section titled “Options”Option | Type | Description |
---|---|---|
--name | Text | The name of the engine to get details for. |
Example
Section titled “Example”Use the engines:get
command to get details for a specific RAI engine:
$ rai engines:get --name my_engine
---------------------------------------------------
Name Size State ───────────────────────────────── my_engine HIGHMEM_X64_S READY
---------------------------------------------------
If no engine named my_engine
exists, an error message is displayed:
$ rai engines:get --name my_engine
---------------------------------------------------
Engine not found
---------------------------------------------------
If the --name
option is missing, you are prompted to select the engine name interactively:
❯ rai engines:get
---------------------------------------------------
? Engine name: my_engine
Name Size State ───────────────────────────────── my_engine HIGHMEM_X64_S READY
---------------------------------------------------
See Compute Resources for more information on RAI engines and engine management.