Type Alias: SystemInfo ​
SystemInfo:
object
Type declaration ​
| Name | Type | Description |
|---|---|---|
Architecture? | string | 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. |
BridgeNfIp6tables? | boolean | Indicates if bridge-nf-call-ip6tables is available on the host. |
BridgeNfIptables? | boolean | Indicates if bridge-nf-call-iptables is available on the host. |
CDISpecDirs? | string[] | 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. |
CgroupDriver? | "cgroupfs" | "systemd" | "none" | The driver to use for managing cgroups. |
CgroupVersion? | "1" | "2" | The version of the cgroup. |
Containerd? | ContainerdInfo | - |
ContainerdCommit? | Commit | - |
Containers? | number | Total number of containers on the host. |
ContainersPaused? | number | Number of containers with status "paused". |
ContainersRunning? | number | Number of containers with status "running". |
ContainersStopped? | number | Number of containers with status "stopped". |
CpuCfsPeriod? | boolean | Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. |
CpuCfsQuota? | boolean | Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. |
CPUSet? | boolean | Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See cpuset(7) |
CPUShares? | boolean | Indicates if CPU Shares limiting is supported by the host. |
Debug? | boolean | Indicates if the daemon is running in debug-mode / with debug-level logging enabled. |
DefaultAddressPools? | object[] | 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. |
DefaultRuntime? | string | Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time. |
DockerRootDir? | string | Root directory of persistent Docker state. Defaults to /var/lib/docker on Linux, and C:\ProgramData\docker on Windows. |
Driver? | string | Name of the storage driver in use. |
DriverStatus? | string[][] | 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. |
ExperimentalBuild? | boolean | Indicates if experimental features are enabled on the daemon. |
GenericResources? | GenericResources | - |
HttpProxy? | string | 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? | string | 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. |
ID? | string | Unique identifier of the daemon. |
Images? | number | Total number of images on the host. Both tagged and untagged (dangling) images are counted. |
IndexServerAddress? | string | 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. |
InitBinary? | string | 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. |
InitCommit? | Commit | - |
IPv4Forwarding? | boolean | Indicates IPv4 forwarding is enabled. |
Isolation? | "default" | "hyperv" | "process" | 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. |
KernelMemoryTCP? | boolean | 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. |
KernelVersion? | string | 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)". |
Labels? | string[] | User-defined labels (key/value metadata) as set on the daemon. /nodes/(id) endpoint > on a manager node in the Swarm. |
LiveRestoreEnabled? | boolean | 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. |
LoggingDriver? | string | The logging driver to use as a default for new containers. |
MemoryLimit? | boolean | Indicates if the host has memory limit support enabled. |
MemTotal? | number | Total amount of physical memory available on the host, in bytes. |
Name? | string | Hostname of the host. |
NCPU? | number | 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. |
NEventsListener? | number | Number of event listeners subscribed. |
NFd? | number | The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled. |
NGoroutines? | number | The number of goroutines that currently exist. This information is only returned if debug-mode is enabled. |
NoProxy? | string | 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. |
OomKillDisable? | boolean | Indicates if OOM killer disable is supported on the host. |
OperatingSystem? | string | Name of the host's operating system, for example: "Ubuntu 24.04 LTS" or "Windows Server 2016 Datacenter" |
OSType? | string | 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. |
OSVersion? | string | Version of the host's operating system |
PidsLimit? | boolean | Indicates if the host kernel has PID limit support enabled. |
Plugins? | PluginsInfo | - |
ProductLicense? | string | 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. |
RegistryConfig? | RegistryServiceConfig | - |
RuncCommit? | Commit | - |
Runtimes? | object | 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. |
SecurityOptions? | string[] | 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. |
ServerVersion? | string | Version string of the daemon. |
SwapLimit? | boolean | Indicates if the host has memory swap limit support enabled. |
Swarm? | SwarmInfo | - |
SystemTime? | string | Current system-time in RFC 3339 format with nano-seconds. |
Warnings? | string[] | 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. |