Documentation

SystemInfo

Table of Contents

$architecture  : string|null
Hardware architecture of the host, as returned by the Go runtime.
$bridgeNfIp6tables  : bool|null
Indicates if `bridge-nf-call-ip6tables` is available on the host.
$bridgeNfIptables  : bool|null
Indicates if `bridge-nf-call-iptables` is available on the host.
$cgroupDriver  : string|null
The driver to use for managing cgroups.
$clusterAdvertise  : string|null
The network endpoint that the Engine advertises for the purpose of.
$clusterStore  : string|null
URL of the distributed storage backend.
$containerdCommit  : Commit|null
Commit holds the Git-commit (SHA1) that a binary was built from, as.
$containers  : int|null
Total number of containers on the host.
$containersPaused  : int|null
Number of containers with status `"paused"`.
$containersRunning  : int|null
Number of containers with status `"running"`.
$containersStopped  : int|null
Number of containers with status `"stopped"`.
$cpuCfsPeriod  : bool|null
Indicates if CPU CFS(Completely Fair Scheduler) period is supported by.
$cpuCfsQuota  : bool|null
Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by.
$cPUSet  : bool|null
Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host.
$cPUShares  : bool|null
Indicates if CPU Shares limiting is supported by the host.
$debug  : bool|null
Indicates if the daemon is running in debug-mode / with debug-level.
$defaultRuntime  : string|null
Name of the default OCI runtime that is used when starting containers.
$dockerRootDir  : string|null
Root directory of persistent Docker state.
$driver  : string|null
Name of the storage driver in use.
$driverStatus  : array<string|int, array<string|int, string>>|null
Information specific to the storage driver, provided as.
$experimentalBuild  : bool|null
Indicates if experimental features are enabled on the daemon.
$genericResources  : array<string|int, GenericResourcesItem>|null
User-defined resources can be either Integer resources (e.g, `SSD=3`) or.
$httpProxy  : string|null
HTTP-proxy configured for the daemon. This value is obtained from the.
$httpsProxy  : string|null
HTTPS-proxy configured for the daemon. This value is obtained from the.
$iD  : string|null
Unique identifier of the daemon.
$images  : int|null
Total number of images on the host.
$indexServerAddress  : string|null
Address / URL of the index server that is used for image search,.
$initBinary  : string|null
Name and, optional, path of the `docker-init` binary.
$initCommit  : Commit|null
Commit holds the Git-commit (SHA1) that a binary was built from, as.
$iPv4Forwarding  : bool|null
Indicates IPv4 forwarding is enabled.
$isolation  : string|null
Represents the isolation technology to use as a default for containers.
$kernelMemory  : bool|null
Indicates if the host has kernel memory limit support enabled.
$kernelVersion  : string|null
Kernel version of the host.
$labels  : array<string|int, string>|null
User-defined labels (key/value metadata) as set on the daemon.
$liveRestoreEnabled  : bool|null
Indicates if live restore is enabled.
$loggingDriver  : string|null
The logging driver to use as a default for new containers.
$memoryLimit  : bool|null
Indicates if the host has memory limit support enabled.
$memTotal  : int|null
Total amount of physical memory available on the host, in bytes.
$name  : string|null
Hostname of the host.
$nCPU  : int|null
The number of logical CPUs usable by the daemon.
$nEventsListener  : int|null
Number of event listeners subscribed.
$nFd  : int|null
The total number of file Descriptors in use by the daemon process.
$nGoroutines  : int|null
The number of goroutines that currently exist.
$noProxy  : string|null
Comma-separated list of domain extensions for which no proxy should be.
$oomKillDisable  : bool|null
Indicates if OOM killer disable is supported on the host.
$operatingSystem  : string|null
Name of the host's operating system, for example: "Ubuntu 16.04.2 LTS".
$oSType  : string|null
Generic type of the operating system of the host, as returned by the.
$pidsLimit  : bool|null
Indicates if the host kernel has PID limit support enabled.
$plugins  : PluginsInfo|null
Available plugins per type.
$productLicense  : string|null
Reports a summary of the product license on the daemon.
$registryConfig  : RegistryServiceConfig|null
RegistryServiceConfig stores daemon registry services configuration.
$runcCommit  : Commit|null
Commit holds the Git-commit (SHA1) that a binary was built from, as.
$runtimes  : array<string|int, Runtime>|null
List of [OCI compliant](https://github.com/opencontainers/runtime-spec).
$securityOptions  : array<string|int, string>|null
List of security features that are enabled on the daemon, such as.
$serverVersion  : string|null
Version string of the daemon.
$swapLimit  : bool|null
Indicates if the host has memory swap limit support enabled.
$swarm  : SwarmInfo|null
Represents generic information about swarm.
$systemStatus  : array<string|int, array<string|int, string>>|null
Status information about this node (standalone Swarm API).
$systemTime  : string|null
Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).
$warnings  : array<string|int, string>|null
List of warnings / informational messages about missing features, or.
getArchitecture()  : string|null
Hardware architecture of the host, as returned by the Go runtime.
getBridgeNfIp6tables()  : bool|null
Indicates if `bridge-nf-call-ip6tables` is available on the host.
getBridgeNfIptables()  : bool|null
Indicates if `bridge-nf-call-iptables` is available on the host.
getCgroupDriver()  : string|null
The driver to use for managing cgroups.
getClusterAdvertise()  : string|null
The network endpoint that the Engine advertises for the purpose of.
getClusterStore()  : string|null
URL of the distributed storage backend.
getContainerdCommit()  : Commit|null
Commit holds the Git-commit (SHA1) that a binary was built from, as.
getContainers()  : int|null
Total number of containers on the host.
getContainersPaused()  : int|null
Number of containers with status `"paused"`.
getContainersRunning()  : int|null
Number of containers with status `"running"`.
getContainersStopped()  : int|null
Number of containers with status `"stopped"`.
getCpuCfsPeriod()  : bool|null
Indicates if CPU CFS(Completely Fair Scheduler) period is supported by.
getCpuCfsQuota()  : bool|null
Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by.
getCPUSet()  : bool|null
Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host.
getCPUShares()  : bool|null
Indicates if CPU Shares limiting is supported by the host.
getDebug()  : bool|null
Indicates if the daemon is running in debug-mode / with debug-level.
getDefaultRuntime()  : string|null
Name of the default OCI runtime that is used when starting containers.
getDockerRootDir()  : string|null
Root directory of persistent Docker state.
getDriver()  : string|null
Name of the storage driver in use.
getDriverStatus()  : array<string|int, array<string|int, string>>|null
Information specific to the storage driver, provided as.
getExperimentalBuild()  : bool|null
Indicates if experimental features are enabled on the daemon.
getGenericResources()  : array<string|int, GenericResourcesItem>|null
User-defined resources can be either Integer resources (e.g, `SSD=3`) or.
getHttpProxy()  : string|null
HTTP-proxy configured for the daemon. This value is obtained from the.
getHttpsProxy()  : string|null
HTTPS-proxy configured for the daemon. This value is obtained from the.
getID()  : string|null
Unique identifier of the daemon.
getImages()  : int|null
Total number of images on the host.
getIndexServerAddress()  : string|null
Address / URL of the index server that is used for image search,.
getInitBinary()  : string|null
Name and, optional, path of the `docker-init` binary.
getInitCommit()  : Commit|null
Commit holds the Git-commit (SHA1) that a binary was built from, as.
getIPv4Forwarding()  : bool|null
Indicates IPv4 forwarding is enabled.
getIsolation()  : string|null
Represents the isolation technology to use as a default for containers.
getKernelMemory()  : bool|null
Indicates if the host has kernel memory limit support enabled.
getKernelVersion()  : string|null
Kernel version of the host.
getLabels()  : array<string|int, string>|null
User-defined labels (key/value metadata) as set on the daemon.
getLiveRestoreEnabled()  : bool|null
Indicates if live restore is enabled.
getLoggingDriver()  : string|null
The logging driver to use as a default for new containers.
getMemoryLimit()  : bool|null
Indicates if the host has memory limit support enabled.
getMemTotal()  : int|null
Total amount of physical memory available on the host, in bytes.
getName()  : string|null
Hostname of the host.
getNCPU()  : int|null
The number of logical CPUs usable by the daemon.
getNEventsListener()  : int|null
Number of event listeners subscribed.
getNFd()  : int|null
The total number of file Descriptors in use by the daemon process.
getNGoroutines()  : int|null
The number of goroutines that currently exist.
getNoProxy()  : string|null
Comma-separated list of domain extensions for which no proxy should be.
getOomKillDisable()  : bool|null
Indicates if OOM killer disable is supported on the host.
getOperatingSystem()  : string|null
Name of the host's operating system, for example: "Ubuntu 16.04.2 LTS".
getOSType()  : string|null
Generic type of the operating system of the host, as returned by the.
getPidsLimit()  : bool|null
Indicates if the host kernel has PID limit support enabled.
getPlugins()  : PluginsInfo|null
Available plugins per type.
getProductLicense()  : string|null
Reports a summary of the product license on the daemon.
getRegistryConfig()  : RegistryServiceConfig|null
RegistryServiceConfig stores daemon registry services configuration.
getRuncCommit()  : Commit|null
Commit holds the Git-commit (SHA1) that a binary was built from, as.
getRuntimes()  : array<string|int, Runtime>|null
List of [OCI compliant](https://github.com/opencontainers/runtime-spec).
getSecurityOptions()  : array<string|int, string>|null
List of security features that are enabled on the daemon, such as.
getServerVersion()  : string|null
Version string of the daemon.
getSwapLimit()  : bool|null
Indicates if the host has memory swap limit support enabled.
getSwarm()  : SwarmInfo|null
Represents generic information about swarm.
getSystemStatus()  : array<string|int, array<string|int, string>>|null
Status information about this node (standalone Swarm API).
getSystemTime()  : string|null
Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).
getWarnings()  : array<string|int, string>|null
List of warnings / informational messages about missing features, or.
setArchitecture()  : self
Hardware architecture of the host, as returned by the Go runtime.
setBridgeNfIp6tables()  : self
Indicates if `bridge-nf-call-ip6tables` is available on the host.
setBridgeNfIptables()  : self
Indicates if `bridge-nf-call-iptables` is available on the host.
setCgroupDriver()  : self
The driver to use for managing cgroups.
setClusterAdvertise()  : self
The network endpoint that the Engine advertises for the purpose of.
setClusterStore()  : self
URL of the distributed storage backend.
setContainerdCommit()  : self
Commit holds the Git-commit (SHA1) that a binary was built from, as.
setContainers()  : self
Total number of containers on the host.
setContainersPaused()  : self
Number of containers with status `"paused"`.
setContainersRunning()  : self
Number of containers with status `"running"`.
setContainersStopped()  : self
Number of containers with status `"stopped"`.
setCpuCfsPeriod()  : self
Indicates if CPU CFS(Completely Fair Scheduler) period is supported by.
setCpuCfsQuota()  : self
Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by.
setCPUSet()  : self
Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host.
setCPUShares()  : self
Indicates if CPU Shares limiting is supported by the host.
setDebug()  : self
Indicates if the daemon is running in debug-mode / with debug-level.
setDefaultRuntime()  : self
Name of the default OCI runtime that is used when starting containers.
setDockerRootDir()  : self
Root directory of persistent Docker state.
setDriver()  : self
Name of the storage driver in use.
setDriverStatus()  : self
Information specific to the storage driver, provided as.
setExperimentalBuild()  : self
Indicates if experimental features are enabled on the daemon.
setGenericResources()  : self
User-defined resources can be either Integer resources (e.g, `SSD=3`) or.
setHttpProxy()  : self
HTTP-proxy configured for the daemon. This value is obtained from the.
setHttpsProxy()  : self
HTTPS-proxy configured for the daemon. This value is obtained from the.
setID()  : self
Unique identifier of the daemon.
setImages()  : self
Total number of images on the host.
setIndexServerAddress()  : self
Address / URL of the index server that is used for image search,.
setInitBinary()  : self
Name and, optional, path of the `docker-init` binary.
setInitCommit()  : self
Commit holds the Git-commit (SHA1) that a binary was built from, as.
setIPv4Forwarding()  : self
Indicates IPv4 forwarding is enabled.
setIsolation()  : self
Represents the isolation technology to use as a default for containers.
setKernelMemory()  : self
Indicates if the host has kernel memory limit support enabled.
setKernelVersion()  : self
Kernel version of the host.
setLabels()  : self
User-defined labels (key/value metadata) as set on the daemon.
setLiveRestoreEnabled()  : self
Indicates if live restore is enabled.
setLoggingDriver()  : self
The logging driver to use as a default for new containers.
setMemoryLimit()  : self
Indicates if the host has memory limit support enabled.
setMemTotal()  : self
Total amount of physical memory available on the host, in bytes.
setName()  : self
Hostname of the host.
setNCPU()  : self
The number of logical CPUs usable by the daemon.
setNEventsListener()  : self
Number of event listeners subscribed.
setNFd()  : self
The total number of file Descriptors in use by the daemon process.
setNGoroutines()  : self
The number of goroutines that currently exist.
setNoProxy()  : self
Comma-separated list of domain extensions for which no proxy should be.
setOomKillDisable()  : self
Indicates if OOM killer disable is supported on the host.
setOperatingSystem()  : self
Name of the host's operating system, for example: "Ubuntu 16.04.2 LTS".
setOSType()  : self
Generic type of the operating system of the host, as returned by the.
setPidsLimit()  : self
Indicates if the host kernel has PID limit support enabled.
setPlugins()  : self
Available plugins per type.
setProductLicense()  : self
Reports a summary of the product license on the daemon.
setRegistryConfig()  : self
RegistryServiceConfig stores daemon registry services configuration.
setRuncCommit()  : self
Commit holds the Git-commit (SHA1) that a binary was built from, as.
setRuntimes()  : self
List of [OCI compliant](https://github.com/opencontainers/runtime-spec).
setSecurityOptions()  : self
List of security features that are enabled on the daemon, such as.
setServerVersion()  : self
Version string of the daemon.
setSwapLimit()  : self
Indicates if the host has memory swap limit support enabled.
setSwarm()  : self
Represents generic information about swarm.
setSystemStatus()  : self
Status information about this node (standalone Swarm API).
setSystemTime()  : self
Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).
setWarnings()  : self
List of warnings / informational messages about missing features, or.

