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

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/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.

• #cores ⇒ Integer^?

  Specify number of cores per socket.

• #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 ⇒ :yes, ...

  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),must be unique if vmid is not passed.

• #ip_address ⇒ Object^?

  Specifies the address the container will be assigned.

• #memory ⇒ Integer^?

  Memory size in MB for instance.

• #mounts ⇒ Hash^?

  Specifies additional mounts (separate disks) for the container.

• #nameserver ⇒ Object^?

  Sets DNS server IP address for a container.

• #netif ⇒ Hash^?

  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 ⇒ :yes, ...

  Specifies whether a VM will be started during system bootup.

• #ostemplate ⇒ String^?

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

• #password ⇒ Integer, ...

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

• #pool ⇒ Object^?

  Proxmox VE resource pool.

• #pubkey ⇒ Object^?

  Public key to add to /root/.ssh/authorized_keys.

• #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.

• #unprivileged ⇒ :yes, ...

  Indicate if the container should be unprivileged.

• #validate_certs ⇒ :yes, ...

  Enable / disable https certificate verification.

• #vmid ⇒ Integer^?

  The instance id,if not set, the next available VM ID will be fetched from ProxmoxAPI.,if not set, will be fetched from PromoxAPI based on the hostname.

Methods inherited from Base

#ansible_name, #to_h

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

#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/cloud/misc/proxmox.rb', line 13

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/cloud/misc/proxmox.rb', line 21

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/cloud/misc/proxmox.rb', line 17

attribute :api_user

#cores ⇒ Integer^?

Returns Specify number of cores per socket.

Returns:

• (Integer, nil) —

  Specify number of cores per socket.

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

attribute :cores

#cpus ⇒ Integer^?

Returns numbers of allocated cpus for instance.

Returns:

• (Integer, nil) —

  numbers of allocated cpus for instance

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

attribute :cpus

#cpuunits ⇒ Integer^?

Returns CPU weight for a VM.

Returns:

• (Integer, nil) —

  CPU weight for a VM

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

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/cloud/misc/proxmox.rb', line 52

attribute :disk

#force ⇒ :yes, ...

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:

• (:yes, :no, 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/cloud/misc/proxmox.rb', line 105

attribute :force

#hostname ⇒ String^?

Returns the instance hostname,required only for C(state=present),must be unique if vmid is not passed.

Returns:

• (String, nil) —

  the instance hostname,required only for C(state=present),must be unique if vmid is not passed

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

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/cloud/misc/proxmox.rb', line 80

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/cloud/misc/proxmox.rb', line 64

attribute :memory

#mounts ⇒ Hash^?

Returns specifies additional mounts (separate disks) for the container. As a hash/dictionary defining mount points.

Returns:

• (Hash, nil) —

  specifies additional mounts (separate disks) for the container. As a hash/dictionary defining mount points

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

attribute :mounts

#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/cloud/misc/proxmox.rb', line 95

attribute :nameserver

#netif ⇒ Hash^?

Returns specifies network interfaces for the container. As a hash/dictionary defining interfaces.

Returns:

• (Hash, nil) —

  specifies network interfaces for the container. As a hash/dictionary defining interfaces.

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

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/cloud/misc/proxmox.rb', line 33

attribute :node

#onboot ⇒ :yes, ...

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

Returns:

• (:yes, :no, nil) —

  specifies whether a VM will be started during system bootup

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

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/cloud/misc/proxmox.rb', line 48

attribute :ostemplate

#password ⇒ Integer, ...

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

Returns:

• (Integer, String, nil) —

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

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

attribute :password

#pool ⇒ Object^?

Returns Proxmox VE resource pool.

Returns:

• (Object, nil) —

  Proxmox VE resource pool

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

attribute :pool

#pubkey ⇒ Object^?

Returns Public key to add to /root/.ssh/authorized_keys. This was added on Proxmox 4.2, it is ignored for earlier versions.

Returns:

• (Object, nil) —

  Public key to add to /root/.ssh/authorized_keys. This was added on Proxmox 4.2, it is ignored for earlier versions

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

attribute :pubkey

#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/cloud/misc/proxmox.rb', line 98

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/cloud/misc/proxmox.rb', line 109

attribute :state

#storage ⇒ String^?

Returns target storage.

Returns:

• (String, nil) —

  target storage

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

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/cloud/misc/proxmox.rb', line 68

attribute :swap

#timeout ⇒ Integer^?

Returns timeout for operations.

Returns:

• (Integer, nil) —

  timeout for operations

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

attribute :timeout

#unprivileged ⇒ :yes, ...

Returns Indicate if the container should be unprivileged.

Returns:

• (:yes, :no, nil) —

  Indicate if the container should be unprivileged

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

attribute :unprivileged

#validate_certs ⇒ :yes, ...

Returns enable / disable https certificate verification.

Returns:

• (:yes, :no, nil) —

  enable / disable https certificate verification

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

attribute :validate_certs

#vmid ⇒ Integer^?

Returns the instance id,if not set, the next available VM ID will be fetched from ProxmoxAPI.,if not set, will be fetched from PromoxAPI based on the hostname.

Returns:

• (Integer, nil) —

  the instance id,if not set, the next available VM ID will be fetched from ProxmoxAPI.,if not set, will be fetched from PromoxAPI based on the hostname

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

attribute :vmid