Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_extendercontroller_extenderprofile — настройка профиля FortiExtender.

Примечание

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

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

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

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

Добавлено в 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

extendercontroller_extenderprofile

dictionary

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

allowaccess

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

Управление доступом к управлению управляемым расширителем.

Варианты:

  • "https"
  • "ping"
  • "ssh"
  • "snmp"
  • "http"
  • "telnet"

bandwidth_limit

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

integer

Ограничение пропускной способности расширения локальной сети FortiExtender

cellular

dictionary

Сотовая связь.

controller_report

псевдонимы: controller-report

dictionary

Отчет контроллера.

interval

integer

Интервал отправки отчета контроллера.

signal_threshold

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

integer

Пороговое значение уровня сигнала для отчета контроллера.

status

string

Состояние отчета контроллера FortiExtender.

Варианты:

  • "disable"
  • "enable"

dataplan

any

(список или строка) Названия тарифных планов передачи данных.

modem1

dictionary

Модем 1.

auto_switch

псевдонимы: auto-switch

dictionary

Автоматическое переключение.

dataplan

string

Автоматическое переключение на основе использования данных.

Варианты:

  • "disable"
  • "enable"

disconnect

string

Автоматическое переключение при отключении.

Варианты:

  • "disable"
  • "enable"

disconnect_period

псевдонимы: disconnect-period

integer

Автоматическое переключение на основе периода отключения.

disconnect_threshold

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

integer

Автоматическое переключение на основе порогового значения отключения.

signal

string

Автоматическое переключение на основе уровня сигнала.

Варианты:

  • "disable"
  • "enable"

switch_back

псевдонимы: switch-back

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

Автоматическое переключение с несколькими вариантами возврата на исходное подключение.

Варианты:

  • "time"
  • "timer"

switch_back_time

псевдонимы: switch-back-time

string

Автоматическое переключение на предпочтительную SIM-карту/оператора в указанное время по UTC

switch_back_timer

псевдонимы: switch-back-timer

integer

Автоматическое переключение на предпочтительную SIM-карту/оператора по истечении заданного времени

conn_status

псевдонимы: conn-status

integer

Состояние подключения.

default_sim

псевдонимы: default-sim

string

Выбор SIM-карты по умолчанию.

Варианты:

  • "sim1"
  • "sim2"
  • "carrier"
  • "cost"

gps

string

Включение/отключение GPS в FortiExtender.

Варианты:

  • "disable"
  • "enable"

modem_id

псевдонимы: modem-id

integer

Идентификатор модема.

preferred_carrier

псевдонимы: preferred-carrier

string

Предпочтительный оператор связи.

redundant_intf

псевдонимы: redundant-intf

string

Резервный интерфейс.

redundant_mode

псевдонимы: redundant-mode

string

Режим FortiExtender.

Варианты:

  • "disable"
  • "enable"

sim1_pin

псевдонимы: sim1-pin

string

SIM-карта

Варианты:

  • "disable"
  • "enable"

sim1_pin_code

псевдонимы: sim1-pin-code

any

(список) SIM-карта

sim2_pin

псевдонимы: sim2-pin

string

SIM-карта

Варианты:

  • "disable"
  • "enable"

sim2_pin_code

псевдонимы: sim2-pin-code

any

(список) SIM-карта

modem2

dictionary

Модем 2.

auto_switch

псевдонимы: auto-switch

dictionary

Автоматическое переключение.

dataplan

string

Автоматическое переключение на основе использования данных.

Варианты:

  • "disable"
  • "enable"

disconnect

string

Автоматическое переключение при отключении.

Варианты:

  • "disable"
  • "enable"

disconnect_period

псевдонимы: disconnect-period

integer

Автоматическое переключение на основе периода отключения.

disconnect_threshold

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

integer

Автоматическое переключение на основе порогового значения отключения.

signal

string

Автоматическое переключение на основе уровня сигнала.

Варианты:

  • "disable"
  • "enable"

switch_back

псевдонимы: switch-back

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

Автоматическое переключение с несколькими вариантами возврата на исходное подключение.

Варианты:

  • "time"
  • "timer"

switch_back_time

псевдонимы: switch-back-time

string

Автоматическое переключение на предпочтительную SIM-карту/оператора в указанное время по UTC

