Модуль fortinet.fortios.fortios_system_sms_server – Настройка SMS-сервера для отправки SMS-сообщений для поддержки аутентификации пользователей в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: fortinet.fortios.fortios_system_sms_server.
Добавлен в fortinet.fortios 2.0.0
Обзор
- Этот модуль может настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять системные параметры и категорию sms_server. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токенов. Генерируется из графического интерфейса Fortigate. |
enable_log логический | Включить/выключить логирование для задачи. Варианты:
|
member_path строка | Путь к атрибуту члена для выполнения операции. Разделяется слэшем, если атрибутов более одного. Параметр, помеченный member_path, подходит для выполнения операций с членом. |
member_state строка | Добавить или удалить члена по указанному пути к атрибуту. Если указан member_state, опция state игнорируется. Варианты:
|
state строка / обязательный | Указывает, нужно ли создать или удалить объект. Варианты:
|
system_sms_server словарь | Настройка SMS-сервера для отправки SMS-сообщений для поддержки аутентификации пользователей. |
|
mail_server строка |
Имя домена сервера электронной почты для SMS. |
|
name строка / обязательный |
Имя SMS-сервера. |
vdom строка | Виртуальная область, из ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который может быть настроен и использован как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший модуль fortiosapi устарел; httpapi — предпочтительный способ выполнения плейбуков
- Модуль поддерживает режим check_mode.
Примеры
- name: Configure SMS server for sending SMS messages to support user authentication.
fortinet.fortios.fortios_system_sms_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_sms_server:
mail_server: "<your_own_value>"
name: "default_name_4"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для предоставления содержимого в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, предоставленный FortiGate при последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успешно Пример: |
name строка | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер версии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на сборку
© 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/fortios/fortios_system_sms_server_module.html
