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

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
address list / elements=string	Задаёт IP-адрес сервера SYSLOG, с которым необходимо установить соединение.
clear integer	Удаляет все записи IP-блоков для указанного протокола перед добавлением новых записей. Допустимые значения: `0` `1`
cpm_password string / обязательный	Пароль устройства WTI для отправки модуля.
cpm_url string / обязательный	URL устройства WTI для отправки модуля.
cpm_username string / обязательный	Имя пользователя устройства WTI для отправки модуля.
index list / elements=integer	Индекс изменяемого IP-блока.
port list / elements=integer	Задаёт номер порта, используемого клиентом SYSLOG (1–65535).
protocol integer	Протокол для записи SYSLOG. 0 = ipv4, 1 = ipv6. Допустимые значения: `0` `1`
secure list / elements=integer	Задаёт, использует ли клиент SYSLOG защищённое соединение (требуется транспорт TCP).
transport list / elements=integer	Задаёт тип протокола передачи данных, используемого клиентом SYSLOG. 0=UDP, 1=TCP;
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.

Примеры

# Sets the device SYSLOG Client Parameters
- name: Set the an SYSLOG Client Parameter for a WTI device
  cpm_syslog_client_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    protocol: 0
    index:
      - 1
    address:
      - "11.22.33.44"
    port:
      - 555
    transport:
      - 1
    secure:
      - 0

# Sets the device SYSLOG Client Parameters
- name: Set the SYSLOG Client Parameters a WTI device
  cpm_syslog_client_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    protocol: 0
    index:
      - 1
      - 2
    address:
      - "11.22.33.44"
      - "55.66.77.88"
    port:
      - 555
      - 557
    transport:
      - 1
      - 0
    secure:
      - 0
      - 1

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

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

Ключ	Описание
data complex	Выходные данные JSON, возвращаемые в ответ на отправленные команды Возвращается: всегда
syslogclient dictionary	Текущие пары ключ/значение с данными интерфейса устройства WTI после выполнения модуля. Возвращается: всегда Пример: {"syslogclient": {"ietf-ipv4": {"clients": [{"address": "", "index": "1", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "2", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "3", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "4", "port": "514", "secure": "0", "transport": "0"}]}, "ietf-ipv6": {"clients": [{"address": "", "index": "1", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "2", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "3", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "4", "port": "514", "secure": "0", "transport": "0"}]}}}

Ключ

Описание

data

complex

Выходные данные JSON, возвращаемые в ответ на отправленные команды

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

syslogclient

dictionary

Текущие пары ключ/значение с данными интерфейса устройства WTI после выполнения модуля.

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

Пример: {"syslogclient": {"ietf-ipv4": {"clients": [{"address": "", "index": "1", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "2", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "3", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "4", "port": "514", "secure": "0", "transport": "0"}]}, "ietf-ipv6": {"clients": [{"address": "", "index": "1", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "2", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "3", "port": "514", "secure": "0", "transport": "0"}, {"address": "", "index": "4", "port": "514", "secure": "0", "transport": "0"}]}}}

Авторы

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_syslog_client_config_module.html