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

Note

This module is part of the community.general collection (version 10.0.1).

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. You need further requirements to be able to use this module, see Requirements for details.

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

Comments

auto_increment

boolean

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

Choices:

  • false

  • true ← (default)

bus

string

The bus type.

Choices:

  • "IDE"

  • "VIRTIO" ← (default)

count

integer

The number of volumes you wish to create.

Default: 1

datacenter

string

The datacenter in which to create the volumes.

disk_type

string

The disk type of the volume.

Choices:

  • "HDD" ← (default)

  • "SSD"

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.

Default: []

licence_type

string

The licence type for the volume. This is used when the image is non-standard.

The available choices are: LINUX, WINDOWS, UNKNOWN, OTHER.

Default: "UNKNOWN"

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

The size of the volume.

Default: 10

ssh_keys

list / elements=string

Public SSH keys allowing access to the virtual machine.

Default: []

state

string

create or terminate datacenters

The available choices are: present, absent.

Default: "present"

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

wait for the datacenter to be created before returning

Choices:

  • false

  • true ← (default)

wait_timeout

integer

how long before wait gives up, in seconds

Default: 600

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name: Create multiple volumes
  community.general.profitbricks_volume:
    datacenter: Tardis One
    name: vol%02d
    count: 5
    auto_increment: true
    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

  • Matt Baldwin (@baldwinSPC)