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

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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 и настраивать пользовательскую категорию. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировался с FOS v6.0.0

Требования

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

ansible>=2.15

Параметры

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

Примечания

Примечание

Рекомендуется использовать собственное значение для id вместо 0. Хотя «0» — это специальный заполнитель, позволяющий бэкенду назначить последнее доступное число для объекта, он имеет ограничения. Подробнее см. в разделе Вопросы и ответы.
Модуль legacy 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 строка	Номер сборки образа fortigate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, используемый для подготовки содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, полученный от FortiGate при последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успех Пример: `"id"`
name строка	Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_3g_modem_custom_module.html