fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck_sla модуль — Соглашение об уровне обслуживания
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck_sla.
Добавлена в 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. |
health-check строка | Устарело, используйте «health_check» |
health_check строка | Параметр (health-check) в запрошенном URL. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Выбор:
|
rc_failed список / элементы=целое число | Список rc-кодов, при которых условие будет считаться выполненным с ошибкой. |
rc_succeeded список / элементы=целое число | Список rc-кодов, при которых условие будет считаться выполненным. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Выбор:
|
wanprof строка / обязательно | Параметр (wanprof) в запрошенном URL. |
wanprof_system_virtualwanlink_healthcheck_sla словарь | Настройка параметров верхнего уровня. |
|
id целое число / обязательно |
Идентификатор SLA. |
|
jitter_threshold целое число |
Устарело, используйте jitter_threshold. Задержка для принятия решения SLA в миллисекундах. |
|
latency_threshold целое число |
Устарело, используйте latency_threshold. Задержка для принятия решения SLA в миллисекундах. |
|
link_cost_factor список / элементы=строка |
Устарело, используйте link_cost_factor. Критерии выбора ссылки. Выбор:
|
|
packetloss_threshold целое число |
Устарело, используйте packetloss_threshold. Потеря пакетов для принятия решения SLA в процентах. |
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: Service level agreement
fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck_sla:
# 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>
wanprof: <your own value>
health_check: <your own value>
state: present # <value in [present, absent]>
wanprof_system_virtualwanlink_healthcheck_sla:
id: <integer>
jitter_threshold: <integer>
latency_threshold: <integer>
link_cost_factor:
- latency
- jitter
- packet-loss
packetloss_threshold: <integer>
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
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_wanprof_system_virtualwanlink_healthcheck_sla_module.html
