fortinet.fortimanager.fmgr_system_smsserver – Настройка SMS-сервера для отправки SMS-сообщений для поддержки аутентификации пользователей.
Примечание
Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_smsserver.
Новое в версии 2.10: of fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить с помощью источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливается только в значение Истина, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут отклоняться | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут приниматься | ||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | |
| system_smsserver словарь | настройка параметров верхнего уровня | ||
| mail-server строка | Доменное имя сервера почты-SMS. | ||
| name строка | Имя SMS-сервера. | ||
| workspace_locking_adom строка | adom для блокировки при работе FortiManager в режиме рабочей области, значение может быть глобальным и другими, включая root | ||
| workspace_locking_timeout целое число | По умолчанию: 300 | максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем | |
Примечания
Примечание
- Поддерживается работа в режиме блокировки рабочей области в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
- Для создания или обновления объекта используйте направление state present.
- Для удаления объекта используйте направление state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой код rc. Вы также можете переопределить условия для отклонения или принятия с параметрами rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure SMS server for sending SMS messages to support user authentication.
fmgr_system_smsserver:
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: <value in [present, absent]>
system_smsserver:
mail-server: <value of string>
name: <value of string>
Возвращаемые значения
Общие значения возврата описаны в здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрошенный URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Детальное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_smsserver_module.html
