Skip to content

Commit

Permalink
Update faq.md (#168)
Browse files Browse the repository at this point in the history
* Update faq.md

Co-authored-by: Jeff Kala <48843785+jeffkala@users.noreply.github.com>
Co-authored-by: Stephen Kiely <stephenkiely87@gmail.com>
  • Loading branch information
3 people authored Sep 7, 2024
1 parent e9245bc commit a34220d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
1 change: 1 addition & 0 deletions changes/168.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Documentation for the Connectivity Check in the FAQ.
12 changes: 11 additions & 1 deletion docs/user/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,14 @@ PLUGINS_CONFIG = {
}
```

Once again, the wrong indentation will not work. This leads to errors one would not expect.
Once again, the wrong indentation will not work. This leads to errors one would not expect.

_How can I set the TCP Port that is used in the connectivity check?_

Nornir-Nautobot provides the ability to check the connectivity first via TCP, this port is set per OS driver and is generally port 22. However, you can adjust this yourself, and is partially described in the [nornir-nautobot docs](https://docs.nautobot.com/projects/nornir-nautobot/en/latest/task/task/#check-connectivity-configuration).

The docs indicate that there is 3 choices for check connectivity will send attempt to tcp ping the port based on the following order or precedence from most to least preferred.

- If there is a [Custom Field](https://docs.nautobot.com/projects/core/en/stable/user-guide/feature-guides/custom-fields/) called `tcp_port` that is an integer, prefer that.
- Next check if there is a [Config Context](https://docs.nautobot.com/projects/core/en/stable/user-guide/core-data-model/extras/configcontext/) key called `tcp_port` and if it is a valid integer, prefer that.
- Finally, there is default for each driver, which is generally port 22 which it will be defaulted to.

0 comments on commit a34220d

Please sign in to comment.