fortinet.fortimanager.fmgr_extendercontroller_dataplan модуль — Настройка плана данных FortiExtender.

Примечание

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

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

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

Для использования в playbook укажите: fortinet.fortimanager.fmgr_extendercontroller_dataplan.

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

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только при несовпадении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
extendercontroller_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"`
status string	Модуль FortiExtender dataplan Выбор: `"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 / elements=integer	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded list / elements=integer	Список кодов rc, с которыми будут переопределены условия для успеха.
state string / обязательно	Директива для создания, обновления или удаления объекта. Выбор: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки при работе FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая 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 помогают в этой работе.
Для создания или обновления объекта используйте директиву 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_extendercontroller_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]>
        extendercontroller_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]>
          status: <value in [disable, enable]>
          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_extendercontroller_dataplan_module.html