cisco.nxos.nxos_telemetry (7.0.0) — module

Install collection

Install with ansible-galaxy collection install cisco.nxos:==7.0.0

Add to requirements.yml

  collections:
    - name: cisco.nxos
      version: 7.0.0

Description

Manages Telemetry Monitoring Service (TMS) configuration

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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

Inputs

    
state:
    choices:
    - merged
    - replaced
    - deleted
    - gathered
    default: merged
    description:
    - Final configuration state
    type: str

config:
    description: The provided configuration
    suboptions:
      certificate:
        description:
        - Certificate SSL/TLS and hostname values.
        - Value must be a dict defining values for keys (key and hostname).
        suboptions:
          hostname:
            description:
            - Certificate hostname
            type: str
          key:
            description:
            - Certificate key
            type: str
        type: dict
      compression:
        choices:
        - gzip
        description:
        - Destination profile compression method.
        type: str
      destination_groups:
        description:
        - List of telemetry destination groups.
        elements: raw
        suboptions:
          destination:
            description:
            - Group destination ipv4, port, protocol and encoding values.
            - Value must be a dict defining values for keys (ip, port, protocol, encoding).
            suboptions:
              encoding:
                choices:
                - GPB
                - JSON
                description:
                - Destination group encoding.
                type: str
              ip:
                description:
                - Destination group IP address.
                type: str
              port:
                description:
                - Destination group port number.
                type: int
              protocol:
                choices:
                - HTTP
                - TCP
                - UDP
                - gRPC
                description:
                - Destination group protocol.
                type: str
            type: dict
          id:
            description:
            - Destination group identifier.
            - Value must be an integer or string representing the destination group identifier.
            type: str
        type: list
      sensor_groups:
        description:
        - List of telemetry sensor groups.
        elements: raw
        suboptions:
          data_source:
            choices:
            - NX-API
            - DME
            - YANG
            description:
            - Telemetry data source.
            type: str
          id:
            description:
            - Sensor group identifier.
            - Value must be a integer or a string representing the sensor group identifier.
            type: str
          path:
            description:
            - Telemetry sensor path.
            - Value must be a dict defining values for keys (name, depth, filter_condition,
              query_condition).
            - Mandatory Keys (name)
            - Optional Keys  (depth, filter_condition, query_condition)
            suboptions:
              depth:
                description:
                - Sensor group depth.
                type: str
              filter_condition:
                description:
                - Sensor group filter condition.
                type: str
              name:
                description:
                - Sensor group path name.
                type: str
              query_condition:
                description:
                - Sensor group query condition.
                type: str
            type: dict
        type: list
      source_interface:
        description:
        - Destination profile source interface.
        - Valid value is a str representing the source interface name.
        type: str
      subscriptions:
        description:
        - List of telemetry subscriptions.
        elements: raw
        suboptions:
          destination_group:
            description:
            - Associated destination group.
            type: str
          id:
            description:
            - Subscription identifier.
            - Value must be an integer or string representing the subscription identifier.
            type: str
          sensor_group:
            description:
            - Associated sensor group.
            - Value must be a dict defining values for keys (id, sample_interval).
            suboptions:
              id:
                description:
                - Associated sensor group id.
                type: str
              sample_interval:
                description:
                - Associated sensor group id sample interval.
                type: int
            type: dict
        type: list
      vrf:
        description:
        - Destination profile vrf.
        - Valid value is a str representing the vrf name.
        type: str
    type: dict

Outputs

after:
  description: The configuration as structured data after module completion.
  returned: when changed
  sample: "The configuration returned will always be in the same format\n of the parameters\
    \ above.\n"
  type: dict
before:
  description: The configuration as structured data prior to module invocation.
  returned: always
  sample: "The configuration returned will always be in the same format\n of the parameters\
    \ above.\n"
  type: dict
commands:
  description: The set of commands pushed to the remote device.
  returned: always
  sample:
  - command 1
  - command 2
  - command 3
  type: list