community.general.profitbricks_volume_attachments module – Attach or detach a volume
Note
This module is part of the community.general collection (version 9.5.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
.
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_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 |
Comments |
---|---|
The datacenter in which to operate. |
|
The name of the server you wish to detach or attach the volume. |
|
Indicate desired state of the resource The available choices are: Default: |
|
THe ProfitBricks password. Overrides the PB_PASSWORD environment variable. |
|
The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environment variable. |
|
The volume name or ID. |
|
wait for the operation to complete before returning Choices:
|
|
how long before wait gives up, in seconds Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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