fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular модуль — Конфигурация сотовой связи FortiExtender.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к 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_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 список / элементы=строка	Устарело, переименуйте в 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. Идентификатор модема.
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	(список) Устаревшее, пожалуйста, переименуйте его на sim1_pin_code. SIM
sim2-pin string	Устаревшее, пожалуйста, переименуйте его на sim2_pin. SIM Варианты: `"disable"` `"enable"`
sim2-pin-code any	(список) Устаревшее, пожалуйста, переименуйте его на 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. Автоматический переключение на основе порога отключения.

END_OF_DOCUMENT_MARKER

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. Идентификатор модема.
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"`
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	ADOM для блокировки в режиме работы с рабочей областью FortiManager, значение может быть глобальным и другими, включая корневой.
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 cellular configuration.
      fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular:
        # 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_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]>

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

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

Ключ	Описание
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_cellular_module.html