fortinet.fortimanager.fmgr_vpn_ipsec_fec модуль — Настройка коррекции ошибок пересылки
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_vpn_ipsec_fec.
Добавлена в fortinet.fortimanager 2.1.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое | Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое | Список кодов rc, с помощью которых будут переопределены условия для отказа. |
rc_succeeded список / элементы=целое | Список кодов rc, с помощью которых будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
vpn_ipsec_fec словарь | Установленные параметры верхнего уровня. |
|
mappings список / элементы=словарь |
Сопоставления. |
|
bandwidth_bi_threshold целое |
Устарело, пожалуйста, переименуйте в bandwidth_bi_threshold. Применяет параметры FEC, когда доступная двусторонняя полоса пропускания >= порогового значения… |
|
bandwidth_down_threshold целое |
Устарело, пожалуйста, переименуйте в bandwidth_down_threshold. Применяет параметры FEC, когда доступная полоса пропускания по нисходящему каналу >=… |
|
bandwidth_up_threshold целое |
Устарело, пожалуйста, переименуйте в bandwidth_up_threshold. Применяет параметры FEC, когда доступная полоса пропускания по восходящему каналу >=… |
|
base целое |
Количество базовых пакетов FEC |
|
latency_threshold целое |
Устарело, пожалуйста, переименуйте в latency_threshold. Применяет параметры FEC, когда задержка |
|
packet_loss_threshold целое |
Устарело, пожалуйста, переименуйте в packet_loss_threshold. Применяет параметры FEC, когда потери пакетов >= порога |
|
redundant целое |
Количество резервных пакетов FEC |
|
seqno целое |
Порядковый номер |
|
name строка / обязательно |
Имя профиля. |
workspace_locking_adom строка | ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть global и другими, включая root. |
workspace_locking_timeout целое | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure Forward Error Correction
fortinet.fortimanager.fmgr_vpn_ipsec_fec:
# 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, ...]
adom: <your own value>
state: present # <value in [present, absent]>
vpn_ipsec_fec:
mappings:
-
bandwidth_bi_threshold: <integer>
bandwidth_down_threshold: <integer>
bandwidth_up_threshold: <integer>
base: <integer>
latency_threshold: <integer>
packet_loss_threshold: <integer>
redundant: <integer>
seqno: <integer>
name: <string>
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложное |
Ссылки на коллекцию
© 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_vpn_ipsec_fec_module.html
