Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_smsnotification — настройка уведомлений FortiExtender по SMS.

Примечание

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

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

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

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

Добавлено в 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

extender-profile

string

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

extender_profile

string

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

extendercontroller_extenderprofile_cellular_smsnotification

dictionary

Набор параметров верхнего уровня.

alert

dictionary

Оповещение.

data_exhausted

псевдонимы: data-exhausted

string

Строка для отображения при исчерпании трафика.

fgt_backup_mode_switch

псевдонимы: fgt-backup-mode-switch

string

Строка для отображения при переключении FortiGate в режим резервирования.

low_signal_strength

псевдонимы: low-signal-strength

string

Строка для отображения при низком уровне сигнала.

mode_switch

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

string

Строка для отображения при переключении режима.

os_image_fallback

псевдонимы: os-image-fallback

string

Строка для отображения при возврате к предыдущему образу ОС.

session_disconnect

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

string

Строка для отображения при отключении сеанса.

system_reboot

псевдонимы: system-reboot

string

Строка для отображения при перезагрузке системы.

receiver

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

Получатель.

alert

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

Несколько параметров оповещения.

Возможные значения:

  • "system-reboot"
  • "data-exhausted"
  • "session-disconnect"
  • "low-signal-strength"
  • "mode-switch"
  • "os-image-fallback"
  • "fgt-backup-mode-switch"

name

string

Имя получателя SMS-уведомлений FortiExtender.

phone_number

псевдонимы: phone-number

string

Номер телефона получателя.

status

string

Статус получателя SMS-уведомлений.

Возможные значения:

  • "disable"
  • "enable"

status

string

Статус SMS-уведомлений FortiExtender.

Возможные значения:

  • "disable"
  • "enable"

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 или другие варианты, включая 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: FortiExtender cellular SMS notification configuration.
      fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_smsnotification:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        extender_profile: <your own value>
        extendercontroller_extenderprofile_cellular_smsnotification:
          # alert:
          #   data_exhausted: <string>
          #   fgt_backup_mode_switch: <string>
          #   low_signal_strength: <string>
          #   mode_switch: <string>
          #   os_image_fallback: <string>
          #   session_disconnect: <string>
          #   system_reboot: <string>
          # receiver:
          #   - alert: ["system-reboot", "data-exhausted", "session-disconnect",
          #             "low-signal-strength", "mode-switch", "os-image-fallback",
          #             "fgt-backup-mode-switch"]
          #     name: <string>
          #     phone_number: <string>
          #     status: <value in [disable, enable]>
          # status: <value in [disable, enable]>

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

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

Ключ

Описание

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

Spec-Zone.ru

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