Spec-Zone.ru › Ansible

Модуль community.general.rundeck_job_run — запуск задания Rundeck

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

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

Добавлен в community.general 3.8.0

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

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

  • Этот модуль запускает задание Rundeck, указанное по ID.

Параметры

Параметр

Комментарии

abort_on_timeout

boolean

Отправить запрос на прерывание задания, если превышено указанное значение wait_execution_timeout.

Варианты:

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

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 содержит и сертификат, и ключ, этот параметр не требуется.

filter_nodes

string

Фильтр узлов, на которых должны выполняться задания.

См. https://docs.rundeck.com/docs/manual/11-node-filters.html#node-filter-syntax.

force

boolean

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

Варианты:

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

force_basic_auth

boolean

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

Варианты:

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

http_agent

string

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

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

job_id

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

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

job_options

dictionary

Параметры задания для шагов.

Числовые значения необходимо заключать в кавычки.

loglevel

string

Настройка уровня журналирования.

Варианты:

  • "debug"
  • "verbose"
  • "info" ← (по умолчанию)
  • "warn"
  • "error"

run_at_time

string

Запланировать выполнение задания на указанную дату и время.

Дата и время в формате ISO-8601, например 2021-10-05T15:45:00-03:00.

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 ← (по умолчанию)

wait_execution

boolean

Ожидать завершения выполнения задания.

Варианты:

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

wait_execution_delay

integer

Задержка в секундах между запросами на проверку состояния выполнения задания.

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

wait_execution_timeout

integer

Тайм-аут ожидания выполнения задания в секундах.

По истечении тайм-аута задание прерывается.

Учитывайте, что после каждой проверки состояния задания выполняется пауза длительностью wait_execution_delay.

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

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

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

diff_mode

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

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

Примеры

- name: Run a Rundeck job
  community.general.rundeck_job_run:
    url: "https://rundeck.example.org"
    api_version: 39
    api_token: "mytoken"
    job_id: "xxxxxxxxxxxxxxxxx"
  register: rundeck_job_run

- name: Show execution info
  ansible.builtin.debug:
    var: rundeck_job_run.execution_info

- name: Run a Rundeck job with options
  community.general.rundeck_job_run:
    url: "https://rundeck.example.org"
    api_version: 39
    api_token: "mytoken"
    job_id: "xxxxxxxxxxxxxxxxx"
    job_options:
      option_1: "value_1"
      option_2: "value_3"
      option_3: "value_3"
  register: rundeck_job_run

- name: Run a Rundeck job with timeout, delay between status check and abort on timeout
  community.general.rundeck_job_run:
    url: "https://rundeck.example.org"
    api_version: 39
    api_token: "mytoken"
    job_id: "xxxxxxxxxxxxxxxxx"
    wait_execution_timeout: 30
    wait_execution_delay: 10
    abort_on_timeout: true
  register: rundeck_job_run

- name: Schedule a Rundeck job
  community.general.rundeck_job_run:
    url: "https://rundeck.example.org"
    api_version: 39
    api_token: "mytoken"
    job_id: "xxxxxxxxxxxxxxxxx"
    run_at_time: "2021-10-05T15:45:00-03:00"
  register: rundeck_job_schedule

- name: Fire-and-forget a Rundeck job
  community.general.rundeck_job_run:
    url: "https://rundeck.example.org"
    api_version: 39
    api_token: "mytoken"
    job_id: "xxxxxxxxxxxxxxxxx"
    wait_execution: false
  register: rundeck_job_run

Возвращаемые значения

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

Ключ

Описание

execution_info

dictionary

Метаданные выполнения задания Rundeck.

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

Пример: {"execution_info": {"argstring": "-exit_code 0", "date-ended": {"date": "2021-10-05T15:50:26Z", "unixtime": 1633449026358}, "date-started": {"date": "2021-10-05T15:50:20Z", "unixtime": 1633449020784}, "description": "sleep 5 && echo 'Test!' && exit ${option.exit_code}", "executionType": "user", "href": "https://rundeck.example.org/api/39/execution/1", "id": 1, "job": {"averageDuration": 4917, "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"}, "output": "Test!", "permalink": "https://rundeck.example.org/project/myproject/execution/show/1", "project": "myproject", "serverUUID": "5b9a1438-fa3a-457e-b254-8f3d70338068", "status": "succeeded", "successfulNodes": ["localhost"], "user": "admin"}, "msg": "Job execution succeeded!"}

Авторы

  • 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_run_module.html

Spec-Zone.ru

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