W3cubDocs

/Ansible 2.10

community.general.profitbricks_volume_attachments – Attach or detach a volume.

Note

This plugin is part of the community.general collection.

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

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

Synopsis

  • Allows you to attach or detach a volume from a ProfitBricks server. 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
datacenter
string / required
The datacenter in which to operate.
server
string / required
The name of the server you wish to detach or attach the volume.
state
string
    Choices:
  • present ←
  • absent
Indicate desired state of the resource
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.
volume
string / required
The volume name or ID.
wait
boolean
    Choices:
  • no
  • yes ←
wait for the operation to complete before returning
wait_timeout
string
Default:
600
how long before wait gives up, in seconds

Examples

- name: Attach a volume
  community.general.profitbricks_volume_attachments:
    datacenter: Tardis One
    server: node002
    volume: vol01
    wait_timeout: 500
    state: present

- name: Detach a volume
  community.general.profitbricks_volume_attachments:
    datacenter: Tardis One
    server: node002
    volume: vol01
    wait_timeout: 500
    state: absent

Authors

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/profitbricks_volume_attachments_module.html