Class: Ansible::Ruby::Modules::Proxmox

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb

Overview

allows you to create/delete/stop instances in Proxmox VE cluster Starting in Ansible 2.1, it automatically detects containerization type (lxc for PVE 4, openvz for older)

Instance Method Summary

• #api_host ⇒ String

  The host of the Proxmox VE cluster.

• #api_password ⇒ String^?

  The password to authenticate with,you can use PROXMOX_PASSWORD environment variable.

• #api_user ⇒ String

  The user to authenticate with.

• #cpus ⇒ Integer^?

  Numbers of allocated cpus for instance.

• #cpuunits ⇒ Integer^?

  CPU weight for a VM.

• #disk ⇒ Integer^?

  Hard disk size in GB for instance.

• #force ⇒ Boolean^?

  Forcing operations,can be used only with states C(present), C(stopped), C(restarted),with C(state=present) force option allow to overwrite existing container,with states C(stopped) , C(restarted) allow to force stop instance.

• #hostname ⇒ String^?

  The instance hostname,required only for C(state=present).

• #ip_address ⇒ Object^?

  Specifies the address the container will be assigned.

• #memory ⇒ Integer^?

  Memory size in MB for instance.

• #nameserver ⇒ Object^?

  Sets DNS server IP address for a container.

• #netif ⇒ String^?

  Specifies network interfaces for the container.

• #node ⇒ String^?

  Proxmox VE node, when new VM will be created,required only for C(state=present),for another states will be autodiscovered.

• #onboot ⇒ Boolean^?

  Specifies whether a VM will be started during system bootup.

• #ostemplate ⇒ String^?

  The template for VM creating,required only for C(state=present).

• #password ⇒ String^?

  The instance root password,required only for C(state=present).

• #searchdomain ⇒ Object^?

  Sets DNS search domain for a container.

• #state ⇒ :present, ...

  Indicate desired state of the instance.

• #storage ⇒ String^?

  Target storage.

• #swap ⇒ Integer^?

  Swap memory size in MB for instance.

• #timeout ⇒ Integer^?

  Timeout for operations.

• #validate_certs ⇒ Boolean^?

  Enable / disable https certificate verification.

• #vmid ⇒ String

  The instance id.

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

#api_host ⇒ String

Returns the host of the Proxmox VE cluster.

Returns:

• (String) —

  the host of the Proxmox VE cluster

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 12

attribute :api_host

#api_password ⇒ String^?

Returns the password to authenticate with,you can use PROXMOX_PASSWORD environment variable.

Returns:

• (String, nil) —

  the password to authenticate with,you can use PROXMOX_PASSWORD environment variable

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 20

attribute :api_password

#api_user ⇒ String

Returns the user to authenticate with.

Returns:

• (String) —

  the user to authenticate with

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 16

attribute :api_user

#cpus ⇒ Integer^?

Returns numbers of allocated cpus for instance.

Returns:

• (Integer, nil) —

  numbers of allocated cpus for instance

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

attribute :cpus

#cpuunits ⇒ Integer^?

Returns CPU weight for a VM.

Returns:

• (Integer, nil) —

  CPU weight for a VM

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 79

attribute :cpuunits

#disk ⇒ Integer^?

Returns hard disk size in GB for instance.

Returns:

• (Integer, nil) —

  hard disk size in GB for instance

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 48

attribute :disk

#force ⇒ Boolean^?

Returns forcing operations,can be used only with states C(present), C(stopped), C(restarted),with C(state=present) force option allow to overwrite existing container,with states C(stopped) , C(restarted) allow to force stop instance.

Returns:

• (Boolean, nil) —

  forcing operations,can be used only with states C(present), C(stopped), C(restarted),with C(state=present) force option allow to overwrite existing container,with states C(stopped) , C(restarted) allow to force stop instance

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 93

attribute :force

#hostname ⇒ String^?

Returns the instance hostname,required only for C(state=present).

Returns:

• (String, nil) —

  the instance hostname,required only for C(state=present)

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 40

attribute :hostname

#ip_address ⇒ Object^?

Returns specifies the address the container will be assigned.

Returns:

• (Object, nil) —

  specifies the address the container will be assigned

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 68

attribute :ip_address

#memory ⇒ Integer^?

Returns memory size in MB for instance.

Returns:

• (Integer, nil) —

  memory size in MB for instance

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 56

attribute :memory

#nameserver ⇒ Object^?

Returns sets DNS server IP address for a container.

Returns:

• (Object, nil) —

  sets DNS server IP address for a container

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 83

attribute :nameserver

#netif ⇒ String^?

Returns specifies network interfaces for the container.

Returns:

• (String, nil) —

  specifies network interfaces for the container

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 64

attribute :netif

#node ⇒ String^?

Returns Proxmox VE node, when new VM will be created,required only for C(state=present),for another states will be autodiscovered.

Returns:

• (String, nil) —

  Proxmox VE node, when new VM will be created,required only for C(state=present),for another states will be autodiscovered

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 32

attribute :node

#onboot ⇒ Boolean^?

Returns specifies whether a VM will be started during system bootup.

Returns:

• (Boolean, nil) —

  specifies whether a VM will be started during system bootup

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 71

attribute :onboot

#ostemplate ⇒ String^?

Returns the template for VM creating,required only for C(state=present).

Returns:

• (String, nil) —

  the template for VM creating,required only for C(state=present)

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 44

attribute :ostemplate

#password ⇒ String^?

Returns the instance root password,required only for C(state=present).

Returns:

• (String, nil) —

  the instance root password,required only for C(state=present)

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 36

attribute :password

#searchdomain ⇒ Object^?

Returns sets DNS search domain for a container.

Returns:

• (Object, nil) —

  sets DNS search domain for a container

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

attribute :searchdomain

#state ⇒ :present, ...

Returns Indicate desired state of the instance.

Returns:

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

  Indicate desired state of the instance

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 97

attribute :state

#storage ⇒ String^?

Returns target storage.

Returns:

• (String, nil) —

  target storage

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 75

attribute :storage

#swap ⇒ Integer^?

Returns swap memory size in MB for instance.

Returns:

• (Integer, nil) —

  swap memory size in MB for instance

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 60

attribute :swap

#timeout ⇒ Integer^?

Returns timeout for operations.

Returns:

• (Integer, nil) —

  timeout for operations

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 89

attribute :timeout

#validate_certs ⇒ Boolean^?

Returns enable / disable https certificate verification.

Returns:

• (Boolean, nil) —

  enable / disable https certificate verification

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 28

attribute :validate_certs

#vmid ⇒ String

Returns the instance id.

Returns:

• (String) —

  the instance id

# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/proxmox.rb', line 24

attribute :vmid