fortinet.fortimanager.fmgr_extendercontroller_extenderprofile модуль — Настройка профиля расширителя FortiExtender.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
extendercontroller_extenderprofile словарь	Настройка параметров верхнего уровня.
allowaccess список / элементы=строка	Управление доступом к управляемому расширителю. Варианты: `"https"` `"ping"` `"ssh"` `"snmp"` `"http"` `"telnet"`
bandwidth_limit целое число	Устаревшее, пожалуйста, переименуйте на bandwidth_limit. Предел пропускной способности LAN-расширения FortiExtender
cellular словарь	Мобильная связь.
controller_report словарь	Устаревшее, пожалуйста, переименуйте на controller_report. Отчет контроллера.
interval целое число	Интервал отчета контроллера.
signal_threshold целое число	Устаревшее, пожалуйста, переименуйте на signal_threshold. Пороговое значение сигнала отчета контроллера.
status строка	Статус отчета контроллера FortiExtender. Варианты: `"disable"` `"enable"`
dataplan любой	(список или строка) Имена планов данных.
modem1 словарь	Модем 1.
auto_switch словарь	Устаревшее, пожалуйста, переименуйте на auto_switch. Автоматическое переключение.
dataplan строка	Автоматическое переключение на основе использования данных. Варианты: `"disable"` `"enable"`
disconnect строка	Автоматическое переключение при отключении. Варианты: `"disable"` `"enable"`
disconnect_period целое число	Устаревшее, пожалуйста, переименуйте на disconnect_period. Автоматическое переключение по интервалу отключения.
disconnect_threshold целое число	Устаревшее, пожалуйста, переименуйте на disconnect_threshold. Автоматическое переключение по порогу отключения…
signal строка	Автоматическое переключение на основе силы сигнала. Варианты: `"disable"` `"enable"`

switch-back list / elements=string	Устарело, переименуйте в switch_back. Автоматическое переключение с несколькими вариантами переключения назад. Варианты: `"time"` `"timer"`
switch-back-time string	Устарело, переименуйте в switch_back_time. Автоматическое переключение на предпочтительную SIM-карту/оператора…
switch-back-timer integer	Устарело, переименуйте в switch_back_timer. Автоматическое переключение на предпочтительную SIM-карту/оператора…
conn-status integer	Устарело, переименуйте в conn_status. Состояние соединения.
default-sim string	Устарело, переименуйте в default_sim. Выбор SIM-карты по умолчанию. Варианты: `"sim1"` `"sim2"` `"carrier"` `"cost"`
gps string	Включение/отключение GPS FortiExtender. Варианты: `"disable"` `"enable"`
modem-id integer	Устарело, переименуйте в modem_id. ID модема.
preferred-carrier string	Устарело, переименуйте в preferred_carrier. Предпочтительный оператор.
redundant-intf string	Устарело, переименуйте в redundant_intf. Резервный интерфейс.
redundant-mode string	Устарело, переименуйте в redundant_mode. Режим FortiExtender. Варианты: `"disable"` `"enable"`
sim1-pin string	Устарело, переименуйте в sim1_pin. SIM Варианты: `"disable"` `"enable"`
sim1-pin-code any	(list) Устарело, переименуйте в sim1_pin_code. SIM
sim2-pin string	Устарело, переименуйте в sim2_pin. SIM Варианты: `"disable"` `"enable"`
sim2-pin-code any	(list) Устарело, переименуйте в sim2_pin_code. SIM
modem2 dictionary	Модем2.
auto-switch dictionary	Устарело, переименуйте в auto_switch. Автоматическое переключение.
dataplan string	Автоматическое переключение на основе использования данных. Варианты: `"disable"` `"enable"`
disconnect string	Автоматическое переключение по отключению. Варианты: `"disable"` `"enable"`
disconnect-period integer	Устарело, переименуйте в disconnect_period. Автоматическое переключение на основе периода отключения.

disconnect-threshold integer	Устарело, переименуйте в disconnect_threshold. Автоматическое переключение на основе порога отключения…
signal string	Автоматическое переключение на основе силы сигнала. Choices: `"disable"` `"enable"`
switch-back list / elements=string	Устарело, переименуйте в switch_back. Автоматическое переключение с несколькими вариантами обратного переключения. Choices: `"time"` `"timer"`
switch-back-time string	Устарело, переименуйте в switch_back_time. Автоматическое переключение на предпочтительный SIM/оператора…
switch-back-timer integer	Устарело, переименуйте в switch_back_timer. Автоматическое переключение на предпочтительный SIM/оператора…
conn-status integer	Устарело, переименуйте в conn_status. Статус соединения.
default-sim string	Устарело, переименуйте в default_sim. Выбор SIM по умолчанию. Choices: `"sim1"` `"sim2"` `"carrier"` `"cost"`
gps string	Включение/отключение GPS FortiExtender. Choices: `"disable"` `"enable"`
modem-id integer	Устарело, переименуйте в modem_id. ID модема.
preferred-carrier string	Устарело, переименуйте в preferred_carrier. Предпочтительный оператор.
redundant-intf string	Устарело, переименуйте в redundant_intf. Резервный интерфейс.
redundant-mode string	Устарело, переименуйте в redundant_mode. Режим FortiExtender. Choices: `"disable"` `"enable"`
sim1-pin string	Устарело, переименуйте в sim1_pin. SIM Choices: `"disable"` `"enable"`
sim1-pin-code any	(list) Устарело, переименуйте в sim1_pin_code. SIM
sim2-pin string	Устарело, переименуйте в sim2_pin. SIM Choices: `"disable"` `"enable"`
sim2-pin-code any	(list) Устарело, переименуйте в sim2_pin_code. SIM
sms-notification dictionary	Устарело, переименуйте в sms_notification. SMS уведомление.
alert dictionary	Предупреждение.
data-exhausted string	Устарело, переименуйте в data_exhausted. Строка отображения при исчерпании данных.

