Spec-Zone.ru › Ansible

Модуль wti.remote.cpm_serial_port_config — настройка параметров последовательного порта на устройствах WTI OOB и PDU

Примечание

Этот модуль входит в коллекцию wti.remote (версия 1.0.11).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install wti.remote.

Чтобы использовать её в плейбуке, укажите: wti.remote.cpm_serial_port_config.

Добавлено в wti.remote 2.9.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Настройка параметров последовательного порта на устройствах WTI OOB и PDU

Параметры

Параметр

Описание

baud

integer

Скорость передачи данных, назначаемая порту.

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

boolean

Разрешена ли передача символа break через порт: 0=выкл., 1=вкл.

Допустимые значения:

  • false
  • true

cmd

integer

Режим администрирования, назначаемый порту: 0=запретить, 1=разрешить.

Допустимые значения:

  • 0
  • 1

cpm_password

string / обязательный

Пароль устройства WTI, на которое отправляется модуль.

cpm_url

string / обязательный

URL устройства WTI, на которое отправляется модуль.

cpm_username

string / обязательный

Имя пользователя устройства WTI, на которое отправляется модуль.

echo

boolean

- Параметр эха команд, назначаемый порту: 0=выкл., 1=вкл.

Допустимые значения:

  • false
  • true

handshake

integer

Рукопожатие, назначаемое порту: 0=нет, 1=XON/XOFF, 2=RTS/CTS, 3=оба варианта.

Допустимые значения:

  • 0
  • 1
  • 2
  • 3

logoff

string

Символ выхода из системы, назначаемый порту.

Если перед ним стоит символ ^, последовательность будет управляющим символом. Используется, если для seq задано значение 0 или 1.

mode

integer

Режим порта: 0=Any-to-Any, 1=пассивный, 2=буферизация, 3=модем, 4=ModemPPP.

Допустимые значения:

  • 0
  • 1
  • 2
  • 3
  • 4

parity

integer

Проверка чётности, назначаемая порту: 0=7 бит, без проверки, 1=7 бит, чётность, 2=7 бит, нечётность, 3=8 бит, без проверки, 4=8 бит, чётность, 5=8 бит, нечётность.

Допустимые значения:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5

port

integer / обязательный

Номер порта, для которого выполняется действие.

portname

string

Отображаемое имя порта.

seq

integer

Тип последовательности отключения, назначаемый порту: 1=три символа (до и после), 2=только один символ, 3=выкл.

Допустимые значения:

  • 1
  • 2
  • 3

stopbits

integer

Количество стоповых битов, назначаемое порту: 1=1 стоповый бит, 2=2 стоповых бита.

Допустимые значения:

  • 1
  • 2

tout

integer

Тайм-аут активности порта: 0=выкл., 1=5 мин, 2=15 мин, 3=30 мин, 4=90 мин, 5=1 мин.

Допустимые значения:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5

use_https

boolean

Определяет, использовать ли подключение HTTPS или HTTP.

Допустимые значения:

  • false
  • true ← (по умолчанию)

use_proxy

boolean

Определяет, будет ли поиск учитывать переменные среды HTTP-прокси, если они заданы.

Допустимые значения:

  • false ← (по умолчанию)
  • true

validate_certs

boolean

Если задано значение false, SSL-сертификаты не будут проверяться. Используйте этот параметр только

на сайтах под личным контролем, использующих самоподписанные сертификаты.

Допустимые значения:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Используйте groups/cpm в module_defaults, чтобы задавать общие параметры для модулей 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"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

data

string

Выходные данные JSON, возвращённые командами

Возвращается: всегда

Авторы

  • Western Telematic Inc. (@wtinetworkgear)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/wti/remote/cpm_serial_port_config_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API