Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_modem2 модуль — Параметры конфигурации модема 2.

Примечание

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

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

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

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

Новая версия в fortinet.fortimanager 2.1.0

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

Обзор

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

Параметры

Параметр

Комментарии

access_token

строка

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

adom

строка / обязательно

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

bypass_validation

булево

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

Варианты:

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

enable_log

булево

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

Варианты:

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

extender-profile

строка

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

extender_profile

строка

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

extendercontroller_extenderprofile_cellular_modem2

словарь

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

auto-switch

словарь

Устаревшее значение, переименуйте на auto_switch. Автоматический выбор.

dataplan

строка

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

Варианты:

  • "disable"
  • "enable"

disconnect

строка

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

Варианты:

  • "disable"
  • "enable"

disconnect-period

целое число

Устаревшее значение, переименуйте на disconnect_period. Автоматический выбор по периоду отключения.

disconnect-threshold

целое число

Устаревшее значение, переименуйте на disconnect_threshold. Автоматический выбор по порогу отключения.

signal

строка

Автоматический выбор в зависимости от силы сигнала.

Варианты:

  • "disable"
  • "enable"

switch-back

список / элементы=строка

Устаревшее значение, переименуйте на switch_back. Автоматический выбор с многочисленными вариантами возврата.

Варианты:

  • "time"
  • "timer"

switch-back-time

строка

Устаревшее значение, переименуйте на switch_back_time. Автоматический переход на предпочтительную SIM/оператора в…

switch-back-timer

целое число

Устаревшее значение, переименуйте на switch_back_timer. Автоматический переход на предпочтительную SIM/оператора через…

conn-status

целое число

Устаревшее значение, переименуйте на conn_status. Статус подключения.

default-sim

строка

Устаревшее значение, переименуйте на default_sim. Выбор по умолчанию SIM.

Варианты:

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

gps

строка

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

Варианты:

  • "disable"
  • "enable"
END_OF_DOCUMENT_MARKER

modem-id

integer

Устарело, пожалуйста, переименуйте на modem_id. Идентификатор модема.

preferred-carrier

string

Устарело, пожалуйста, переименуйте на preferred_carrier. Предпочтительный оператор связи.

redundant-intf

string

Устарело, пожалуйста, переименуйте на redundant_intf. Резервный интерфейс.

redundant-mode

string

Устарело, пожалуйста, переименуйте на redundant_mode. Режим FortiExtender.

Варианты:

  • "disable"
  • "enable"

sim1-pin

string

Устарело, пожалуйста, переименуйте на sim1_pin. SIM

Варианты:

  • "disable"
  • "enable"

sim1-pin-code

any

(список) Устарело, пожалуйста, переименуйте на sim1_pin_code. SIM

sim2-pin

string

Устарело, пожалуйста, переименуйте на sim2_pin. SIM

Варианты:

  • "disable"
  • "enable"

sim2-pin-code

any

(список) Устарело, пожалуйста, переименуйте на sim2_pin_code. SIM

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, с которыми будут переопределены условия успешного завершения.

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 помогают в этом.
  • Обычно, выполнение одного модуля может завершиться ошибкой, если возвращён ненулевой код 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: Configuration options for modem 2.
      fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_modem2:
        # 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>
        extender_profile: <your own value>
        extendercontroller_extenderprofile_cellular_modem2:
          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>

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

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

Ключ

Описание

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_extenderprofile_cellular_modem2_module.html

Spec-Zone.ru

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