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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/smartos/vmadm.rb

Overview

Manage SmartOS virtual machines through vmadm(1M).

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_on_deleteObject?

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

Returns:

  • (Object, nil)

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



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

attribute :archive_on_delete

#autobootObject?

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

Returns:

  • (Object, nil)

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



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

attribute :autoboot

#bootObject?

Returns Set the boot order for KVM VMs.

Returns:

  • (Object, nil)

    Set the boot order for KVM VMs.



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

attribute :boot

#brand:joyent, ...

Returns Type of virtual machine.

Returns:

  • (:joyent, :"joyent-minimal", :kvm, :lx)

    Type of virtual machine.



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

attribute :brand

#cpu_capObject?

Returns Sets a limit on the amount of CPU time that can be used by a VM. Use C(0) for no cap.

Returns:

  • (Object, nil)

    Sets a limit on the amount of CPU time that can be used by a VM. Use C(0) for no cap.



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

attribute :cpu_cap

#cpu_sharesObject?

Returns Sets a limit on the number of fair share scheduler (FSS) CPU shares for a VM. This limit is relative to all other VMs on the system.

Returns:

  • (Object, nil)

    Sets a limit on the number of fair share scheduler (FSS) CPU shares for a VM. This limit is relative to all other VMs on the system.



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

attribute :cpu_shares

#cpu_type:qemu64, ...

Returns Control the type of virtual CPU exposed to KVM VMs.

Returns:

  • (:qemu64, :host, nil)

    Control the type of virtual CPU exposed to KVM VMs.



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

attribute :cpu_type

#customer_metadataObject?

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

Returns:

  • (Object, nil)

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



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

attribute :customer_metadata

#delegate_datasetObject?

Returns Whether to delegate a ZFS dataset to an OS VM.

Returns:

  • (Object, nil)

    Whether to delegate a ZFS dataset to an OS VM.



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

attribute :delegate_dataset

#disk_driverObject?

Returns Default value for a virtual disk model for KVM guests.

Returns:

  • (Object, nil)

    Default value for a virtual disk model for KVM guests.



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

attribute :disk_driver

#disksObject?

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

Returns:

  • (Object, nil)

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



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

attribute :disks

#dns_domainObject?

Returns Domain value for C(/etc/hosts).

Returns:

  • (Object, nil)

    Domain value for C(/etc/hosts).



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

attribute :dns_domain

#dockerObject?

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

Returns:

  • (Object, nil)

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



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

attribute :docker

#filesystemsObject?

Returns Mount additional filesystems into an OS VM.

Returns:

  • (Object, nil)

    Mount additional filesystems into an OS VM.



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

attribute :filesystems

#firewall_enabledBoolean?

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

Returns:

  • (Boolean, nil)

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



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

attribute :firewall_enabled

#forceObject?

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

Returns:

  • (Object, nil)

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



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

attribute :force

#fs_allowedObject?

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

Returns:

  • (Object, nil)

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



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

attribute :fs_allowed

#hostnameObject?

Returns Zone/VM hostname.

Returns:

  • (Object, nil)

    Zone/VM hostname.



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

attribute :hostname

#image_uuidString?

Returns Image UUID.

Returns:

  • (String, nil)

    Image UUID.



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

attribute :image_uuid

#indestructible_delegatedObject?

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

Returns:

  • (Object, nil)

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



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

attribute :indestructible_delegated

#indestructible_zonerootBoolean?

Returns Adds an C(@indestructible) snapshot to zoneroot.

Returns:

  • (Boolean, nil)

    Adds an C(@indestructible) snapshot to zoneroot.



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

attribute :indestructible_zoneroot

#internal_metadataHash?

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

Returns:

  • (Hash, nil)

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



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

attribute :internal_metadata

#internal_metadata_namespaceObject?

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

Returns:

  • (Object, nil)

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



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

attribute :internal_metadata_namespace

#kernel_versionObject?

Returns Kernel version to emulate for LX VMs.

Returns:

  • (Object, nil)

    Kernel version to emulate for LX VMs.



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

attribute :kernel_version

#limit_privObject?

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

Returns:

  • (Object, nil)

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



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

attribute :limit_priv

#maintain_resolversObject?

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

Returns:

  • (Object, nil)

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



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

attribute :maintain_resolvers

#max_locked_memoryObject?

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

Returns:

  • (Object, nil)

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



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

attribute :max_locked_memory

#max_lwpsObject?

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

Returns:

  • (Object, nil)

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



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

attribute :max_lwps

#max_physical_memoryObject?

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

Returns:

  • (Object, nil)

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



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

attribute :max_physical_memory

#max_swapObject?

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

Returns:

  • (Object, nil)

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



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

attribute :max_swap

#mdata_exec_timeoutObject?

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

Returns:

  • (Object, nil)

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



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

attribute :mdata_exec_timeout

#nameObject?

Returns Name of the VM. vmadm(1M) uses this as an optional name.

Returns:

  • (Object, nil)

    Name of the VM. vmadm(1M) uses this as an optional name.



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

attribute :name

#nic_driverObject?

Returns Default value for a virtual NIC model for KVM guests.

Returns:

  • (Object, nil)

    Default value for a virtual NIC model for KVM guests.



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

attribute :nic_driver

#nicsArray<Hash>, ...

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

Returns:

  • (Array<Hash>, Hash, nil)

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



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

attribute :nics

#nowaitObject?

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

