fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_smsnotification модуль — Настройка уведомлений по SMS для мобильной связи FortiExtender.

Примечание

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

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

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

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

Новая функция в fortinet.fortimanager 2.2.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.
extensioncontroller_extenderprofile_cellular_smsnotification словарь	Настройка параметров верхнего уровня.
alert словарь	Уведомление.
data_exhausted строка	Устарело, переименуйте на data_exhausted. Строка отображения при исчерпании данных.
fgt_backup_mode_switch строка	Устарело, переименуйте на fgt_backup_mode_switch. Строка отображения при переключении резервного режима FortiGate.
low_signal_strength строка	Устарело, переименуйте на low_signal_strength. Строка отображения при слабом сигнале.
mode_switch строка	Устарело, переименуйте на mode_switch. Строка отображения при переключении режима.
os_image_fallback строка	Устарело, переименуйте на os_image_fallback. Строка отображения при откате к предыдущей ОС.
session_disconnect строка	Устарело, переименуйте на session_disconnect. Строка отображения при отключении сессии.
system_reboot строка	Устарело, переименуйте на system_reboot. Строка отображения при перезагрузке системы.
receiver список / элементы=словарь	Получатель.
alert список / элементы=строка	Много вариантов уведомления. Варианты: `"system-reboot"` `"data-exhausted"` `"session-disconnect"` `"low-signal-strength"` `"mode-switch"` `"os-image-fallback"` `"fgt-backup-mode-switch"`
name строка	Имя получателя уведомлений FortiExtender SMS.
phone_number строка	Устарело, переименуйте на phone_number. Номер телефона получателя.

статус строка	Статус получателя уведомлений по SMS. Выбираемые значения: `"disable"` `"enable"`
статус строка	Статус уведомлений по SMS FortiExtender. Выбираемые значения: `"disable"` `"enable"`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Выбираемые значения: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, при которых будут переопределены условия завершения неудачей.
rc_succeeded список / элементы=целое число	Список rc-кодов, при которых будут переопределены условия успешного завершения.
workspace_locking_adom строка	Область управления (ADOM), которая будет заблокирована при запуске FortiManager в режиме рабочего пространства; значение может быть глобальным или другим, включая корневой.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: `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: FortiExtender cellular SMS notification configuration.
      fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_smsnotification:
        # 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>
        extensioncontroller_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 словарь	Результат запроса. Возвращаемое значение: всегда
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_extenderprofile_cellular_smsnotification_module.html