модуль theforeman.foreman.webhook — управление веб-перехватчиками

Примечание

Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.0).

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

Для установки используйте: ansible-galaxy collection install theforeman.foreman. Для работы с этим модулем могут потребоваться дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.webhook.

Добавлен в theforeman.foreman 4.0.0

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

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

Управление веб-перехватчиками

Требования

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

requests

Параметры

Параметр	Комментарии
ca_path путь	Файл в формате PEM, содержащий сертификат CA, используемый для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_CA_PATH`.
enabled логический	Включить или отключить веб-перехватчик Варианты: `false` `true`
event строка	Название события, которое должно запускать веб-перехватчик Обязательно при создании нового веб-перехватчика
http_content_type строка	Тип содержимого HTTP для веб-перехватчика
http_headers строка	Заголовки HTTP для веб-перехватчика
http_method строка	Метод HTTP, используемый веб-перехватчиком Варианты: `"POST"` `"GET"` `"PUT"` `"DELETE"` `"PATCH"`
locations список / элементы=строки	Список расположений, которым должна быть назначена сущность
name строка / обязательный	Название веб-перехватчика
oauth1_consumer_key строка	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret строка	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organizations список / элементы=строки	Список организаций, которым должна быть назначена сущность
password строка	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_PASSWORD`.
proxy_authorization логический	Авторизоваться с помощью клиентского сертификата и проверять CA из настроек Варианты: `false` `true`
server_url строка / обязательный	URL сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_SERVER_URL`.
ssl_ca_certs строка	Сертификаты центров сертификации X.509, объединённые в формате PEM
state строка	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
target_url строка	URL, вызываемый при срабатывании веб-перехватчика Обязательно при создании нового веб-перехватчика
use_gssapi логический	Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos с аутентификацией Negotiate. Требуется установить библиотеку Python requests-gssapi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
username строка	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_USERNAME`.
validate_certs логический	Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
verify_ssl логический	Проверять SSL-сертификаты веб-перехватчика Варианты: `false` `true`
webhook_password строка	Пароль веб-перехватчика, если требуется
webhook_template строка	Название шаблона веб-перехватчика
webhook_username строка	Имя пользователя веб-перехватчика, если требуется

Атрибуты

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

Примеры

- name: 'Create Webhook'
  theforeman.foreman.webhook:
    username: 'admin'
    password: 'secret_password'
    server_url: 'https://foreman.example.com'
    name: 'test-webhook'
    target_url: 'https://google.com'
    http_method: 'GET'
    event: 'actions.katello.content_view.promote_succeeded'
    enabled: true
    organizations:
      - 'MyOrg'
    locations:
      - 'DC1'

- name: 'Remove Webhook'
  theforeman.foreman.webhook:
    username: 'admin'
    password: 'secret_password'
    server_url: 'https://foreman.example.com'
    name: 'test-webhook'
    state: 'absent'

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

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

Ключ	Описание
entity словарь	Итоговое состояние затронутых сущностей, сгруппированных по типу. Возвращается: при успешном выполнении
webhooks список / элементы=словарь	Список веб-перехватчиков. Возвращается: при успешном выполнении

Авторы

Griffin Sullivan (@Griffin-Sullivan)

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

© 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/theforeman/foreman/webhook_module.html