Properties

$architecture

Hardware architecture of the host, as returned by the Go runtime.

protected string|null $architecture

$bridgeNfIp6tables

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

protected bool|null $bridgeNfIp6tables

$bridgeNfIptables

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

protected bool|null $bridgeNfIptables

$cgroupDriver

The driver to use for managing cgroups.

protected string|null $cgroupDriver = 'cgroupfs'

$clusterAdvertise

The network endpoint that the Engine advertises for the purpose of.

protected string|null $clusterAdvertise


Note: This field is only propagated when using standalone Swarm

$clusterStore

URL of the distributed storage backend.

protected string|null $clusterStore


Note: This field is only propagated when using standalone Swarm

$containerdCommit

Commit holds the Git-commit (SHA1) that a binary was built from, as.

protected Commit|null $containerdCommit

$containers

Total number of containers on the host.

protected int|null $containers

$containersPaused

Number of containers with status `"paused"`.

protected int|null $containersPaused

$containersRunning

Number of containers with status `"running"`.

protected int|null $containersRunning

$containersStopped

Number of containers with status `"stopped"`.

protected int|null $containersStopped

$cpuCfsPeriod

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

protected bool|null $cpuCfsPeriod

$cpuCfsQuota

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

protected bool|null $cpuCfsQuota

$cPUSet

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

