Модуль fortinet.fortios.fortios_system_3g_modem_custom — пользовательские настройки 3G-модема в FortiOS и FortiGate от Fortinet.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_3g_modem_custom.

Добавлено в fortinet.fortios 2.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции system_3g_modem и категории custom. В примерах приведены все параметры и значения, которые перед использованием необходимо адаптировать к источникам данных. Проверено на FOS v6.0.0

Требования

На хосте, на котором выполняется этот модуль, необходимы перечисленные ниже компоненты.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются символом косой черты. Параметр с указанием member_path можно использовать для выполнения операции над элементом.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state string / обязательный	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
system_3g_modem_custom dictionary	Пользовательские настройки 3G-модема.
class_id string	Класс интерфейса USB в шестнадцатеричном формате (00-ff).
id integer / обязательный	Идентификатор. См. <a href=’#notes’>примечания</a>.
init_string string	Строка инициализации в шестнадцатеричном формате (четная длина).
model string	Название модели модема.
modeswitch_string string	Аргументы USB modeswitch. Например: “-v 1410 -p 9030 -V 1410 -P 9032 -u 3”.
product_id string	Идентификатор продукта USB в шестнадцатеричном формате (0000-ffff).
vendor string	Название производителя модема.
vendor_id string	Идентификатор производителя USB в шестнадцатеричном формате (0000-ffff).
vdom string	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Настоятельно рекомендуем использовать собственное значение id вместо 0. Значение «0» — это специальный заполнитель, позволяющий серверной части назначить объекту последний доступный номер, однако у этого варианта есть ограничения. Подробности см. в разделе «Вопросы и ответы».
Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi.
Модуль поддерживает check_mode.

Примеры

- name: 3G MODEM custom.
  fortinet.fortios.fortios_system_3g_modem_custom:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_3g_modem_custom:
          class_id: "<your_own_value>"
          id: "4"
          init_string: "<your_own_value>"
          model: "<your_own_value>"
          modeswitch_string: "<your_own_value>"
          product_id: "<your_own_value>"
          vendor: "<your_own_value>"
          vendor_id: "<your_own_value>"

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

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

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи конфигурации на FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey string	Мастер-ключ (id), использованный в последнем запросе к FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Результат операции Возвращается: всегда Пример: `"success"`
vdom string	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Ссылки на коллекцию

© 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_3g_modem_custom_module.html