nxos_telemetry – Telemetry Monitoring Service (TMS) configuration
New in version 2.9.
Synopsis
- Manages Telemetry Monitoring Service (TMS) configuration
Parameters
Parameter | Choices/Defaults | Comments | |||
---|---|---|---|---|---|
config
dictionary
|
The provided configuration
|
||||
certificate
dictionary
|
Certificate SSL/TLS and hostname values.
Value must be a dict defining values for keys (key and hostname).
|
||||
hostname
string
|
Certificate hostname
|
||||
key
string
|
Certificate key
|
||||
compression
string
|
|
Destination profile compression method.
|
|||
destination_groups
list
|
List of telemetry destination groups.
|
||||
destination
dictionary
|
Group destination ipv4, port, protocol and encoding values.
Value must be a dict defining values for keys (ip, port, protocol, encoding).
|
||||
encoding
string
|
|
Destination group encoding.
|
|||
ip
string
|
Destination group IP address.
|
||||
port
integer
|
Destination group port number.
|
||||
protocol
string
|
|
Destination group protocol.
|
|||
id
integer
|
Destination group identifier.
Value must be a int representing the destination group identifier.
|
||||
sensor_groups
list
|
List of telemetry sensor groups.
|
||||
data_source
string
|
|
Telemetry data source.
|
|||
id
integer
|
Sensor group identifier.
Value must be a int representing the sensor group identifier.
|
||||
path
dictionary
|
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)
|
||||
depth
string
|
Sensor group depth.
|
||||
filter_condition
string
|
Sensor group filter condition.
|
||||
name
string
|
Sensor group path name.
|
||||
query_condition
string
|
Sensor group query condition.
|
||||
source_interface
string
|
Destination profile source interface.
Valid value is a str representing the source interface name.
|
||||
subscriptions
list
|
List of telemetry subscriptions.
|
||||
destination_group
integer
|
Associated destination group.
|
||||
id
integer
|
Subscription identifier.
Value must be a int representing the subscription identifier.
|
||||
sensor_group
dictionary
|
Associated sensor group.
Value must be a dict defining values for keys (id, sample_interval).
|
||||
id
integer
|
Associated sensor group id.
|
||||
sample_interval
integer
|
Associated sensor group id sample interval.
|
||||
vrf
string
|
Destination profile vrf.
Valid value is a str representing the vrf name.
|
||||
state
string
|
|
Final configuration state
|
Notes
Note
- Supported on N9k Version 7.0(3)I7(5) and later.
Examples
# 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
after
dictionary
|
when changed |
The configuration as structured data after module completion.
Sample:
The configuration returned will always be in the same format of the parameters above.
|
before
dictionary
|
always |
The configuration as structured data prior to module invocation.
Sample:
The configuration returned will always be in the same format of the parameters above.
|
commands
list
|
always |
The set of commands pushed to the remote device.
Sample:
['command 1', 'command 2', 'command 3']
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]
Red Hat Support
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Authors
- Mike Wiebe (@mikewiebe)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 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