Skip to content

engines:get

Terminal window
rai engines:get [OPTIONS]

Gets details about a specified RelationalAI (RAI) engine. Requires the eng_user application role.

OptionTypeDescription
--nameTextThe name of the engine to get details for.

Use the engines:get command to get details for a specific RAI engine:

Terminal window
$ 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:

Terminal window
$ rai engines:get --name my_engine
---------------------------------------------------
Engine not found
---------------------------------------------------

If the --name option is missing, you are prompted to select the engine name interactively:

Terminal window
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.