Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_lanextension модуль — Настройка расширения LAN FortiExtender.

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_lanextension.

Новая функция в fortinet.fortimanager 2.2.0

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

Описание

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

Параметры

Параметр

Комментарии

access_token

строка

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

adom

строка / обязательно

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

bypass_validation

булево

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

Варианты:

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

enable_log

булево

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

Варианты:

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

extender-profile

строка

Устаревшее значение, используйте «extender_profile»

extender_profile

строка

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

extensioncontroller_extenderprofile_lanextension

словарь

Параметры верхнего уровня.

backhaul

список / элементы=словарь

Обратная связь.

name

строка

Имя обратной связи FortiExtender LAN extension.

port

строка

Порт канала FortiExtender.

Варианты:

  • "wan"
  • "lte1"
  • "lte2"
  • "port1"
  • "port2"
  • "port3"
  • "port4"
  • "port5"
  • "sfp"

role

строка

Порт канала FortiExtender.

Варианты:

  • "primary"
  • "secondary"

weight

целое число

Параметр веса WRR.

backhaul_interface

строка

Устаревшее значение, переименуйте на backhaul_interface. Интерфейс фазы 1 IPsec.

backhaul_ip

строка

Устаревшее значение, переименуйте на backhaul_ip. IPv4/FQDN фазы 1 IPsec.

downlinks

список / элементы=словарь

Нижние каналы.

name

строка

Имя записи конфигурации канала FortiExtender LAN extension.

port

строка

Порт FortiExtender LAN extension.

Варианты:

  • "port1"
  • "port2"
  • "port3"
  • "port4"
  • "port5"
  • "lan1"
  • "lan2"

pvid

целое число

PVID канала FortiExtender LAN extension.

type

строка

Тип канала FortiExtender LAN extension [порт/vap].

Варианты:

  • "port"
  • "vap"

vap

любой

(список) FortiExtender LAN extension vap.

ipsec-tunnel

string

Устаревшее, пожалуйста, переименуйте на ipsec_tunnel. Имя туннеля IPsec.

link-loadbalance

string

Устаревшее, пожалуйста, переименуйте на link_loadbalance. Стратегия балансировки нагрузки канала LAN-расширения.

Варианты:

  • "activebackup"
  • "loadbalance"

forticloud_access_token

string

Авторизовать Ansible-клиента с помощью маркера доступа к API forticloud.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

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

rc_failed

list / elements=integer

Список кодов rc, с которыми будут переопределены условия для отказа.

rc_succeeded

list / elements=integer

Список кодов rc, с которыми будут переопределены условия для успеха.

workspace_locking_adom

string

Область для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая 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

Примеры

- 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: FortiExtender lan extension configuration.
      fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_lanextension:
        # 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>
        extender_profile: <your own value>
        extensioncontroller_extenderprofile_lanextension:
          backhaul:
            -
              name: <string>
              port: <value in [wan, lte1, lte2, ...]>
              role: <value in [primary, secondary]>
              weight: <integer>
          backhaul_interface: <string>
          backhaul_ip: <string>
          ipsec_tunnel: <string>
          link_loadbalance: <value in [activebackup, loadbalance]>
          downlinks:
            -
              name: <string>
              port: <value in [port1, port2, port3, ...]>
              pvid: <integer>
              type: <value in [port, vap]>
              vap: <list or string>

Значения возврата

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

Ключ

Описание

meta

словарь

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

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

request_url

строка

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

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

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

response_code

целое число

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

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

Пример: 0

response_data

список / элементы=строка

Ответ API.

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

response_message

строка

Дескриптивное сообщение ответа API.

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

Пример: "OK."

system_information

словарь

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

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

rc

целое число

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

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

Пример: 0

version_check_warning

список / элементы=строка

Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_extensioncontroller_extenderprofile_lanextension_module.html

Spec-Zone.ru

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