cisco.ise.guest_smtp_notification_settings – Resource module for Guest Smtp Notification Settings

Note

This plugin is part of the cisco.ise collection (version 1.2.0).

To install it use: ansible-galaxy collection install cisco.ise.

To use it in a playbook, specify: cisco.ise.guest_smtp_notification_settings.

New in version 1.0.0: of cisco.ise

Synopsis

• Manage operations create and update of the resource Guest Smtp Notification Settings.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• ciscoisesdk >= 1.1.0

• python >= 3.5

Parameters

Parameter	Choices/Defaults	Comments
connectionTimeout string		Interval in seconds for all the SMTP client connections.
defaultFromAddress string		The default from email address to be used to send emails from.
id string		Guest Smtp Notification Settings's id.
ise_debug boolean	Choices: no ← yes	Flag for Identity Services Engine SDK to enable debugging.
ise_hostname string / required		The Identity Services Engine hostname.
ise_password string / required		The Identity Services Engine password to authenticate.
ise_username string / required		The Identity Services Engine username to authenticate.
ise_uses_api_gateway boolean added in 1.1.0 of cisco.ise	Choices: no yes ←	Flag that informs the SDK whether to use the Identity Services Engine's API Gateway to send requests. If it is true, it uses the ISE's API Gateway and sends requests to https://{{ise_hostname}}. If it is false, it sends the requests to https://{{ise_hostname}}:{{port}}, where the port value depends on the Service used (ERS, Mnt, UI, PxGrid).
ise_verify boolean	Choices: no yes ←	Flag to enable or disable SSL certificate verification.
ise_version string	Default: "3.1.0"	Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit boolean	Choices: no yes ←	Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
notificationEnabled boolean	Choices: no yes	Indicates if the email notification service is to be enabled.
password string		Password of Secure SMTP server.
smtpPort string		Port at which SMTP Secure Server is listening.
smtpServer string		The SMTP server ip address or fqdn such as outbound.mycompany.com.
useDefaultFromAddress boolean	Choices: no yes	If the default from address should be used rather than using a sponsor user email address.
usePasswordAuthentication boolean	Choices: no yes	If configured to true, SMTP server authentication will happen using username/password.
userName string		Username of Secure SMTP server.
useTLSorSSLEncryption boolean	Choices: no yes	If configured to true, SMTP server authentication will happen using TLS/SSL.

Notes

Note

• Does not support check_mode

See Also

See also

Guest Smtp Notification Settings reference

Complete reference of the Guest Smtp Notification Settings object model.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
ise_response dictionary	always	A dictionary or list with the response returned by the Cisco ISE Python SDK Sample: { "id": "string", "smtpServer": "string", "notificationEnabled": true, "useDefaultFromAddress": true, "defaultFromAddress": "string", "smtpPort": "string", "connectionTimeout": "string", "useTLSorSSLEncryption": true, "usePasswordAuthentication": true, "userName": "string", "password": "string", "link": { "rel": "string", "href": "string", "type": "string" } }
ise_update_response dictionary added in 1.1.0 of cisco.ise	always	A dictionary or list with the response returned by the Cisco ISE Python SDK Sample: { "UpdatedFieldsList": { "updatedField": { "field": "string", "oldValue": "string", "newValue": "string" }, "field": "string", "oldValue": "string", "newValue": "string" } }

Authors

• Rafael Campos (@racampos)