protected bool|null $cPUSet

$cPUShares

Indicates if CPU Shares limiting is supported by the host.

protected bool|null $cPUShares

$debug

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

protected bool|null $debug

$defaultRuntime

Name of the default OCI runtime that is used when starting containers.

protected string|null $defaultRuntime = 'runc'

$dockerRootDir

Root directory of persistent Docker state.

protected string|null $dockerRootDir

$driver

Name of the storage driver in use.

protected string|null $driver

$driverStatus

Information specific to the storage driver, provided as.

protected array<string|int, array<string|int, string>>|null $driverStatus


Note: The information returned in this field, including the

$experimentalBuild

Indicates if experimental features are enabled on the daemon.

protected bool|null $experimentalBuild

$genericResources

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

protected array<string|int, GenericResourcesItem>|null $genericResources

$httpProxy

HTTP-proxy configured for the daemon. This value is obtained from the.

protected string|null $httpProxy

$httpsProxy

HTTPS-proxy configured for the daemon. This value is obtained from the.

protected string|null $httpsProxy

$iD

Unique identifier of the daemon.

protected string|null $iD


Note: The format of the ID itself is not part of the API, and

$images

Total number of images on the host.

protected int|null $images

$indexServerAddress

Address / URL of the index server that is used for image search,.

protected string|null $indexServerAddress = 'https://index.docker.io/v1/'

