Class: Ansible::Ruby::Modules::Vmadm

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb

Overview

Manage SmartOS virtual machines through vmadm(1M).

Instance Method Summary

• #archive_on_delete ⇒ Object^?

  When enabled, the zone dataset will be mounted on C(/zones/archive) upon removal.

• #autoboot ⇒ Object^?

  Whether or not a VM is booted when the system is rebooted.

• #boot ⇒ Object^?

  Set the boot order for KVM VMs.

• #brand ⇒ :joyent, ...

  Type of virtual machine.

• #cpu_cap ⇒ Object^?

  Sets a limit on the amount of CPU time that can be used by a VM.

• #cpu_shares ⇒ Object^?

  Sets a limit on the number of fair share scheduler (FSS) CPU shares for a VM.

• #cpu_type ⇒ :qemu64, ...

  Control the type of virtual CPU exposed to KVM VMs.

• #customer_metadata ⇒ Object^?

  Metadata to be set and associated with this VM, this contain customer modifiable keys.

• #delegate_dataset ⇒ Object^?

  Whether to delegate a ZFS dataset to an OS VM.

• #disk_driver ⇒ Object^?

  Default value for a virtual disk model for KVM guests.

• #disks ⇒ Object^?

  A list of disks to add, valid properties are documented in vmadm(1M).

• #dns_domain ⇒ Object^?

  Domain value for C(/etc/hosts).

• #docker ⇒ Object^?

  Docker images need this flag enabled along with the I(brand) set to C(lx).

• #filesystems ⇒ Object^?

  Mount additional filesystems into an OS VM.

• #firewall_enabled ⇒ Boolean^?

  Enables the firewall, allowing fwadm(1M) rules to be applied.

• #force ⇒ Object^?

  Force a particular action (i.e. stop or delete a VM).

• #fs_allowed ⇒ Object^?

  Comma separated list of filesystem types this zone is allowed to mount.

• #hostname ⇒ Object^?

  Zone/VM hostname.

• #image_uuid ⇒ String^?

  Image UUID.

• #indestructible_delegated ⇒ Object^?

  Adds an C(@indestructible) snapshot to delegated datasets.

• #indestructible_zoneroot ⇒ Boolean^?

  Adds an C(@indestructible) snapshot to zoneroot.

• #internal_metadata ⇒ Hash^?

  Metadata to be set and associated with this VM, this contains operator generated keys.

• #internal_metadata_namespace ⇒ Object^?

  List of namespaces to be set as I(internal_metadata-only); these namespaces will come from I(internal_metadata) rather than I(customer_metadata).

• #kernel_version ⇒ Object^?

  Kernel version to emulate for LX VMs.

• #limit_priv ⇒ Object^?

  Set (comma separated) list of privileges the zone is allowed to use.

• #maintain_resolvers ⇒ Object^?

  Resolvers in C(/etc/resolv.conf) will be updated when updating the I(resolvers) property.

• #max_locked_memory ⇒ Object^?

  Total amount of memory (in MiBs) on the host that can be locked by this VM.

• #max_lwps ⇒ Object^?

  Maximum number of lightweight processes this VM is allowed to have running.

• #max_physical_memory ⇒ Object^?

  Maximum amount of memory (in MiBs) on the host that the VM is allowed to use.

• #max_swap ⇒ Object^?

  Maximum amount of virtual memory (in MiBs) the VM is allowed to use.

• #mdata_exec_timeout ⇒ Object^?

  Timeout in seconds (or 0 to disable) for the C(svc:/smartdc/mdata:execute) service that runs user-scripts in the zone.

• #name ⇒ Object^?

  Name of the VM.

• #nic_driver ⇒ Object^?

  Default value for a virtual NIC model for KVM guests.

• #nics ⇒ Array<Hash>, ...

  A list of nics to add, valid properties are documented in vmadm(1M).

• #nowait ⇒ Object^?

  Consider the provisioning complete when the VM first starts, rather than when the VM has rebooted.

• #qemu_extra_opts ⇒ Object^?

  Additional qemu cmdline arguments for KVM guests.

• #qemu_opts ⇒ Object^?

  Additional qemu arguments for KVM guests.

• #quota ⇒ Integer^?

  Quota on zone filesystems (in MiBs).

• #ram ⇒ Object^?

  Amount of virtual RAM for a KVM guest (in MiBs).

• #resolvers ⇒ Object^?

  List of resolvers to be put into C(/etc/resolv.conf).

• #routes ⇒ Object^?

  Dictionary that maps destinations to gateways, these will be set as static routes in the VM.

• #spice_opts ⇒ Object^?

  Addition options for SPICE-enabled KVM VMs.

• #spice_password ⇒ Object^?

  Password required to connect to SPICE.

• #state ⇒ :present, ...

  States for the VM to be in.

• #tmpfs ⇒ Object^?

  Amount of memory (in MiBs) that will be available in the VM for the C(/tmp) filesystem.

