community.general.packet_project – Create/delete a project in Packet host.

Note

This plugin is part of the community.general collection (version 1.3.6).

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

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

New in version 0.2.0: of community.general

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

  • packet-python >= 1.40

Parameters

Parameter Choices/Defaults Comments
auth_token
string
Packet api token. You can also supply it in env var PACKET_API_TOKEN.
custom_data
string
Custom data about the project to create.
id
string
UUID of the project which you want to remove.
name
string
Name for/of the project.
org_id
string
UUID of the organization to create a project for.
When blank, the API assumes the default organization.
payment_method
string
Payment method is name of one of the payment methods available to your user.
When blank, the API assumes the default payment method.
state
string
    Choices:
  • present ←
  • absent
Indicate desired state of the target.

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 Returned Description
changed
boolean
success
True if a project was created or removed.

Sample:
True
id
string
success
UUID of addressed project.
name
string
success
Name of addressed project.


Authors