Class: Ansible::Ruby::Modules::Lxc_container

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb

Overview

Management of LXC containers

Instance Method Summary collapse

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

#archive ⇒ Boolean?

Returns Create an archive of a container. This will create a tarball of the running container.

Returns:

  • (Boolean, nil) —

    Create an archive of a container. This will create a tarball of the running container.



78
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 78

attribute :archive

#archive_compression ⇒ :gzip, ...

Returns Type of compression to use when creating an archive of a running container.

Returns:

  • (:gzip, :bzip2, :none, nil) —

    Type of compression to use when creating an archive of a running container.



86
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 86

attribute :archive_compression

#archive_path ⇒ String?

Returns Path the save the archived container. If the path does not exist the archive method will attempt to create it.

Returns:

  • (String, nil) —

    Path the save the archived container. If the path does not exist the archive method will attempt to create it.



82
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 82

attribute :archive_path

#backing_store ⇒ :dir, ...

Returns Backend storage type for the container.

Returns:

  • (:dir, :lvm, :loop, :btrfs, :overlayfs, :zfs, nil) —

    Backend storage type for the container.



15
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 15

attribute :backing_store

#clone_name ⇒ Boolean?

Returns Name of the new cloned server. This is only used when state is clone.

Returns:

  • (Boolean, nil) —

    Name of the new cloned server. This is only used when state is clone.



70
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 70

attribute :clone_name

#clone_snapshot ⇒ Boolean?

Returns Create a snapshot a container when cloning. This is not supported by all container storage backends. Enabling this may fail if the backing store does not support snapshots.

Returns:

  • (Boolean, nil) —

    Create a snapshot a container when cloning. This is not supported by all container storage backends. Enabling this may fail if the backing store does not support snapshots.



74
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 74

attribute :clone_snapshot

#config ⇒ Object?

Returns Path to the LXC configuration file.

Returns:

  • (Object, nil) —

    Path to the LXC configuration file.



27
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 27

attribute :config

#container_command ⇒ String?

Returns Run a command within a container.

Returns:

  • (String, nil) —

    Run a command within a container.



55
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 55

attribute :container_command

#container_config ⇒ Array<String>, ...

Returns list of ‘key=value’ options to use when configuring a container.

Returns:

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

    list of ‘key=value’ options to use when configuring a container.



94
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 94

attribute :container_config

#container_log ⇒ Boolean?

Returns Enable a container log for host actions to the container.

Returns:

  • (Boolean, nil) —

    Enable a container log for host actions to the container.



62
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 62

attribute :container_log

#container_log_level ⇒ :INFO, ...

Returns Set the log level for a container where container_log was set.

Returns:

  • (:INFO, :ERROR, :DEBUG, nil) —

    Set the log level for a container where container_log was set.



66
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 66

attribute :container_log_level

#directory ⇒ Object?

Returns Place rootfs directory under DIR.

Returns:

  • (Object, nil) —

    Place rootfs directory under DIR.



49
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 49

attribute :directory

#fs_size ⇒ String?

Returns File system Size.

Returns:

  • (String, nil) —

    File system Size.



45
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 45

attribute :fs_size

#fs_type ⇒ String?

Returns Create fstype TYPE.

Returns:

  • (String, nil) —

    Create fstype TYPE.



41
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 41

attribute :fs_type

#lv_name ⇒ String?

Returns Name of the logical volume, defaults to the container name.

Returns:

  • (String, nil) —

    Name of the logical volume, defaults to the container name.



30
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 30

attribute :lv_name

#lxc_path ⇒ Object?

Returns Place container under PATH.

Returns:

  • (Object, nil) —

    Place container under PATH



59
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 59

attribute :lxc_path

#name ⇒ String

Returns Name of a container.

Returns:

  • (String) —

    Name of a container.



11
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 11

attribute :name

#state ⇒ :started, ...

Returns Define the state of a container. If you clone a container using ‘clone_name` the newly cloned container created in a stopped state. The running container will be stopped while the clone operation is happening and upon completion of the clone the original container state will be restored.

Returns:

  • (:started, :stopped, :restarted, :absent, :frozen, nil) —

    Define the state of a container. If you clone a container using ‘clone_name` the newly cloned container created in a stopped state. The running container will be stopped while the clone operation is happening and upon completion of the clone the original container state will be restored.



90
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 90

attribute :state

#template ⇒ String?

Returns Name of the template to use within an LXC create.

Returns:

  • (String, nil) —

    Name of the template to use within an LXC create.



19
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 19

attribute :template

#template_options ⇒ String?

Returns Template options when building the container.

Returns:

  • (String, nil) —

    Template options when building the container.



23
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 23

attribute :template_options

#thinpool ⇒ Object?

Returns Use LVM thin pool called TP.

Returns:

  • (Object, nil) —

    Use LVM thin pool called TP.



38
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 38

attribute :thinpool

#vg_name ⇒ String?

Returns If Backend store is lvm, specify the name of the volume group.

Returns:

  • (String, nil) —

    If Backend store is lvm, specify the name of the volume group.



34
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 34

attribute :vg_name

#zfs_root ⇒ Object?

Returns Create zfs under given zfsroot.

Returns:

  • (Object, nil) —

    Create zfs under given zfsroot.



52
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/lxc/lxc_container.rb', line 52

attribute :zfs_root