Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_modem1 — параметры конфигурации модема 1.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

extender-profile

string

Устарел, используйте «extender_profile»

extender_profile

string

Параметр (extender-profile) в запрошенном URL.

extensioncontroller_extenderprofile_cellular_modem1

dictionary

Параметры верхнего уровня.

auto_switch

псевдонимы: auto-switch

dictionary

Автоматическое переключение.

dataplan

string

Автоматическое переключение на основе использования данных.

Варианты:

  • "disable"
  • "enable"

disconnect

string

Автоматическое переключение при отключении.

Варианты:

  • "disable"
  • "enable"

disconnect_period

псевдонимы: disconnect-period

integer

Автоматическое переключение на основе периода отключения.

disconnect_threshold

псевдонимы: disconnect-threshold

integer

Автоматическое переключение на основе порогового значения отключения.

signal

string

Автоматическое переключение на основе уровня сигнала.

Варианты:

  • "disable"
  • "enable"

switch_back

псевдонимы: switch-back

list / элементы=string

Автоматическое переключение с несколькими вариантами возврата на исходную SIM-карту.

Варианты:

  • "time"
  • "timer"

switch_back_time

псевдонимы: switch-back-time

string

Автоматическое переключение на предпочитаемую SIM-карту/оператора в указанное время по UTC

switch_back_timer

псевдонимы: switch-back-timer

integer

Автоматическое переключение на предпочитаемую SIM-карту/оператора по истечении заданного времени

conn_status

псевдонимы: conn-status

integer

Состояние подключения.

default_sim

псевдонимы: default-sim

string

Выбор SIM-карты по умолчанию.

Варианты:

  • "sim1"
  • "sim2"
  • "carrier"
  • "cost"

gps

string

Включение/отключение GPS в FortiExtender.

Варианты:

  • "disable"
  • "enable"

modem_id

псевдонимы: modem-id

integer

Идентификатор модема.

multiple_PDN

псевдонимы: multiple-PDN

string

Включение/отключение Multiple-PDN.

Варианты:

  • "disable"
  • "enable"

pdn1_dataplan

псевдонимы: pdn1-dataplan

any

(список) План передачи данных PDN1.

pdn2_dataplan

псевдонимы: pdn2-dataplan

any

(список) План передачи данных PDN2.

pdn3_dataplan

псевдонимы: pdn3-dataplan

any

(список) План передачи данных PDN3.

pdn4_dataplan

псевдонимы: pdn4-dataplan

any

(список) План передачи данных PDN4.

preferred_carrier

псевдонимы: preferred-carrier

string

Предпочитаемый оператор связи.

redundant_intf

псевдонимы: redundant-intf

string

Резервный интерфейс.

redundant_mode

псевдонимы: redundant-mode

string

Режим FortiExtender.

Варианты:

  • "disable"
  • "enable"

sim1_pin

псевдонимы: sim1-pin

string

SIM-карта

Варианты:

  • "disable"
  • "enable"

sim1_pin_code

псевдонимы: sim1-pin-code

any

(список) SIM-карта

sim2_pin

псевдонимы: sim2-pin

string

SIM-карта

Варианты:

  • "disable"
  • "enable"

sim2_pin_code

псевдонимы: sim2-pin-code

any

(список) SIM-карта

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

Примечание об изменении, которое можно указать при создании или обновлении объекта.

workspace_locking_adom

string

ADOM, блокируемый для FortiManager, работающего в режиме рабочего пространства. Значением может быть global или другой ADOM, включая 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.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configuration options for modem 1.
      fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_modem1:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        extender_profile: <your own value>
        extensioncontroller_extenderprofile_cellular_modem1:
          # auto_switch:
          #   dataplan: <value in [disable, enable]>
          #   disconnect: <value in [disable, enable]>
          #   disconnect_period: <integer>
          #   disconnect_threshold: <integer>
          #   signal: <value in [disable, enable]>
          #   switch_back: ["time", "timer"]
          #   switch_back_time: <string>
          #   switch_back_timer: <integer>
          # conn_status: <integer>
          # default_sim: <value in [sim1, sim2, carrier, ...]>
          # gps: <value in [disable, enable]>
          # modem_id: <integer>
          # preferred_carrier: <string>
          # redundant_intf: <string>
          # redundant_mode: <value in [disable, enable]>
          # sim1_pin: <value in [disable, enable]>
          # sim1_pin_code: <list or string>
          # sim2_pin: <value in [disable, enable]>
          # sim2_pin_code: <list or string>
          # multiple_PDN: <value in [disable, enable]>
          # pdn1_dataplan: <list or string>
          # pdn2_dataplan: <list or string>
          # pdn3_dataplan: <list or string>
          # pdn4_dataplan: <list or 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_extensioncontroller_extenderprofile_cellular_modem1_module.html

Spec-Zone.ru

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