Class: Ansible::Ruby::Modules::Profitbricks

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

Overview

Create, destroy, update, start, stop, and reboot a ProfitBricks virtual machine. When the virtual machine is created it can optionally wait for it to be ‘running’ before returning. This module has a dependency on profitbricks >= 1.0.0

Instance Method Summary collapse

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

#assign_public_ip ⇒ :yes, ...

Returns This will assign the machine to the public LAN. If no LAN exists with public Internet access it is created.

Returns:

  • (:yes, :no, nil) —

    This will assign the machine to the public LAN. If no LAN exists with public Internet access it is created.



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

attribute :assign_public_ip

#auto_increment ⇒ :yes, ...

Returns Whether or not to increment a single number in the name for created virtual machines.

Returns:

  • (:yes, :no, nil) —

    Whether or not to increment a single number in the name for created virtual machines.



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

attribute :auto_increment

#bus ⇒ :IDE, ...

Returns The bus type for the volume.

Returns:

  • (:IDE, :VIRTIO, nil) —

    The bus type for the volume.



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

attribute :bus

#cores ⇒ Integer?

Returns The number of CPU cores to allocate to the virtual machine.

Returns:

  • (Integer, nil) —

    The number of CPU cores to allocate to the virtual machine.



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 34

attribute :cores

#count ⇒ Integer?

Returns The number of virtual machines to create.

Returns:

  • (Integer, nil) —

    The number of virtual machines to create.



58
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 58

attribute :count

#cpu_family ⇒ :AMD_OPTERON, ...

Returns The CPU family type to allocate to the virtual machine.

Returns:

  • (:AMD_OPTERON, :INTEL_XEON, nil) —

    The CPU family type to allocate to the virtual machine.



42
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 42

attribute :cpu_family

#datacenter ⇒ String?

Returns The datacenter to provision this virtual machine.

Returns:

  • (String, nil) —

    The datacenter to provision this virtual machine.



30
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 30

attribute :datacenter

#image ⇒ String

Returns The system image ID for creating the virtual machine, e.g. a3eae284-a2fe-11e4-b187-5f1f641608c8.

Returns:

  • (String) —

    The system image ID for creating the virtual machine, e.g. a3eae284-a2fe-11e4-b187-5f1f641608c8.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 20

attribute :image

#image_password ⇒ Object?

Returns Password set for the administrative user.

Returns:

  • (Object, nil) —

    Password set for the administrative user.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 24

attribute :image_password

#instance_ids ⇒ Array<String>, ...

Returns list of instance ids, currently only used when state=‘absent’ to remove instances.

Returns:

  • (Array<String>, String, nil) —

    list of instance ids, currently only used when state=‘absent’ to remove instances.



54
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 54

attribute :instance_ids

#lan ⇒ Integer?

Returns The ID of the LAN you wish to add the servers to.

Returns:

  • (Integer, nil) —

    The ID of the LAN you wish to add the servers to.



70
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 70

attribute :lan

#location ⇒ :"us/las", ...

Returns The datacenter location. Use only if you want to create the Datacenter or else this value is ignored.

Returns:

  • (:"us/las", :"de/fra", :"de/fkb", nil) —

    The datacenter location. Use only if you want to create the Datacenter or else this value is ignored.



62
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 62

attribute :location

#name ⇒ String

Returns The name of the virtual machine.

Returns:

  • (String) —

    The name of the virtual machine.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 16

attribute :name

#ram ⇒ Integer?

Returns The amount of memory to allocate to the virtual machine.

Returns:

  • (Integer, nil) —

    The amount of memory to allocate to the virtual machine.



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

attribute :ram

#remove_boot_volume ⇒ :yes, ...

Returns remove the bootVolume of the virtual machine you’re destroying.

Returns:

  • (:yes, :no, nil) —

    remove the bootVolume of the virtual machine you’re destroying.



88
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 88

attribute :remove_boot_volume

#ssh_keys ⇒ Object?

Returns Public SSH keys allowing access to the virtual machine.

Returns:

  • (Object, nil) —

    Public SSH keys allowing access to the virtual machine.



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 27

attribute :ssh_keys

#state ⇒ :running, ...

Returns create or terminate instances.

Returns:

  • (:running, :stopped, :absent, :present, nil) —

    create or terminate instances



92
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 92

attribute :state

#subscription_password ⇒ Object?

Returns THe ProfitBricks password. Overrides the PB_PASSWORD environment variable.

Returns:

  • (Object, nil) —

    THe ProfitBricks password. Overrides the PB_PASSWORD environment variable.



77
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 77

attribute :subscription_password

#subscription_user ⇒ Object?

Returns The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environment variable.

Returns:

  • (Object, nil) —

    The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environment variable.



74
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 74

attribute :subscription_user

#volume_size ⇒ Integer?

Returns The size in GB of the boot volume.

Returns:

  • (Integer, nil) —

    The size in GB of the boot volume.



46
 
# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks.rb', line 46

attribute :volume_size

#wait ⇒ :yes, ...

Returns wait for the instance to be in state ‘running’ before returning.

Returns:

  • (:yes, :no, nil) —

    wait for the instance to be in state ‘running’ before returning



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

attribute :wait

#wait_timeout ⇒ Integer?

Returns how long before wait gives up, in seconds.

Returns:

  • (Integer, nil) —

    how long before wait gives up, in seconds



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

attribute :wait_timeout