Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular module – конфигурация сотовой связи FortiExtender.

Примечание

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

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

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

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

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

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

Обзор

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

Параметры

Параметр

Комментарии

access_token

string

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

adom

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

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

bypass_validation

boolean

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

Варианты:

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

enable_log

boolean

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

Варианты:

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

extender-profile

string

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

extender_profile

string

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

extensioncontroller_extenderprofile_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

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

multiple_PDN

псевдонимы: multiple-PDN

string

Включение/отключение нескольких PDN.

Варианты:

  • "disable"
  • "enable"

pdn1_dataplan

псевдонимы: pdn1-dataplan

any

(список) Тарифный план PDN1.

pdn2_dataplan

псевдонимы: pdn2-dataplan

any

(список) Тарифный план PDN2.

pdn3_dataplan

псевдонимы: pdn3-dataplan

any

(список) Тарифный план PDN3.

pdn4_dataplan

псевдонимы: pdn4-dataplan

any

(список) Тарифный план PDN4.

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

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

multiple_PDN

псевдонимы: multiple-PDN

string

Включение/отключение Multiple-PDN.

Варианты:

  • "disable"
  • "enable"

pdn1_dataplan

псевдонимы: pdn1-dataplan

any

(список) План передачи данных PDN1.

pdn2_dataplan

псевдонимы: pdn2-dataplan

any

(список) План передачи данных PDN2.

pdn3_dataplan

псевдонимы: pdn3-dataplan

any

(список) План передачи данных PDN3.

pdn4_dataplan

псевдонимы: pdn4-dataplan

any

(список) План передачи данных PDN4.

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-карта

sms_notification

псевдонимы: sms-notification

dictionary

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

alert

dictionary

Оповещение.

data_exhausted

псевдонимы: data-exhausted

string

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

fgt_backup_mode_switch

псевдонимы: fgt-backup-mode-switch

string

Текст, отображаемый при переключении FortiGate в режим резервирования.

low_signal_strength

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

string

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

mode_switch

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

string

Текст, отображаемый при переключении режима.

os_image_fallback

псевдонимы: os-image-fallback

string

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

session_disconnect

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

string

Текст, отображаемый при отключении сеанса.

system_reboot

псевдонимы: system-reboot

string

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

receiver

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

Получатель.

alert

list / элементы=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

псевдонимы: phone-number

string

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

status

string

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

Варианты:

  • "disable"
  • "enable"

status

string

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

Варианты:

  • "disable"
  • "enable"

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

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

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.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: FortiExtender cellular configuration.
      fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        extender_profile: <your own value>
        extensioncontroller_extenderprofile_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>
          #   multiple_PDN: <value in [disable, enable]>
          #   pdn1_dataplan: <list or string>
          #   pdn2_dataplan: <list or string>
          #   pdn3_dataplan: <list or string>
          #   pdn4_dataplan: <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>
          #   multiple_PDN: <value in [disable, enable]>
          #   pdn1_dataplan: <list or string>
          #   pdn2_dataplan: <list or string>
          #   pdn3_dataplan: <list or string>
          #   pdn4_dataplan: <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]>

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

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

Ключ

Описание

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

Spec-Zone.ru

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