cisco.intersight.intersight_smtp_policy module – SMTP Policy configuration for Cisco Intersight

Note

This module is part of the cisco.intersight collection (version 2.18.0).

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

To use it in a playbook, specify: cisco.intersight.intersight_smtp_policy.

Synopsis
Parameters
Examples
Return Values

Synopsis

Manages SMTP Policy configuration on Cisco Intersight.
Configures SMTP settings for email notifications.
For more information see Cisco Intersight.

Parameters

Parameter	Comments
api_key_id string / required	Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used.
api_private_key path / required	Filename (absolute path) or string of PEM formatted private key data to be used for Intersight API authentication. If a string is used, Ansible vault should be used to encrypt string data. Ex. ansible-vault encrypt_string --vault-id tme@/Users/dsoper/Documents/vault_password_file ‘-----BEGIN EC PRIVATE KEY----- <your private key data> -----END EC PRIVATE KEY-----’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used.
api_uri string	URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used. Default: `"https://intersight.com/api/v1"`
description aliases: descr string	The user-defined description for the SMTP Policy. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_).
enabled boolean	If enabled, controls the state of the SMTP client service on the managed device. Choices: `false` `true` ← (default)
min_severity string	Minimum fault severity level to receive email notifications. Email notifications are sent for all faults whose severity is equal to or greater than the chosen level. Choices: `"critical"` ← (default) `"major"` `"minor"` `"warning"` `"condition"` `"condition"`
name string / required	The name assigned to the SMTP Policy. The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_.
organization string	The name of the Organization this resource is assigned to. Profiles, Policies, and Pools that are created within a Custom Organization are applicable only to devices in the same Organization. Default: `"default"`
sender_email string	The email address entered here will be displayed as the from address (mail received from address) of all the SMTP mail alerts that are received. If not configured, the hostname of the server is used in the from address field.
smtp_port integer	Port number used by the SMTP server for outgoing SMTP communication. Valid range is 1-65535. Default: `25`
smtp_recipients list / elements=string	List of email addresses that will receive notifications for faults.
smtp_server string	IP address or hostname of the SMTP server. The SMTP server is used by the managed device to send email notifications. Required when `enabled` is True.
state string	If `present`, will verify the resource is present and will create if needed. If `absent`, will verify the resource is absent and will delete if needed. Choices: `"present"` ← (default) `"absent"`
tags list / elements=dictionary	List of tags in Key:<user-defined key> Value:<user-defined value> format. Default: `[]`
use_proxy boolean	If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. Choices: `false` `true` ← (default)
validate_certs boolean	Boolean control for verifying the api_uri TLS certificate Choices: `false` `true` ← (default)

Examples

- name: Create SMTP Policy
  cisco.intersight.intersight_smtp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "smtp-policy-test"
    description: "SMTP Policy for Alerting"
    enabled: true
    smtp_server: "smtp.example.com"
    smtp_port: 25
    min_severity: "warning"
    sender_email: "alerts@example.com"
    smtp_recipients:
      - "admin@example.com"
      - "devops@example.com"
    tags:
      - Key: "Environment"
        Value: "Production"
    state: present

- name: Disable SMTP Policy
  cisco.intersight.intersight_smtp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "smtp-policy-test"
    enabled: false
    state: present

- name: Delete SMTP Policy
  cisco.intersight.intersight_smtp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "smtp-policy-test"
    state: absent

Return Values

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

Key	Description
api_response dictionary	The API response output returned by the specified resource. Returned: always Sample: `{"api_response": {"Description": "SMTP Policy for Alerting", "Enabled": true, "MinSeverity": "warning", "Name": "smtp-policy-test", "ObjectType": "smtp.Policy", "SenderEmail": "alerts@example.com", "SmtpPort": 25, "SmtpRecipients": ["admin@example.com", "devops@example.com"], "SmtpServer": "smtp.example.com", "Tags": [{"Key": "Environment", "Value": "Production"}]}}`

Key

Description

api_response

dictionary

The API response output returned by the specified resource.

Returned: always

Sample: {"api_response": {"Description": "SMTP Policy for Alerting", "Enabled": true, "MinSeverity": "warning", "Name": "smtp-policy-test", "ObjectType": "smtp.Policy", "SenderEmail": "alerts@example.com", "SmtpPort": 25, "SmtpRecipients": ["admin@example.com", "devops@example.com"], "SmtpServer": "smtp.example.com", "Tags": [{"Key": "Environment", "Value": "Production"}]}}

Authors

Ron Gershburg (@rgershbu)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/intersight/intersight_smtp_policy_module.html