$initBinary

Name and, optional, path of the `docker-init` binary.

protected string|null $initBinary

$initCommit

Commit holds the Git-commit (SHA1) that a binary was built from, as.

protected Commit|null $initCommit

$iPv4Forwarding

Indicates IPv4 forwarding is enabled.

protected bool|null $iPv4Forwarding

$isolation

Represents the isolation technology to use as a default for containers.

protected string|null $isolation = 'default'

$kernelMemory

Indicates if the host has kernel memory limit support enabled.

protected bool|null $kernelMemory

$kernelVersion

Kernel version of the host.

protected string|null $kernelVersion

$labels

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

protected array<string|int, string>|null $labels


Note: When part of a Swarm, nodes can both have daemon labels,

$liveRestoreEnabled

Indicates if live restore is enabled.

protected bool|null $liveRestoreEnabled = false

$loggingDriver

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

protected string|null $loggingDriver

$memoryLimit

Indicates if the host has memory limit support enabled.

protected bool|null $memoryLimit

$memTotal

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

protected int|null $memTotal

$name

Hostname of the host.

protected string|null $name

$nCPU

The number of logical CPUs usable by the daemon.

protected int|null $nCPU

$nEventsListener

Number of event listeners subscribed.

protected int|null $nEventsListener

$nFd

The total number of file Descriptors in use by the daemon process.

protected int|null $nFd

$nGoroutines

The number of goroutines that currently exist.

protected int|null $nGoroutines

$noProxy

Comma-separated list of domain extensions for which no proxy should be.

protected string|null $noProxy

$oomKillDisable

Indicates if OOM killer disable is supported on the host.

protected bool|null $oomKillDisable

$operatingSystem

Name of the host's operating system, for example: "Ubuntu 16.04.2 LTS".

protected string|null $operatingSystem

$oSType

Generic type of the operating system of the host, as returned by the.

protected string|null $oSType

$pidsLimit

Indicates if the host kernel has PID limit support enabled.

protected bool|null $pidsLimit

$plugins

Available plugins per type.

protected PluginsInfo|null $plugins


Note: Only unmanaged (V1) plugins are included in this list.

$productLicense

Reports a summary of the product license on the daemon.

protected string|null $productLicense

$runcCommit

Commit holds the Git-commit (SHA1) that a binary was built from, as.

protected Commit|null $runcCommit

$runtimes

List of [OCI compliant](https://github.com/opencontainers/runtime-spec).

protected array<string|int, Runtime>|null $runtimes

$securityOptions

List of security features that are enabled on the daemon, such as.

protected array<string|int, string>|null $securityOptions

$swapLimit

Indicates if the host has memory swap limit support enabled.

protected bool|null $swapLimit

$systemStatus

Status information about this node (standalone Swarm API).

protected array<string|int, array<string|int, string>>|null $systemStatus


Note: The information returned in this field is only propagated

$systemTime

Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).

protected string|null $systemTime

$warnings

List of warnings / informational messages about missing features, or.

protected array<string|int, string>|null $warnings

Methods

getArchitecture()

Hardware architecture of the host, as returned by the Go runtime.

public getArchitecture() : string|null

A full list of possible values can be found in the Go documentation.

Return values
string|null —

getBridgeNfIp6tables()

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

public getBridgeNfIp6tables() : bool|null
Return values
bool|null —

getBridgeNfIptables()

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

