Class: Ansible::Ruby::Modules::Docker_container

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb,
lib/ansible/ruby/modules/custom/cloud/core/docker/docker_container.rb

Overview

Manage the life cycle of docker containers. Supports check mode. Run with –check and –diff to view config difference and list of actions to be taken.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#blkio_weight ⇒ Object?

Returns Block IO (relative weight), between 10 and 1000.

Returns:

  • (Object, nil) —

    Block IO (relative weight), between 10 and 1000.



12
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 12

attribute :blkio_weight

#capabilities ⇒ Object?

Returns List of capabilities to add to the container.

Returns:

  • (Object, nil) —

    List of capabilities to add to the container.



15
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 15

attribute :capabilities

#command ⇒ String?

Returns Command or list of commands to execute in the container when it starts.

Returns:

  • (String, nil) —

    Command or list of commands to execute in the container when it starts.



18
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 18

attribute :command

#cpu_period ⇒ Integer?

Returns Limit CPU CFS (Completely Fair Scheduler) period.

Returns:

  • (Integer, nil) —

    Limit CPU CFS (Completely Fair Scheduler) period



22
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 22

attribute :cpu_period

#cpu_quota ⇒ Integer?

Returns Limit CPU CFS (Completely Fair Scheduler) quota.

Returns:

  • (Integer, nil) —

    Limit CPU CFS (Completely Fair Scheduler) quota



26
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 26

attribute :cpu_quota

#cpu_shares ⇒ Object?

Returns CPU shares (relative weight).

Returns:

  • (Object, nil) —

    CPU shares (relative weight).



36
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 36

attribute :cpu_shares

#cpuset_cpus ⇒ Object?

Returns CPUs in which to allow execution C(1,3) or C(1-3).

Returns:

  • (Object, nil) —

    CPUs in which to allow execution C(1,3) or C(1-3).



30
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 30

attribute :cpuset_cpus

#cpuset_mems ⇒ Object?

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

Returns:

  • (Object, nil) —

    Memory nodes (MEMs) in which to allow execution C(0-3) or C(0,1)



33
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 33

attribute :cpuset_mems

#detach ⇒ Boolean?

Returns Enable detached mode to leave the container running in background. If disabled, the task will reflect the status of the container run (failed if the command failed).

Returns:

  • (Boolean, nil) —

    Enable detached mode to leave the container running in background. If disabled, the task will reflect the status of the container run (failed if the command failed).



39
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 39

attribute :detach

#devices ⇒ Array<String>, ...

Returns List of host device bindings to add to the container. Each binding is a mapping expressed in the format: <path_on_host>:<path_in_container>:<cgroup_permissions>.

Returns:

  • (Array<String>, String, nil) —

    List of host device bindings to add to the container. Each binding is a mapping expressed in the format: <path_on_host>:<path_in_container>:<cgroup_permissions>



43
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 43

attribute :devices

#dns_search_domains ⇒ Object?

Returns List of custom DNS search domains.

Returns:

  • (Object, nil) —

    List of custom DNS search domains.



50
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 50

attribute :dns_search_domains

#dns_servers ⇒ Object?

Returns List of custom DNS servers.

Returns:

  • (Object, nil) —

    List of custom DNS servers.



47
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 47

attribute :dns_servers

#entrypoint ⇒ Object?

Returns String or list of commands that overwrite the default ENTRYPOINT of the image.

Returns:

  • (Object, nil) —

    String or list of commands that overwrite the default ENTRYPOINT of the image.



60
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 60

attribute :entrypoint

#env ⇒ Hash?

Returns Dictionary of key,value pairs.

Returns:

  • (Hash, nil) —

    Dictionary of key,value pairs.



53
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 53

attribute :env

#env_file ⇒ Object?

Returns Path to a file containing environment variables I(FOO=BAR).,If variable also present in C(env), then C(env) value will override.,Requires docker-py >= 1.4.0.

Returns:

  • (Object, nil) —

    Path to a file containing environment variables I(FOO=BAR).,If variable also present in C(env), then C(env) value will override.,Requires docker-py >= 1.4.0.



57
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 57

attribute :env_file

#etc_hosts ⇒ Object?

Returns Dict of host-to-IP mappings, where each host name is a key in the dictionary. Each host name will be added to the container’s /etc/hosts file.

Returns:

  • (Object, nil) —

    Dict of host-to-IP mappings, where each host name is a key in the dictionary. Each host name will be added to the container’s /etc/hosts file.



