Documentation

ContainersIdUpdatePostBody

Table of Contents

$blkioDeviceReadBps  : array<string|int, ThrottleDevice>|null
Limit read rate (bytes per second) from a device, in the form:.
$blkioDeviceReadIOps  : array<string|int, ThrottleDevice>|null
Limit read rate (IO per second) from a device, in the form:.
$blkioDeviceWriteBps  : array<string|int, ThrottleDevice>|null
Limit write rate (bytes per second) to a device, in the form:.
$blkioDeviceWriteIOps  : array<string|int, ThrottleDevice>|null
Limit write rate (IO per second) to a device, in the form:.
$blkioWeight  : int|null
Block IO weight (relative weight).
$blkioWeightDevice  : array<string|int, ResourcesBlkioWeightDeviceItem>|null
Block IO weight (relative device weight) in the form:.
$cgroupParent  : string|null
Path to `cgroups` under which the container's `cgroup` is created. If.
$cpuCount  : int|null
The number of usable CPUs (Windows only).
$cpuPercent  : int|null
The usable percentage of the available CPUs (Windows only).
$cpuPeriod  : int|null
The length of a CPU period in microseconds.
$cpuQuota  : int|null
Microseconds of CPU time that the container can get in a CPU period.
$cpuRealtimePeriod  : int|null
The length of a CPU real-time period in microseconds. Set to 0 to.
$cpuRealtimeRuntime  : int|null
The length of a CPU real-time runtime in microseconds. Set to 0 to.
$cpusetCpus  : string|null
CPUs in which to allow execution (e.g., `0-3`, `0,1`).
$cpusetMems  : string|null
Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only.
$cpuShares  : int|null
An integer value representing this container's relative CPU weight.
$deviceCgroupRules  : array<string|int, string>|null
a list of cgroup rules to apply to the container.
$deviceRequests  : array<string|int, DeviceRequest>|null
A list of requests for devices to be sent to device drivers.
$devices  : array<string|int, DeviceMapping>|null
A list of devices to add to the container.
$init  : bool|null
Run an init inside the container that forwards signals and reaps.
$iOMaximumBandwidth  : int|null
Maximum IO in bytes per second for the container system drive.
$iOMaximumIOps  : int|null
Maximum IOps for the container system drive (Windows only).
$kernelMemory  : int|null
Kernel memory limit in bytes.
$kernelMemoryTCP  : int|null
Hard limit for kernel TCP buffer memory (in bytes).
$memory  : int|null
Memory limit in bytes.
$memoryReservation  : int|null
Memory soft limit in bytes.
$memorySwap  : int|null
Total memory limit (memory + swap). Set as `-1` to enable unlimited.
$memorySwappiness  : int|null
Tune a container's memory swappiness behavior. Accepts an integer.
$nanoCPUs  : int|null
CPU quota in units of 10<sup>-9</sup> CPUs.
$oomKillDisable  : bool|null
Disable OOM Killer for the container.
$pidsLimit  : int|null
Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`.
$restartPolicy  : RestartPolicy|null
The behavior to apply when the container exits. The default is not to.
$ulimits  : array<string|int, ResourcesUlimitsItem>|null
A list of resource limits to set in the container. For example:.
getBlkioDeviceReadBps()  : array<string|int, ThrottleDevice>|null
Limit read rate (bytes per second) from a device, in the form:.
getBlkioDeviceReadIOps()  : array<string|int, ThrottleDevice>|null
Limit read rate (IO per second) from a device, in the form:.
getBlkioDeviceWriteBps()  : array<string|int, ThrottleDevice>|null
Limit write rate (bytes per second) to a device, in the form:.
getBlkioDeviceWriteIOps()  : array<string|int, ThrottleDevice>|null
Limit write rate (IO per second) to a device, in the form:.
getBlkioWeight()  : int|null
Block IO weight (relative weight).
getBlkioWeightDevice()  : array<string|int, ResourcesBlkioWeightDeviceItem>|null
Block IO weight (relative device weight) in the form:.
getCgroupParent()  : string|null
Path to `cgroups` under which the container's `cgroup` is created. If.
getCpuCount()  : int|null
The number of usable CPUs (Windows only).
getCpuPercent()  : int|null
The usable percentage of the available CPUs (Windows only).
getCpuPeriod()  : int|null
The length of a CPU period in microseconds.
getCpuQuota()  : int|null
Microseconds of CPU time that the container can get in a CPU period.
getCpuRealtimePeriod()  : int|null
The length of a CPU real-time period in microseconds. Set to 0 to.
getCpuRealtimeRuntime()  : int|null
The length of a CPU real-time runtime in microseconds. Set to 0 to.
getCpusetCpus()  : string|null
CPUs in which to allow execution (e.g., `0-3`, `0,1`).
getCpusetMems()  : string|null
Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only.
getCpuShares()  : int|null
An integer value representing this container's relative CPU weight.
getDeviceCgroupRules()  : array<string|int, string>|null
a list of cgroup rules to apply to the container.
getDeviceRequests()  : array<string|int, DeviceRequest>|null
A list of requests for devices to be sent to device drivers.
getDevices()  : array<string|int, DeviceMapping>|null
A list of devices to add to the container.
getInit()  : bool|null
Run an init inside the container that forwards signals and reaps.
getIOMaximumBandwidth()  : int|null
Maximum IO in bytes per second for the container system drive.
getIOMaximumIOps()  : int|null
Maximum IOps for the container system drive (Windows only).
getKernelMemory()  : int|null
Kernel memory limit in bytes.
getKernelMemoryTCP()  : int|null
Hard limit for kernel TCP buffer memory (in bytes).
getMemory()  : int|null
Memory limit in bytes.
getMemoryReservation()  : int|null
Memory soft limit in bytes.
getMemorySwap()  : int|null
Total memory limit (memory + swap). Set as `-1` to enable unlimited.
getMemorySwappiness()  : int|null
Tune a container's memory swappiness behavior. Accepts an integer.
getNanoCPUs()  : int|null
CPU quota in units of 10<sup>-9</sup> CPUs.
getOomKillDisable()  : bool|null
Disable OOM Killer for the container.
getPidsLimit()  : int|null
Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`.
getRestartPolicy()  : RestartPolicy|null
The behavior to apply when the container exits. The default is not to.
getUlimits()  : array<string|int, ResourcesUlimitsItem>|null
A list of resource limits to set in the container. For example:.
setBlkioDeviceReadBps()  : self
Limit read rate (bytes per second) from a device, in the form:.
setBlkioDeviceReadIOps()  : self
Limit read rate (IO per second) from a device, in the form:.
setBlkioDeviceWriteBps()  : self
Limit write rate (bytes per second) to a device, in the form:.
setBlkioDeviceWriteIOps()  : self
Limit write rate (IO per second) to a device, in the form:.
setBlkioWeight()  : self
Block IO weight (relative weight).
setBlkioWeightDevice()  : self
Block IO weight (relative device weight) in the form:.
setCgroupParent()  : self
Path to `cgroups` under which the container's `cgroup` is created. If.
setCpuCount()  : self
The number of usable CPUs (Windows only).
setCpuPercent()  : self
The usable percentage of the available CPUs (Windows only).
setCpuPeriod()  : self
The length of a CPU period in microseconds.
setCpuQuota()  : self
Microseconds of CPU time that the container can get in a CPU period.
setCpuRealtimePeriod()  : self
The length of a CPU real-time period in microseconds. Set to 0 to.
setCpuRealtimeRuntime()  : self
The length of a CPU real-time runtime in microseconds. Set to 0 to.
setCpusetCpus()  : self
CPUs in which to allow execution (e.g., `0-3`, `0,1`).
setCpusetMems()  : self
Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only.
setCpuShares()  : self
An integer value representing this container's relative CPU weight.
setDeviceCgroupRules()  : self
a list of cgroup rules to apply to the container.
setDeviceRequests()  : self
A list of requests for devices to be sent to device drivers.
setDevices()  : self
A list of devices to add to the container.
setInit()  : self
Run an init inside the container that forwards signals and reaps.
setIOMaximumBandwidth()  : self
Maximum IO in bytes per second for the container system drive.
setIOMaximumIOps()  : self
Maximum IOps for the container system drive (Windows only).
setKernelMemory()  : self
Kernel memory limit in bytes.
setKernelMemoryTCP()  : self
Hard limit for kernel TCP buffer memory (in bytes).
setMemory()  : self
Memory limit in bytes.
setMemoryReservation()  : self
Memory soft limit in bytes.
setMemorySwap()  : self
Total memory limit (memory + swap). Set as `-1` to enable unlimited.
setMemorySwappiness()  : self
Tune a container's memory swappiness behavior. Accepts an integer.
setNanoCPUs()  : self
CPU quota in units of 10<sup>-9</sup> CPUs.
setOomKillDisable()  : self
Disable OOM Killer for the container.
setPidsLimit()  : self
Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`.
setRestartPolicy()  : self
The behavior to apply when the container exits. The default is not to.
setUlimits()  : self
A list of resource limits to set in the container. For example:.

Properties

$cgroupParent

Path to `cgroups` under which the container's `cgroup` is created. If.

protected string|null $cgroupParent

$cpuRealtimePeriod

The length of a CPU real-time period in microseconds. Set to 0 to.

protected int|null $cpuRealtimePeriod

$cpuRealtimeRuntime

The length of a CPU real-time runtime in microseconds. Set to 0 to.

protected int|null $cpuRealtimeRuntime

$cpusetMems

Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only.

protected string|null $cpusetMems

$deviceCgroupRules

a list of cgroup rules to apply to the container.

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

$iOMaximumBandwidth

Maximum IO in bytes per second for the container system drive.

protected int|null $iOMaximumBandwidth

$memorySwap

Total memory limit (memory + swap). Set as `-1` to enable unlimited.

protected int|null $memorySwap

$memorySwappiness

Tune a container's memory swappiness behavior. Accepts an integer.

protected int|null $memorySwappiness

$pidsLimit

Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`.

