wti.remote.cpm_serial_port_config 模块 – 在 WTI OOB 和 PDU 设备中设置串口参数

注意

此模块是 wti.remote 集合（版本 1.0.10）的一部分。

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

要安装它，请使用：ansible-galaxy collection install wti.remote。

要在 playbook 中使用它，请指定：wti.remote.cpm_serial_port_config。

wti.remote 2.9.0 中的新功能

概要

  • 在 WTI OOB 和 PDU 设备中设置串口参数

参数

参数

注释

baud

整数

这是要分配给端口的波特率。

0=300, 1=1200, 2=2400, 3=4800, 4=9600, 5=19200, 6=38400, 7=57600, 8=115200, 9=230400, 10=460800

选择

  • 0

  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

break_allow

布尔值

这是是否允许将中断字符传递通过端口，0=关闭，1=开启

选择

  • false

  • true

cmd

整数

这是要分配给端口的管理模式，0=拒绝，1=允许。

选择

  • 0

  • 1

cpm_password

字符串 / 必需

这是 WTI 设备的密码，用于发送模块。

cpm_url

字符串 / 必需

这是 WTI 设备的 URL，用于发送模块。

cpm_username

字符串 / 必需

这是 WTI 设备的用户名，用于发送模块。

echo

布尔值

-这是要分配给端口的命令回显参数，0=关闭，1=开启

选择

  • false

  • true

handshake

整数

这是要分配给端口的握手，0=无，1=XON/XOFF，2=RTS/CTS，3=两者。

选择

  • 0

  • 1

  • 2

  • 3

logoff

字符串

这是要分配给端口的注销字符

如果以 ^ 字符开头，则该序列将是控制字符。如果 seq 设置为 0 或 1，则使用

mode

整数

这是要分配给端口的端口模式，0=任意到任意。1=被动，2=缓冲，3=调制解调器，4=调制解调器PPP。

选择

  • 0

  • 1

  • 2

  • 3

  • 4

parity

整数

这是要分配给端口的奇偶校验，0=7-无，1=7-偶，2=7-奇，3=8-无，4=8-偶，5=8-奇。

选择

  • 0

  • 1

  • 2

  • 3

  • 4

  • 5

port

整数 / 必需

这是正在执行操作的端口号。

portname

字符串

这是显示的端口名称。

seq

整数

这是要分配给端口的序列断开连接类型，1=三个字符（之前和之后），2=仅一个字符，3=关闭

选择

  • 1

  • 2

  • 3

stopbits

整数

这是要分配给端口的停止位，1=1 个停止位，2=2 个停止位。

选择

  • 1

  • 2

tout

整数

这是要分配给端口的端口活动超时，0=关闭，1=5 分钟，2=15 分钟，3=30 分钟，4=90 分钟，5=1 分钟。

选择

  • 0

  • 1

  • 2

  • 3

  • 4

  • 5

use_https

布尔值

指定使用 https 连接还是 http 连接。

选择

  • false

  • true ← (默认)

use_proxy

布尔值

标志，用于控制在存在 HTTP 代理环境变量时，查找是否会观察它们。

选择

  • false ← (默认)

  • true

validate_certs

布尔值

如果为 false，则不会验证 SSL 证书。这应该仅用于

使用自签名证书的个人控制站点。

选择

  • false

  • true ← (默认)

备注

注意

  • 在 module_defaults 中使用 groups/cpm 来设置 CPM 模块之间使用的公共选项。

示例

# Set Serial Port Parameters
- name: Set the Port Parameters for port 2 of a WTI device
  cpm_serial_port_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    port: "2"
    portname: "RouterLabel"
    baud: "7"
    handshake: "1"
    stopbits: "1"
    parity: "0"
    mode: "0"
    cmd: "0"
    seq: "1"
    tout: "1"
    echo: "0"
    break_allow: "0"
    logoff: "^H"

# Set Serial Port Port Name and Baud Rate Parameters
- name: Set New port name and baud rate (115k) for port 4 of a WTI device
  cpm_serial_port_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    port: "4"
    portname: "NewPortName1"
    baud: "8"

返回值

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

键

描述

数据

字符串

从发送的命令返回的输出 JSON

返回：始终

作者

  • Western Telematic Inc. (@wtinetworkgear)