public getBridgeNfIptables() : bool|null
Return values
bool|null —

getCgroupDriver()

The driver to use for managing cgroups.

public getCgroupDriver() : string|null
Return values
string|null —

getClusterAdvertise()

The network endpoint that the Engine advertises for the purpose of.

public getClusterAdvertise() : string|null


Note: This field is only propagated when using standalone Swarm mode, and overlay networking using an external k/v store. Overlay networks with Swarm mode enabled use the built-in raft store, and this field will be empty.

Return values
string|null —

getClusterStore()

URL of the distributed storage backend.

public getClusterStore() : string|null


Note: This field is only propagated when using standalone Swarm mode, and overlay networking using an external k/v store. Overlay networks with Swarm mode enabled use the built-in raft store, and this field will be empty.

Return values
string|null —

getContainerdCommit()

Commit holds the Git-commit (SHA1) that a binary was built from, as.

public getContainerdCommit() : Commit|null

or runC.

Return values
Commit|null —

getContainers()

Total number of containers on the host.

public getContainers() : int|null
Return values
int|null —

getContainersPaused()

Number of containers with status `"paused"`.

public getContainersPaused() : int|null
Return values
int|null —

getContainersRunning()

Number of containers with status `"running"`.

public getContainersRunning() : int|null
Return values
int|null —

getContainersStopped()

Number of containers with status `"stopped"`.

public getContainersStopped() : int|null
Return values
int|null —

getCpuCfsPeriod()

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

public getCpuCfsPeriod() : bool|null

the host.

Return values
bool|null —

getCpuCfsQuota()

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

public getCpuCfsQuota() : bool|null

the host.

Return values
bool|null —

getCPUSet()

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

public getCPUSet() : bool|null

See cpuset(7)

Return values
bool|null —

getCPUShares()

Indicates if CPU Shares limiting is supported by the host.

public getCPUShares() : bool|null
Return values
bool|null —

getDebug()

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

public getDebug() : bool|null

logging enabled.

Return values
bool|null —

getDefaultRuntime()

Name of the default OCI runtime that is used when starting containers.

public getDefaultRuntime() : string|null

The default can be overridden per-container at create time.

Return values
string|null —

getDockerRootDir()

Root directory of persistent Docker state.

public getDockerRootDir() : string|null

on Windows.

Return values
string|null —

getDriver()

Name of the storage driver in use.

public getDriver() : string|null
Return values
string|null —

getDriverStatus()

Information specific to the storage driver, provided as.

public getDriverStatus() : array<string|int, array<string|int, string>>|null


Note: The information returned in this field, including the

Return values
array<string|int, array<string|int, string>>|null —

getExperimentalBuild()

Indicates if experimental features are enabled on the daemon.

public getExperimentalBuild() : bool|null
Return values
bool|null —

getHttpProxy()

HTTP-proxy configured for the daemon. This value is obtained from the.

public getHttpProxy() : string|null

Containers do not automatically inherit this configuration.

Return values
string|null —

getHttpsProxy()

HTTPS-proxy configured for the daemon. This value is obtained from the.

public getHttpsProxy() : string|null

Containers do not automatically inherit this configuration.

Return values
string|null —

getID()

Unique identifier of the daemon.

public getID() : string|null


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

Return values
string|null —

getImages()

Total number of images on the host.

public getImages() : int|null

Both tagged and untagged (dangling) images are counted.

Return values
int|null —

getIndexServerAddress()

Address / URL of the index server that is used for image search,.

public getIndexServerAddress() : string|null

and as a default for user authentication for Docker Hub and Docker Cloud.

Return values
string|null —

getInitBinary()

Name and, optional, path of the `docker-init` binary.

public getInitBinary() : string|null

binary and uses the first result.

Return values
string|null —

getInitCommit()

Commit holds the Git-commit (SHA1) that a binary was built from, as.

public getInitCommit() : Commit|null

or runC.

Return values
Commit|null —

getIPv4Forwarding()

Indicates IPv4 forwarding is enabled.

public getIPv4Forwarding() : bool|null
Return values
bool|null —

getIsolation()

Represents the isolation technology to use as a default for containers.

public getIsolation() : string|null

This option is currently not used on other platforms.

Return values
string|null —

getKernelMemory()

Indicates if the host has kernel memory limit support enabled.

public getKernelMemory() : bool|null
Return values
bool|null —

getKernelVersion()

Kernel version of the host.

public getKernelVersion() : string|null

registry value, for example "10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)".

Return values
string|null —

getLabels()

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

public getLabels() : array<string|int, string>|null


Note: When part of a Swarm, nodes can both have daemon labels,

Return values
array<string|int, string>|null —

getLiveRestoreEnabled()

Indicates if live restore is enabled.

public getLiveRestoreEnabled() : bool|null

or upon daemon start if running containers are detected.

Return values
bool|null —

getLoggingDriver()

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

public getLoggingDriver() : string|null
Return values
string|null —

getMemoryLimit()

Indicates if the host has memory limit support enabled.

public getMemoryLimit() : bool|null
Return values
bool|null —

getMemTotal()

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

public getMemTotal() : int|null
Return values
int|null —

getName()

