inspur.sm.edit_smtp – Set SMTP information.

Note

This plugin is part of the inspur.sm collection (version 1.3.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.sm.

To use it in a playbook, specify: inspur.sm.edit_smtp.

New in version 0.1.0: of inspur.sm

Synopsis

  • Set SMTP information on Inspur server.
  • Only the M5 models support this feature.

Parameters

Parameter Choices/Defaults Comments
email
string
Sender email.
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.
interface
string / required
    Choices:
  • eth0
  • eth1
  • bond0
LAN Channel,eth0 is shared,eth1 is dedicated.
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.
primary_auth
string
    Choices:
  • enable
  • disable
Primary SMTP server authentication.
primary_ip
string
Primary SMTP server IP.
primary_name
string
Primary SMTP server name.
primary_password
string
Primary SMTP server Password,lenth be 4 to 64 bits,cannot contain ' '(space).
Required when primary_auth=enable.
primary_port
integer
Primary SMTP server port,The Identification for retry count configuration(1-65535).
primary_status
string
    Choices:
  • enable
  • disable
Primary SMTP Support.
primary_username
string
Primary SMTP server Username,lenth be 4 to 64 bits,
must start with letters and cannot contain ','(comma) ':'(colon) ' '(space) ';'(semicolon) '\'(backslash).
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.
secondary_auth
string
    Choices:
  • enable
  • disable
S.econdary SMTP server authentication
secondary_ip
string
Secondary SMTP server IP.
secondary_name
string
Secondary SMTP server name.
secondary_password
string
Secondary SMTP server Password,lenth be 4 to 64 bits,cannot contain ' '(space).
Required when secondary_auth=enable.
secondary_port
integer
Secondary SMTP server port,The Identification for retry count configuration(1-65535).
secondary_status
string
    Choices:
  • enable
  • disable
Secondary SMTP Support.
secondary_username
string
Secondary SMTP server Username,lenth be 4 to 64 bits,
must start with letters and cannot contain ','(comma) ':'(colon) ' '(space) ';'(semicolon) '\'(backslash).
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.

Examples

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

  tasks:

  - name: "Set smtp information"
    inspur.sm.edit_smtp:
      interface: "eth0"
      email: "[email protected]"
      primary_status: "enable"
      primary_ip: "100.2.2.2"
      primary_name: "inspur"
      primary_auth: "disable"
      provider: "{{ ism }}"

  - name: "Set smtp information"
    inspur.sm.edit_smtp:
      interface: "eth0"
      email: "[email protected]"
      primary_status: "enable"
      primary_ip: "100.2.2.2"
      primary_name: "inspur"
      primary_auth: "enable"
      primary_username: "test"
      primary_password: my_password
      provider: "{{ ism }}"

Return Values

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

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


Authors

  • WangBaoshan (@ISIB-group)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/inspur/sm/edit_smtp_module.html