protected int|null $pidsLimit

Methods

getBlkioWeight()

Block IO weight (relative weight).

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

getCgroupParent()

Path to `cgroups` under which the container's `cgroup` is created. If.

public getCgroupParent() : string|null

already exist.

Return values
string|null —

getCpuCount()

The number of usable CPUs (Windows only).

public getCpuCount() : int|null

CPUShares, and CPUPercent last.

Return values
int|null —

getCpuPercent()

The usable percentage of the available CPUs (Windows only).

public getCpuPercent() : int|null

CPUShares, and CPUPercent last.

Return values
int|null —

getCpuPeriod()

The length of a CPU period in microseconds.

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

getCpuQuota()

Microseconds of CPU time that the container can get in a CPU period.

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

getCpuRealtimePeriod()

The length of a CPU real-time period in microseconds. Set to 0 to.

public getCpuRealtimePeriod() : int|null

allocate no time allocated to real-time tasks.

Return values
int|null —

getCpuRealtimeRuntime()

The length of a CPU real-time runtime in microseconds. Set to 0 to.

public getCpuRealtimeRuntime() : int|null

allocate no time allocated to real-time tasks.

Return values
int|null —

getCpusetCpus()

CPUs in which to allow execution (e.g., `0-3`, `0,1`).

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

getCpusetMems()

Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only.

