W3cubDocs

/Ansible

profitbricks_volume - Create or destroy a volume.

New in version 2.0.

Synopsis

Allows you to create or remove a volume from a ProfitBricks datacenter. This module has a dependency on profitbricks >= 1.0.0

Requirements (on host that executes module)

  • profitbricks

Options

parameter required default choices comments
auto_increment
 no True
  • yes
  • no
Whether or not to increment a single number in the name for created virtual machines.
bus
 no VIRTIO
  • IDE
  • VIRTIO
The bus type.
count
 no 1
The number of volumes you wish to create.
datacenter
 yes
The datacenter in which to create the volumes.
disk_type
 no HDD
  • HDD
  • SSD
The disk type of the volume.
image
 yes
The system image ID for the volume, e.g. a3eae284-a2fe-11e4-b187-5f1f641608c8. This can also be a snapshot image ID.
image_password
(added in 2.2)
 no
Password set for the administrative user.
instance_ids
 no
list of instance ids, currently only used when state='absent' to remove instances.
licence_type
 no UNKNOWN
  • LINUX
  • WINDOWS
  • UNKNOWN
  • OTHER
The licence type for the volume. This is used when the image is non-standard.
name
 yes
The name of the volumes. You can enumerate the names using auto_increment.
size
 no 10
The size of the volume.
ssh_keys
(added in 2.2)
 no
Public SSH keys allowing access to the virtual machine.
state
 no present
  • present
  • absent
create or terminate datacenters
subscription_password
 no
THe ProfitBricks password. Overrides the PB_PASSWORD environement variable.
subscription_user
 no
The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environement variable.
wait
 no yes
  • yes
  • no
wait for the datacenter to be created before returning
wait_timeout
 no 600
how long before wait gives up, in seconds

Examples

# Create Multiple Volumes

- profitbricks_volume:
    datacenter: Tardis One
    name: vol%02d
    count: 5
    auto_increment: yes
    wait_timeout: 500
    state: present

# Remove Volumes

- profitbricks_volume:
    datacenter: Tardis One
    instance_ids:
      - 'vol01'
      - 'vol02'
    wait_timeout: 500
    state: absent

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/profitbricks_volume_module.html