cisco.ise.guest_smtp_notification_settings 模块 – 用于访客 SMTP 通知设置的资源模块

注意

此模块是 cisco.ise 集合（版本 2.9.6）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：cisco.ise.guest_smtp_notification_settings。

cisco.ise 1.0.0 中的新增功能

概要 

管理资源访客 SMTP 通知设置的创建和更新操作。
此 API 创建访客 SMTP 通知配置。
此 API 允许客户端更新 SMTP 配置设置。

注意

此模块具有相应的操作插件。

要求 

在执行此模块的主机上需要以下要求。

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
connectionTimeout 字符串	所有 SMTP 客户端连接的间隔（以秒为单位）。
defaultFromAddress 字符串	默认的发送电子邮件的“发件人”电子邮件地址。
id 字符串	访客 SMTP 通知设置的 ID。
ise_debug 布尔值	用于启用调试的 Identity Services Engine SDK 的标志。选项 `false` ←（默认） `true`
ise_hostname 字符串 / 必需	Identity Services Engine 主机名。
ise_password 字符串 / 必需	用于身份验证的 Identity Services Engine 密码。
ise_single_request_timeout 整数在 cisco.ise 3.0.0 中添加	RESTful HTTP 请求的超时时间（以秒为单位）。默认值： `60`
ise_username 字符串 / 必需	用于身份验证的 Identity Services Engine 用户名。
ise_uses_api_gateway 布尔值在 cisco.ise 1.1.0 中添加	通知 SDK 是否使用 Identity Services Engine 的 API 网关发送请求的标志。如果为 true，则它使用 ISE 的 API 网关并将请求发送到 https://{{ise_hostname}}。如果为 false，则它将请求发送到 https://{{ise_hostname}}:{{port}}，其中端口值取决于使用的服务（ERS、Mnt、UI、PxGrid）。选项 `false` `true` ←（默认）
ise_uses_csrf_token 布尔值在 cisco.ise 3.0.0 中添加	通知 SDK 是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。如果为 True，则 SDK 假设您的 ISE CSRF 检查已启用。如果为 True，则表示您需要 SDK 为您自动管理 CSRF 令牌。选项 `false` ←（默认） `true`
ise_verify 布尔值	用于启用或禁用 SSL 证书验证的标志。选项 `false` `true` ←（默认）
ise_version 字符串	通知 SDK 要使用的 Identity Services Engine 版本。默认值： `"3.1_Patch_1"`
ise_wait_on_rate_limit 布尔值	用于启用自动速率限制处理的 Identity Services Engine SDK 的标志。选项 `false` `true` ←（默认）
notificationEnabled 布尔值	指示是否启用电子邮件通知服务。选项 `false` `true`
password 字符串	安全 SMTP 服务器的密码。
smtpPort 字符串	SMTP 安全服务器正在侦听的端口。
smtpServer 字符串	SMTP 服务器的 IP 地址或 FQDN，例如 outbound.mycompany.com。
useDefaultFromAddress 布尔值	是否应使用默认的“发件人”地址，而不是使用赞助商用户的电子邮件地址。选项 `false` `true`
usePasswordAuthentication 布尔值	如果配置为 true，则将使用用户名/密码进行 SMTP 服务器身份验证。选项 `false` `true`
userName 字符串	安全 SMTP 服务器的用户名。
useTLSorSSLEncryption 布尔值	如果配置为 true，则将使用 TLS/SSL 进行 SMTP 服务器身份验证。选项 `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 中添加