Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_lanextension.

Новое в fortinet.fortimanager 2.1.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.

extendercontroller_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. Интерфейс IPsec phase1.

backhaul_ip

строка

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

ipsec_tunnel

строка

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

link_loadbalance

строка

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

Варианты:

  • "activebackup"
  • "loadbalance"

forticloud_access_token

строка

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

proposed_method

строка

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

Варианты:

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

rc_failed

список / элементы=целое число

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

rc_succeeded

список / элементы=целое число

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

END_OF_DOCUMENT_MARKER

workspace_locking_adom

string

ADOM для блокировки в режиме работы 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_extendercontroller_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>
        extendercontroller_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]>

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

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

Ключ

Описание

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_extendercontroller_extenderprofile_lanextension_module.html

Spec-Zone.ru

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