Spec-Zone.ru › Ansible

fortinet.fortios.fortios_extension_controller_dataplan модуль — Настройка FortiExtender dataplan в FortiOS и FortiGate Fortinet.

Примечание

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

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

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

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

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

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

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

Требования

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

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

string

Токенная аутентификация. Создается в GUI Fortigate.

enable_log

boolean

Включить/Выключить логирование для задачи.

Варианты:

  • false ← (default)
  • true

extension_controller_dataplan

dictionary

Конфигурация FortiExtender dataplan.

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 / required

Имя тарифного плана 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 / required

Указывает, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен, среди ранее определенных. Vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный блок.

Значение по умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi был объявлен устаревшим, httpapi — предпочтительный способ запуска playbook’ов

Примеры

- name: FortiExtender dataplan configuration.
  fortinet.fortios.fortios_extension_controller_dataplan:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extension_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: "0"
          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

Возвращается: при успехе

Пример: "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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_extension_controller_dataplan_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API