Documentation

profitbricks_volume_attachments - Attach or detach a volume.

New in version 2.0.

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 environement variable.
        subscription_user
        no
          The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environement 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
              

              This is an Extras Module

              For more information on what this means please read Extras Modules

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