Модуль fortinet.fortimanager.fmgr_extendercontroller_dataplan — конфигурация плана передачи данных FortiExtender.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_extendercontroller_dataplan.

Добавлено в fortinet.fortimanager 2.1.0

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

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

Этот модуль позволяет настраивать устройство FortiManager.
Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager: модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
extendercontroller_dataplan dictionary	Набор параметров верхнего уровня.
apn string	Конфигурация APN.
auth_type псевдонимы: auth-type string	Тип аутентификации. Варианты: `"none"` `"pap"` `"chap"`
billing_date псевдонимы: billing-date integer	День выставления счёта в месяце
capacity integer	Ёмкость в МБ
carrier string	Конфигурация оператора связи.
iccid string	Конфигурация ICCID.
modem_id псевдонимы: modem-id string	Специфические параметры модема для плана передачи данных, если таковые имеются. Варианты: `"all"` `"modem1"` `"modem2"`
monthly_fee псевдонимы: monthly-fee integer	Ежемесячная плата за план передачи данных
name string / обязательный	Имя плана передачи данных FortiExtender
overage string	Включить/отключить обнаружение превышения лимита плана передачи данных. Варианты: `"disable"` `"enable"`
password any	(список) Пароль.
pdn string	Тип PDN. Варианты: `"ipv4-only"` `"ipv6-only"` `"ipv4-ipv6"`
preferred_subnet псевдонимы: preferred-subnet integer	Предпочтительная маска подсети
private_network псевдонимы: private-network string	Включить/отключить поддержку частной сети для плана передачи данных. Варианты: `"disable"` `"enable"`
signal_period псевдонимы: signal-period integer	Период сигнала
signal_threshold псевдонимы: signal-threshold integer	Порог сигнала.
slot string	Конфигурация слота SIM-карты. Варианты: `"sim1"` `"sim2"`
status string	План передачи данных FortiExtender Варианты: `"disable"` `"enable"`
type string	Конфигурация предпочтений типа. Варианты: `"carrier"` `"slot"` `"iccid"` `"generic"`
username string	Имя пользователя.
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, с помощью которого переопределяются условия неудачного выполнения.
rc_succeeded list / элементы=integer	Список кодов rc, с помощью которого переопределяются условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global, а также другие значения, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы именуются в соответствии с соглашением об использовании подчёркиваний (snake_case). Замените аргументы, например “var-name” на “var_name”. Старые имена аргументов по-прежнему доступны, однако будут появляться предупреждения об устаревании. Чтобы скрыть эти предупреждения, задайте deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают выполнять эту задачу.
Обычно выполнение модуля завершается с ошибкой, если возвращается ненулевой код rc. Условия неудачного или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: FortiExtender dataplan configuration.
      fortinet.fortimanager.fmgr_extendercontroller_dataplan:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        extendercontroller_dataplan:
          name: "your value" # Required variable, string
          # apn: <string>
          # auth_type: <value in [none, pap, chap]>
          # billing_date: <integer>
          # capacity: <integer>
          # carrier: <string>
          # iccid: <string>
          # modem_id: <value in [all, modem1, modem2]>
          # monthly_fee: <integer>
          # overage: <value in [disable, enable]>
          # password: <list or string>
          # pdn: <value in [ipv4-only, ipv6-only, ipv4-ipv6]>
          # preferred_subnet: <integer>
          # private_network: <value in [disable, enable]>
          # signal_period: <integer>
          # signal_threshold: <integer>
          # slot: <value in [sim1, sim2]>
          # status: <value in [disable, enable]>
          # type: <value in [carrier, slot, iccid, ...]>
          # username: <string>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortimanager/fmgr_extendercontroller_dataplan_module.html