fortinet.fortimanager.fmgr_firewall_ldbmonitor модуль — Настройка мониторов работоспособности балансировки нагрузки серверов.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_firewall_ldbmonitor.

Новое в fortinet.fortimanager 2.0.0

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_ldbmonitor словарь	Настройка параметров верхнего уровня.
dns_match_ip строка	IP, ожидаемый от DNS-сервера.
dns_protocol строка	Выберите протокол, используемый монитором проверки работоспособности DNS для проверки работоспособности… Варианты: `"udp"` `"tcp"`
dns_request_domain строка	Полное доменное имя для разрешения DNS-запроса.
http_get строка	URL для отправки запроса GET для проверки работоспособности HTTP-сервера.
http_match строка	Строка для соответствия ожидаемому значению в ответе на запрос HTTP-GET.
http_max_redirects целое число	Максимальное количество HTTP-редиректов, разрешенных к выполнению
interval целое число	Время между проверками работоспособности
name строка / обязательно	Имя монитора.
port целое число	Порт сервиса, используемый для проверки работоспособности.
retry целое число	Количество попыток проверки работоспособности до того, как сервер будет признан нерабочим
src_ip строка	Исходный IP-адрес для ldb-монитора.
timeout целое число	Время ожидания получения ответа на проверку работоспособности от сервера.
type строка	Выбор типа монитора, используемого для проверки работоспособности сервера Варианты: `"ping"` `"tcp"` `"http"` `"passive-sip"` `"https"` `"dns"`
forticloud_access_token строка	Авторизация Ansible-клиента с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия для завершения неудачей.
rc_succeeded список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия для успешного завершения.

END_OF_DOCUMENT_MARKER

состояние строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки при работе FortiManager в режиме рабочего пространства; значение может быть глобальным или другим, включая корень.
workspace_locking_timeout целое число	Максимальное время ожидания в секундах, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют имена с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
В этом модуле FortiManager поддерживается работа в режиме блокировки рабочего пространства; параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой код rc. Вы также можете переопределить условия ошибки или успеха параметрами rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure server load balancing health monitors.
      fortinet.fortimanager.fmgr_firewall_ldbmonitor:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_ldbmonitor:
          name: "ansible-test"
          port: 1
          type: tcp # <value in [ping, tcp, http, ...]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the server load balancing health monitors
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_ldbmonitor"
          params:
            adom: "ansible"
            ldb-monitor: "your_value"

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией FortiManager. Возвращается: сложный

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на сборку

© 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/fortinet/fortimanager/fmgr_firewall_ldbmonitor_module.html