модуль fortinet.fortimanager.fmgr_hotspot20_h2qpwanmetric — настройка метрик WAN.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_hotspot20_h2qpwanmetric.
Добавлено в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
hotspot20_h2qpwanmetric dictionary | Набор параметров верхнего уровня. |
|
downlink_load псевдонимы: downlink-load integer |
Загрузка нисходящего канала. |
|
downlink_speed псевдонимы: downlink-speed integer |
Скорость нисходящего канала |
|
link_at_capacity псевдонимы: link-at-capacity string |
Канал работает на пределе пропускной способности. Варианты:
|
|
link_status псевдонимы: link-status string |
Состояние канала. Варианты:
|
|
load_measurement_duration псевдонимы: load-measurement-duration integer |
Длительность измерения загрузки |
|
name string / обязательный |
Имя метрики WAN. |
|
symmetric_wan_link псевдонимы: symmetric-wan-link string |
Симметричность канала WAN. Варианты:
|
|
uplink_load псевдонимы: uplink-load integer |
Загрузка восходящего канала. |
|
uplink_speed псевдонимы: uplink-speed integer |
Скорость восходящего канала |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия, при которых операция считается неудачной. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия, при которых операция считается успешной. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание создать, обновить или удалить объект. Варианты:
|
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global или другие ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, имена всех входных аргументов соответствуют соглашению об именовании с подчёркиванием (snake_case). Замените аргументы, например “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но при их использовании будут выводиться предупреждения об устаревании. Это предупреждение можно игнорировать, задав deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области. Для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Обычно выполнение модуля может завершиться ошибкой при возврате ненулевого rc. Условия завершения с ошибкой или успехом также можно переопределить с помощью параметров rc_failed и rc_succeeded.
- Чтобы создать или обновить объект, используйте директиву state present.
- Чтобы удалить объект, используйте директиву state absent.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure WAN metrics.
fortinet.fortimanager.fmgr_hotspot20_h2qpwanmetric:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
hotspot20_h2qpwanmetric:
name: "your value" # Required variable, string
# 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>
# symmetric_wan_link: <value in [asymmetric, symmetric]>
# uplink_load: <integer>
# uplink_speed: <integer>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, характерные только для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Сведения о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при наличии соответствующих условий |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_hotspot20_h2qpwanmetric_module.html