public getCpusetMems() : string|null

effective on NUMA systems.

Return values
string|null —

getCpuShares()

An integer value representing this container's relative CPU weight.

public getCpuShares() : int|null

versus other containers.

Return values
int|null —

getDeviceCgroupRules()

a list of cgroup rules to apply to the container.

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

getInit()

Run an init inside the container that forwards signals and reaps.

public getInit() : bool|null

configured on the daemon) is used.

Return values
bool|null —

getIOMaximumBandwidth()

Maximum IO in bytes per second for the container system drive.

public getIOMaximumBandwidth() : int|null

(Windows only).

Return values
int|null —

getIOMaximumIOps()

Maximum IOps for the container system drive (Windows only).

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

getKernelMemoryTCP()

Hard limit for kernel TCP buffer memory (in bytes).

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

getMemoryReservation()

Memory soft limit in bytes.

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

getMemorySwap()

Total memory limit (memory + swap). Set as `-1` to enable unlimited.

public getMemorySwap() : int|null

swap.

Return values
int|null —

getMemorySwappiness()

Tune a container's memory swappiness behavior. Accepts an integer.

public getMemorySwappiness() : int|null

between 0 and 100.

Return values
int|null —

getNanoCPUs()

CPU quota in units of 10<sup>-9</sup> CPUs.

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

