Модуль fortinet.fortios.fortios_system_modem — настройка MODEM в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: fortinet.fortios.fortios_system_modem.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры системной функции и категории модема. Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено с FOS v6.0.0
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создается в графическом интерфейсе Fortigate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, разделяйте их символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан member_state, параметр state игнорируется. Варианты:
|
system_modem dictionary | Настройка MODEM. |
|
action string |
Установить или разорвать соединение MODEM. Варианты:
|
|
altmode string |
Включить или отключить altmode для установок, использующих PPP в Китае. Варианты:
|
|
authtype1 list / elements=string |
Разрешенные типы аутентификации для ISP 1. Варианты:
|
|
authtype2 list / elements=string |
Разрешенные типы аутентификации для ISP 2. Варианты:
|
|
authtype3 list / elements=string |
Разрешенные типы аутентификации для ISP 3. Варианты:
|
|
auto_dial string |
Включить или отключить автоматический дозвон после перезагрузки или разрыва соединения. Варианты:
|
|
connect_timeout integer |
Тайм-аут установления соединения (30–255 с). |
|
dial_cmd1 string |
Команда набора номера (часто используется команда ATD или ATDT). |
|
dial_cmd2 string |
Команда набора номера (часто используется команда ATD или ATDT). |
|
dial_cmd3 string |
Команда набора номера (часто используется команда ATD или ATDT). |
|
dial_on_demand string |
Включить или отключить дозвон модема при маршрутизации пакетов через интерфейс модема. Варианты:
|
|
distance integer |
Метрика изученных маршрутов (1–255). |
|
dont_send_CR1 string |
Не отправлять CR после установления соединения (ISP1). Варианты:
|
|
dont_send_CR2 string |
Не отправлять CR после установления соединения (ISP2). Варианты:
|
|
dont_send_CR3 string |
Не отправлять CR после установления соединения (ISP3). Варианты:
|
|
extra_init1 string |
Дополнительная строка инициализации для ISP 1. |
|
extra_init2 string |
Дополнительная строка инициализации для ISP 2. |
|
extra_init3 string |
Дополнительная строка инициализации для ISP 3. |
|
holddown_timer integer |
Таймер удержания в секундах (1–60 с). |
|
idle_timer integer |
Время простоя соединения MODEM (1–9999 мин). |
|
interface string |
Имя резервного интерфейса. Источник: system.interface.name. |
|
lockdown_lac string |
Разрешить подключение только к указанному коду местоположения (LAC). |
|
mode string |
Задать режим работы MODEM: резервный или автономный. Варианты:
|
|
network_init string |
Команда AT для задания имени/типа сети (AT+COPS=<mode>,[<format>,<oper>[,<AcT>]]). |
|
passwd1 string |
Пароль для доступа к указанной учетной записи дозвона. |
|
passwd2 string |
Пароль для доступа к указанной учетной записи дозвона. |
|
passwd3 string |
Пароль для доступа к указанной учетной записи дозвона. |
|
peer_modem1 string |
Указать тип удаленного MODEM для телефона 1. Варианты:
|
|
peer_modem2 string |
Указать тип удаленного MODEM для телефона 2. Варианты:
|
|
peer_modem3 string |
Указать тип удаленного MODEM для телефона 3. Варианты:
|
|
phone1 string |
Номер телефона для подключения к учетной записи дозвона (не должен содержать пробелов; рекомендуется использовать стандартные специальные символы). |
|
phone2 string |
Номер телефона для подключения к учетной записи дозвона (не должен содержать пробелов; рекомендуется использовать стандартные специальные символы). |
|
phone3 string |
Номер телефона для подключения к учетной записи дозвона (не должен содержать пробелов; рекомендуется использовать стандартные специальные символы). |
|
pin_init string |
Команда AT для задания PIN-кода (AT+PIN=<pin>). |
|
ppp_echo_request1 string |
Включить или отключить отправку PPP echo-request на ISP 1. Варианты:
|
|
ppp_echo_request2 string |
Включить или отключить отправку PPP echo-request на ISP 2. Варианты:
|
|
ppp_echo_request3 string |
Включить или отключить отправку PPP echo-request на ISP 3. Варианты:
|
|
priority integer |
Приоритет изученных маршрутов (1–65535). |
|
redial string |
Лимит повторных попыток дозвона (1–10; none = повторять бесконечно). Варианты:
|
|
reset integer |
Количество попыток дозвона до сброса модема (0 = не сбрасывать). |
|
status string |
Включить или отключить поддержку модема (аналогично включению или отключению интерфейса). Варианты:
|
|
traffic_check string |
Включить или отключить проверку трафика. Варианты:
|
|
username1 string |
Имя пользователя для доступа к указанной учетной записи дозвона. |
|
username2 string |
Имя пользователя для доступа к указанной учетной записи дозвона. |
|
username3 string |
Имя пользователя для доступа к указанной учетной записи дозвона. |
|
wireless_port integer |
Укажите номер беспроводного порта: 0 — порт по умолчанию, 1 — первый порт и т. д. (0–4294967295). |
vdom string | Виртуальный домен из ранее определенных. VDOM — виртуальный экземпляр FortiGate, который можно настраивать и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска плейбуков — httpapi.
- Модуль поддерживает check_mode.
Примеры
- name: Configure MODEM.
fortinet.fortios.fortios_system_modem:
vdom: "{{ vdom }}"
system_modem:
action: "dial"
altmode: "enable"
authtype1: "pap"
authtype2: "pap"
authtype3: "pap"
auto_dial: "enable"
connect_timeout: "90"
dial_cmd1: "<your_own_value>"
dial_cmd2: "<your_own_value>"
dial_cmd3: "<your_own_value>"
dial_on_demand: "enable"
distance: "1"
dont_send_CR1: "enable"
dont_send_CR2: "enable"
dont_send_CR3: "enable"
extra_init1: "<your_own_value>"
extra_init2: "<your_own_value>"
extra_init3: "<your_own_value>"
holddown_timer: "60"
idle_timer: "5"
interface: "<your_own_value> (source system.interface.name)"
lockdown_lac: "<your_own_value>"
mode: "standalone"
network_init: "<your_own_value>"
passwd1: "<your_own_value>"
passwd2: "<your_own_value>"
passwd3: "<your_own_value>"
peer_modem1: "generic"
peer_modem2: "generic"
peer_modem3: "generic"
phone1: "<your_own_value>"
phone2: "<your_own_value>"
phone3: "<your_own_value>"
pin_init: "<your_own_value>"
ppp_echo_request1: "enable"
ppp_echo_request2: "enable"
ppp_echo_request3: "enable"
priority: "1"
redial: "none"
reset: "0"
status: "enable"
traffic_check: "enable"
username1: "<your_own_value>"
username2: "<your_own_value>"
username3: "<your_own_value>"
wireless_port: "0"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortios/fortios_system_modem_module.html