Модуль community.general.packet_project – Создание/удаление проекта в Packet host

Примечание

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

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

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

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

Новая в community.general 0.2.0

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

Обзор

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

Требования

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

packet-python >= 1.40

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз состояния изменения без изменения целевого объекта.
diff_mode	Поддержка: нет	Возвращает детали изменений (или, возможно, требующих изменений в `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"

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

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

Ключ	Описание
changed логическое	True, если проект был создан или удален. Возвращается: успех Пример: `true`
id строка	UUID адресованного проекта. Возвращается: успех
name строка	Имя адресованного проекта. Возвращается: успех

Авторы

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

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

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