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

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 11.2.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 словарь	Предоставленная конфигурация
certificate словарь	Значения SSL/TLS-сертификата и имени узла. Значение должно быть словарём, задающим значения для ключей (key и hostname).
hostname строка	Имя узла сертификата
key строка	Ключ сертификата
compression строка	Метод сжатия профиля назначения. Варианты: `"gzip"`
destination_groups список / элементы=любые	Список групп назначения телеметрии.
destination словарь	Значения IPv4-адреса, порта, протокола и кодировки назначения группы. Значение должно быть словарём, задающим значения для ключей (ip, port, protocol, encoding).
encoding строка	Кодировка группы назначения. Варианты: `"GPB"` `"JSON"`
ip строка	IP-адрес группы назначения.
port целое число	Номер порта группы назначения.
protocol строка	Протокол группы назначения. Варианты: `"HTTP"` `"TCP"` `"UDP"` `"gRPC"`
id строка	Идентификатор группы назначения. Значение должно быть целым числом или строкой, представляющей идентификатор группы назначения.
sensor_groups список / элементы=любые	Список групп датчиков телеметрии.
data_source строка	Источник данных телеметрии. Варианты: `"NX-API"` `"DME"` `"YANG"`
id строка	Идентификатор группы датчиков. Значение должно быть целым числом или строкой, представляющей идентификатор группы датчиков.
path словарь	Путь датчика телеметрии. Значение должно быть словарём, задающим значения для ключей (name, depth, filter_condition, query_condition). Обязательные ключи (name) Необязательные ключи (depth, filter_condition, query_condition)
depth строка	Глубина группы датчиков.
filter_condition строка	Условие фильтрации группы датчиков.
name строка	Имя пути группы датчиков.
query_condition строка	Условие запроса группы датчиков.
source_interface строка	Исходный интерфейс профиля назначения. Допустимое значение — строка, представляющая имя исходного интерфейса.
subscriptions список / элементы=любые	Список подписок телеметрии.
destination_group строка	Связанная группа назначения.
id строка	Идентификатор подписки. Значение должно быть целым числом или строкой, представляющей идентификатор подписки.
sensor_group словарь	Связанная группа датчиков. Значение должно быть словарём, задающим значения для ключей (id, sample_interval).
id строка	Идентификатор связанной группы датчиков.
sample_interval целое число	Интервал выборки для идентификатора связанной группы датчиков.
vrf строка	VRF профиля назначения. Допустимое значение — строка, представляющая имя VRF.
state строка	Итоговое состояние конфигурации Варианты: `"merged"` ← (по умолчанию) `"replaced"` `"deleted"` `"gathered"` `"overridden"`

Примечания

Примечание

Поддерживается в 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: Replace 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

# Using overridden
# This action will override all 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: overridden

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

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

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

Авторы

Mike Wiebe (@mikewiebe)

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

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