container.update¶
Update a Container.
No Additional Items
Tuple Validation
Parameter 1: id
id
Type: integerContainer ID.
Parameter 2: container_update
container_update
Type: objectNew container parameters.
No Additional PropertiesUuid
Container UUID (for libvirt).
Name
Type: stringContainer name.
Must be at least 1 characters long
Description
Type: stringContainer description.
Cpuset
List of physical CPU numbers that domain process and virtual CPUs can be pinned to by default.
Autostart
Type: booleanAutomatically start the container on boot.
Time
Type: enum (of string)Whether container time should be local time or UTC time.
Must be one of:
- "LOCAL"
- "UTC"
Shutdown Timeout
Type: integerHow 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
Init
Type: string"init" process commandline.
Initdir
"init" process working dir.
Initenv
Type: object"init" process environment variables.
Each additional property must conform to the following schema
Type: stringInituser
"init" process username.
Initgroup
"init" process group.
Capabilities Policy
Type: enum (of string)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
Type: objectEnable or disable specific capabilities.
Each additional property must conform to the following schema
Type: booleanContainerEntry
Type: objectUpdated container.
No Additional PropertiesId
Type: integerContainer ID.
Uuid
Default: nullContainer UUID (for libvirt).
Name
Type: stringContainer name.
Must be at least 1 characters long
Description
Type: string Default: ""Container description.
Devices
Type: array of object Default: []Container's devices.
No Additional ItemsEach item of this array must be:
ContainerDeviceEntry
Type: objectNo Additional Properties
Id
Type: integerUnique identifier for the containers device.
Attributes
Device-specific configuration attributes.
ContainerFilesystemDevice
Type: objectNo Additional Properties
Dtype
Type: constDevice type identifier for FILESYSTEM devices.
Specific value:"FILESYSTEM"
Target
Type: string Default: "/usr/bin/zsh"Target must not contain braces.
Must match regular expression:^[^{}]*$
Must be at least 1 characters long
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: objectNo Additional Properties
Dtype
Type: constDevice type identifier for GPU devices.
Specific value:"GPU"
Gpu Type
Type: enum (of string)GPU device type.
Must be one of:
- "AMD"
- "INTEL"
- "NVIDIA"
Pci Address
Type: stringPCI address of the GPU device on the host system.
Must be at least 1 characters long
ContainerNICDevice
Type: objectNo Additional Properties
Dtype
Type: constDevice type identifier for network interface cards.
Specific value:"NIC"
Trust Guest Rx Filters
Type: boolean Default: falseWhether to trust guest OS receive filter settings for better performance.
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
Default: nullHost network interface or bridge to attach to. null for no attachment.
Mac
Default: nullMAC address for the virtual network interface. null for auto-generation.
Must match regular expression:
^([0-9A-Fa-f]{2}[:-]?){5}([0-9A-Fa-f]{2})$
ContainerUSBDevice
Type: objectNo Additional Properties
Dtype
Type: constDevice type identifier for USB devices.
Specific value:"USB"
USB device attributes for identification. null for USB host controller only.
USBAttributes
Type: objectNo Additional Properties
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
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
Device
Default: nullHost USB device path to pass through. null for controller only.
Must be at least 1 characters long
Container
Type: integerID of the container this device belongs to.
Cpuset
Default: nullList of physical CPU numbers that domain process and virtual CPUs can be pinned to by default.
Autostart
Type: boolean Default: trueAutomatically start the container on boot.
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
Type: integer Default: 90How 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
Type: stringWhich dataset to use as the container root filesystem.
Init
Type: string Default: "/sbin/init""init" process commandline.
Initdir
Default: null"init" process working dir.
Initenv
Type: object Default: {}"init" process environment variables.
Each additional property must conform to the following schema
Type: stringInituser
Default: null"init" process username.
Initgroup
Default: null"init" process group.
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.
DefaultIdmapConfiguration
Type: objectNo Additional Properties
Type
Type: constConfiguration type for default ID mapping.
Specific value:"DEFAULT"
IsolatedIdmapConfiguration
Type: objectNo Additional Properties
Type
Type: constConfiguration type for isolated ID mapping.
Specific value:"ISOLATED"
Slice
null when creating means we'll look up an unused slice on backend.
Value must be strictly greater than 0 and strictly lesser than 1000
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
Type: object Default: {}Enable or disable specific capabilities.
Each additional property must conform to the following schema
Type: booleanDefault Network
Default: nullThe 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.
ContainerStatus
Type: objectContainer state.
No Additional PropertiesState
Type: enum (of string)Container state.
Must be one of:
- "RUNNING"
- "STOPPED"
Pid
Container host PID (if running). Informational only do not rely on this value to identify the container's init process.
Domain State
Domain state reported by libvirt.
Must be at least 1 characters long
Required roles: CONTAINER_WRITE