Модуль cisco.ise.guest_smtp_notification_settings_info – Информационный модуль для параметров уведомлений SMTP для гостей

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: cisco.ise.guest_smtp_notification_settings_info.

Новое в cisco.ise 1.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Получение всех параметров уведомлений SMTP для гостей.
Получение параметров уведомлений SMTP для гостей по идентификатору.
Этот API позволяет клиенту получить конфигурацию уведомлений SMTP для гостей по.
Этот API позволяет клиенту получить все уведомления SMTP для гостей.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
filter list / elements=string	Параметр запроса фильтра. Простая фильтрация должна быть доступна через параметр строки запроса filter. Структура фильтра представляет собой тройку поле-оператор-значение, разделенные точками. Можно отправить более одного фильтра. Логический оператор, общий для ВСЕХ критериев фильтра, по умолчанию будет AND, и его можно изменить, используя параметр строки запроса «filterType=or». Описание модели данных каждого ресурса должно указывать, является ли атрибут фильтруемым полем. Оператор ‘EQ’ описывает ‘Равно’. Оператор ‘NEQ’ описывает ‘Не равно’. Оператор ‘GT’ описывает ‘Больше чем’. Оператор ‘LT’ описывает ‘Меньше чем’. Оператор ‘STARTSW’ описывает ‘Начинается с’. Оператор ‘NSTARTSW’ описывает ‘Не начинается с’. Оператор ‘ENDSW’ описывает ‘Заканчивается на’. Оператор ‘NENDSW’ описывает ‘Не заканчивается на’. Оператор ‘CONTAINS’ описывает ‘Содержит’. Оператор ‘NCONTAINS’ описывает ‘Не содержит’.
filterType string	Параметр запроса FilterType. Логический оператор, общий для ВСЕХ критериев фильтра, по умолчанию будет AND, и его можно изменить, используя этот параметр.
id string	Параметр пути Id.
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 added in cisco.ise 3.0.0	Время ожидания (в секундах) для HTTP-запросов RESTful. По умолчанию: `60`
ise_username string / required	Имя пользователя Identity Services Engine для аутентификации.
ise_uses_api_gateway boolean added in 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 added in 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)
page integer	Параметр запроса Page. Номер страницы.
size integer	Параметр запроса Size. Количество возвращаемых объектов на страницу.
sortasc string	Параметр запроса Sortasc. Сортировка по возрастанию.
sortdsc string	Параметр запроса Sortdsc. Сортировка по убыванию.

Примечания

Примечание

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

Примеры

- name: Get all Guest SMTP Notification Settings
  cisco.ise.guest_smtp_notification_settings_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
    sortasc: string
    sortdsc: string
    filter: []
    filterType: AND
  register: result

- name: Get Guest SMTP Notification Settings by id
  cisco.ise.guest_smtp_notification_settings_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

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

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

Ключ	Описание
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_responses список / элементы=словарь добавлено в cisco.ise 1.1.0	Словарь или список с ответом, возвращаемым Cisco ISE Python SDK Возвращается: всегда Пример: "[\n {\n \"id\": \"string\",\n \"smtpServer\": \"string\",\n \"notificationEnabled\": true,\n \"useDefaultFromAddress\": true,\n \"defaultFromAddress\": \"string\",\n \"smtpPort\": \"string\",\n \"connectionTimeout\": \"string\",\n \"useTLSorSSLEncryption\": true,\n \"usePasswordAuthentication\": true,\n \"userName\": \"string\",\n \"password\": \"string\",\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"

Ключ

Описание

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_responses

список / элементы=словарь

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

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

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

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

Авторы

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_info_module.html