модуль fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_modem1 — параметры конфигурации для модема 1.

Примечание

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

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

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

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

Добавлено в 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_modem1 словарь	Набор параметров верхнего уровня.
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 псевдонимы: switch-back-time строка	Автоматическое переключение на предпочтительную SIM-карту или оператора в указанное время по UTC
switch_back_timer псевдонимы: switch-back-timer целое число	Автоматическое переключение на предпочтительную SIM-карту или оператора по истечении заданного времени
conn_status псевдонимы: conn-status целое число	Состояние подключения.
default_sim псевдонимы: default-sim строка	Выбор SIM-карты по умолчанию. Варианты: `"sim1"` `"sim2"` `"carrier"` `"cost"`
gps строка	Включение или отключение GPS на FortiExtender. Варианты: `"disable"` `"enable"`
modem_id псевдонимы: modem-id целое число	Идентификатор модема.
preferred_carrier псевдонимы: preferred-carrier строка	Предпочтительный оператор связи.
redundant_intf псевдонимы: redundant-intf строка	Резервный интерфейс.
redundant_mode псевдонимы: redundant-mode строка	Режим FortiExtender. Варианты: `"disable"` `"enable"`
sim1_pin псевдонимы: sim1-pin строка	SIM-карта Варианты: `"disable"` `"enable"`
sim1_pin_code псевдонимы: sim1-pin-code любой тип	(список) SIM-карта
sim2_pin псевдонимы: sim2-pin строка	SIM-карта Варианты: `"disable"` `"enable"`
sim2_pin_code псевдонимы: sim2-pin-code любой тип	(список) SIM-карта
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, переопределяющий условия неудачного выполнения.
rc_succeeded список / элементы=целое число	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note строка	Примечание об изменении, которое можно указать при создании или обновлении объекта.
workspace_locking_adom строка	ADOM для блокировки в FortiManager, работающем в режиме рабочей области. Значением может быть global или другое значение, включая root.
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.
Обычно выполнение одного модуля может завершиться ошибкой при возврате ненулевого значения rc. Условия неудачного или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configuration options for modem 1.
      fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_modem1:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        extender_profile: <your own value>
        extendercontroller_extenderprofile_cellular_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>

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

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

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