Class: Ansible::Ruby::Modules::Docker_network

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Docker_network

Defined in:

lib/ansible/ruby/modules/generated/cloud/docker/docker_network.rb

Overview

Create/remove Docker networks and connect containers to them. Performs largely the same function as the “docker network” CLI subcommand.

Instance Method Summary

• #appends ⇒ :yes, ...

  By default the connected list is canonical, meaning containers not on the list are removed from the network.

• #connected ⇒ Array<String>, ...

  List of container names or container IDs to connect to a network.

• #driver ⇒ String^?

  Specify the type of network.

• #driver_options ⇒ Hash^?

  Dictionary of network settings.

• #force ⇒ :yes, ...

  With state I(absent) forces disconnecting all containers from the network prior to deleting the network.

• #ipam_driver ⇒ Object^?

  Specify an IPAM driver.

• #ipam_options ⇒ Hash^?

  Dictionary of IPAM options.

• #name ⇒ String

  Name of the network to operate on.

• #state ⇒ :absent, ...

  I(absent) deletes the network.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#appends ⇒ :yes, ...

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

attribute :appends

#connected ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_network.rb', line 17

attribute :connected

#driver ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_network.rb', line 21

attribute :driver

#driver_options ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_network.rb', line 25

attribute :driver_options

#force ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_network.rb', line 29

attribute :force

#ipam_driver ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_network.rb', line 37

attribute :ipam_driver

#ipam_options ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_network.rb', line 40

attribute :ipam_options

#name ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_network.rb', line 13

attribute :name

#state ⇒ :absent, ...

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_network.rb', line 44

attribute :state