fortinet.fortimanager.fmgr_extensioncontroller_dataplan модуль — Настройка dataplan FortiExtender.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_extensioncontroller_dataplan.

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

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить логирование для задачи. Варианты: `false` ← (по умолчанию) `true`
extensioncontroller_dataplan словарь	Настройка параметров верхнего уровня.
apn строка	Настройка APN.
auth_type строка	Устарело, пожалуйста, переименуйте на auth_type. Тип аутентификации. Варианты: `"none"` `"pap"` `"chap"`
billing_date целое число	Устарело, пожалуйста, переименуйте на billing_date. Номер дня месяца для выставления счетов.
capacity целое число	Емкость в МБ
carrier строка	Настройка оператора.
iccid строка	Настройка ICCID.
modem_id строка	Устарело, пожалуйста, переименуйте на modem_id. Подробности модема для тарифа, если есть. Варианты: `"all"` `"modem1"` `"modem2"`
monthly_fee целое число	Устарело, пожалуйста, переименуйте на monthly_fee. Ежемесячная плата за тарифный план.
name строка / обязательный	Имя тарифного плана FortiExtender.
overage строка	Включить/выключить обнаружение превышения объема тарифа. Варианты: `"disable"` `"enable"`
password любой тип	(список) Пароль.
pdn строка	Тип PDN. Варианты: `"ipv4-only"` `"ipv6-only"` `"ipv4-ipv6"`
preferred_subnet целое число	Устарело, пожалуйста, переименуйте на preferred_subnet. Предпочтительная маска подсети.
private_network строка	Устарело, пожалуйста, переименуйте на private_network. Включить/выключить поддержку частной сети тарифа. Варианты: `"disable"` `"enable"`
signal_period целое число	Устарело, пожалуйста, переименуйте на signal_period. Период сигнала.
signal_threshold целое число	Устарело, пожалуйста, переименуйте на signal_threshold. Пороговое значение сигнала.

END_OF_DOCUMENT_MARKER

slot string	Настройка конфигурации слота SIM. Варианты: `"sim1"` `"sim2"`
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 / элементы=целое	Список rc-кодов, при которых выполнение будет прервано.
rc_succeeded list / элементы=целое	Список rc-кодов, при которых выполнение будет успешно завершено.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки в режиме работы FortiManager в пространстве имен. Значение может быть глобальным или другим, включая корневой.
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 помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно, выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой rc. Вы также можете переопределить условия ошибки или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: FortiExtender dataplan configuration.
      fortinet.fortimanager.fmgr_extensioncontroller_dataplan:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        extensioncontroller_dataplan:
          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>
          name: <string>
          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]>
          type: <value in [carrier, slot, iccid, ...]>
          username: <string>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_extensioncontroller_dataplan_module.html