community.general.packet_project module – Create/delete a project in Packet host
Note
This module is part of the community.general collection (version 8.6.4).
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.packet_project
.
New in community.general 0.2.0
Synopsis
Create/delete a project in Packet host.
API is documented at https://www.packet.com/developers/api/#projects.
Aliases: cloud.packet.packet_project
Requirements
The below requirements are needed on the host that executes this module.
packet-python >= 1.40
Parameters
Parameter |
Comments |
---|---|
Packet api token. You can also supply it in environment variable |
|
Custom data about the project to create. |
|
UUID of the project which you want to remove. |
|
Name for/of the project. |
|
UUID of the organization to create a project for. When blank, the API assumes the default organization. |
|
Payment method is name of one of the payment methods available to your user. When blank, the API assumes the default payment method. |
|
Indicate desired state of the target. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
# All the examples assume that you have your Packet API token in env var PACKET_API_TOKEN.
# You can also pass the api token in module param auth_token.
- name: Create new project
hosts: localhost
tasks:
community.general.packet_project:
name: "new project"
- name: Create new project within non-default organization
hosts: localhost
tasks:
community.general.packet_project:
name: "my org project"
org_id: a4cc87f9-e00f-48c2-9460-74aa60beb6b0
- name: Remove project by id
hosts: localhost
tasks:
community.general.packet_project:
state: absent
id: eef49903-7a09-4ca1-af67-4087c29ab5b6
- name: Create new project with non-default billing method
hosts: localhost
tasks:
community.general.packet_project:
name: "newer project"
payment_method: "the other visa"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
True if a project was created or removed. Returned: success Sample: |
|
UUID of addressed project. Returned: success |
|
Name of addressed project. Returned: success |