Модуль cisco.nxos.nxos_telemetry – Модуль ресурса TELEMETRY

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 8.1.0).

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

Для установки используйте: ansible-galaxy collection install cisco.nxos.

Чтобы использовать её в книге задач, укажите: cisco.nxos.nxos_telemetry.

Новинка в cisco.nxos 1.0.0

Описание
Параметры
Примечания
Примеры
Значения возврата

Описание

Управляет конфигурацией службы мониторинга телеметрии (TMS)

Псевдонимы: telemetry

Параметры

Параметр	Комментарии
config dictionary	Предоставленная конфигурация
certificate dictionary	Значения сертификата SSL/TLS и имени хоста. Значение должно быть словарем, определяющим значения для ключей (ключ и имя хоста).
hostname string	Имя хоста сертификата
key string	Ключ сертификата
compression string	Метод сжатия профиля назначения. Варианты: `"gzip"`
destination_groups list / elements=any	Список групп назначений телеметрии.
destination dictionary	Значения группы назначения ipv4, порт, протокол и кодировка. Значение должно быть словарем, определяющим значения для ключей (ip, port, protocol, encoding).
encoding string	Кодировка группы назначения. Варианты: `"GPB"` `"JSON"`
ip string	IP-адрес группы назначения.
port integer	Номер порта группы назначения.
protocol string	Протокол группы назначения. Варианты: `"HTTP"` `"TCP"` `"UDP"` `"gRPC"`
id string	Идентификатор группы назначения. Значение должно быть целым числом или строкой, представляющей идентификатор группы назначения.
sensor_groups list / elements=any	Список групп датчиков телеметрии.
data_source string	Источник данных телеметрии. Варианты: `"NX-API"` `"DME"` `"YANG"`
id string	Идентификатор группы датчиков. Значение должно быть целым числом или строкой, представляющей идентификатор группы датчиков.
path dictionary	Путь датчика телеметрии. Значение должно быть словарем, определяющим значения для ключей (name, depth, filter_condition, query_condition). Обязательные ключи (name) Необязательные ключи (depth, filter_condition, query_condition)
depth string	Глубина группы датчиков.
filter_condition string	Условие фильтра группы датчиков.
name string	Имя пути группы датчиков.
query_condition string	Условие запроса группы датчиков.
source_interface string	Исходный интерфейс профиля назначения. Допустимое значение - строка, представляющая имя исходного интерфейса.
subscriptions list / elements=any	Список подписок на телеметрию.
destination_group string	Связанная группа назначения.
id string	Идентификатор подписки. Значение должно быть целым числом или строкой, представляющей идентификатор подписки.

sensor_group dictionary	Связанная группа датчиков. Значение должно быть словарем, определяющим значения для ключей (id, sample_interval).
id string	Идентификатор связанной группы датчиков.
sample_interval integer	Интервал выборки для идентификатора связанной группы датчиков.
vrf string	VRF профиля назначения. Допустимое значение — строка, представляющая имя vrf.
state string	Конечное состояние конфигурации Варианты: `"merged"` ← (по умолчанию) `"replaced"` `"deleted"` `"gathered"`

Примечания

Примечание

Поддерживается в версии N9k 7.0(3)I7(5) и более поздних.
Не поддерживается для Cisco MDS

Примеры

# Using deleted
# This action will delete all telemetry configuration on the device

- name: Delete Telemetry Configuration
  cisco.nxos.nxos_telemetry:
    state: deleted


# Using merged
# This action will merge telemetry configuration defined in the playbook with
# telemetry configuration that is already on the device.

- name: Merge Telemetry Configuration
  cisco.nxos.nxos_telemetry:
    config:
      certificate:
        key: /bootflash/server.key
        hostname: localhost
      compression: gzip
      source_interface: Ethernet1/1
      vrf: management
      destination_groups:
        - id: 2
          destination:
            ip: 192.168.0.2
            port: 50001
            protocol: gRPC
            encoding: GPB
        - id: 55
          destination:
            ip: 192.168.0.55
            port: 60001
            protocol: gRPC
            encoding: GPB
      sensor_groups:
        - id: 1
          data_source: NX-API
          path:
            name: '"show lldp neighbors detail"'
            depth: 0
        - id: 55
          data_source: DME
          path:
            name: sys/ch
            depth: unbounded
            filter_condition: ne(eqptFt.operSt,"ok")
      subscriptions:
        - id: 5
          destination_group: 55
          sensor_group:
            id: 1
            sample_interval: 1000
        - id: 6
          destination_group: 2
          sensor_group:
            id: 55
            sample_interval: 2000
    state: merged


# Using replaced
# This action will replace telemetry configuration on the device with the
# telemetry configuration defined in the playbook.

- name: Override Telemetry Configuration
  cisco.nxos.nxos_telemetry:
    config:
      certificate:
        key: /bootflash/server.key
        hostname: localhost
      compression: gzip
      source_interface: Ethernet1/1
      vrf: management
      destination_groups:
        - id: 2
          destination:
            ip: 192.168.0.2
            port: 50001
            protocol: gRPC
            encoding: GPB
      subscriptions:
        - id: 5
          destination_group: 55
    state: replaced

Значения возврата

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

Ключ	Описание
after dictionary	Конфигурация в формате структурированных данных после завершения модуля. Возвращается: при изменении Пример: `"The configuration returned will always be in the same format\n of the parameters above.\n"`
before dictionary	Конфигурация в формате структурированных данных до вызова модуля. Возвращается: всегда Пример: `"The configuration returned will always be in the same format\n of the parameters above.\n"`
commands list / elements=string	Набор команд, отправленных на удалённое устройство. Возвращается: всегда Пример: `["command 1", "command 2", "command 3"]`

Авторы

Mike Wiebe (@mikewiebe)

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

© 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/cisco/nxos/nxos_telemetry_module.html