Hostname of the host.

public getName() : string|null
Return values
string|null —

getNCPU()

The number of logical CPUs usable by the daemon.

public getNCPU() : int|null

allocation after the daemon is started are not reflected.

Return values
int|null —

getNEventsListener()

Number of event listeners subscribed.

public getNEventsListener() : int|null
Return values
int|null —

getNFd()

The total number of file Descriptors in use by the daemon process.

public getNFd() : int|null

This information is only returned if debug-mode is enabled.

Return values
int|null —

getNGoroutines()

The number of goroutines that currently exist.

public getNGoroutines() : int|null

This information is only returned if debug-mode is enabled.

Return values
int|null —

getNoProxy()

Comma-separated list of domain extensions for which no proxy should be.

public getNoProxy() : string|null

Containers do not automatically inherit this configuration.

Return values
string|null —

getOomKillDisable()

Indicates if OOM killer disable is supported on the host.

public getOomKillDisable() : bool|null
Return values
bool|null —

getOperatingSystem()

Name of the host's operating system, for example: "Ubuntu 16.04.2 LTS".

public getOperatingSystem() : string|null

or "Windows Server 2016 Datacenter"

Return values
string|null —

getOSType()

Generic type of the operating system of the host, as returned by the.

public getOSType() : string|null

possible values can be found in the Go documentation.

Return values
string|null —

getPidsLimit()

Indicates if the host kernel has PID limit support enabled.

public getPidsLimit() : bool|null
Return values
bool|null —

getPlugins()

Available plugins per type.

public getPlugins() : PluginsInfo|null


Note: Only unmanaged (V1) plugins are included in this list. V1 plugins are "lazily" loaded, and are not returned in this list if there is no resource using the plugin.

Return values
PluginsInfo|null —

getProductLicense()

Reports a summary of the product license on the daemon.

public getProductLicense() : string|null

such as number of nodes, and expiration are included.

Return values
string|null —

getRuncCommit()

Commit holds the Git-commit (SHA1) that a binary was built from, as.

public getRuncCommit() : Commit|null

or runC.

Return values
Commit|null —

getRuntimes()

List of [OCI compliant](https://github.com/opencontainers/runtime-spec).

public getRuntimes() : array<string|int, Runtime>|null
Return values
array<string|int, Runtime>|null —

getSecurityOptions()

List of security features that are enabled on the daemon, such as.

public getSecurityOptions() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getServerVersion()

Version string of the daemon.

public getServerVersion() : string|null

Note: the standalone Swarm API swarm/1.2.8.

Return values
string|null —

getSwapLimit()

Indicates if the host has memory swap limit support enabled.

public getSwapLimit() : bool|null
Return values
bool|null —

getSystemStatus()

Status information about this node (standalone Swarm API).

public getSystemStatus() : array<string|int, array<string|int, string>>|null


Note: The information returned in this field is only propagated

Return values
array<string|int, array<string|int, string>>|null —

getSystemTime()

Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).

public getSystemTime() : string|null

format with nano-seconds.

Return values
string|null —

getWarnings()

List of warnings / informational messages about missing features, or.

public getWarnings() : array<string|int, string>|null
Return values
array<string|int, string>|null —

setArchitecture()

Hardware architecture of the host, as returned by the Go runtime.

public setArchitecture(string|null $architecture) : self

A full list of possible values can be found in the Go documentation.

Parameters
$architecture : string|null
Return values
self —

setBridgeNfIp6tables()

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

public setBridgeNfIp6tables(bool|null $bridgeNfIp6tables) : self
Parameters
$bridgeNfIp6tables : bool|null
Return values
self —

setBridgeNfIptables()

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

public setBridgeNfIptables(bool|null $bridgeNfIptables) : self
Parameters
$bridgeNfIptables : bool|null
Return values
self —

setCgroupDriver()

The driver to use for managing cgroups.

public setCgroupDriver(string|null $cgroupDriver) : self
Parameters
$cgroupDriver : string|null
Return values
self —

setClusterAdvertise()

The network endpoint that the Engine advertises for the purpose of.

public setClusterAdvertise(string|null $clusterAdvertise) : self


Note: This field is only propagated when using standalone Swarm mode, and overlay networking using an external k/v store. Overlay networks with Swarm mode enabled use the built-in raft store, and this field will be empty.

Parameters
$clusterAdvertise : string|null
Return values
self —

setClusterStore()

URL of the distributed storage backend.

public setClusterStore(string|null $clusterStore) : self


Note: This field is only propagated when using standalone Swarm mode, and overlay networking using an external k/v store. Overlay networks with Swarm mode enabled use the built-in raft store, and this field will be empty.

Parameters
$clusterStore : string|null
Return values
self —

setContainerdCommit()

Commit holds the Git-commit (SHA1) that a binary was built from, as.

public setContainerdCommit(Commit|null $containerdCommit) : self

or runC.

Parameters
$containerdCommit : Commit|null
Return values
self —

setContainers()

Total number of containers on the host.

public setContainers(int|null $containers) : self
Parameters
$containers : int|null
Return values
self —

setContainersPaused()

Number of containers with status `"paused"`.

