ieisystem.inmanage.edit_smtp module – Set SMTP information

Note

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

To use it in a playbook, specify: ieisystem.inmanage.edit_smtp.

New in ieisystem.inmanage 1.0.0

Synopsis

  • Set SMTP information on ieisystem Server.

  • Only the M5 models support this feature.

Requirements

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

  • Python 3.7+

  • inManage

Parameters

Parameter

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

LAN Channel, eth0 is shared, eth1 is dedicated.

Choices:

  • "eth0"

  • "eth1"

  • "bond0"

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

Primary SMTP server authentication.

Choices:

  • "enable"

  • "disable"

primary_ip

string

Primary SMTP server IP.

primary_name

string

Primary SMTP server name.

primary_password

string

Primary SMTP server Password, length 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

Primary SMTP Support.

Choices:

  • "enable"

  • "disable"

primary_username

string

Primary SMTP server Username, length 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

Secondary SMTP server authentication.

Choices:

  • "enable"

  • "disable"

secondary_ip

string

Secondary SMTP server IP.

secondary_name

string

Secondary SMTP server name.

secondary_password

string

Secondary SMTP server Password, length 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

Secondary SMTP Support.

Choices:

  • "enable"

  • "disable"

secondary_username

string

Secondary SMTP server Username, length 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.

Notes

Note

  • Does not support check_mode.

Examples

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

  tasks:

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

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

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 (@ieisystem)