Модуль fortinet.fortios.fortios_extender_controller_dataplan — настройка dataplan FortiExtender в FortiOS и FortiGate от Fortinet.

Примечание

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

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

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

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

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

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

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

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

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
extender_controller_dataplan dictionary	Настройка dataplan FortiExtender.
apn string	Настройка APN.
auth_type string	Тип аутентификации. Варианты: `"none"` `"pap"` `"chap"`
billing_date integer	День выставления счета в месяце (1–31).
capacity integer	Емкость в МБ (0–102400000).
carrier string	Настройка оператора связи.
iccid string	Настройка ICCID.
modem_id string	Параметры модема dataplan, если они заданы. Варианты: `"modem1"` `"modem2"` `"all"`
monthly_fee integer	Ежемесячная плата за dataplan (0–100000 в местной валюте).
name string / обязательный	Имя тарифного плана FortiExtender.
overage string	Включить или отключить обнаружение превышения лимита dataplan. Варианты: `"disable"` `"enable"`
password string	Пароль.
pdn string	Тип PDN. Варианты: `"ipv4-only"` `"ipv6-only"` `"ipv4-ipv6"`
preferred_subnet integer	Предпочтительная маска подсети (0–32).
private_network string	Включить или отключить поддержку частной сети dataplan. Варианты: `"disable"` `"enable"`
signal_period integer	Период сигнала (от 600 до 18000 секунд).
signal_threshold integer	Пороговое значение сигнала. Укажите значение в диапазоне 50–100, где 50/100 соответствует −50/−100 дБм.
slot string	Настройка слота SIM-карты. Варианты: `"sim1"` `"sim2"`
type string	Настройка предпочтений типа. Варианты: `"carrier"` `"slot"` `"iccid"` `"generic"`
username string	Имя пользователя.
member_path string	Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции над элементом.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state string / обязательный	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom string	Виртуальный домен из числа предварительно определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
Модуль поддерживает check_mode.

Примеры

- name: FortiExtender dataplan configuration.
  fortinet.fortios.fortios_extender_controller_dataplan:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extender_controller_dataplan:
          apn: "<your_own_value>"
          auth_type: "none"
          billing_date: "1"
          capacity: "0"
          carrier: "<your_own_value>"
          iccid: "<your_own_value>"
          modem_id: "modem1"
          monthly_fee: "0"
          name: "default_name_11"
          overage: "disable"
          password: "<your_own_value>"
          pdn: "ipv4-only"
          preferred_subnet: "32"
          private_network: "disable"
          signal_period: "3600"
          signal_threshold: "100"
          slot: "sim1"
          type: "carrier"
          username: "<your_own_value>"

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

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

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: success Пример: `"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_extender_controller_dataplan_module.html