container.query

Sent on container changes.

Type: object

ADDED

ContainerAddedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

ContainerEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Container ID.

uuid

Uuid

Default: null

Container UUID (for libvirt).

Any of

• Option 1
• Option 2

Type: string

Type: null

name Required

Name

Type: string

Container name.

Must be at least 1 characters long

description

Description

Type: string Default: ""

Container description.

devices

Devices

Type: array of object Default: []

Container's devices.

No Additional Items

Each item of this array must be:

ContainerDeviceEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for the containers device.

attributes Required

Attributes

Device-specific configuration attributes.

One of

• ContainerFilesystemDevice
• ContainerGPUDevice
• ContainerNICDevice
• ContainerUSBDevice

ContainerFilesystemDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Device type identifier for FILESYSTEM devices.

Specific value: "FILESYSTEM"

target

Target

Type: string Default: "/usr/bin/zsh"

Target must not contain braces.

Must match regular expression: ^[^{}]*$

Must be at least 1 characters long

source

Source

Type: string Default: "/usr/bin/zsh"

Source must not contain braces, and not start with /mnt/.

Must match regular expression: ^[^{}]*$

Must be at least 1 characters long

ContainerGPUDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Device type identifier for GPU devices.

Specific value: "GPU"

gpu_type Required

Gpu Type

Type: enum (of string)

GPU device type.

Must be one of:

• "AMD"
• "INTEL"
• "NVIDIA"

pci_address Required

Pci Address

Type: string

PCI address of the GPU device on the host system.

Must be at least 1 characters long

ContainerNICDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Device type identifier for network interface cards.

Specific value: "NIC"

trust_guest_rx_filters

Trust Guest Rx Filters

Type: boolean Default: false

Whether to trust guest OS receive filter settings for better performance.

type

Type

Type: enum (of string) Default: "E1000"

Network interface controller type. E1000 for Intel compatibility, VIRTIO for performance.

Must be one of:

• "E1000"
• "VIRTIO"

nic_attach

Nic Attach

Default: null

Host network interface or bridge to attach to. null for no attachment.

Any of

• Option 1
• Option 2

Type: string

Type: null

mac

Mac

Default: null

MAC address for the virtual network interface. null for auto-generation.

Any of

• Option 1
• Option 2

Type: string
Must match regular expression: ^([0-9A-Fa-f]{2}[:-]?){5}([0-9A-Fa-f]{2})$

Type: null

ContainerUSBDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Device type identifier for USB devices.

Specific value: "USB"

usb

Default: null

USB device attributes for identification. null for USB host controller only.

Any of

• USBAttributes
• Option 2

USBAttributes

Type: object
No Additional Properties

vendor_id

Vendor Id

Type: string Default: "/usr/bin/zsh"

USB vendor identifier in hexadecimal format (e.g., '0x1d6b' for Linux Foundation).

Must match regular expression: ^0x.*

Must be at least 1 characters long

product_id

Product Id

Type: string Default: "/usr/bin/zsh"

USB product identifier in hexadecimal format (e.g., '0x0002' for 2.0 root hub).

Must match regular expression: ^0x.*

Must be at least 1 characters long

Type: null

device

Device

Default: null

Host USB device path to pass through. null for controller only.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

container Required

Container

Type: integer

ID of the container this device belongs to.

cpuset

Cpuset

Default: null

List of physical CPU numbers that domain process and virtual CPUs can be pinned to by default.

Any of

• Option 1
• Option 2

Type: string

Type: null

autostart

Autostart

Type: boolean Default: true

Automatically start the container on boot.

time

Time

Type: enum (of string) Default: "LOCAL"

Whether container time should be local time or UTC time.

Must be one of:

• "LOCAL"
• "UTC"

shutdown_timeout

Shutdown Timeout

Type: integer Default: 90

How many seconds to wait for container to shut down before killing it.

Value must be greater or equal to 5 and lesser or equal to 300

dataset Required

Dataset

Type: string

Which dataset to use as the container root filesystem.

init

Init

Type: string Default: "/sbin/init"

"init" process commandline.

initdir

Initdir

Default: null

"init" process working dir.

Any of

• Option 1
• Option 2

Type: string

Type: null

initenv

Initenv

Type: object Default: {}

"init" process environment variables.

Additional Properties

Each additional property must conform to the following schema

Type: string

inituser

Inituser

Default: null

"init" process username.

Any of

• Option 1
• Option 2

Type: string

Type: null

initgroup

Initgroup

Default: null

"init" process group.

Any of

• Option 1
• Option 2

Type: string

Type: null

idmap

Idmap

Default: {"type": "DEFAULT"}