switch_back_timer

псевдонимы: switch-back-timer

integer

Автоматическое переключение на предпочтительную SIM-карту/оператора по истечении заданного времени

conn_status

псевдонимы: conn-status

integer

Состояние подключения.

default_sim

псевдонимы: default-sim

string

Выбор SIM-карты по умолчанию.

Варианты:

  • "sim1"
  • "sim2"
  • "carrier"
  • "cost"

gps

string

Включение/отключение GPS в FortiExtender.

Варианты:

  • "disable"
  • "enable"

modem_id

псевдонимы: modem-id

integer

Идентификатор модема.

preferred_carrier

псевдонимы: preferred-carrier

string

Предпочтительный оператор связи.

redundant_intf

aliases: redundant-intf

string

Резервный интерфейс.

redundant_mode

aliases: redundant-mode

string

Режим FortiExtender.

Варианты:

  • "disable"
  • "enable"

sim1_pin

aliases: sim1-pin

string

SIM

Варианты:

  • "disable"
  • "enable"

sim1_pin_code

aliases: sim1-pin-code

any

(список) SIM

sim2_pin

aliases: sim2-pin

string

SIM

Варианты:

  • "disable"
  • "enable"

sim2_pin_code

aliases: sim2-pin-code

any

(список) SIM

sms_notification

aliases: sms-notification

dictionary

Уведомление по SMS.

alert

dictionary

Оповещение.

data_exhausted

aliases: data-exhausted

string

Строка, отображаемая при исчерпании объема данных.

fgt_backup_mode_switch

aliases: fgt-backup-mode-switch

string

Строка, отображаемая при переключении FortiGate в режим резервного копирования.

low_signal_strength

aliases: low-signal-strength

string

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

mode_switch

aliases: mode-switch

string

Строка, отображаемая при переключении режима.

os_image_fallback

aliases: os-image-fallback

string

Строка, отображаемая при возврате к предыдущему образу ОС.

session_disconnect

aliases: session-disconnect

string

Строка, отображаемая при отключении сеанса.

system_reboot

aliases: system-reboot

string

Строка, отображаемая при перезагрузке системы.

receiver

list / elements=dictionary

Получатель.

alert

list / elements=string

Несколько параметров оповещения.

Варианты:

  • "system-reboot"
  • "data-exhausted"
  • "session-disconnect"
  • "low-signal-strength"
  • "mode-switch"
  • "os-image-fallback"
  • "fgt-backup-mode-switch"

name

string

Имя получателя SMS-уведомлений FortiExtender.

phone_number

aliases: phone-number

string

Номер телефона получателя.

status

string

Статус получателя SMS-уведомлений.

Варианты:

  • "disable"
  • "enable"

status

string

Статус SMS-уведомлений FortiExtender.

Варианты:

  • "disable"
  • "enable"

enforce_bandwidth

aliases: enforce-bandwidth

string

Включить/отключить ограничение пропускной способности интерфейса расширения LAN.

Варианты:

  • "disable"
  • "enable"

extension

string

Параметр расширения.

Варианты:

  • "wan-extension"
  • "lan-extension"

id

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

Идентификатор.

lan_extension

aliases: lan-extension

dictionary

Расширение LAN.

backhaul

list / elements=dictionary

Канал обратной связи.

name

string

Имя канала обратной связи расширения LAN FortiExtender.

port

string

Порт восходящего канала FortiExtender.

Варианты:

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

role

string

Порт восходящего канала FortiExtender.

Варианты:

  • "primary"
  • "secondary"

weight

integer

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

backhaul_interface

aliases: backhaul-interface

string

Интерфейс фазы 1 IPsec.

backhaul_ip

aliases: backhaul-ip

string

IPv4-адрес/FQDN фазы 1 IPsec.

ipsec_tunnel

aliases: ipsec-tunnel

string

Имя туннеля IPsec.

link_loadbalance

aliases: link-loadbalance

string

Стратегия балансировки нагрузки каналов расширения LAN.

Варианты:

  • "activebackup"
  • "loadbalance"

login_password

aliases: login-password

any

(список) Задать пароль администратора для управляемых расширителей.

login_password_change

aliases: login-password-change

string

