Skip to content

Commit

Permalink
Update check.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lvangink authored Sep 27, 2023
1 parent b7c0d08 commit 1851022
Showing 1 changed file with 1 addition and 11 deletions.
12 changes: 1 addition & 11 deletions docs/check.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This file tells the pipeline to run the following command on your hq_pop router:
show flow exporter
```

You want to provide the destination address, destination port, and transport protocol of your ELK stack host. If you didn't take note of your telemetry host when setting up your environment, you can open your CML prod topology and console into the host to get the IP.
You want to provide the destination address of your ELK stack host. If you didn't take note of your telemetry host when setting up your environment, you can open your CML prod topology and console into the host to get the IP.

Here is an example:

Expand All @@ -45,12 +45,8 @@ mdd_checks:
check_vars:
exporter_name: NetFlow-To-Collector
destination_address: 192.133.185.152
destination_port: 2055
transport_protocol: UDP
```

Filebeat is listening on UDP port 2055 by default.

## Schema File

Once pyATS runs the commands on the specefied host, it will send the output back. Open up the schema files under schema/pyats to see our expected output.
Expand All @@ -71,12 +67,6 @@ properties:
destination_ip_address:
type: string
enum: {{ check_vars.destination_address }}
destination_port:
type: integer
const: {{ check_vars.destination_port }}
transport_protocol:
type: string
const: {{ check_vars.transport_protocol }}
```
In this schema, the output needs to match the format with the variables defined in your check file.

Expand Down

0 comments on commit 1851022

Please sign in to comment.