fortinet.fortimanager.fmgr_system_route – Настройка таблицы маршрутизации.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_route
В версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливать в True только в случае расхождений схемы модуля со структурой API FortiManager, модуль продолжит выполнение без валидации параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут считаться выполненными с ошибкой | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут считаться выполненными успешно | ||
| state строка / обязательно |
| инструкция для создания, обновления или удаления объекта | |
| system_route словарь | параметры верхнего уровня | ||
| device строка | Интерфейс шлюза. | ||
| dst строка | Значение по умолчанию: "0.0.0.0 0.0.0.0" | IP-адрес назначения и маска для данного маршрута. | |
| gateway строка | Значение по умолчанию: "0.0.0.0" | IP-адрес шлюза для данного маршрута. | |
| seq_num целое число | Значение по умолчанию: 0 | Номер записи. | |
| workspace_locking_adom строка | область управления (ADOM) для блокировки при работе в режиме рабочей области FortiManager, значение может быть глобальным и другими, включая root | ||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем | |
Примечания
Примечание
- Поддерживается работа в режиме блокировки рабочей области в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно, выполнение одного модуля может завершиться неудачей при возврате ненулевого rc. Вы также можете переопределить условия для завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded.
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Routing table configuration.
fmgr_system_route:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
state: <value in [present, absent]>
system_route:
device: <value of string>
dst: <value of string>
gateway: <value of string>
seq_num: <value of integer>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный URL запроса Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Описание сообщения ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_route_module.html