63
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 63

attribute :etc_hosts

#exposed_ports ⇒ Array<Integer>, ...

Returns List of additional container ports to expose for port mappings or links. If the port is already exposed using EXPOSE in a Dockerfile, it does not need to be xposed again.

Returns:

  • (Array<Integer>, Integer, nil) —

    List of additional container ports to expose for port mappings or links. If the port is already exposed using EXPOSE in a Dockerfile, it does not need to be xposed again.



66
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 66

attribute :exposed_ports

#force_kill ⇒ Boolean?

Returns Use the kill command when stopping a running container.

Returns:

  • (Boolean, nil) —

    Use the kill command when stopping a running container.



70
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 70

attribute :force_kill

#groups ⇒ Object?

Returns List of additional group names and/or IDs that the container process will run as.

Returns:

  • (Object, nil) —

    List of additional group names and/or IDs that the container process will run as.



74
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 74

attribute :groups

#hostname ⇒ Object?

Returns Container hostname.

Returns:

  • (Object, nil) —

    Container hostname.



77
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 77

attribute :hostname

#ignore_image ⇒ Boolean?

Returns When C(state) is I(present) or I(started) the module compares the configuration of an existing container to requested configuration. The evaluation includes the image version. If the image vesion in the registry does not match the container, the container will be recreated. Stop this behavior by setting C(ignore_image) to I(True).

Returns:

  • (Boolean, nil) —

    When C(state) is I(present) or I(started) the module compares the configuration of an existing container to requested configuration. The evaluation includes the image version. If the image vesion in the registry does not match the container, the container will be recreated. Stop this behavior by setting C(ignore_image) to I(True).



80
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 80

attribute :ignore_image

#image ⇒ String?

Returns Repository path and tag used to create the container. If an image is not found or pull is true, the image will be pulled from the registry. If no tag is included, ‘latest’ will be used.

Returns:

  • (String, nil) —

    Repository path and tag used to create the container. If an image is not found or pull is true, the image will be pulled from the registry. If no tag is included, ‘latest’ will be used.



84
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 84

attribute :image

#interactive ⇒ Boolean?

Returns Keep stdin open after a container is launched, even if not attached.

Returns:

  • (Boolean, nil) —

    Keep stdin open after a container is launched, even if not attached.



88
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 88

attribute :interactive

#ipc_mode ⇒ Object?

Returns Set the IPC mode for the container. Can be one of ‘container:<name|id>’ to reuse another container’s IPC namespace or ‘host’ to use the host’s IPC namespace within the container.

Returns:

  • (Object, nil) —

    Set the IPC mode for the container. Can be one of ‘container:<name|id>’ to reuse another container’s IPC namespace or ‘host’ to use the host’s IPC namespace within the container.



92
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 92

attribute :ipc_mode

#keep_volumes ⇒ Boolean?

Returns Retain volumes associated with a removed container.

Returns:

  • (Boolean, nil) —

    Retain volumes associated with a removed container.



95
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 95

attribute :keep_volumes

#kernel_memory ⇒ Integer?

Returns Kernel memory limit (format: <number>). Number is a positive integer. Unit can be one of b, k, m, or g. Minimum is 4M.

Returns:

  • (Integer, nil) —

    Kernel memory limit (format: <number>). Number is a positive integer. Unit can be one of b, k, m, or g. Minimum is 4M.



102
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 102

attribute :kernel_memory

#kill_signal ⇒ Object?

Returns Override default signal used to kill a running container.

Returns:

  • (Object, nil) —

    Override default signal used to kill a running container.



99
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 99

attribute :kill_signal

#labels ⇒ Object?

Returns Dictionary of key value pairs.

Returns:

  • (Object, nil) —

    Dictionary of key value pairs.



106
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 106

attribute :labels

#links ⇒ Array<String>, ...

Returns List of name aliases for linked containers in the format C(container_name:alias).

Returns:

  • (Array<String>, String, nil) —

    List of name aliases for linked containers in the format C(container_name:alias)



109
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 109

attribute :links

#log_driver ⇒ :"json-file", ...

Returns Specify the logging driver.

Returns:

  • (:"json-file", :syslog, :journald, :gelf, :fluentd, :awslogs, :splunk, nil) —

    Specify the logging driver.



113
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 113

attribute :log_driver

#log_options ⇒ Hash?

Returns Dictionary of options specific to the chosen log_driver. See docs.docker.com/engine/admin/logging/overview/ for details.

Returns:



117
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 117

