SystemInfo

constructor(ID: String? = null, containers: Int? = null, containersRunning: Int? = null, containersPaused: Int? = null, containersStopped: Int? = null, images: Int? = null, driver: String? = null, driverStatus: List<List<String>>? = null, dockerRootDir: String? = null, plugins: PluginsInfo? = null, memoryLimit: Boolean? = null, swapLimit: Boolean? = null, kernelMemoryTCP: Boolean? = null, cpuCfsPeriod: Boolean? = null, cpuCfsQuota: Boolean? = null, cpUShares: Boolean? = null, cpUSet: Boolean? = null, pidsLimit: Boolean? = null, oomKillDisable: Boolean? = null, ipv4Forwarding: Boolean? = null, bridgeNfIptables: Boolean? = null, bridgeNfIp6tables: Boolean? = null, debug: Boolean? = null, nfd: Int? = null, ngoroutines: Int? = null, systemTime: String? = null, loggingDriver: String? = null, cgroupDriver: SystemInfo.CgroupDriver? = CgroupDriver.CGROUPFS, cgroupVersion: SystemInfo.CgroupVersion? = CgroupVersion._1, neventsListener: Int? = null, kernelVersion: String? = null, operatingSystem: String? = null, osVersion: String? = null, osType: String? = null, architecture: String? = null, NCPU: Int? = null, memTotal: Long? = null, indexServerAddress: String? = "https://index.docker.io/v1/", registryConfig: RegistryServiceConfig? = null, genericResources: List<GenericResourcesInner>? = null, httpProxy: String? = null, httpsProxy: String? = null, noProxy: String? = null, name: String? = null, labels: List<String>? = null, experimentalBuild: Boolean? = null, serverVersion: String? = null, runtimes: Map<String, Runtime>? = null, defaultRuntime: String? = "runc", swarm: SwarmInfo? = null, liveRestoreEnabled: Boolean? = false, isolation: SystemInfo.Isolation? = Isolation.DEFAULT, initBinary: String? = null, containerdCommit: Commit? = null, runcCommit: Commit? = null, initCommit: Commit? = null, securityOptions: List<String>? = null, productLicense: String? = null, defaultAddressPools: List<SystemInfoDefaultAddressPoolsInner>? = null, firewallBackend: FirewallInfo? = null, discoveredDevices: List<DeviceInfo>? = null, warnings: List<String>? = null, cdISpecDirs: List<String>? = null, containerd: ContainerdInfo? = null)

Parameters

ID

Unique identifier of the daemon.


>Note: The format of the ID itself is not part of the API, and > should not be considered stable.

containers

Total number of containers on the host.

containersRunning

Number of containers with status \"running\".

containersPaused

Number of containers with status \"paused\".

containersStopped

Number of containers with status \"stopped\".

images

Total number of images on the host. Both tagged and untagged (dangling) images are counted.

driver

Name of the storage driver in use.

driverStatus

Information specific to the storage driver, provided as \"label\" / \"value\" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of docker info on the command line.


>Note: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice.

dockerRootDir

Root directory of persistent Docker state. Defaults to /var/lib/docker on Linux, and C:\\ProgramData\\docker on Windows.

plugins
memoryLimit

Indicates if the host has memory limit support enabled.

swapLimit

Indicates if the host has memory swap limit support enabled.

kernelMemoryTCP

Indicates if the host has kernel memory TCP limit support enabled. This field is omitted if not supported. Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding memory.kmem.tcp.limit_in_bytes cgroup.

cpuCfsPeriod

Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host.

cpuCfsQuota

Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host.

cpUShares

Indicates if CPU Shares limiting is supported by the host.

cpUSet

Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See cpuset(7)

pidsLimit

Indicates if the host kernel has PID limit support enabled.

oomKillDisable

Indicates if OOM killer disable is supported on the host.

ipv4Forwarding

Indicates IPv4 forwarding is enabled.

bridgeNfIptables

Indicates if bridge-nf-call-iptables is available on the host when the daemon was started.


>Deprecated: netfilter module is now loaded on-demand and no longer > during daemon startup, making this field obsolete. This field is always >false and will be removed in a API v1.49.