Returns:

  • (Object, nil)

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



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

attribute :nowait

#qemu_extra_optsObject?

Returns Additional qemu cmdline arguments for KVM guests.

Returns:

  • (Object, nil)

    Additional qemu cmdline arguments for KVM guests.



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

attribute :qemu_extra_opts

#qemu_optsObject?

Returns Additional qemu arguments for KVM guests. This overwrites the default arguments provided by vmadm(1M) and should only be used for debugging.

Returns:

  • (Object, nil)

    Additional qemu arguments for KVM guests. This overwrites the default arguments provided by vmadm(1M) and should only be used for debugging.



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

attribute :qemu_opts

#quotaInteger?

Returns Quota on zone filesystems (in MiBs).

Returns:

  • (Integer, nil)

    Quota on zone filesystems (in MiBs).



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

attribute :quota

#ramObject?

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

Returns:

  • (Object, nil)

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



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

attribute :ram

#resolversObject?

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

Returns:

  • (Object, nil)

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



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

attribute :resolvers

#routesObject?

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

Returns:

  • (Object, nil)

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



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

attribute :routes

#spice_optsObject?

Returns Addition options for SPICE-enabled KVM VMs.

Returns:

  • (Object, nil)

    Addition options for SPICE-enabled KVM VMs.



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

attribute :spice_opts

#spice_passwordObject?

Returns Password required to connect to SPICE. By default no password is set. Please note this can be read from the Global Zone.

Returns:

  • (Object, nil)

    Password required to connect to SPICE. By default no password is set. Please note this can be read from the Global Zone.



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

attribute :spice_password

#state:present, ...

Returns States for the VM to be in. Please note that C(present), C(stopped) and C(restarted) operate on a VM that is currently provisioned. C(present) means that the VM will be created if it was absent, and that it will be in a running state. C(absent) will shutdown the zone before removing it. C(stopped) means the zone will be created if it doesn’t exist already, before shutting it down.

Returns:

  • (:present, :absent, :stopped, :restarted)

    States for the VM to be in. Please note that C(present), C(stopped) and C(restarted) operate on a VM that is currently provisioned. C(present) means that the VM will be created if it was absent, and that it will be in a running state. C(absent) will shutdown the zone before removing it. C(stopped) means the zone will be created if it doesn’t exist already, before shutting it down.



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

attribute :state

#tmpfsObject?

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

Returns:

  • (Object, nil)

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



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

attribute :tmpfs

#uuidString?

Returns UUID of the VM. Can either be a full UUID or C(*) for all VMs.

Returns:

  • (String, nil)

    UUID of the VM. Can either be a full UUID or C(*) for all VMs.



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

attribute :uuid

#vcpusObject?

Returns Number of virtual CPUs for a KVM guest.

Returns:

  • (Object, nil)

    Number of virtual CPUs for a KVM guest.



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

attribute :vcpus

#vgaObject?

Returns Specify VGA emulation used by KVM VMs.

Returns:

  • (Object, nil)

    Specify VGA emulation used by KVM VMs.



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

attribute :vga

#virtio_txburstObject?

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

Returns:

  • (Object, nil)

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



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

attribute :virtio_txburst

#virtio_txtimerObject?

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

Returns:

  • (Object, nil)

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



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

attribute :virtio_txtimer

#vnc_passwordObject?

Returns Password required to connect to VNC. By default no password is set. Please note this can be read from the Global Zone.

Returns:

  • (Object, nil)

    Password required to connect to VNC. By default no password is set. Please note this can be read from the Global Zone.



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

attribute :vnc_password

#vnc_portObject?

Returns TCP port to listen of the VNC server. Or set C(0) for random, or C(-1) to disable.

Returns:

  • (Object, nil)

    TCP port to listen of the VNC server. Or set C(0) for random, or C(-1) to disable.



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

attribute :vnc_port

#zfs_data_compressionObject?

Returns Specifies compression algorithm used for this VMs data dataset. This option only has effect on delegated datasets.

Returns:

  • (Object, nil)

    Specifies compression algorithm used for this VMs data dataset. This option only has effect on delegated datasets.



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

attribute :zfs_data_compression

#zfs_data_recsizeObject?

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

Returns:

  • (Object, nil)

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



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

attribute :zfs_data_recsize

#zfs_filesystem_limitObject?

Returns Maximum number of filesystems the VM can have.

Returns:

  • (Object, nil)

    Maximum number of filesystems the VM can have.



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

attribute :zfs_filesystem_limit

#zfs_io_priorityObject?

Returns IO throttle priority value relative to other VMs.

Returns:

  • (Object, nil)

    IO throttle priority value relative to other VMs.



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

attribute :zfs_io_priority

#zfs_root_compressionObject?

Returns Specifies compression algorithm used for this VMs root dataset. This option only has effect on the zoneroot dataset.

Returns:

  • (Object, nil)

    Specifies compression algorithm used for this VMs root dataset. This option only has effect on the zoneroot dataset.



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

attribute :zfs_root_compression

#zfs_root_recsizeObject?

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

Returns:

  • (Object, nil)

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



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

attribute :zfs_root_recsize

#zfs_snapshot_limitObject?

Returns Number of snapshots the VM can have.

Returns:

  • (Object, nil)

    Number of snapshots the VM can have.



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

attribute :zfs_snapshot_limit

#zpoolObject?

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

Returns:

  • (Object, nil)

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



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

attribute :zpool