Изменить или сбросить пароль администратора управляемого расширителя

Варианты:

  • "no"
  • "yes"
  • "default"

model

string

Модель.

Варианты:

  • "FX201E"
  • "FX211E"
  • "FX200F"
  • "FXA11F"
  • "FXE11F"
  • "FXA21F"
  • "FXE21F"
  • "FXA22F"
  • "FXE22F"
  • "FX212F"
  • "FX311F"
  • "FX312F"
  • "FX511F"
  • "FVG21F"
  • "FVA21F"
  • "FVG22F"
  • "FVA22F"
  • "FX04DA"
  • "FX04DN"
  • "FX04DI"

name

string

Имя профиля FortiExtender.

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, переопределяющий условия успешного выполнения.

revision_note

string

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

state

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

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

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

ADOM для блокировки в FortiManager, работающем в режиме рабочего пространства; значением может быть global или другой ADOM, включая 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: FortiExtender extender profile configuration.
      fortinet.fortimanager.fmgr_extendercontroller_extenderprofile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        extendercontroller_extenderprofile:
          id: 0 # Required variable, integer
          # allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet"]
          # bandwidth_limit: <integer>
          # cellular:
          #   controller_report:
          #     interval: <integer>
          #     signal_threshold: <integer>
          #     status: <value in [disable, enable]>
          #   dataplan: <list or string>
          #   modem1:
          #     auto_switch:
          #       dataplan: <value in [disable, enable]>
          #       disconnect: <value in [disable, enable]>
          #       disconnect_period: <integer>
          #       disconnect_threshold: <integer>
          #       signal: <value in [disable, enable]>
          #       switch_back: ["time", "timer"]
          #       switch_back_time: <string>
          #       switch_back_timer: <integer>
          #     conn_status: <integer>
          #     default_sim: <value in [sim1, sim2, carrier, ...]>
          #     gps: <value in [disable, enable]>
          #     modem_id: <integer>
          #     preferred_carrier: <string>
          #     redundant_intf: <string>
          #     redundant_mode: <value in [disable, enable]>
          #     sim1_pin: <value in [disable, enable]>
          #     sim1_pin_code: <list or string>
          #     sim2_pin: <value in [disable, enable]>
          #     sim2_pin_code: <list or string>
          #   modem2:
          #     auto_switch:
          #       dataplan: <value in [disable, enable]>
          #       disconnect: <value in [disable, enable]>
          #       disconnect_period: <integer>
          #       disconnect_threshold: <integer>
          #       signal: <value in [disable, enable]>
          #       switch_back: ["time", "timer"]
          #       switch_back_time: <string>
          #       switch_back_timer: <integer>
          #     conn_status: <integer>
          #     default_sim: <value in [sim1, sim2, carrier, ...]>
          #     gps: <value in [disable, enable]>
          #     modem_id: <integer>
          #     preferred_carrier: <string>
          #     redundant_intf: <string>
          #     redundant_mode: <value in [disable, enable]>
          #     sim1_pin: <value in [disable, enable]>
          #     sim1_pin_code: <list or string>
          #     sim2_pin: <value in [disable, enable]>
          #     sim2_pin_code: <list or string>
          #   sms_notification:
          #     alert:
          #       data_exhausted: <string>
          #       fgt_backup_mode_switch: <string>
          #       low_signal_strength: <string>
          #       mode_switch: <string>
          #       os_image_fallback: <string>
          #       session_disconnect: <string>
          #       system_reboot: <string>
          #     receiver:
          #       - alert: ["system-reboot", "data-exhausted", "session-disconnect",
          #                 "low-signal-strength", "mode-switch", "os-image-fallback",
          #                 "fgt-backup-mode-switch"]
          #         name: <string>
          #         phone_number: <string>
          #         status: <value in [disable, enable]>
          #     status: <value in [disable, enable]>
          # enforce_bandwidth: <value in [disable, enable]>
          # extension: <value in [wan-extension, lan-extension]>
          # lan_extension:
          #   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]>
          # login_password: <list or string>
          # login_password_change: <value in [no, yes, default]>
          # model: <value in [FX201E, FX211E, FX200F, ...]>
          # name: <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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_extendercontroller_extenderprofile_module.html

Spec-Zone.ru

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