• #uuid ⇒ String^?

  UUID of the VM.

• #vcpus ⇒ Object^?

  Number of virtual CPUs for a KVM guest.

• #vga ⇒ Object^?

  Specify VGA emulation used by KVM VMs.

• #virtio_txburst ⇒ Object^?

  Number of packets that can be sent in a single flush of the tx queue of virtio NICs.

• #virtio_txtimer ⇒ Object^?

  Timeout (in nanoseconds) for the TX timer of virtio NICs.

• #vnc_password ⇒ Object^?

  Password required to connect to VNC.

• #vnc_port ⇒ Object^?

  TCP port to listen of the VNC server.

• #zfs_data_compression ⇒ Object^?

  Specifies compression algorithm used for this VMs data dataset.

• #zfs_data_recsize ⇒ Object^?

  Suggested block size (power of 2) for files in the delegated dataset’s filesystem.

• #zfs_filesystem_limit ⇒ Object^?

  Maximum number of filesystems the VM can have.

• #zfs_io_priority ⇒ Object^?

  IO throttle priority value relative to other VMs.

• #zfs_root_compression ⇒ Object^?

  Specifies compression algorithm used for this VMs root dataset.

• #zfs_root_recsize ⇒ Object^?

  Suggested block size (power of 2) for files in the zoneroot dataset’s filesystem.

• #zfs_snapshot_limit ⇒ Object^?

  Number of snapshots the VM can have.

• #zpool ⇒ Object^?

  ZFS pool the VM’s zone dataset will be created in.

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_on_delete ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 12

attribute :archive_on_delete

#autoboot ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 15

attribute :autoboot

#boot ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 22

attribute :boot

#brand ⇒ :joyent, ...

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 18

attribute :brand

#cpu_cap ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 25

attribute :cpu_cap

#cpu_shares ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 28

attribute :cpu_shares

#cpu_type ⇒ :qemu64, ...

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 31

attribute :cpu_type

#customer_metadata ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 35

attribute :customer_metadata

#delegate_dataset ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 38

attribute :delegate_dataset

#disk_driver ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 41

attribute :disk_driver

#disks ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 44

attribute :disks

#dns_domain ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 47

attribute :dns_domain

#docker ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 50

attribute :docker

#filesystems ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 53

attribute :filesystems

#firewall_enabled ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 56

attribute :firewall_enabled

#force ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 60

attribute :force

#fs_allowed ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 63

attribute :fs_allowed

#hostname ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 66

attribute :hostname

#image_uuid ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 69

attribute :image_uuid

#indestructible_delegated ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 73

attribute :indestructible_delegated

#indestructible_zoneroot ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 76

attribute :indestructible_zoneroot

#internal_metadata ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 80

attribute :internal_metadata

#internal_metadata_namespace ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 84

attribute :internal_metadata_namespace

#kernel_version ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 87

attribute :kernel_version

#limit_priv ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 90

attribute :limit_priv

#maintain_resolvers ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 93

attribute :maintain_resolvers

#max_locked_memory ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 96

attribute :max_locked_memory

#max_lwps ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 99

attribute :max_lwps

#max_physical_memory ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 102

attribute :max_physical_memory

#max_swap ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 105

attribute :max_swap

#mdata_exec_timeout ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 108

attribute :mdata_exec_timeout

#name ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 111

attribute :name

#nic_driver ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 114

attribute :nic_driver

#nics ⇒ Array<Hash>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 117

attribute :nics

#nowait ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 121

attribute :nowait

#qemu_extra_opts ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 127

attribute :qemu_extra_opts

#qemu_opts ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 124

attribute :qemu_opts

#quota ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 130

attribute :quota

#ram ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 134

attribute :ram

#resolvers ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 137

attribute :resolvers

#routes ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 140

attribute :routes

#spice_opts ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 143

attribute :spice_opts

#spice_password ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 146

attribute :spice_password

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 149

attribute :state

#tmpfs ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 153

attribute :tmpfs

#uuid ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 156

attribute :uuid

#vcpus ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 160

attribute :vcpus

#vga ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 163

attribute :vga

#virtio_txburst ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 166

attribute :virtio_txburst

#virtio_txtimer ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 169

attribute :virtio_txtimer

#vnc_password ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 172

attribute :vnc_password

#vnc_port ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 175

attribute :vnc_port

#zfs_data_compression ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 178

attribute :zfs_data_compression

#zfs_data_recsize ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 181

attribute :zfs_data_recsize

#zfs_filesystem_limit ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 184

attribute :zfs_filesystem_limit

#zfs_io_priority ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 187

attribute :zfs_io_priority

#zfs_root_compression ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 190

attribute :zfs_root_compression

#zfs_root_recsize ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 193

attribute :zfs_root_recsize

#zfs_snapshot_limit ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 196

attribute :zfs_snapshot_limit

#zpool ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb', line 199

attribute :zpool