bridgeNfIp6tables

Indicates if bridge-nf-call-ip6tables is available on the host.


>Deprecated: netfilter module is now loaded on-demand, and no longer > during daemon startup, making this field obsolete. This field is always >false and will be removed in a API v1.49.

debug

Indicates if the daemon is running in debug-mode / with debug-level logging enabled.

nfd

The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled.

ngoroutines

The number of goroutines that currently exist. This information is only returned if debug-mode is enabled.

systemTime

Current system-time in RFC 3339 format with nano-seconds.

loggingDriver

The logging driver to use as a default for new containers.

cgroupDriver

The driver to use for managing cgroups.

cgroupVersion

The version of the cgroup.

neventsListener

Number of event listeners subscribed.

kernelVersion

Kernel version of the host. On Linux, this information obtained from uname. On Windows this information is queried from the HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\\\\ registry value, for example \"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\".

operatingSystem

Name of the host's operating system, for example: \"Ubuntu 24.04 LTS\" or \"Windows Server 2016 Datacenter\"

osVersion

Version of the host's operating system


>Note: The information returned in this field, including its > very existence, and the formatting of values, should not be considered > stable, and may change without notice.

osType

Generic type of the operating system of the host, as returned by the Go runtime (GOOS). Currently returned values are \"linux\" and \"windows\". A full list of possible values can be found in the Go documentation.

architecture

Hardware architecture of the host, as returned by the Go runtime (GOARCH). A full list of possible values can be found in the Go documentation.

NCPU

The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected.

memTotal

Total amount of physical memory available on the host, in bytes.

indexServerAddress

Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud.

registryConfig
genericResources

User-defined resources can be either Integer resources (e.g, SSD=3) or String resources (e.g, GPU=UUID1).

httpProxy

HTTP-proxy configured for the daemon. This value is obtained from the HTTP_PROXY environment variable. Credentials (user info component) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration.

httpsProxy

HTTPS-proxy configured for the daemon. This value is obtained from the HTTPS_PROXY environment variable. Credentials (user info component) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration.

noProxy

Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the NO_PROXY environment variable. Containers do not automatically inherit this configuration.

name

Hostname of the host.

labels

User-defined labels (key/value metadata) as set on the daemon.


>Note: When part of a Swarm, nodes can both have daemon labels, > set through the daemon configuration, and node labels, set from a > manager node in the Swarm. Node labels are not included in this > field. Node labels can be retrieved using the /nodes/(id) endpoint > on a manager node in the Swarm.

experimentalBuild

Indicates if experimental features are enabled on the daemon.

serverVersion

Version string of the daemon.

runtimes

List of OCI compliant runtimes configured on the daemon. Keys hold the \"name\" used to reference the runtime. The Docker daemon relies on an OCI compliant runtime (invoked via the containerd daemon) as its interface to the Linux kernel namespaces, cgroups, and SELinux. The default runtime is runc, and automatically configured. Additional runtimes can be configured by the user and will be listed here.

defaultRuntime

Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time.

swarm
liveRestoreEnabled

Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected.

isolation

Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is hyperv, and on Windows server, the default is process. This option is currently not used on other platforms.

initBinary

Name and, optional, path of the docker-init binary. If the path is omitted, the daemon searches the host's $PATH for the binary and uses the first result.

containerdCommit
runcCommit
initCommit
securityOptions

List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), rootless and no-new-privileges. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs.

productLicense

Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included.

defaultAddressPools

List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base \"10.10.0.0/16\" with Size 24 will define the set of 256 10.10.0-255.0/24 address pools.

firewallBackend
discoveredDevices

List of devices discovered by device drivers. Each device includes information about its source driver, kind, name, and additional driver-specific attributes.

warnings

List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user.

cdISpecDirs

List of directories where (Container Device Interface) CDI specifications are located. These specifications define vendor-specific modifications to an OCI runtime specification for a container being created. An empty list indicates that CDI device injection is disabled. Note that since using CDI device injection requires the daemon to have experimental enabled. For non-experimental daemons an empty list will always be returned.

containerd