Class: Ansible::Ruby::Modules::Lxc_container
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Lxc_container
- Defined in:
- lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb
Overview
Management of LXC containers
Instance Method Summary collapse
-
#archive ⇒ :yes, ...
Create an archive of a container.
-
#archive_compression ⇒ :gzip, ...
Type of compression to use when creating an archive of a running container.
-
#archive_path ⇒ String?
Path the save the archived container.
-
#backing_store ⇒ :dir, ...
Backend storage type for the container.
-
#clone_name ⇒ :yes, ...
Name of the new cloned server.
-
#clone_snapshot ⇒ :yes, ...
Create a snapshot a container when cloning.
-
#config ⇒ Object?
Path to the LXC configuration file.
-
#container_command ⇒ String?
Run a command within a container.
-
#container_config ⇒ Array<String>, ...
List of ‘key=value’ options to use when configuring a container.
-
#container_log ⇒ :yes, ...
Enable a container log for host actions to the container.
-
#container_log_level ⇒ :INFO, ...
Set the log level for a container where container_log was set.
-
#directory ⇒ Object?
Place rootfs directory under DIR.
-
#fs_size ⇒ String?
File system Size.
-
#fs_type ⇒ String?
Create fstype TYPE.
-
#lv_name ⇒ String?
Name of the logical volume, defaults to the container name.
-
#lxc_path ⇒ Object?
Place container under PATH.
-
#name ⇒ String
Name of a container.
-
#state ⇒ :started, ...
Define the state of a container.
-
#template ⇒ String?
Name of the template to use within an LXC create.
-
#template_options ⇒ String?
Template options when building the container.
-
#thinpool ⇒ Object?
Use LVM thin pool called TP.
-
#vg_name ⇒ String?
If Backend store is lvm, specify the name of the volume group.
-
#zfs_root ⇒ Object?
Create zfs under given zfsroot.
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates
Constructor Details
This class inherits a constructor from Ansible::Ruby::Models::Base
Instance Method Details
#archive ⇒ :yes, ...
Returns Create an archive of a container. This will create a tarball of the running container.
79 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 79 attribute :archive |
#archive_compression ⇒ :gzip, ...
Returns Type of compression to use when creating an archive of a running container.
87 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 87 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.
83 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 83 attribute :archive_path |
#backing_store ⇒ :dir, ...
Returns Backend storage type for the container.
16 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 16 attribute :backing_store |
#clone_name ⇒ :yes, ...
Returns Name of the new cloned server. This is only used when state is clone.
71 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 71 attribute :clone_name |
#clone_snapshot ⇒ :yes, ...
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.
75 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 75 attribute :clone_snapshot |
#config ⇒ Object?
Returns Path to the LXC configuration file.
28 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 28 attribute :config |
#container_command ⇒ String?
Returns Run a command within a container.
56 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 56 attribute :container_command |
#container_config ⇒ Array<String>, ...
Returns list of ‘key=value’ options to use when configuring a container.
95 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 95 attribute :container_config |
#container_log ⇒ :yes, ...
Returns Enable a container log for host actions to the container.
63 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 63 attribute :container_log |
#container_log_level ⇒ :INFO, ...
Returns Set the log level for a container where container_log was set.
67 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 67 attribute :container_log_level |
#directory ⇒ Object?
Returns Place rootfs directory under DIR.
50 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 50 attribute :directory |
#fs_size ⇒ String?
Returns File system Size.
46 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 46 attribute :fs_size |
#fs_type ⇒ String?
Returns Create fstype TYPE.
42 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 42 attribute :fs_type |
#lv_name ⇒ String?
Returns Name of the logical volume, defaults to the container name.
31 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 31 attribute :lv_name |
#lxc_path ⇒ Object?
Returns Place container under PATH.
60 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 60 attribute :lxc_path |
#name ⇒ String
Returns Name of a container.
12 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 12 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.
91 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 91 attribute :state |
#template ⇒ String?
Returns Name of the template to use within an LXC create.
20 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 20 attribute :template |
#template_options ⇒ String?
Returns Template options when building the container.
24 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 24 attribute :template_options |
#thinpool ⇒ Object?
Returns Use LVM thin pool called TP.
39 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 39 attribute :thinpool |
#vg_name ⇒ String?
Returns If Backend store is lvm, specify the name of the volume group.
35 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 35 attribute :vg_name |
#zfs_root ⇒ Object?
Returns Create zfs under given zfsroot.
53 |
# File 'lib/ansible/ruby/modules/generated/cloud/lxc/lxc_container.rb', line 53 attribute :zfs_root |