fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular модуль — Настройка мобильной связи FortiExtender.

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular.

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

END_OF_DOCUMENT_MARKER

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	(список) Устарело, переименуйте в 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. Автоматический переключатель на основе порога отключения.

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"`
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_extendercontroller_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>
        extendercontroller_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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_cellular_module.html