community.general.profitbricks_datacenter – Create or destroy a ProfitBricks Virtual Datacenter.
Note
This plugin is part of the community.general collection (version 3.8.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
.
To use it in a playbook, specify: community.general.profitbricks_datacenter
.
Synopsis
- This is a simple module that supports creating or removing vDCs. A vDC is required before you can create servers. 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 |
---|---|---|
description string | The description of the virtual datacenter. | |
location string |
| The datacenter location. |
name string | The name of the virtual datacenter. | |
state string | Default: "present" | Create or terminate datacenters. The available choices are: present , absent . |
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 |
wait_timeout integer | Default: 600 | how long before wait gives up, in seconds |
Examples
- name: Create a datacenter community.general.profitbricks_datacenter: datacenter: Tardis One wait_timeout: 500 - name: Destroy a datacenter (remove all servers, volumes, and other objects in the datacenter) community.general.profitbricks_datacenter: datacenter: Tardis One wait_timeout: 500 state: absent
Authors
- Matt Baldwin (@baldwinSPC) <baldwin@stackpointcloud.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/profitbricks_datacenter_module.html