pakin/docker-sdk-rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
docker-sdk-rust/docs/SystemInfo.md
Pakin 381e758fdf genereated from openapi generator
2025-06-16 16:37:36 +07:00

13 KiB
Raw Permalink Blame History

SystemInfo

Properties

Name Type Description Notes
id Option<String> Unique identifier of the daemon.


> Note: The format of the ID itself is not part of the API, and > should not be considered stable.		 [optional]
containers Option<i32> Total number of containers on the host. [optional]
containers_running Option<i32> Number of containers with status \"running\". [optional]
containers_paused Option<i32> Number of containers with status \"paused\". [optional]
containers_stopped Option<i32> Number of containers with status \"stopped\". [optional]
images Option<i32> Total number of images on the host. Both tagged and untagged (dangling) images are counted. [optional]
driver Option<String> Name of the storage driver in use. [optional]
driver_status Option<Vec<Vec>> 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.		 [optional]
docker_root_dir Option<String> Root directory of persistent Docker state. Defaults to /var/lib/docker on Linux, and C:\\ProgramData\\docker on Windows. [optional]
plugins Option<models::PluginsInfo> [optional]
memory_limit Option<bool> Indicates if the host has memory limit support enabled. [optional]
swap_limit Option<bool> Indicates if the host has memory swap limit support enabled. [optional]
kernel_memory_tcp Option<bool> 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]
cpu_cfs_period Option<bool> Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. [optional]
cpu_cfs_quota Option<bool> Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. [optional]
cpu_shares Option<bool> Indicates if CPU Shares limiting is supported by the host. [optional]
cpu_set Option<bool> Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See cpuset(7) [optional]
pids_limit Option<bool> Indicates if the host kernel has PID limit support enabled. [optional]
oom_kill_disable Option<bool> Indicates if OOM killer disable is supported on the host. [optional]
ipv4_forwarding Option<bool> Indicates IPv4 forwarding is enabled. [optional]
bridge_nf_iptables Option<bool> 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.		 [optional]
bridge_nf_ip6tables Option<bool> 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.		 [optional]
debug Option<bool> Indicates if the daemon is running in debug-mode / with debug-level logging enabled. [optional]
nfd Option<i32> The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled. [optional]
n_goroutines Option<i32> The number of goroutines that currently exist. This information is only returned if debug-mode is enabled. [optional]
system_time Option<String> Current system-time in RFC 3339 format with nano-seconds. [optional]
logging_driver Option<String> The logging driver to use as a default for new containers. [optional]
cgroup_driver Option<String> The driver to use for managing cgroups. [optional][default to Cgroupfs]
cgroup_version Option<String> The version of the cgroup. [optional][default to Variant1]
n_events_listener Option<i32> Number of event listeners subscribed. [optional]
kernel_version Option<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)". [optional]
operating_system Option<String> Name of the host's operating system, for example: "Ubuntu 24.04 LTS" or "Windows Server 2016 Datacenter" [optional]
os_version Option<String> 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.		 [optional]
os_type Option<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. [optional]
architecture Option<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 Option<i32> 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]
mem_total Option<i64> Total amount of physical memory available on the host, in bytes. [optional]
index_server_address Option<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][default to https://index.docker.io/v1/]
registry_config Option<models::RegistryServiceConfig> [optional]
generic_resources Option<Vecmodels::GenericResourcesInner> User-defined resources can be either Integer resources (e.g, SSD=3) or String resources (e.g, GPU=UUID1). [optional]
http_proxy Option<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]
https_proxy Option<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]
no_proxy Option<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 Option<String> Hostname of the host. [optional]
labels Option<Vec> 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.		 [optional]
experimental_build Option<bool> Indicates if experimental features are enabled on the daemon. [optional]
server_version Option<String> Version string of the daemon. [optional]
runtimes Option<std::collections::HashMap<String, models::Runtime>> 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. [optional]
default_runtime Option<String> Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time. [optional][default to runc]
swarm Option<models::SwarmInfo> [optional]
live_restore_enabled Option<bool> 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][default to false]
isolation Option<String> 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][default to Default]
init_binary Option<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]
containerd_commit Option<models::Commit> [optional]
runc_commit Option<models::Commit> [optional]
init_commit Option<models::Commit> [optional]
security_options Option<Vec> 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]
product_license Option<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]
default_address_pools Option<Vecmodels::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 "10.10.0.0/16" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools. [optional]
firewall_backend Option<models::FirewallInfo> [optional]
discovered_devices Option<Vecmodels::DeviceInfo> List of devices discovered by device drivers. Each device includes information about its source driver, kind, name, and additional driver-specific attributes. [optional]
warnings Option<Vec> 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]
cdi_spec_dirs Option<Vec> 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]
containerd Option<models::ContainerdInfo> [optional]

[Back to Model list] [Back to API list] [Back to README]