fortinet.fortimanager.fmgr_hotspot20_h2qpwanmetric — Настройка метрик WAN.
Примечание
Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_hotspot20_h2qpwanmetric.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL-адресе | ||
| bypass_validation логическое значение |
| устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров | |
| hotspot20_h2qpwanmetric словарь | устанавливаемые параметры верхнего уровня | ||
| downlink-load целое число | Загрузка по нисходящей линии. | ||
| downlink-speed целое число | Скорость по нисходящей линии (в килобитах/с). | ||
| link-at-capacity строка |
| Пропускная способность канала. | |
| link-status строка |
| Статус канала. | |
| load-measurement-duration целое число | Продолжительность измерения загрузки (в десятых долях секунды). | ||
| name строка | Имя метрики WAN. | ||
| symmetric-wan-link строка |
| Симметрия канала WAN. | |
| uplink-load целое число | Загрузка по восходящей линии. | ||
| uplink-speed целое число | Скорость по восходящей линии (в килобитах/с). | ||
| rc_failed список / элементы=строка | список кодов rc, с которыми будут переопределены условия для завершения неудачей | ||
| rc_succeeded список / элементы=строка | список кодов rc, с которыми будут переопределены условия для успешного завершения | ||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |
| workspace_locking_adom строка | область, которую нужно заблокировать для FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая корневой | ||
| 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: Configure WAN metrics.
fmgr_hotspot20_h2qpwanmetric:
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: <value in [present, absent]>
hotspot20_h2qpwanmetric:
downlink-load: <value of integer>
downlink-speed: <value of integer>
link-at-capacity: <value in [disable, enable]>
link-status: <value in [down, up, in-test]>
load-measurement-duration: <value of integer>
name: <value of string>
symmetric-wan-link: <value in [asymmetric, symmetric]>
uplink-load: <value of integer>
uplink-speed: <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_hotspot20_h2qpwanmetric_module.html
