Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_vpn_ipsec_fec_mappings — таблица сопоставления резервирования FEC.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_vpn_ipsec_fec_mappings.

Добавлено в fortinet.fortimanager 2.1.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiManager.
  • В примерах приведены все параметры и значения, которые необходимо настроить в соответствии с источниками данных перед использованием.

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

fec

string / обязательный

Параметр (fec) в запрошенном URL.

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

string

Метод, переопределяющий метод базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / элементы=integer

Список кодов rc, переопределяющий условия возникновения ошибки.

rc_succeeded

list / элементы=integer

Список кодов rc, переопределяющий условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Указание на создание, обновление или удаление объекта.

Варианты:

  • "present"
  • "absent"

vpn_ipsec_fec_mappings

dictionary

Набор параметров верхнего уровня.

bandwidth_bi_threshold

псевдонимы: bandwidth-bi-threshold

integer

Применять параметры FEC, если доступная двунаправленная пропускная способность >= порогового значения

bandwidth_down_threshold

псевдонимы: bandwidth-down-threshold

integer

Применять параметры FEC, если доступная пропускная способность входящего канала >= порогового значения

bandwidth_up_threshold

псевдонимы: bandwidth-up-threshold

integer

Применять параметры FEC, если доступная пропускная способность исходящего канала >= порогового значения

base

integer

Количество базовых пакетов FEC

latency_threshold

псевдонимы: latency-threshold

integer

Применять параметры FEC, если задержка составляет

packet_loss_threshold

псевдонимы: packet-loss-threshold

integer

Применять параметры FEC, если потеря пакетов >= порогового значения

redundant

integer

Количество резервных пакетов FEC

seqno

integer

Порядковый номер

workspace_locking_adom

string

ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие области, включая root.

workspace_locking_timeout

integer

Максимальное время ожидания в секундах, в течение которого другой пользователь должен освободить блокировку рабочей области.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 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: FEC redundancy mapping table.
      fortinet.fortimanager.fmgr_vpn_ipsec_fec_mappings:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        fec: <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>

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / элементы=string

Ответ API.

Возвращается: всегда

response_message

string

Текстовое описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / элементы=string

Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager.

Возвращается: при определенных условиях

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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_vpn_ipsec_fec_mappings_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API