You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

inspur.ispim.edit_smtp_dest module – Set SMTP information

Note

This module is part of the inspur.ispim collection (version 1.2.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 inspur.ispim. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: inspur.ispim.edit_smtp_dest.

New in inspur.ispim 1.0.0

Synopsis

• Set SMTP dest information on Inspur server.

• Only the M6 models support this feature.

Requirements

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

• Python 3.7+

• inspursmsdk

Parameters

Parameter	Comments
address string	Email address.
description string	Description information.
host string	Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
id integer / required	Email destination id. Choices: 1 2 3 4
password string	Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
provider dictionary	A dict object containing connection details.
host string	Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
password string	Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
username string	Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
status string	Email enable. Choices: "enable" "disable"
username string	Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

Notes

Note

• Does not support check_mode.

Examples

- name: Smtp  dest test
  hosts: ism
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set smtp dest information"
    inspur.ispim.edit_smtp_dest:
      id: 1
      status: "disable"
      provider: "{{ ism }}"

  - name: "Set smtp dest information"
    inspur.ispim.edit_smtp_dest:
      id: 1
      status: "enable"
      address: "100.2.2.2"
      description": "test"
      provider: "{{ ism }}"

Return Values

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

Key	Description
changed boolean	Check to see if a change was made on the device. Returned: always
message string	Messages returned after module execution. Returned: always
state string	Status after module execution. Returned: always

Authors

• WangBaoshan (@ispim)

Collection links

Issue Tracker Repository (Sources)