Device

Device commands enable you to manage Atym devices within your tenant or group. These commands allow you to add new devices, list existing devices, view device details, update device configurations, and remove devices from your system.

---

add device

Add a device to a tenant or group within a tenant

Usage:
  atym add device [flags]

Flags:
  -o, --aotEnabled            AOT enabled(default: false)
  -c, --cpu string            Device cpu type
  -d, --description string    Device description
  -n, --deviceName string     Device name
  -e, --enabled               Device enabled (default: true)
  -f, --file string           File path containing device info
  -g, --group                 Group ID
  -h, --help                  help for device
  -s, --serialNumber string   Device serial number
  -t, --target string         Device target architecture type
  -a, --targetAbi string      Device target ABI
  -x, --xip                   XIP enabled(default: false)

Required: --cpu, --deviceName, --serialNumber, --target and --targetAbi (if --aotEnabled is set to true).

Note

When using the -f, --file flag, you can provide a YAML configuration file instead of specifying individual flags. See the Device File Format for details on creating this configuration file. Additionally, for comprehensive AOT configuration guidance, see the AOT Compilation documentation.

Accepted Values

Parameter	Description	Accepted Values
cpu	The device cpu type	See available CPU types
target	The device architecture type	See available Target types
targetAbi	The Application Binary Interface for the target platform	See available TargetAbi types

---

list devices

List all devices within a specified group.

Usage:
  atym list devices [GROUP_ID] [flags]

Flags:
  -h, --help            help for devices
  -g, --in_group        list devices in group
  -i, --index int       Start index for the group list (default 1)
  -p, --page_size int   Total items returned list of groups (default 20)

---

remove device

Remove a device from the system or from a specific group.

Usage:
 atym remove device [DEVICE_ID] action [GROUP_ID](only used with from_group flag)

Flags:
 -g, --from_group   Delete device from group
 -h, --help         Help for device

Required: DEVICE_ID.

---

show device

Display detailed information about a specific Atym device, including its configuration and status.

Usage:
 atym show device DEVICE_ID

Flags:
 -h, --help            Help for device
 -n, --name string     Device name

Required: DEVICE_ID.

---

show twin

Retrieves the twin information of a device

Usage:
  atym show twin [DEVICE_ID] [flags]

Flags:
  -h, --help   help for twin

Required: [DEVICE_ID].

---

update device

Performs a patch operation on a device's metadata

Usage:
  atym update device DEVICE_ID [flags]

Flags:
  -o, --aot string         AOT enabled status of the device('true'/'false')
  -c, --cpu string         CPU variant of the device
  -d, --desc string        Description of the device
  -e, --enabled string     Enabled status of the device('true'/'false')
  -h, --help               help for device
  -n, --name string        Name of the device
  -s, --sn string          Serial number of the device
  -t, --target string      Target Architecture of the device
  -a, --targetAbi string   Target ABI of the device
  -x, --xip string         XIP enabled status of the device('true'/'false')

Required: DEVICE_ID, and at least one argument to update the device.

Accepted Values

Parameter	Description	Accepted Values
cpu	The device cpu type	See available CPU types
target	The device architecture type	See available Target types
targetAbi	The Application Binary Interface for the target platform	See available TargetAbi types