kaytus.ksmanage.edit_smtp_com module – Set SMTP information

Note

This module is part of the kaytus.ksmanage collection (version 1.2.2).

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 kaytus.ksmanage. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: kaytus.ksmanage.edit_smtp_com.

New in kaytus.ksmanage 1.0.0

Synopsis

  • Set SMTP com information on kaytus Server.

  • Only the M6 models support this feature.

Requirements

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

  • Python 3.7+

  • inManage

Parameters

Parameter

Comments

asset_tag

string

Product asset label.

Choices:

  • "enable"

  • "disable"

email

string

Sender email.

event_level

string

Events above this level will be sent.

Choices:

  • "Info"

  • "Warning"

  • "Critical"

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.

host_name

string

Server name.

Choices:

  • "enable"

  • "disable"

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.

serial_number

string

Serial number.

Choices:

  • "enable"

  • "disable"

server_auth

string

SMTP server authentication.

Choices:

  • "enable"

  • "disable"

server_ip

string

SMTP server IP.

server_password

string

SMTP server Password, length be 4 to 64 bits, cannot contain ‘ ‘(space).

Required when server_auth=enable.

server_port

integer

SMTP server port, The Identification for retry count configuration(1-65535).

server_secure_port

integer

SMTP server secure port, The Identification for retry count configuration(1-65535).

server_username

string

SMTP server Username, length be 4 to 64 bits.

Must start with letters and cannot contain ‘,’(comma) ‘:’(colon) ‘ ‘(space) ‘;’(semicolon) ‘\’(backslash).

Required when server_auth=enable.

ssl_tls_enable

string

SMTP SSLTLS Enable.

ssl_tls_enable=disable, when star_tls_enable=enable.

Choices:

  • "enable"

  • "disable"

star_tls_enable

string

SMTP STARTTLS Enable.

star_tls_enable=disable, when ssl_tls_enable=enable.

Choices:

  • "enable"

  • "disable"

status

string / required

SMTP Support.

Choices:

  • "enable"

  • "disable"

subject

string

Email theme.

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 com test
  hosts: ksmanage
  no_log: true
  connection: local
  gather_facts: false
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set smtp com information"
    kaytus.ksmanage.edit_smtp_com:
      status: "disable"
      provider: "{{ ksmanage }}"

  - name: "Set smtp com information"
    kaytus.ksmanage.edit_smtp_com:
      status: "enable"
      server_ip: "100.2.2.2"
      email: "[email protected]"
      server_auth: "enable"
      server_username: "admin"
      server_password: "1234qwer!@#$"
      provider: "{{ ksmanage }}"

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)