You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

profitbricks_volume_attachments - Attach or detach a volume.¶

New in version 2.0.

Synopsis
Requirements (on host that executes module)
Options
Examples
- Status

Synopsis ¶

Allows you to attach or detach a volume from a ProfitBricks server. This module has a dependency on profitbricks >= 1.0.0

Requirements (on host that executes module)¶

profitbricks

Options ¶

parameter	required	default	choices	comments
datacenter	yes			The datacenter in which to operate.
server	yes			The name of the server you wish to detach or attach the volume.
state	no	present	present absent	Indicate desired state of the resource
subscription_password	no			THe ProfitBricks password. Overrides the PB_PASSWORD environment variable.
subscription_user	no			The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environment variable.
volume	yes			The volume name or ID.
wait	no	yes	yes no	wait for the operation to complete before returning
wait_timeout	no	600		how long before wait gives up, in seconds

Examples ¶

# Attach a Volume

- profitbricks_volume_attachments:
    datacenter: Tardis One
    server: node002
    volume: vol01
    wait_timeout: 500
    state: present

# Detach a Volume

- profitbricks_volume_attachments:
    datacenter: Tardis One
    server: node002
    volume: vol01
    wait_timeout: 500
    state: absent

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

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