intersight_smtp_policy

SMTP Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_smtp_policy

Synopsis

SMTP Policy configuration for Cisco Intersight

Parameters

Name	Type	Required	Default	Description
api_private_key	string			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—– —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. Required if I(api_bearer_token) is not provided. Secret value; omitted from logs and results.
api_uri	string		`https://intersight.com/api/v1`	URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used.
api_key_id	string			Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. Required if I(api_bearer_token) is not provided.
api_bearer_token	string			Bearer token for OAuth2 authentication with the Intersight API. When provided, I(api_key_id) and I(api_private_key) are not required and the C(cryptography) Python library is not needed. If not set, the value of the INTERSIGHT_API_BEARER_TOKEN environment variable is used. Secret value; omitted from logs and results.
validate_certs	bool		`true`	Boolean control for verifying the api_uri TLS certificate
use_proxy	bool		`true`	If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
state	string		`present`	If C(present), will verify the resource is present and will create if needed. If C(absent), will verify the resource is absent and will delete if needed. Choices: `present`, `absent`
organization	string		`default`	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.
name	string	yes		The name assigned to the SMTP Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	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(_).
tags	list		`[]`	List of tags in Key: Value: format.
enabled	bool		`true`	If enabled, controls the state of the SMTP client service on the managed device.
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 C(enabled) is True.
smtp_port	int		`25`	Port number used by the SMTP server for outgoing SMTP communication. Valid range is 1-65535.
min_severity	string		`critical`	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`, `major`, `minor`, `warning`, `condition`, `condition`
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_recipients	list			List of email addresses that will receive notifications for faults.

Example

yaml

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

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

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