kaytus.ksmanage.edit_smtp 模块 – 设置 SMTP 信息

注意

此模块是 kaytus.ksmanage 集合(版本 2.0.0)的一部分。

如果您正在使用 ansible 包,您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install kaytus.ksmanage。您需要其他要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:kaytus.ksmanage.edit_smtp

kaytus.ksmanage 1.0.0 中的新增功能

概要

  • 在 kaytus 服务器上设置 SMTP 信息。

  • 只有 M5 型号支持此功能。

要求

执行此模块的主机需要满足以下要求。

  • Python 3.7+

  • inManage

参数

参数

注释

email

字符串

发件人电子邮件。

host

字符串

指定用于通过指定传输连接到远程设备的 DNS 主机名或地址。主机的值用作传输的目标地址。

interface

字符串 / 必需

LAN 通道,eth0 是共享的,eth1 是专用的。

选择

  • "eth0"

  • "eth1"

  • "bond0"

password

字符串

指定用于验证与远程设备连接的密码。如果任务中未指定该值,则将使用环境变量 ANSIBLE_NET_PASSWORD 的值。

primary_auth

字符串

主 SMTP 服务器身份验证。

选择

  • "enable"

  • "disable"

primary_ip

字符串

主 SMTP 服务器 IP。

primary_name

字符串

主 SMTP 服务器名称。

primary_password

字符串

主 SMTP 服务器密码,长度为 4 到 64 位,不能包含“ ”(空格)。

primary_auth=enable 时是必需的。

primary_port

整数

主 SMTP 服务器端口,用于重试次数配置的标识 (1-65535)。

primary_status

字符串

主 SMTP 支持。

选择

  • "enable"

  • "disable"

primary_username

字符串

主 SMTP 服务器用户名,长度为 4 到 64 位。

必须以字母开头,并且不能包含“,”(逗号)“:”(冒号)“ ”(空格)“;”(分号)“\”(反斜杠)。

provider

字典

包含连接详细信息的 dict 对象。

host

字符串

指定用于通过指定传输连接到远程设备的 DNS 主机名或地址。主机的值用作传输的目标地址。

password

字符串

指定用于验证与远程设备连接的密码。如果任务中未指定该值,则将使用环境变量 ANSIBLE_NET_PASSWORD 的值。

username

字符串

配置用于验证与远程设备连接的用户名。如果任务中未指定该值,则将使用环境变量 ANSIBLE_NET_USERNAME 的值。

secondary_auth

字符串

辅助 SMTP 服务器身份验证。

选择

  • "enable"

  • "disable"

secondary_ip

字符串

辅助 SMTP 服务器 IP。

secondary_name

字符串

辅助 SMTP 服务器名称。

secondary_password

字符串

辅助 SMTP 服务器密码,长度为 4 到 64 位,不能包含“ ”(空格)。

secondary_auth=enable 时是必需的。

secondary_port

整数

辅助 SMTP 服务器端口,用于重试次数配置的标识 (1-65535)。

secondary_status

字符串

辅助 SMTP 支持。

选择

  • "enable"

  • "disable"

secondary_username

字符串

辅助 SMTP 服务器用户名,长度为 4 到 64 位。

必须以字母开头,并且不能包含“,”(逗号)“:”(冒号)“ ”(空格)“;”(分号)“\”(反斜杠)。

username

字符串

配置用于验证与远程设备连接的用户名。如果任务中未指定该值,则将使用环境变量 ANSIBLE_NET_USERNAME 的值。

注意

注意

  • 不支持 check_mode

示例

- name: Smtp 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 information"
    kaytus.ksmanage.edit_smtp:
      interface: "eth0"
      email: "[email protected]"
      primary_status: "enable"
      primary_ip: "100.2.2.2"
      primary_name: "test"
      primary_auth: "disable"
      provider: "{{ ksmanage }}"

  - name: "Set smtp information"
    kaytus.ksmanage.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: "{{ ksmanage }}"

返回值

通用返回值记录在 此处,以下是此模块特有的字段

描述

changed

布尔值

检查设备是否进行了更改。

返回值:总是

message

字符串

模块执行后返回的消息。

返回值:总是

state

字符串

模块执行后的状态。

返回值:总是

作者

  • WangBaoshan (@ieisystem)