Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

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

Параметры

Параметр

Комментарии

api_token

псевдонимы: token

string / обязательный

Задает токен для аутентификации в Rundeck API.

api_version

integer

Используемая версия Rundeck API.

Версия API должна быть не ниже 14.

По умолчанию: 39

client_cert

path

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

Файл цепочки сертификатов в формате PEM для аутентификации SSL-клиента.

Этот файл также может содержать ключ; если ключ включен, client_key не требуется.

client_key

path

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

Файл в формате PEM с закрытым ключом для аутентификации SSL-клиента.

Если client_cert содержит и сертификат, и ключ, этот параметр не требуется.

force

boolean

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

Если yes, не использовать кэшированную копию.

Варианты:

  • false ← (по умолчанию)
  • true

force_basic_auth

boolean

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

Передавать учетные данные, указанные с помощью url_username и url_password, в HTTP-заголовке.

Варианты:

  • false ← (по умолчанию)
  • true

http_agent

string

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

Заголовок, используемый для идентификации; обычно отображается в журналах веб-сервера.

По умолчанию: "ansible-httpget"

name

string / обязательный

Задает имя проекта.

state

string

Создать или удалить проект Rundeck.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

url

string / обязательный

URL HTTP, HTTPS или FTP в формате (http|https|ftp)://[user[:pass]]@host.domain[:port]/path

url_password

string

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

Пароль для HTTP-аутентификации Basic.

Если параметр url_username не указан, параметр url_password использоваться не будет.

url_username

string

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

Имя пользователя для HTTP-аутентификации Basic.

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

use_gssapi

boolean

добавлено в 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

boolean

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

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

Варианты:

  • false
  • true ← (по умолчанию)

validate_certs

boolean

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

Если no, сертификаты SSL проверяться не будут.

Используйте этот параметр только на сайтах под вашим контролем, где применяются самоподписанные сертификаты.

Варианты:

  • false
  • true ← (по умолчанию)

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Может работать в режиме check_mode и прогнозировать наличие изменений, не изменяя целевой объект.

diff_mode

Поддержка: нет

В режиме diff возвращает сведения об изменениях (или о том, что может потребоваться изменить в check_mode).

Примеры

- 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

dictionary

Словарь с информацией о проекте после изменения.

Возвращается: при успешном выполнении

before

dictionary

Словарь с информацией о проекте до изменения.

Возвращается: при успешном выполнении

rundeck_response

string

Ответ Rundeck при возникновении ошибки.

Возвращается: при ошибке

Авторы

  • Loic Blot (@nerzhul)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Задать вопрос
  • Сообщить об ошибке
  • Предложить новую функцию
  • Общение

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API