Модуль community.general.packet_project — создание/удаление проекта на хосте Packet

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Эта коллекция уже может быть установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.packet_project.

Добавлено в community.general 0.2.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Создание/удаление проекта на хосте Packet.
Документация API доступна по адресу https://www.packet.com/developers/api/#projects.

Требования

Следующие требования должны быть выполнены на хосте, на котором выполняется этот модуль.

packet-python >= 1.40

Параметры

Параметр	Комментарии
auth_token string	Токен API Packet. Его также можно указать в переменной окружения `PACKET_API_TOKEN`.
custom_data string	Пользовательские данные о создаваемом проекте.
id string	UUID проекта, который требуется удалить.
name string	Имя проекта.
org_id string	UUID организации, для которой создается проект. Если значение не указано, API использует организацию по умолчанию.
payment_method string	Способ оплаты — это название одного из способов оплаты, доступных вашему пользователю. Если значение не указано, API использует способ оплаты по умолчанию.
state string	Указывает желаемое состояние целевого объекта. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о том, что, возможно, потребуется изменить в `check_mode`).

Примеры

# 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"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
id string	UUID указанного проекта. Возвращается: при успехе
name string	Имя указанного проекта. Возвращается: при успехе

Авторы

Tomas Karasek (@t0mk)
Nurfet Becirevic (@nurfet-becirevic)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/packet_project_module.html