fgt-backup-mode-switch string	Устаревшее, пожалуйста, переименуйте на fgt_backup_mode_switch. Отображение строки, когда FortiGate резервный режим …
low-signal-strength string	Устаревшее, пожалуйста, переименуйте на low_signal_strength. Отображение строки, когда сила сигнала низкая.
mode-switch string	Устаревшее, пожалуйста, переименуйте на mode_switch. Отображение строки, когда режим переключается.
os-image-fallback string	Устаревшее, пожалуйста, переименуйте на os_image_fallback. Отображение строки при переходе на предыдущую …
session-disconnect string	Устаревшее, пожалуйста, переименуйте на session_disconnect. Отображение строки при отключении сессии.
system-reboot string	Устаревшее, пожалуйста, переименуйте на system_reboot. Отображение строки при перезагрузке системы.
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 string	Устаревшее, пожалуйста, переименуйте на phone_number. Номер телефона получателя.
status string	Статус получателя уведомлений по SMS. Варианты: `"disable"` `"enable"`
status string	Статус уведомлений по SMS FortiExtender. Варианты: `"disable"` `"enable"`
enforce-bandwidth string	Устаревшее, пожалуйста, переименуйте на enforce_bandwidth. Включить/выключить принудительное ограничение пропускной способности на интерфейсе расширения LAN. Варианты: `"disable"` `"enable"`
extension string	Вариант расширения. Варианты: `"wan-extension"` `"lan-extension"`
id integer / обязательно	Идентификатор.
lan-extension dictionary	Устаревшее, пожалуйста, переименуйте на lan_extension. Расширение LAN.
backhaul list / elements=dictionary	Обратный канал.
name string	Имя обратного канала расширения LAN FortiExtender.
port string	Порт обратной связи FortiExtender. Варианты: `"wan"` `"lte1"` `"lte2"` `"port1"` `"port2"` `"port3"` `"port4"` `"port5"` `"sfp"`

роль строка	Порт подключения FortiExtender. Варианты: `"primary"` `"secondary"`
вес целое число	Параметр веса WRR.
backhaul-интерфейс строка	Устаревшее, пожалуйста, переименуйте его в backhaul_interface. Интерфейс IPsec phase1.
backhaul-ip строка	Устаревшее, пожалуйста, переименуйте его в backhaul_ip. IPsec phase1 IPv4/FQDN.
ipsec-туннель строка	Устаревшее, пожалуйста, переименуйте его в ipsec_tunnel. Имя туннеля IPsec.
link-балансировка нагрузки строка	Устаревшее, пожалуйста, переименуйте его в link_loadbalance. Стратегия балансировки нагрузки канала LAN расширения. Варианты: `"activebackup"` `"loadbalance"`
пароль входа любой	(список) Устаревшее, пожалуйста, переименуйте его в login_password. Установка пароля администратора управляемых экстендеров.
изменение пароля входа строка	Устаревшее, пожалуйста, переименуйте его в login_password_change. Изменение или сброс пароля администратора управляемого экстендера Варианты: `"no"` `"yes"` `"default"`
модель строка	Модель. Варианты: `"FX201E"` `"FX211E"` `"FX200F"` `"FXA11F"` `"FXE11F"` `"FXA21F"` `"FXE21F"` `"FXA22F"` `"FXE22F"` `"FX212F"` `"FX311F"` `"FX312F"` `"FX511F"` `"FVG21F"` `"FVA21F"` `"FVG22F"` `"FVA22F"` `"FX04DA"` `"FX04DN"` `"FX04DI"`
имя строка	Имя профиля FortiExtender.
forticloud_access_токен строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
предложенный_метод строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_неудача список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для неудачи.
rc_успех список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для успеха.
состояние строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки при работе FortiManager в режиме рабочего пространства. Значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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: FortiExtender extender profile configuration.
      fortinet.fortimanager.fmgr_extendercontroller_extenderprofile:
        # 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>
        state: present # <value in [present, absent]>
        extendercontroller_extenderprofile:
          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]>
          id: <integer>
          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–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_module.html