Idmap configuration for the container There are three two possible values: DEFAULT: This applies the standard TrueNAS idmap namespace configuration. It changes user ID (UID) 0 (root) in the container to UID 2147000001 (truenascontainerunpriv_root). It offsets the other container UIDs by the same amount. For example, UID 1000 in the container becomes UID 2147001001 in the host. ISOLATED: Same as DEFAULT, but UID will be calculated as 2147000001 + 65536 * slice. This will ensure unique ID for each container (provided that the slice is also unique).
None: The container does not apply any idmap namespace. Container UIDs map directly to host UIDs. For example, UID 0 in the container is UID 0 in the host. WARNING: For security, use the DEFAULT value. Security best practice is to run containers with idmap namespaces.

Any of

• Option 1
• Option 2

One of

• DefaultIdmapConfiguration
• IsolatedIdmapConfiguration

DefaultIdmapConfiguration

Type: object
No Additional Properties

type Required

Type

Type: const

Configuration type for default ID mapping.

Specific value: "DEFAULT"

IsolatedIdmapConfiguration

Type: object
No Additional Properties

type Required

Type

Type: const

Configuration type for isolated ID mapping.

Specific value: "ISOLATED"

slice Required

Slice

null when creating means we'll look up an unused slice on backend.

Any of

• Option 1
• Option 2

Type: integer

Value must be strictly greater than 0 and strictly lesser than 1000

Type: null

Type: null

capabilities_policy

Capabilities Policy

Type: enum (of string) Default: "DEFAULT"

Default rules for capabilities: either keep the default behavior that is dropping the following capabilities: sysmodule, systime, mknod, auditcontrol, macadmin. Or keep all capabilities, or drop all capabilities.

Must be one of:

• "DEFAULT"
• "ALLOW"
• "DENY"

capabilities_state

Capabilities State

Type: object Default: {}

Enable or disable specific capabilities.

Additional Properties

Each additional property must conform to the following schema

Type: boolean

default_network

Default Network

Default: null

The default network bridge this container will use when no NIC devices are explicitly attached. When the container has explicitly configured NIC devices, this is null because the NIC configuration is visible in the devices list.

Any of

• Option 1
• Option 2

Type: string

Type: null

status Required

ContainerStatus

Type: object

Container state.

No Additional Properties

state Required

State

Type: enum (of string)

Container state.

Must be one of:

• "RUNNING"
• "STOPPED"

pid Required

Pid

Container host PID (if running). Informational only do not rely on this value to identify the container's init process.

Any of

• Option 1
• Option 2

Type: integer

Type: null

domain_state Required

Domain State

Domain state reported by libvirt.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

CHANGED

ContainerChangedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

ContainerEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Container ID.

uuid

Uuid

Default: null

Container UUID (for libvirt).

Any of

• Option 1
• Option 2

Type: string

Type: null

name Required

Name

Type: string

Container name.

Must be at least 1 characters long

description

Description

Type: string Default: ""

Container description.

devices

Devices

Type: array of object Default: []

Container's devices.

No Additional Items

Each item of this array must be:

ContainerDeviceEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for the containers device.

attributes Required

Attributes

Device-specific configuration attributes.

One of

• ContainerFilesystemDevice
• ContainerGPUDevice
• ContainerNICDevice
• ContainerUSBDevice

ContainerFilesystemDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Device type identifier for FILESYSTEM devices.

Specific value: "FILESYSTEM"

target

Target

Type: string Default: "/usr/bin/zsh"

Target must not contain braces.

Must match regular expression: ^[^{}]*$

Must be at least 1 characters long

source

Source

Type: string Default: "/usr/bin/zsh"

Source must not contain braces, and not start with /mnt/.

Must match regular expression: ^[^{}]*$

Must be at least 1 characters long

ContainerGPUDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Device type identifier for GPU devices.

Specific value: "GPU"

gpu_type Required

Gpu Type

Type: enum (of string)

GPU device type.

Must be one of:

• "AMD"
• "INTEL"
• "NVIDIA"

pci_address Required

Pci Address

Type: string

PCI address of the GPU device on the host system.

Must be at least 1 characters long

ContainerNICDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Device type identifier for network interface cards.

Specific value: "NIC"

trust_guest_rx_filters

Trust Guest Rx Filters

Type: boolean Default: false

Whether to trust guest OS receive filter settings for better performance.

type

Type

Type: enum (of string) Default: "E1000"

Network interface controller type. E1000 for Intel compatibility, VIRTIO for performance.

Must be one of:

• "E1000"
• "VIRTIO"

nic_attach

Nic Attach

Default: null

Host network interface or bridge to attach to. null for no attachment.

Any of

• Option 1
• Option 2

Type: string

Type: null

mac

Mac

Default: null

MAC address for the virtual network interface. null for auto-generation.

Any of

• Option 1
• Option 2

Type: string
Must match regular expression: ^([0-9A-Fa-f]{2}[:-]?){5}([0-9A-Fa-f]{2})$

Type: null

ContainerUSBDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Device type identifier for USB devices.

Specific value: "USB"

