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

Note

This module is part of the cisco.ise collection (version 2.5.12).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.ise. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.ise 1.0.0

Synopsis

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

  • This API creates a guest SMTP notification configuration.

  • This API allows the client to update a SMTP configuration setting.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 2.0.8

  • python >= 3.5

Parameters

Parameter

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

Flag for Identity Services Engine SDK to enable debugging.

Choices:

  • false ← (default)

  • true

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 cisco.ise 1.1.0

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).

Choices:

  • false

  • true ← (default)

ise_uses_csrf_token

boolean

added in cisco.ise 3.0.0

Flag that informs the SDK whether we send the CSRF token to ISE’s ERS APIs.

If it is True, the SDK assumes that your ISE CSRF Check is enabled.

If it is True, it assumes you need the SDK to manage the CSRF token automatically for you.

Choices:

  • false ← (default)

  • true

ise_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

ise_version

string

Informs the SDK which version of Identity Services Engine to use.

Default: "3.1_Patch_1"

ise_wait_on_rate_limit

boolean

Flag for Identity Services Engine SDK to enable automatic rate-limit handling.

Choices:

  • false

  • true ← (default)

notificationEnabled

boolean

Indicates if the email notification service is to be enabled.

Choices:

  • false

  • true

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

If the default from address should be used rather than using a sponsor user email address.

Choices:

  • false

  • true

usePasswordAuthentication

boolean

If configured to true, SMTP server authentication will happen using username/password.

Choices:

  • false

  • true

userName

string

Username of Secure SMTP server.

useTLSorSSLEncryption

boolean

If configured to true, SMTP server authentication will happen using TLS/SSL.

Choices:

  • false

  • true

Notes

Note

  • SDK Method used are guest_smtp_notification_configuration.GuestSmtpNotificationConfiguration.create_guest_smtp_notification_settings, guest_smtp_notification_configuration.GuestSmtpNotificationConfiguration.update_guest_smtp_notification_settings_by_id,

  • Paths used are post /ers/config/guestsmtpnotificationsettings, put /ers/config/guestsmtpnotificationsettings/{id},

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco ISE SDK

  • The parameters starting with ise_ are used by the Cisco ISE Python SDK to establish the connection

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

Description

ise_response

dictionary

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: {"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

dictionary

added in cisco.ise 1.1.0

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: {"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}

Authors

  • Rafael Campos (@racampos)