attribute :log_options

#mac_address ⇒ Object?

Returns Container MAC address (e.g. 92:d0:c6:0a:29:33).

Returns:

  • (Object, nil) —

    Container MAC address (e.g. 92:d0:c6:0a:29:33)



121
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 121

attribute :mac_address

#memory ⇒ Integer?

Returns Memory limit (format: <number>). Number is a positive integer. Unit can be one of b, k, m, or g.

Returns:

  • (Integer, nil) —

    Memory limit (format: <number>). Number is a positive integer. Unit can be one of b, k, m, or g



124
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 124

attribute :memory

#memory_reservation ⇒ Integer?

Returns Memory soft limit (format: <number>). Number is a positive integer. Unit can be one of b, k, m, or g.

Returns:

  • (Integer, nil) —

    Memory soft limit (format: <number>). Number is a positive integer. Unit can be one of b, k, m, or g



128
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 128

attribute :memory_reservation

#memory_swap ⇒ Integer?

Returns Total memory limit (memory + swap, format:<number>). Number is a positive integer. Unit can be one of b, k, m, or g.

Returns:

  • (Integer, nil) —

    Total memory limit (memory + swap, format:<number>). Number is a positive integer. Unit can be one of b, k, m, or g.



132
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 132

attribute :memory_swap

#memory_swappiness ⇒ Integer?

Returns Tune a container’s memory swappiness behavior. Accepts an integer between 0 and 100.

Returns:

  • (Integer, nil) —

    Tune a container’s memory swappiness behavior. Accepts an integer between 0 and 100.



136
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 136

attribute :memory_swappiness

#name ⇒ String

Returns Assign a name to a new container or match an existing container.,When identifying an existing container name may be a name or a long or short container ID.

Returns:

  • (String) —

    Assign a name to a new container or match an existing container.,When identifying an existing container name may be a name or a long or short container ID.



140
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 140

attribute :name

#network_mode ⇒ :bridge, ...

Returns Connect the container to a network.

Returns:

  • (:bridge, :"container:<name|id>", :host, :none, nil) —

    Connect the container to a network.



144
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 144

attribute :network_mode

#networks ⇒ Array<Hash>, ...

Returns List of networks the container belongs to.,Each network is a dict with keys C(name), C(ipv4_address), C(ipv6_address), C(links), C(aliases).,For each network C(name) is required, all other keys are optional.,If included, C(links) or C(aliases) are lists.,For examples of the data structure and usage see EXAMPLES below.,To remove a container from one or more networks, use the C(purge_networks) option.

Returns:

  • (Array<Hash>, Hash, nil) —

    List of networks the container belongs to.,Each network is a dict with keys C(name), C(ipv4_address), C(ipv6_address), C(links), C(aliases).,For each network C(name) is required, all other keys are optional.,If included, C(links) or C(aliases) are lists.,For examples of the data structure and usage see EXAMPLES below.,To remove a container from one or more networks, use the C(purge_networks) option.



148
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 148

attribute :networks

#oom_killer ⇒ Boolean?

Returns Whether or not to disable OOM Killer for the container.

Returns:

  • (Boolean, nil) —

    Whether or not to disable OOM Killer for the container.



152
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 152

attribute :oom_killer

#paused ⇒ Boolean?

Returns Use with the started state to pause running processes inside the container.

Returns:

  • (Boolean, nil) —

    Use with the started state to pause running processes inside the container.



156
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 156

attribute :paused

#pid_mode ⇒ Object?

Returns Set the PID namespace mode for the container. Currenly only supports ‘host’.

Returns:

  • (Object, nil) —

    Set the PID namespace mode for the container. Currenly only supports ‘host’.



160
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 160

attribute :pid_mode

#privileged ⇒ Boolean?

Returns Give extended privileges to the container.

Returns:

  • (Boolean, nil) —

    Give extended privileges to the container.



163
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 163

attribute :privileged

#published_ports ⇒ Object?

Returns List of ports to publish from the container to the host.,Use docker CLI syntax: C(8000), C(9000:8000), or C(0.0.0.0:9000:8000), where 8000 is a container port, 9000 is a host port, and 0.0.0.0 is a host interface.,Container ports must be exposed either in the Dockerfile or via the C(expose) option.,A value of ALL will publish all exposed container ports to random host ports, ignoring any other mappings.

