Spec-Zone.ru › Ansible

Модуль community.general.rundeck_job_executions_info – Запрос исполнений для задачи Rundeck

Примечание

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

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

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

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

Новая функция в community.general 3.8.0

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

Обзор

  • Этот модуль получает список исполнений для заданной задачи Rundeck.

Параметры

Параметр

Комментарии

api_token

string / required

Токен API пользователя Rundeck.

api_version

integer

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

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

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

client_cert

path

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

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

client_key

path

Файл в формате PEM, содержащий ваш закрытый ключ, используемый для проверки подлинности клиента SSL.

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

force

boolean

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

Варианты:

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

force_basic_auth

boolean

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

Варианты:

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

http_agent

string

Заголовок для идентификации, обычно отображается в логах веб-сервера.

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

job_id

string / required

Уникальный ID задачи.

max

integer

Максимальное количество результатов для возврата.

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

offset

integer

Начальная точка для возврата результатов.

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

status

string

Статус задачи для фильтрации.

Варианты:

  • "succeeded"
  • "failed"
  • "aborted"
  • "running"

url

string / required

URL экземпляра Rundeck.

url_password

string

Пароль для использования в HTTP-авторизации.

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

url_username

string

Имя пользователя для использования в HTTP-авторизации.

Этот параметр может использоваться без 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

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

Варианты:

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

validate_certs

boolean

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

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

Варианты:

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

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

Это действие не изменяет состояние.

Может выполняться в check_mode и возвращать прогноз изменения статуса без изменения целевого объекта.

diff_mode

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

Это действие не изменяет состояние.

Будет возвращать подробности о том, что изменилось (или, возможно, должно измениться в check_mode), когда режим diff включен.

Примеры

- name: Get Rundeck job executions info
  community.general.rundeck_job_executions_info:
    url: "https://rundeck.example.org"
    api_version: 39
    api_token: "mytoken"
    job_id: "xxxxxxxxxxxxxxxxx"
  register: rundeck_job_executions_info

- name: Show Rundeck job executions info
  ansible.builtin.debug:
    var: rundeck_job_executions_info.executions

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

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

Ключ

Описание

executions

список / элементы=словарь

Список исполнений задач.

Возвращается: всегда

Пример: [{"argstring": "-exit_code 0", "date-ended": {"date": "2021-10-06T13:05:18Z", "unixtime": 1633525518386}, "date-started": {"date": "2021-10-06T13:05:15Z", "unixtime": 1633525515026}, "description": "Plugin[com.batix.rundeck.plugins.AnsiblePlaybookInlineWorkflowStep, nodeStep: false]", "executionType": "user", "href": "https://rundeck.example.org/api/39/execution/1", "id": 1, "job": {"averageDuration": 6381, "description": "", "group": "", "href": "https://rundeck.example.org/api/39/job/697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a", "id": "697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a", "name": "Test", "options": {"exit_code": "0"}, "permalink": "https://rundeck.example.org/project/myproject/job/show/697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a", "project": "myproject"}, "permalink": "https://rundeck.example.org/project/myproject/execution/show/1", "project": "myproject", "serverUUID": "5b9a1438-fa3a-457e-b254-8f3d70338068", "status": "succeeded", "user": "admin"}]

paging

словарь

Информация о постраничном выводе результатов.

Возвращается: успех

Пример: {"count": 20, "max": 20, "offset": 0, "total": 100}

count

целое число

Количество результатов в ответе.

Возвращается: успех

max

целое число

Максимальное количество результатов на странице.

Возвращается: успех

offset

целое число

Смещение от первого результата.

Возвращается: успех

total

целое число

Общее количество результатов.

Возвращается: успех

Авторы

  • Phillipe Smith (@phsmith)

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

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

© 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_job_executions_info_module.html

Spec-Zone.ru

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