Модуль wti.remote.cpm_syslog_client_config – Настройка параметров клиента SYSLOG в устройствах 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_syslog_client_config.

Новое в wti.remote 2.11.0

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

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

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

Параметры

Параметр	Комментарии
address список / элементы=строка	Устанавливает IP-адрес сервера SYSLOG для связи.
clear целое число	Удаляет все записи IP-блоков для определяемого протокола перед установкой новых записей. Варианты: `0` `1`
cpm_password строка / обязательно	Это пароль устройства WTI для отправки модуля.
cpm_url строка / обязательно	Это URL-адрес устройства WTI для отправки модуля.
cpm_username строка / обязательно	Это имя пользователя устройства WTI для отправки модуля.
index список / элементы=целое число	Индекс изменяемого IP-блока.
port список / элементы=целое число	Определяет номер порта, используемый клиентом SYSLOG (1–65535).
protocol целое число	Протокол, к которому должна применяться запись SYSLOG. 0 = ipv4, 1 = ipv6. Варианты: `0` `1`
secure список / элементы=целое число	Определяет, используется ли безопасное соединение клиентом SYSLOG (требуется транспорт TCP).
transport список / элементы=целое число	Определяет тип протокола передачи, используемый клиентом SYSLOG. 0=UDP, 1=TCP;
use_https логическое	Обозначает использование HTTPS-соединения или HTTP-соединения. Варианты: `false` `true` ← (по умолчанию)
use_proxy логическое	Флаг для управления тем, будет ли поиск учитывать переменные окружения HTTP-прокси при их наличии. Варианты: `false` ← (по умолчанию) `true`
validate_certs логическое	Если 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_iptables_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_iptables_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 сложный	Выходной JSON, возвращаемый отправленными командами Возвращается: всегда
syslogclient словарь	Текущие пары ключ/значение информации об интерфейсе для устройства 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

сложный

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

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

syslogclient

словарь

Текущие пары ключ/значение информации об интерфейсе для устройства 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/wti/remote/cpm_syslog_client_config_module.html