fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_modem1 модуль – Параметры настройки модема 1.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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_threshold целое число	Автоматический переход на основе порога отключения.
signal строка	Автоматический переход на основе силы сигнала. Варианты: `"disable"` `"enable"`
switch_back список / элементы=строка	Устаревшее, переименуйте на switch_back. Автоматический переход с многократными вариантами возврата. Варианты: `"time"` `"timer"`
switch_back_time строка	Автоматический переход на предпочтительную SIM/оператора в определённый момент…
switch_back_timer целое число	Автоматический переход на предпочтительную SIM/оператора после…
conn_status целое число	Устаревшее, переименуйте на conn_status. Состояние подключения.
default_sim строка	Устаревшее, переименуйте на default_sim. Выбор SIM по умолчанию. Варианты: `"sim1"` `"sim2"` `"carrier"` `"cost"`
gps строка	Включение/выключение GPS FortiExtender. Варианты: `"disable"` `"enable"`

END_OF_DOCUMENT_MARKER

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
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: Configuration options for modem 1.
      fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_modem1:
        # 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_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–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_modem1_module.html