Skip to content

Latest commit

 

History

History
91 lines (80 loc) · 13.1 KB

File metadata and controls

91 lines (80 loc) · 13.1 KB

SystemInfo

Properties

Name Type Description Notes
ID kotlin.String Unique identifier of the daemon. <p><br /></p> > Note: The format of the ID itself is not part of the API, and > should not be considered stable. [optional]
containers kotlin.Int Total number of containers on the host. [optional]
containersRunning kotlin.Int Number of containers with status `&quot;running&quot;`. [optional]
containersPaused kotlin.Int Number of containers with status `&quot;paused&quot;`. [optional]
containersStopped kotlin.Int Number of containers with status `&quot;stopped&quot;`. [optional]
images kotlin.Int Total number of images on the host. Both tagged and untagged (dangling) images are counted. [optional]
driver kotlin.String Name of the storage driver in use. [optional]
driverStatus kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>> Information specific to the storage driver, provided as &quot;label&quot; / &quot;value&quot; 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. <p><br /></p> > Note: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. [optional]
dockerRootDir kotlin.String Root directory of persistent Docker state. Defaults to `/var/lib/docker` on Linux, and `C:\ProgramData\docker` on Windows. [optional]
plugins PluginsInfo [optional]
memoryLimit kotlin.Boolean Indicates if the host has memory limit support enabled. [optional]
swapLimit kotlin.Boolean Indicates if the host has memory swap limit support enabled. [optional]
kernelMemoryTCP kotlin.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. [optional]
cpuCfsPeriod kotlin.Boolean Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. [optional]
cpuCfsQuota kotlin.Boolean Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. [optional]
cpUShares kotlin.Boolean Indicates if CPU Shares limiting is supported by the host. [optional]
cpUSet kotlin.Boolean Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See cpuset(7) [optional]
pidsLimit kotlin.Boolean Indicates if the host kernel has PID limit support enabled. [optional]
oomKillDisable kotlin.Boolean Indicates if OOM killer disable is supported on the host. [optional]
ipv4Forwarding kotlin.Boolean Indicates IPv4 forwarding is enabled. [optional]
bridgeNfIptables kotlin.Boolean Indicates if `bridge-nf-call-iptables` is available on the host. [optional]
bridgeNfIp6tables kotlin.Boolean Indicates if `bridge-nf-call-ip6tables` is available on the host. [optional]
debug kotlin.Boolean Indicates if the daemon is running in debug-mode / with debug-level logging enabled. [optional]
nfd kotlin.Int The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled. [optional]
ngoroutines kotlin.Int The number of goroutines that currently exist. This information is only returned if debug-mode is enabled. [optional]
systemTime kotlin.String Current system-time in RFC 3339 format with nano-seconds. [optional]
loggingDriver kotlin.String The logging driver to use as a default for new containers. [optional]
cgroupDriver inline The driver to use for managing cgroups. [optional]
cgroupVersion inline The version of the cgroup. [optional]
neventsListener kotlin.Int Number of event listeners subscribed. [optional]
kernelVersion kotlin.String Kernel version of the host. On Linux, this information obtained from `uname`. On Windows this information is queried from the <kbd>HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\</kbd> registry value, for example &quot;10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)&quot;. [optional]
operatingSystem kotlin.String Name of the host's operating system, for example: &quot;Ubuntu 16.04.2 LTS&quot; or &quot;Windows Server 2016 Datacenter&quot; [optional]
osVersion kotlin.String Version of the host's operating system <p><br /></p> > 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. [optional]
osType kotlin.String Generic type of the operating system of the host, as returned by the Go runtime (`GOOS`). Currently returned values are &quot;linux&quot; and &quot;windows&quot;. A full list of possible values can be found in the Go documentation. [optional]
architecture kotlin.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. [optional]
NCPU kotlin.Int 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. [optional]
memTotal kotlin.Long Total amount of physical memory available on the host, in bytes. [optional]
indexServerAddress kotlin.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. [optional]
registryConfig RegistryServiceConfig [optional]
genericResources kotlin.collections.MutableList<GenericResourcesInner> User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). [optional]
httpProxy kotlin.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. [optional]
httpsProxy kotlin.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. [optional]
noProxy kotlin.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. [optional]
name kotlin.String Hostname of the host. [optional]
labels kotlin.collections.MutableList<kotlin.String> User-defined labels (key/value metadata) as set on the daemon. <p><br /></p> > 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. [optional]
experimentalBuild kotlin.Boolean Indicates if experimental features are enabled on the daemon. [optional]
serverVersion kotlin.String Version string of the daemon. [optional]
runtimes kotlin.collections.MutableMap<kotlin.String, Runtime> List of OCI compliant runtimes configured on the daemon. Keys hold the &quot;name&quot; 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. [optional]
defaultRuntime kotlin.String Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time. [optional]
swarm SwarmInfo [optional]
liveRestoreEnabled kotlin.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. [optional]
isolation inline 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. [optional]
initBinary kotlin.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. [optional]
containerdCommit Commit [optional]
runcCommit Commit [optional]
initCommit Commit [optional]
securityOptions kotlin.collections.MutableList<kotlin.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. [optional]
productLicense kotlin.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. [optional]
defaultAddressPools kotlin.collections.MutableList<SystemInfoDefaultAddressPoolsInner> List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base &quot;10.10.0.0/16&quot; with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools. [optional]
warnings kotlin.collections.MutableList<kotlin.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. [optional]
cdISpecDirs kotlin.collections.MutableList<kotlin.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. [optional]

Enum: CgroupDriver

Name Value
cgroupDriver cgroupfs, systemd, none

Enum: CgroupVersion

Name Value
cgroupVersion 1, 2

Enum: Isolation

Name Value
isolation default, hyperv, process