nxos_telemetry – Настройка службы мониторинга телеметрии (TMS)

Новая в версии 2.9.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

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

Параметры

Параметр				Варианты/Значения по умолчанию	Комментарии
config словарь					Предоставленная конфигурация
	certificate словарь				Значения сертификата SSL/TLS и хоста. Значение должно быть словарем, определяющим значения для ключей (key и hostname).
		hostname строка			Имя хоста сертификата
		key строка			Ключ сертификата
	compression строка			Варианты: gzip	Метод сжатия профиля назначения.
	destination_groups список				Список групп назначения телеметрии.
		destination словарь			Значения IP-адреса, порта, протокола и кодировки назначения группы. Значение должно быть словарем, определяющим значения для ключей (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 строка				Варианты: объединённый ← заменён удалён	Конечное состояние конфигурации

Примечания

Примечание

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

Примеры

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

- name: Delete Telemetry Configuration
  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
  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: gPRC
            encoding: GPB
        - id: 55
          destination:
            ip: 192.168.0.55
            port: 60001
            protocol: gPRC
            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
  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: gPRC
            encoding: GPB
      subscriptions:
        - id: 5
          destination_group: 55
    state: replaced

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

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

Ключ	Возвращаемое значение	Описание
after словарь	при изменении	Конфигурация в виде структурированных данных после завершения модуля. Пример: Возвращаемая конфигурация всегда будет иметь тот же формат, что и параметры выше.
before словарь	всегда	Конфигурация в виде структурированных данных до вызова модуля. Пример: Возвращаемая конфигурация всегда будет иметь тот же формат, что и параметры выше.
commands список	всегда	Набор команд, отправленных на удаленное устройство. Пример: ['команда 1', 'команда 2', 'команда 3']

Статус

Этот модуль не гарантирует обратной совместимости. [превью]
Этот модуль поддерживается командой Ansible Network. [сеть]

Поддержка Red Hat

Дополнительная информация о поддержке этого модуля Red Hat доступна в этой статье базы знаний Red Hat.

Авторы

Mike Wiebe (@mikewiebe)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/nxos_telemetry_module.html