Модуль fortinet.fortimanager.fmgr_hotspot20_h2qpwanmetric – Настройка метрик WAN.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в playbook, укажите: fortinet.fortimanager.fmgr_hotspot20_h2qpwanmetric.
Новая функция в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать под источники данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к API forticloud. |
hotspot20_h2qpwanmetric словарь | Настройка верхнего уровня параметров. |
|
downlink_load целое число |
Устарело, используйте downlink_load. Загрузка по нисходящей линии. |
|
downlink_speed целое число |
Устарело, используйте downlink_speed. Скорость по нисходящей линии. |
|
link_at_capacity строка |
Устарело, используйте link_at_capacity. Линия на предельной пропускной способности. Варианты:
|
|
link_status строка |
Устарело, используйте link_status. Состояние линии. Варианты:
|
|
load_measurement_duration целое число |
Устарело, используйте load_measurement_duration. Продолжительность измерения загрузки. |
|
name строка / обязательно |
Имя метрики WAN. |
|
symmetric_wan_link строка |
Устарело, используйте symmetric_wan_link. Симметрия WAN-соединения. Варианты:
|
|
uplink_load целое число |
Устарело, используйте uplink_load. Загрузка по восходящей линии. |
|
uplink_speed целое число |
Устарело, используйте uplink_speed. Скорость по восходящей линии. |
proposed_method строка | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми условия завершения задания будут переопределены. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми условия успешного завершения задания будут переопределены. |
state строка / обязательно | Направление для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom строка | Область (adom) для блокировки FortiManager, работающего в режиме рабочей области, значение может быть глобальным и другими, включая 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 WAN metrics.
fortinet.fortimanager.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: present # <value in [present, absent]>
hotspot20_h2qpwanmetric:
downlink_load: <integer>
downlink_speed: <integer>
link_at_capacity: <value in [disable, enable]>
link_status: <value in [down, up, in-test]>
load_measurement_duration: <integer>
name: <string>
symmetric_wan_link: <value in [asymmetric, symmetric]>
uplink_load: <integer>
uplink_speed: <integer>
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный запрашиваемый URL. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_hotspot20_h2qpwanmetric_module.html
