community.general.rundeck_project модуль — Управление проектами Rundeck

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в книге задач, укажите: community.general.rundeck_project.

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

Обзор

Создание и удаление проектов Rundeck через HTTP API.

Параметры

Параметр	Комментарии
api_token псевдонимы: token строка / обязательно	Устанавливает токен для аутентификации в API Rundeck.
api_version целое число	Версия API Rundeck для использования. Версия API должна быть не менее 14. По умолчанию: `39`
client_cert путь добавлен в community.general 0.2.0	Файл цепочки сертификатов в формате PEM для использования в SSL-аутентификации клиента. Этот файл также может содержать ключ, и если ключ включен, `client_key` не требуется.
client_key путь добавлен в community.general 0.2.0	Файл в формате PEM, содержащий ваш закрытый ключ для использования в SSL-аутентификации клиента. Если `client_cert` содержит и сертификат, и ключ, этот параметр не требуется.
force булево добавлен в community.general 0.2.0	Если `yes`, не получить кэшированную копию. Варианты: `false` ← (по умолчанию) `true`
force_basic_auth булево добавлен в community.general 0.2.0	Указанные с помощью `url_username` и `url_password` учетные данные должны передаваться в заголовке HTTP. Варианты: `false` ← (по умолчанию) `true`
http_agent строка добавлен в community.general 0.2.0	Заголовок для идентификации, обычно отображается в журналах веб-сервера. По умолчанию: `"ansible-httpget"`
name строка / обязательно	Устанавливает имя проекта.
state строка	Создание или удаление проекта Rundeck. Варианты: `"present"` ← (по умолчанию) `"absent"`
url строка / обязательно	URL HTTP, HTTPS или FTP в формате (http\|https\|ftp)://[пользователь[:пароль]]@хост.домен[:порт]/путь
url_password строка добавлен в community.general 0.2.0	Пароль для использования в HTTP-аутентификации по схеме Basic. Если параметр `url_username` не указан, параметр `url_password` не будет использован.
url_username строка добавлен в community.general 0.2.0	Имя пользователя для использования в HTTP-аутентификации по схеме Basic. Этот параметр может использоваться без `url_password` для сайтов, разрешающих пустые пароли
use_gssapi булево добавлен в ansible-core 2.11	Использовать GSSAPI для выполнения аутентификации, обычно это для аутентификации Kerberos или Kerberos через Negotiate. Требуется установка Python-библиотеки gssapi. Учетные данные для GSSAPI можно указать с помощью `url_username`/`url_password` или с помощью переменной среды GSSAPI `KRB5CCNAME`, которая указывает на пользовательский кэш учетных данных Kerberos. Аутентификация NTLM не поддерживается, даже если механизм GSSAPI для NTLM был установлен. Варианты: `false` ← (по умолчанию) `true`
use_proxy булево добавлен в community.general 0.2.0	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. Варианты: `false` `true` ← (по умолчанию)
validate_certs булево добавлен в community.general 0.2.0	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Create a rundeck project
  community.general.rundeck_project:
    name: "Project_01"
    label: "Project 01"
    description: "My Project 01"
    url: "https://rundeck.example.org"
    api_version: 39
    api_token: "mytoken"
    state: present

- name: Remove a rundeck project
  community.general.rundeck_project:
    name: "Project_01"
    url: "https://rundeck.example.org"
    api_token: "mytoken"
    state: absent

Значения возврата

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

Ключ	Описание
after словарь	Словарь, содержащий информацию о проекте после изменения. Возвращается при: успехе
before словарь	Словарь, содержащий информацию о проекте до изменения. Возвращается при: успехе
rundeck_response строка	Ответ Rundeck при возникновении ошибки. Возвращается при: ошибке

Авторы

Loic Blot (@nerzhul)

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

© 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/rundeck_project_module.html