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

Примечание

Этот плагин является частью коллекции cisco.nxos (версия 1.3.1).

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

Для использования в playbook укажите: cisco.nxos.nxos_telemetry.

Новое в версии 1.0.0: из cisco.nxos

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

Обзор

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

Примечание

Этот модуль имеет соответствующий плагин действий.

Параметры

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

Примечания

Примечание

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

Примеры

# 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: 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
  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: gPRC
          encoding: GPB
      subscriptions:
      - id: 5
        destination_group: 55
    state: replaced

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

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

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

Авторы

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