public setContainersPaused(int|null $containersPaused) : self
Parameters
$containersPaused : int|null
Return values
self —

setContainersRunning()

Number of containers with status `"running"`.

public setContainersRunning(int|null $containersRunning) : self
Parameters
$containersRunning : int|null
Return values
self —

setContainersStopped()

Number of containers with status `"stopped"`.

public setContainersStopped(int|null $containersStopped) : self
Parameters
$containersStopped : int|null
Return values
self —

setCpuCfsPeriod()

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

public setCpuCfsPeriod(bool|null $cpuCfsPeriod) : self

the host.

Parameters
$cpuCfsPeriod : bool|null
Return values
self —

setCpuCfsQuota()

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

public setCpuCfsQuota(bool|null $cpuCfsQuota) : self

the host.

Parameters
$cpuCfsQuota : bool|null
Return values
self —

setCPUSet()

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

public setCPUSet(bool|null $cPUSet) : self

See cpuset(7)

Parameters
$cPUSet : bool|null
Return values
self —

setCPUShares()

Indicates if CPU Shares limiting is supported by the host.

public setCPUShares(bool|null $cPUShares) : self
Parameters
$cPUShares : bool|null
Return values
self —

setDebug()

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

public setDebug(bool|null $debug) : self

logging enabled.

Parameters
$debug : bool|null
Return values
self —

setDefaultRuntime()

Name of the default OCI runtime that is used when starting containers.

public setDefaultRuntime(string|null $defaultRuntime) : self

The default can be overridden per-container at create time.

Parameters
$defaultRuntime : string|null
Return values
self —

setDockerRootDir()

Root directory of persistent Docker state.

public setDockerRootDir(string|null $dockerRootDir) : self

on Windows.

Parameters
$dockerRootDir : string|null
Return values
self —

setDriver()

Name of the storage driver in use.

public setDriver(string|null $driver) : self
Parameters
$driver : string|null
Return values
self —

setDriverStatus()

Information specific to the storage driver, provided as.

public setDriverStatus(array<string|int, array<string|int, string>>|null $driverStatus) : self


Note: The information returned in this field, including the

Parameters
$driverStatus : array<string|int, array<string|int, string>>|null
Return values
self —

setExperimentalBuild()

Indicates if experimental features are enabled on the daemon.

public setExperimentalBuild(bool|null $experimentalBuild) : self
Parameters
$experimentalBuild : bool|null
Return values
self —

setGenericResources()

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

public setGenericResources(array<string|int, GenericResourcesItem>|null $genericResources) : self
Parameters
$genericResources : array<string|int, GenericResourcesItem>|null
Return values
self —

setHttpProxy()

HTTP-proxy configured for the daemon. This value is obtained from the.

public setHttpProxy(string|null $httpProxy) : self

Containers do not automatically inherit this configuration.

Parameters
$httpProxy : string|null
Return values
self —

setHttpsProxy()

HTTPS-proxy configured for the daemon. This value is obtained from the.

public setHttpsProxy(string|null $httpsProxy) : self

Containers do not automatically inherit this configuration.

Parameters
$httpsProxy : string|null
Return values
self —

setID()

Unique identifier of the daemon.

public setID(string|null $iD) : self


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

Parameters
$iD : string|null
Return values
self —

setImages()

Total number of images on the host.

public setImages(int|null $images) : self

Both tagged and untagged (dangling) images are counted.

Parameters
$images : int|null
Return values
self —

setIndexServerAddress()

Address / URL of the index server that is used for image search,.

public setIndexServerAddress(string|null $indexServerAddress) : self

and as a default for user authentication for Docker Hub and Docker Cloud.

Parameters
$indexServerAddress : string|null
Return values
self —

setInitBinary()

Name and, optional, path of the `docker-init` binary.

public setInitBinary(string|null $initBinary) : self

binary and uses the first result.

Parameters
$initBinary : string|null
Return values
self —

setInitCommit()

Commit holds the Git-commit (SHA1) that a binary was built from, as.

public setInitCommit(Commit|null $initCommit) : self

or runC.

Parameters
$initCommit : Commit|null
Return values
self —

setIPv4Forwarding()

Indicates IPv4 forwarding is enabled.

public setIPv4Forwarding(bool|null $iPv4Forwarding) : self
Parameters
$iPv4Forwarding : bool|null
Return values
self —

setIsolation()

Represents the isolation technology to use as a default for containers.

public setIsolation(string|null $isolation) : self

This option is currently not used on other platforms.

Parameters
$isolation : string|null
Return values
self —

setKernelMemory()

Indicates if the host has kernel memory limit support enabled.

public setKernelMemory(bool|null $kernelMemory) : self
Parameters
$kernelMemory : bool|null
Return values
self —

setKernelVersion()

Kernel version of the host.

public setKernelVersion(string|null $kernelVersion) : self

registry value, for example "10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)".

Parameters
$kernelVersion : string|null
Return values
self —

setLabels()

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

public setLabels(array<string|int, string>|null $labels) : self


Note: When part of a Swarm, nodes can both have daemon labels,

Parameters
$labels : array<string|int, string>|null
Return values
self —

setLiveRestoreEnabled()

Indicates if live restore is enabled.