Returns:

  • (Object, nil) —

    List of ports to publish from the container to the host.,Use docker CLI syntax: C(8000), C(9000:8000), or C(0.0.0.0:9000:8000), where 8000 is a container port, 9000 is a host port, and 0.0.0.0 is a host interface.,Container ports must be exposed either in the Dockerfile or via the C(expose) option.,A value of ALL will publish all exposed container ports to random host ports, ignoring any other mappings.



167
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 167

attribute :published_ports

#pull ⇒ Boolean?

Returns If true, always pull the latest version of an image. Otherwise, will only pull an image when missing.

Returns:

  • (Boolean, nil) —

    If true, always pull the latest version of an image. Otherwise, will only pull an image when missing.



170
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 170

attribute :pull

#purge_networks ⇒ Boolean?

Returns Remove the container from ALL networks not included in C(networks) parameter.,Any default networks such as I(bridge), if not found in C(networks), will be removed as well.

Returns:

  • (Boolean, nil) —

    Remove the container from ALL networks not included in C(networks) parameter.,Any default networks such as I(bridge), if not found in C(networks), will be removed as well.



174
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 174

attribute :purge_networks

#read_only ⇒ Boolean?

Returns Mount the container’s root file system as read-only.

Returns:

  • (Boolean, nil) —

    Mount the container’s root file system as read-only.



178
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 178

attribute :read_only

#recreate ⇒ Boolean?

Returns Use with present and started states to force the re-creation of an existing container.

Returns:

  • (Boolean, nil) —

    Use with present and started states to force the re-creation of an existing container.



182
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 182

attribute :recreate

#restart ⇒ Boolean?

Returns Use with started state to force a matching container to be stopped and restarted.

Returns:

  • (Boolean, nil) —

    Use with started state to force a matching container to be stopped and restarted.



186
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 186

attribute :restart

#restart_policy ⇒ :always, ...

Returns Container restart policy. Place quotes around I(no) option.

Returns:

  • (:always, false, :"on-failure", :"unless-stopped", nil) —

    Container restart policy. Place quotes around I(no) option.



190
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 190

attribute :restart_policy

#restart_retries ⇒ Integer?

Returns Use with restart policy to control maximum number of restart attempts.

Returns:

  • (Integer, nil) —

    Use with restart policy to control maximum number of restart attempts.



194
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 194

attribute :restart_retries

#security_opts ⇒ Object?

Returns List of security options in the form of C(“label:user:User”).

Returns:

  • (Object, nil) —

    List of security options in the form of C(“label:user:User”)



201
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 201

attribute :security_opts

#shm_size ⇒ Object?

Returns Size of ‘/dev/shm`. The format is `<number><unit>`. `number` must be greater than `0`. Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes).,Ommitting the unit defaults to bytes. If you omit the size entirely, the system uses `64m`.

Returns:

  • (Object, nil) —

    Size of ‘/dev/shm`. The format is `<number><unit>`. `number` must be greater than `0`. Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes).,Ommitting the unit defaults to bytes. If you omit the size entirely, the system uses `64m`.



198
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 198

attribute :shm_size

#state ⇒ :absent, ...

Returns I(absent) - A container matching the specified name will be stopped and removed. Use force_kill to kill the container rather than stopping it. Use keep_volumes to retain volumes associated with the removed container.,I(present)“ - Asserts the existence of a container matching the name and any provided configuration parameters. If no container matches the name, a container will be created. If a container matches the name but the provided configuration does not match, the container will be updated, if it can be. If it cannot be updated, it will be removed and re-created with the requested config. Image version will be taken into account when comparing configuration. To ignore image version use the ignore_image option. Use the recreate option to force the re-creation of the matching container. Use force_kill to kill the container rather than stopping it. Use keep_volumes to retain volumes associated with a removed container.,I(started) - Asserts there is a running container matching the name and any provided configuration. If no container matches the name, a container will be created and started. If a container matching the name is found but the configuration does not match, the container will be updated, if it can be. If it cannot be updated, it will be removed and a new container will be created with the requested configuration and started. Image version will be taken into account when comparing configuration. To ignore image version use the ignore_image option. Use recreate to always re-create a matching container, even if it is running. Use restart to force a matching container to be stopped and restarted. Use force_kill to kill a container rather than stopping it. Use keep_volumes to retain volumes associated with a removed container.,I(stopped) - Asserts that the container is first I(present), and then if the container is running moves it to a stopped state. Use force_kill to kill a container rather than stopping it.

