fortinet.fortimanager.fmgr_system_mail модуль — Уведомления об ошибках по электронной почте.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_system_mail.
Новый в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием в источниках данных.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation логическое | Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое | Включить/выключить логирование для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для основного запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое | Список rc-кодов, с которыми условия завершения работы будут переопределены. |
rc_succeeded список / элементы=целое | Список rc-кодов, с которыми условия успешного завершения работы будут переопределены. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
system_mail словарь | Набор параметров верхнего уровня. |
|
auth строка |
Включить аутентификацию. disable - Отключить аутентификацию. enable - Включить аутентификацию. Варианты:
|
|
auth_type строка |
Устарело, пожалуйста, переименуйте на auth_type. Тип аутентификации SMTP. psk - Использование имени пользователя и пароля для аутентификации. certificate - Использование локального сертификата для аутентификации. Варианты:
|
|
from строка |
Имя пользователя для MAIL FROM. |
|
id строка / обязательно |
ID службы электронной почты. |
|
local_cert строка |
Устарело, пожалуйста, переименуйте на local_cert. Локальный сертификат SMTP. |
|
passwd любой |
(список) Пароль учетной записи SMTP. |
|
port целое |
Порт сервера SMTP. |
|
secure_option строка |
Устарело, пожалуйста, переименуйте на secure_option. Параметр безопасности коммуникации. default - Попробуйте STARTTLS, в противном случае используйте обычный текстовый обмен. none - Обмен данными будет в формате простого текста. smtps - Обмен данными будет защищён протоколом SMTPS. starttls - Обмен данными будет защищён протоколом STARTTLS. Варианты:
|
|
server строка |
Сервер SMTP. |
|
user строка |
Имя пользователя учетной записи SMTP. |
workspace_locking_adom строка | ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая root. |
workspace_locking_timeout целое | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы имеют обозначение с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов всё ещё доступны, но вы будете получать предупреждения о устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
- В этом модуле FortiManager поддерживается режим блокировки рабочей области. Параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращён ненулевой код rc. Вы также можете переопределить условия завершения успехом или неудачей с помощью параметров rc_failed и rc_succeeded
Примеры
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Alert emails.
fortinet.fortimanager.fmgr_system_mail:
bypass_validation: false
state: present
system_mail:
auth: enable
id: 1
passwd: fortinet
port: 1
secure-option: none # <value in [default, none, smtps, ...]>
server: ALL
user: ansible
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the alert emails
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_mail"
params:
mail: "your_value"
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращаемое значение: всегда |
|
request_url строка |
Полный URL запроса. Возвращаемое значение: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращаемое значение: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращаемое значение: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращаемое значение: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращаемое значение: всегда |
rc целое число | Статус запроса. Возвращаемое значение: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращаемое значение: сложный |
Ссылки на сборку
© 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_system_mail_module.html
