community.general.packet_project – Создание/удаление проекта в Packet host.
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.packet_project.
Введено в версии 0.2.0: of community.general
Обзор
- Создание/удаление проекта в Packet host.
- Документация API находится по адресу https://www.packet.com/developers/api/#projects.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- packet-python >= 1.40
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_token строка | Токен API Packet. Также можно указать в переменной окружения PACKET_API_TOKEN. | |
| custom_data строка | Дополнительные данные о проекте для создания. | |
| id строка | UUID проекта, который необходимо удалить. | |
| name строка | Имя проекта. | |
| org_id строка | UUID организации, для которой нужно создать проект. Если пусто, API предполагает использование организации по умолчанию. | |
| payment_method строка | Способ оплаты — имя одного из способов оплаты, доступных вашему пользователю. Если пусто, API предполагает использование способа оплаты по умолчанию. | |
| state строка |
| Указывает желаемое состояние целевого объекта. |
Примеры
# 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 boolean | успех | True, если проект был создан или удалён. Пример: True |
| id строка | успех | UUID адресованного проекта. |
| name строка | успех | Имя адресованного проекта. |
Авторы
- Tomas Karasek (@t0mk) <tom.to.the.k@gmail.com>
- Nurfet Becirevic (@nurfet-becirevic) <nurfet.becirevic@gmail.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/packet_project_module.html