public setLiveRestoreEnabled(bool|null $liveRestoreEnabled) : self

or upon daemon start if running containers are detected.

Parameters
$liveRestoreEnabled : bool|null
Return values
self —

setLoggingDriver()

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

public setLoggingDriver(string|null $loggingDriver) : self
Parameters
$loggingDriver : string|null
Return values
self —

setMemoryLimit()

Indicates if the host has memory limit support enabled.

public setMemoryLimit(bool|null $memoryLimit) : self
Parameters
$memoryLimit : bool|null
Return values
self —

setMemTotal()

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

public setMemTotal(int|null $memTotal) : self
Parameters
$memTotal : int|null
Return values
self —

setName()

Hostname of the host.

public setName(string|null $name) : self
Parameters
$name : string|null
Return values
self —

setNCPU()

The number of logical CPUs usable by the daemon.

public setNCPU(int|null $nCPU) : self

allocation after the daemon is started are not reflected.

Parameters
$nCPU : int|null
Return values
self —

setNEventsListener()

Number of event listeners subscribed.

public setNEventsListener(int|null $nEventsListener) : self
Parameters
$nEventsListener : int|null
Return values
self —

setNFd()

The total number of file Descriptors in use by the daemon process.

public setNFd(int|null $nFd) : self

This information is only returned if debug-mode is enabled.

Parameters
$nFd : int|null
Return values
self —

setNGoroutines()

The number of goroutines that currently exist.

public setNGoroutines(int|null $nGoroutines) : self

This information is only returned if debug-mode is enabled.

Parameters
$nGoroutines : int|null
Return values
self —

setNoProxy()

Comma-separated list of domain extensions for which no proxy should be.

public setNoProxy(string|null $noProxy) : self

Containers do not automatically inherit this configuration.

Parameters
$noProxy : string|null
Return values
self —

setOomKillDisable()

Indicates if OOM killer disable is supported on the host.

public setOomKillDisable(bool|null $oomKillDisable) : self
Parameters
$oomKillDisable : bool|null
Return values
self —

setOperatingSystem()

Name of the host's operating system, for example: "Ubuntu 16.04.2 LTS".

public setOperatingSystem(string|null $operatingSystem) : self

or "Windows Server 2016 Datacenter"

Parameters
$operatingSystem : string|null
Return values
self —

setOSType()

Generic type of the operating system of the host, as returned by the.

public setOSType(string|null $oSType) : self

possible values can be found in the Go documentation.

Parameters
$oSType : string|null
Return values
self —

setPidsLimit()

Indicates if the host kernel has PID limit support enabled.

public setPidsLimit(bool|null $pidsLimit) : self
Parameters
$pidsLimit : bool|null
Return values
self —

setPlugins()

Available plugins per type.

public setPlugins(PluginsInfo|null $plugins) : self


Note: Only unmanaged (V1) plugins are included in this list. V1 plugins are "lazily" loaded, and are not returned in this list if there is no resource using the plugin.

Parameters
$plugins : PluginsInfo|null
Return values
self —

setProductLicense()

Reports a summary of the product license on the daemon.

public setProductLicense(string|null $productLicense) : self

such as number of nodes, and expiration are included.

Parameters
$productLicense : string|null
Return values
self —

setRuncCommit()

Commit holds the Git-commit (SHA1) that a binary was built from, as.

public setRuncCommit(Commit|null $runcCommit) : self

or runC.

Parameters
$runcCommit : Commit|null
Return values
self —

setRuntimes()

List of [OCI compliant](https://github.com/opencontainers/runtime-spec).

public setRuntimes(array<string|int, Runtime>|null $runtimes) : self
Parameters
$runtimes : array<string|int, Runtime>|null
Return values
self —

setSecurityOptions()

List of security features that are enabled on the daemon, such as.

public setSecurityOptions(array<string|int, string>|null $securityOptions) : self
Parameters
$securityOptions : array<string|int, string>|null
Return values
self —

setServerVersion()

Version string of the daemon.

public setServerVersion(string|null $serverVersion) : self

Note: the standalone Swarm API swarm/1.2.8.

Parameters
$serverVersion : string|null
Return values
self —

setSwapLimit()

Indicates if the host has memory swap limit support enabled.

public setSwapLimit(bool|null $swapLimit) : self
Parameters
$swapLimit : bool|null
Return values
self —

setSwarm()

Represents generic information about swarm.

public setSwarm(SwarmInfo|null $swarm) : self
Parameters
$swarm : SwarmInfo|null
Return values
self —

setSystemStatus()

Status information about this node (standalone Swarm API).

public setSystemStatus(array<string|int, array<string|int, string>>|null $systemStatus) : self


Note: The information returned in this field is only propagated

Parameters
$systemStatus : array<string|int, array<string|int, string>>|null
Return values
self —

setSystemTime()

Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).

public setSystemTime(string|null $systemTime) : self

format with nano-seconds.

Parameters
$systemTime : string|null
Return values
self —

setWarnings()

List of warnings / informational messages about missing features, or.

public setWarnings(array<string|int, string>|null $warnings) : self
Parameters
$warnings : array<string|int, string>|null
Return values
self —

Search results