Модуль cisco.ise.guest_smtp_notification_settings — Модуль ресурсов для настроек уведомлений SMTP для гостей

Примечание

Этот модуль является частью коллекции cisco.ise (версия 2.9.3).

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

Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в плейбуке укажите: cisco.ise.guest_smtp_notification_settings.

Добавлен в cisco.ise 1.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Управление операциями создания и обновления ресурса «Настройки уведомлений SMTP для гостей».
Этот API создаёт конфигурацию уведомлений SMTP для гостей.
Этот API позволяет клиенту обновить настройку конфигурации SMTP.

Примечание

Этот модуль имеет соответствующий плагин действий.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
connectionTimeout string	Интервал в секундах для всех подключений клиента SMTP.
defaultFromAddress string	Адрес электронной почты "от кого", используемый для отправки писем.
id string	Идентификатор настроек уведомлений Guest SMTP.
ise_debug boolean	Флаг для Identity Services Engine SDK для включения отладки. Варианты: `false` ← (default) `true`
ise_hostname string / required	Имя хоста Identity Services Engine.
ise_password string / required	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout integer добавлено в cisco.ise 3.0.0	Время ожидания (в секундах) для HTTP-запросов RESTful. По умолчанию: `60`
ise_username string / required	Имя пользователя Identity Services Engine для аутентификации.
ise_uses_api_gateway boolean добавлено в cisco.ise 1.1.0	Флаг, который сообщает SDK, следует ли использовать API Gateway Identity Services Engine для отправки запросов. Если это true, он использует API Gateway ISE и отправляет запросы на https://{{ise_hostname}}. Если это false, он отправляет запросы на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты: `false` `true` ← (default)
ise_uses_csrf_token boolean добавлено в cisco.ise 3.0.0	Флаг, который сообщает SDK, отправляем ли мы токен CSRF в API ERS ISE. Если это True, SDK предполагает, что проверка CSRF вашего ISE включена. Если это True, он предполагает, что вам нужно, чтобы SDK автоматически управлял токеном CSRF для вас. Варианты: `false` ← (default) `true`
ise_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (default)
ise_version string	Сообщает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit boolean	Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости. Варианты: `false` `true` ← (default)
notificationEnabled boolean	Указывает, следует ли включать службу уведомлений по электронной почте. Варианты: `false` `true`
password string	Пароль защищенного SMTP-сервера.
smtpPort string	Порт, на котором прослушивает защищенный SMTP-сервер.
smtpServer string	IP-адрес или FQDN SMTP-сервера, например outbound.mycompany.com.
useDefaultFromAddress boolean	Следует ли использовать адрес "от кого" по умолчанию вместо адреса электронной почты пользователя-спонсора. Варианты: `false` `true`
usePasswordAuthentication boolean	Если настроено на true, аутентификация SMTP-сервера будет выполняться с использованием имени пользователя/пароля. Варианты: `false` `true`

userName string	Имя пользователя защищённого SMTP-сервера.
useTLSorSSLEncryption boolean	Если значение установлено в true, аутентификация SMTP-сервера будет выполняться с использованием TLS/SSL. Варианты: `false` `true`

Примечания

Примечание

Используемые методы SDK: guest_smtp_notification_configuration.GuestSmtpNotificationConfiguration.create_guest_smtp_notification_settings, guest_smtp_notification_configuration.GuestSmtpNotificationConfiguration.update_guest_smtp_notification_settings_by_id,
Используемые пути: post /ers/config/guestsmtpnotificationsettings, put /ers/config/guestsmtpnotificationsettings/{id},
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Update by id
  cisco.ise.guest_smtp_notification_settings:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    connectionTimeout: string
    defaultFromAddress: string
    id: string
    notificationEnabled: true
    password: string
    smtpPort: string
    smtpServer: string
    useDefaultFromAddress: true
    usePasswordAuthentication: true
    useTLSorSSLEncryption: true
    userName: string

- name: Create
  cisco.ise.guest_smtp_notification_settings:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    connectionTimeout: string
    defaultFromAddress: string
    notificationEnabled: true
    password: string
    smtpPort: string
    smtpServer: string
    useDefaultFromAddress: true
    usePasswordAuthentication: true
    useTLSorSSLEncryption: true
    userName: string

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

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `{"connectionTimeout": "string", "defaultFromAddress": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "notificationEnabled": true, "password": "string", "smtpPort": "string", "smtpServer": "string", "useDefaultFromAddress": true, "usePasswordAuthentication": true, "useTLSorSSLEncryption": true, "userName": "string"}`
ise_update_response словарь добавлен в cisco.ise 1.1.0	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `{"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}`

Ключ

Описание

ise_response

словарь

Словарь или список с ответом, возвращённым Cisco ISE Python SDK

Возвращается: всегда

Пример: {"connectionTimeout": "string", "defaultFromAddress": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "notificationEnabled": true, "password": "string", "smtpPort": "string", "smtpServer": "string", "useDefaultFromAddress": true, "usePasswordAuthentication": true, "useTLSorSSLEncryption": true, "userName": "string"}

ise_update_response

словарь

добавлен в cisco.ise 1.1.0

Словарь или список с ответом, возвращённым Cisco ISE Python SDK

Возвращается: всегда

Пример: {"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}

Авторы

Rafael Campos (@racampos)

Ссылки на коллекцию

© 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/cisco/ise/guest_smtp_notification_settings_module.html