getOomKillDisable()

Disable OOM Killer for the container.

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

getPidsLimit()

Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`.

public getPidsLimit() : int|null

to not change.

Return values
int|null —

setBlkioDeviceReadBps()

Limit read rate (bytes per second) from a device, in the form:.

public setBlkioDeviceReadBps(array<string|int, ThrottleDevice>|null $blkioDeviceReadBps) : self
Parameters
$blkioDeviceReadBps : array<string|int, ThrottleDevice>|null
Return values
self —

setBlkioDeviceReadIOps()

Limit read rate (IO per second) from a device, in the form:.

public setBlkioDeviceReadIOps(array<string|int, ThrottleDevice>|null $blkioDeviceReadIOps) : self
Parameters
$blkioDeviceReadIOps : array<string|int, ThrottleDevice>|null
Return values
self —

setBlkioDeviceWriteBps()

Limit write rate (bytes per second) to a device, in the form:.

public setBlkioDeviceWriteBps(array<string|int, ThrottleDevice>|null $blkioDeviceWriteBps) : self
Parameters
$blkioDeviceWriteBps : array<string|int, ThrottleDevice>|null
Return values
self —

setBlkioDeviceWriteIOps()

Limit write rate (IO per second) to a device, in the form:.

public setBlkioDeviceWriteIOps(array<string|int, ThrottleDevice>|null $blkioDeviceWriteIOps) : self
Parameters
$blkioDeviceWriteIOps : array<string|int, ThrottleDevice>|null
Return values
self —

setBlkioWeight()

Block IO weight (relative weight).

public setBlkioWeight(int|null $blkioWeight) : self
Parameters
$blkioWeight : int|null
Return values
self —

setCgroupParent()

Path to `cgroups` under which the container's `cgroup` is created. If.

public setCgroupParent(string|null $cgroupParent) : self

already exist.

Parameters
$cgroupParent : string|null
Return values
self —

setCpuCount()

The number of usable CPUs (Windows only).

public setCpuCount(int|null $cpuCount) : self

CPUShares, and CPUPercent last.

Parameters
$cpuCount : int|null
Return values
self —

setCpuPercent()

The usable percentage of the available CPUs (Windows only).

public setCpuPercent(int|null $cpuPercent) : self

CPUShares, and CPUPercent last.

Parameters
$cpuPercent : int|null
Return values
self —

setCpuPeriod()

The length of a CPU period in microseconds.

public setCpuPeriod(int|null $cpuPeriod) : self
Parameters
$cpuPeriod : int|null
Return values
self —

setCpuQuota()

Microseconds of CPU time that the container can get in a CPU period.

public setCpuQuota(int|null $cpuQuota) : self
Parameters
$cpuQuota : int|null
Return values
self —

setCpuRealtimePeriod()

The length of a CPU real-time period in microseconds. Set to 0 to.

public setCpuRealtimePeriod(int|null $cpuRealtimePeriod) : self

allocate no time allocated to real-time tasks.

Parameters
$cpuRealtimePeriod : int|null
Return values
self —

setCpuRealtimeRuntime()

The length of a CPU real-time runtime in microseconds. Set to 0 to.

public setCpuRealtimeRuntime(int|null $cpuRealtimeRuntime) : self

allocate no time allocated to real-time tasks.

Parameters
$cpuRealtimeRuntime : int|null
Return values
self —

setCpusetCpus()

CPUs in which to allow execution (e.g., `0-3`, `0,1`).

public setCpusetCpus(string|null $cpusetCpus) : self
Parameters
$cpusetCpus : string|null
Return values
self —

setCpusetMems()

Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only.

public setCpusetMems(string|null $cpusetMems) : self

effective on NUMA systems.

Parameters
$cpusetMems : string|null
Return values
self —

setCpuShares()

An integer value representing this container's relative CPU weight.

public setCpuShares(int|null $cpuShares) : self

versus other containers.

Parameters
$cpuShares : int|null
Return values
self —

setDeviceCgroupRules()

a list of cgroup rules to apply to the container.

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

setDeviceRequests()

A list of requests for devices to be sent to device drivers.

public setDeviceRequests(array<string|int, DeviceRequest>|null $deviceRequests) : self
Parameters
$deviceRequests : array<string|int, DeviceRequest>|null
Return values
self —

setInit()

Run an init inside the container that forwards signals and reaps.

public setInit(bool|null $init) : self

configured on the daemon) is used.

Parameters
$init : bool|null
Return values
self —

setIOMaximumBandwidth()

Maximum IO in bytes per second for the container system drive.

public setIOMaximumBandwidth(int|null $iOMaximumBandwidth) : self

(Windows only).

Parameters
$iOMaximumBandwidth : int|null
Return values
self —

setIOMaximumIOps()

Maximum IOps for the container system drive (Windows only).

public setIOMaximumIOps(int|null $iOMaximumIOps) : self
Parameters
$iOMaximumIOps : int|null
Return values
self —

setKernelMemory()

Kernel memory limit in bytes.

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

setKernelMemoryTCP()

Hard limit for kernel TCP buffer memory (in bytes).

public setKernelMemoryTCP(int|null $kernelMemoryTCP) : self
Parameters
$kernelMemoryTCP : int|null
Return values
self —

setMemory()

Memory limit in bytes.

public setMemory(int|null $memory) : self
Parameters
$memory : int|null
Return values
self —

setMemoryReservation()

Memory soft limit in bytes.

public setMemoryReservation(int|null $memoryReservation) : self
Parameters
$memoryReservation : int|null
Return values
self —

setMemorySwap()

Total memory limit (memory + swap). Set as `-1` to enable unlimited.

public setMemorySwap(int|null $memorySwap) : self

swap.

Parameters
$memorySwap : int|null
Return values
self —

setMemorySwappiness()

Tune a container's memory swappiness behavior. Accepts an integer.

public setMemorySwappiness(int|null $memorySwappiness) : self

between 0 and 100.

Parameters
$memorySwappiness : int|null
Return values
self —

setNanoCPUs()

CPU quota in units of 10<sup>-9</sup> CPUs.

public setNanoCPUs(int|null $nanoCPUs) : self
Parameters
$nanoCPUs : int|null
Return values
self —

setOomKillDisable()

Disable OOM Killer for the container.

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

setPidsLimit()

Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`.

public setPidsLimit(int|null $pidsLimit) : self

to not change.

Parameters
$pidsLimit : int|null
Return values
self —

setRestartPolicy()

The behavior to apply when the container exits. The default is not to.

public setRestartPolicy(RestartPolicy|null $restartPolicy) : self

added before each restart to prevent flooding the server.

Parameters
$restartPolicy : RestartPolicy|null
Return values
self —

Search results