community.general.profitbricks_volume – Create or destroy a volume.

Note

This plugin is part of the community.general collection (version 4.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.profitbricks_volume.

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

  • profitbricks

Parameters

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

Examples

- name: Create multiple volumes
  community.general.profitbricks_volume:
    datacenter: Tardis One
    name: vol%02d
    count: 5
    auto_increment: yes
    wait_timeout: 500
    state: present

- name: Remove Volumes
  community.general.profitbricks_volume:
    datacenter: Tardis One
    instance_ids:
      - 'vol01'
      - 'vol02'
    wait_timeout: 500
    state: absent

Authors