Модуль theforeman.foreman.webhook – Управление веб-хуками

Примечание

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

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

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

Для использования в плейбуке укажите: theforeman.foreman.webhook.

Новая в theforeman.foreman 4.0.0

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

Описание

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

Требования

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

requests

Параметры

Параметр	Комментарии
enabled boolean	Включить или отключить веб-хук Варианты: `false` `true`
event string	Имя события, которое должно инициировать веб-хук Требуется при создании нового веб-хука
http_content_type string	Тип контента HTTP для веб-хука
http_headers string	HTTP-заголовки для веб-хука
http_method string	HTTP-метод, используемый в веб-хуке Варианты: `"POST"` `"GET"` `"PUT"` `"DELETE"` `"PATCH"`
locations list / elements=string	Список расположений, которым должна быть назначена сущность
name string / обязательно	Имя веб-хука
organizations list / elements=string	Список организаций, которым должна быть назначена сущность
password string / обязательно	Пароль пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_PASSWORD`.
proxy_authorization boolean	Авторизация с помощью сертификата клиента и проверка CA из настроек Варианты: `false` `true`
server_url string / обязательно	URL сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_SERVER_URL`.
ssl_ca_certs string	Конкатенация сертификатов X509 центров сертификации в формате PEM
state string	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
target_url string	URL для вызова при срабатывании веб-хука Требуется при создании нового веб-хука
username string / обязательно	Имя пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_USERNAME`.
validate_certs boolean	Требуется ли проверка TLS-сертификатов сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
verify_ssl boolean	Проверить SSL-сертификаты для веб-хука Варианты: `false` `true`
webhook_password string	Пароль для веб-хука, если требуется
webhook_template string	Имя шаблона веб-хука
webhook_username string	Имя пользователя для веб-хука, если требуется

Атрибуты

Атрибут	Поддержка	Описание
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/theforeman/foreman/webhook_module.html