usb

Default: null

USB device attributes for identification. null for USB host controller only.

Any of

• USBAttributes
• Option 2

USBAttributes

Type: object
No Additional Properties

vendor_id

Vendor Id

Type: string Default: "/usr/bin/zsh"

USB vendor identifier in hexadecimal format (e.g., '0x1d6b' for Linux Foundation).

Must match regular expression: ^0x.*

Must be at least 1 characters long

product_id

Product Id

Type: string Default: "/usr/bin/zsh"

USB product identifier in hexadecimal format (e.g., '0x0002' for 2.0 root hub).

Must match regular expression: ^0x.*

Must be at least 1 characters long

Type: null

device

Device

Default: null

Host USB device path to pass through. null for controller only.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

container Required

Container

Type: integer

ID of the container this device belongs to.

cpuset

Cpuset

Default: null

List of physical CPU numbers that domain process and virtual CPUs can be pinned to by default.

Any of

• Option 1
• Option 2

Type: string

Type: null

autostart

Autostart

Type: boolean Default: true

Automatically start the container on boot.

time

Time

Type: enum (of string) Default: "LOCAL"

Whether container time should be local time or UTC time.

Must be one of:

• "LOCAL"
• "UTC"

shutdown_timeout

Shutdown Timeout

Type: integer Default: 90

How many seconds to wait for container to shut down before killing it.

Value must be greater or equal to 5 and lesser or equal to 300

dataset Required

Dataset

Type: string

Which dataset to use as the container root filesystem.

init

Init

Type: string Default: "/sbin/init"

"init" process commandline.

initdir

Initdir

Default: null

"init" process working dir.

Any of

• Option 1
• Option 2

Type: string

Type: null

initenv

Initenv

Type: object Default: {}

"init" process environment variables.

Additional Properties

Each additional property must conform to the following schema

Type: string

inituser

Inituser

Default: null

"init" process username.

Any of

• Option 1
• Option 2

Type: string

Type: null

initgroup

Initgroup

Default: null

"init" process group.

Any of

• Option 1
• Option 2

Type: string

Type: null

idmap

Idmap

Default: {"type": "DEFAULT"}

Idmap configuration for the container There are three two possible values: DEFAULT: This applies the standard TrueNAS idmap namespace configuration. It changes user ID (UID) 0 (root) in the container to UID 2147000001 (truenascontainerunpriv_root). It offsets the other container UIDs by the same amount. For example, UID 1000 in the container becomes UID 2147001001 in the host. ISOLATED: Same as DEFAULT, but UID will be calculated as 2147000001 + 65536 * slice. This will ensure unique ID for each container (provided that the slice is also unique).
None: The container does not apply any idmap namespace. Container UIDs map directly to host UIDs. For example, UID 0 in the container is UID 0 in the host. WARNING: For security, use the DEFAULT value. Security best practice is to run containers with idmap namespaces.

Any of

• Option 1
• Option 2

One of

• DefaultIdmapConfiguration
• IsolatedIdmapConfiguration

DefaultIdmapConfiguration

Type: object
No Additional Properties

type Required

Type

Type: const

Configuration type for default ID mapping.

Specific value: "DEFAULT"

IsolatedIdmapConfiguration

Type: object
No Additional Properties

type Required

Type

Type: const

Configuration type for isolated ID mapping.

Specific value: "ISOLATED"

slice Required

Slice

null when creating means we'll look up an unused slice on backend.

Any of

• Option 1
• Option 2

Type: integer

Value must be strictly greater than 0 and strictly lesser than 1000

Type: null

Type: null

capabilities_policy

Capabilities Policy

Type: enum (of string) Default: "DEFAULT"

Default rules for capabilities: either keep the default behavior that is dropping the following capabilities: sysmodule, systime, mknod, auditcontrol, macadmin. Or keep all capabilities, or drop all capabilities.

Must be one of:

• "DEFAULT"
• "ALLOW"
• "DENY"

capabilities_state

Capabilities State

Type: object Default: {}

Enable or disable specific capabilities.

Additional Properties

Each additional property must conform to the following schema

Type: boolean

default_network

Default Network

Default: null

The default network bridge this container will use when no NIC devices are explicitly attached. When the container has explicitly configured NIC devices, this is null because the NIC configuration is visible in the devices list.

Any of

• Option 1
• Option 2

Type: string

Type: null

status Required

ContainerStatus

Type: object

Container state.

No Additional Properties

state Required

State

Type: enum (of string)

Container state.

Must be one of:

• "RUNNING"
• "STOPPED"

pid Required

Pid

Container host PID (if running). Informational only do not rely on this value to identify the container's init process.

Any of

• Option 1
• Option 2

Type: integer

Type: null

domain_state Required

Domain State

Domain state reported by libvirt.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

REMOVED

ContainerRemovedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

Required roles: CONTAINER_READ