Spec-Zone.ru › Ansible

Модуль community.general.rundeck_job_executions_info — запрос сведений о выполнениях задания Rundeck

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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 / обязательный

Токен 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 / обязательный

Уникальный идентификатор задания.

max

integer

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

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

offset

integer

Начальная позиция для возвращаемых результатов.

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

status

string

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

Варианты:

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

url

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

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

Поддержка: не применимо

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

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

Примеры

- 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

list / элементы=словарь

Список выполнений задания.

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

Пример: [{"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

dictionary

Сведения о постраничной выдаче результатов.

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

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

count

integer

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

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

max

integer

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

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

offset

integer

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

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

total

integer

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

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

Авторы

  • Phillipe Smith (@phsmith)

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

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

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

Spec-Zone.ru

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