Returns:

  • (:absent, :present, :stopped, :started, nil) —

    I(absent) - A container matching the specified name will be stopped and removed. Use force_kill to kill the container rather than stopping it. Use keep_volumes to retain volumes associated with the removed container.,I(present)“ - Asserts the existence of a container matching the name and any provided configuration parameters. If no container matches the name, a container will be created. If a container matches the name but the provided configuration does not match, the container will be updated, if it can be. If it cannot be updated, it will be removed and re-created with the requested config. Image version will be taken into account when comparing configuration. To ignore image version use the ignore_image option. Use the recreate option to force the re-creation of the matching container. Use force_kill to kill the container rather than stopping it. Use keep_volumes to retain volumes associated with a removed container.,I(started) - Asserts there is a running container matching the name and any provided configuration. If no container matches the name, a container will be created and started. If a container matching the name is found but the configuration does not match, the container will be updated, if it can be. If it cannot be updated, it will be removed and a new container will be created with the requested configuration and started. Image version will be taken into account when comparing configuration. To ignore image version use the ignore_image option. Use recreate to always re-create a matching container, even if it is running. Use restart to force a matching container to be stopped and restarted. Use force_kill to kill a container rather than stopping it. Use keep_volumes to retain volumes associated with a removed container.,I(stopped) - Asserts that the container is first I(present), and then if the container is running moves it to a stopped state. Use force_kill to kill a container rather than stopping it.



204
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 204

attribute :state

#stop_signal ⇒ Object?

Returns Override default signal used to stop the container.

Returns:

  • (Object, nil) —

    Override default signal used to stop the container.



208
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 208

attribute :stop_signal

#stop_timeout ⇒ Object?

Returns Number of seconds to wait for the container to stop before sending SIGKILL.

Returns:

  • (Object, nil) —

    Number of seconds to wait for the container to stop before sending SIGKILL.



211
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 211

attribute :stop_timeout

#to_h ⇒ Object 



15
16
17
18
19
20
21
22
 
# File 'lib/ansible/ruby/modules/custom/cloud/core/docker/docker_container.rb', line 15

def to_h
  result = super
  data = result[:docker_container]
  if data.include? :volumes
    data[:volumes] = transform_volumes data[:volumes]
  end
  result
end

#trust_image_content ⇒ Boolean?

Returns If true, skip image verification.

Returns:

  • (Boolean, nil) —

    If true, skip image verification.



214
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 214

attribute :trust_image_content

#tty ⇒ Boolean?

Returns Allocate a psuedo-TTY.

Returns:

  • (Boolean, nil) —

    Allocate a psuedo-TTY.



218
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 218

attribute :tty

#ulimits ⇒ Object?

Returns List of ulimit options. A ulimit is specified as C(nofile:262144:262144).

Returns:

  • (Object, nil) —

    List of ulimit options. A ulimit is specified as C(nofile:262144:262144)



222
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 222

attribute :ulimits

#user ⇒ Object?

Returns Sets the username or UID used and optionally the groupname or GID for the specified command.,Can be [ user | user:group | uid | uid:gid | user:gid | uid:group ].

Returns:

  • (Object, nil) —

    Sets the username or UID used and optionally the groupname or GID for the specified command.,Can be [ user | user:group | uid | uid:gid | user:gid | uid:group ]



225
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 225

attribute :user

#uts ⇒ Object?

Returns Set the UTS namespace mode for the container.

Returns:

  • (Object, nil) —

    Set the UTS namespace mode for the container.



228
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 228

attribute :uts

#volume_driver ⇒ String?

Returns The container’s volume driver.

Returns:

  • (String, nil) —

    The container’s volume driver.



235
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 235

attribute :volume_driver

#volumes ⇒ Array<String>, ...

Returns List of volumes to mount within the container.,Use docker CLI-style syntax: C(/host:/container),You can specify a read mode for the mount with either C(ro) or C(rw).,SELinux hosts can additionally use C(z) or C(Z) to use a shared or private label for the volume.

Returns:

  • (Array<String>, String, nil) —

    List of volumes to mount within the container.,Use docker CLI-style syntax: C(/host:/container),You can specify a read mode for the mount with either C(ro) or C(rw).,SELinux hosts can additionally use C(z) or C(Z) to use a shared or private label for the volume.



231
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 231

attribute :volumes

#volumes_from ⇒ Array<String>, ...

Returns List of container names or Ids to get volumes from.

Returns:

  • (Array<String>, String, nil) —

    List of container names or Ids to get volumes from.



239
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/docker/docker_container.rb', line 239

attribute :volumes_from