Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions Website/docs/application/bit-calculator.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,27 @@ keywords: [NETworkManager, bit calculator, data unit converter, bits to bytes, b

# Bit Calculator

With the **Bit Calculator** different data units can be converted. Based on the input number and the selected unit the different units like bits, bytes, kilobits, kilobytes, megabits, megabytes, etc. are calculated.
With the **Bit Calculator** you can convert between different data units — enter a number and select the input unit to see the equivalent values in bits, bytes, kilobits, kilobytes, megabits, megabytes, and more.

![Bit Calculator](../img/bit-calculator.png)

In addition, further actions can be performed using the buttons at the bottom right:
### Toolbar

- **Export...** - Export the information to a CSV, XML or JSON file.
| Button | Description |
|--------|-------------|
| **Export...** | Exports the information to a CSV, XML, or JSON file |

:::note
### Context menu

Right-click on the result to copy the information.

:::
| Action | Description |
|--------|-------------|
| **Copy** | Copies the selected information to the clipboard |

## Settings

### Notation

Notation which should be used for the calculation.
Notation used for the calculation.

**Type:** `NETworkManager.Models.Network.BitCaluclatorNotation`

Expand Down
19 changes: 12 additions & 7 deletions Website/docs/application/connections.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
sidebar_position: 25
description: "View all active TCP and UDP connections with source and destination endpoints and associated processes. NETworkManager Connections works like an enhanced netstat."
keywords: [NETworkManager, connections, active connections, netstat, TCP connections, UDP connections, network connections]
description: "View all active TCP connections with source and destination endpoints and associated processes. NETworkManager Connections works like an enhanced netstat."
keywords: [NETworkManager, connections, active connections, netstat, TCP connections, network connections]
---

# Connections

In **Connections** you can see all connections with source and destination IP endpoint (IP address and port) and with the associated process that are currently running on your computer.
The **Connections** view shows all active **TCP** connections with their source and destination IP endpoints (IP address and port) and the associated process running on your computer.

:::info

Expand All @@ -16,10 +16,15 @@ The data shown is similar to the output of the `netstat` command.

![Connections](../img/connections.png)

:::note
### Context menu

With `F5` you can refresh the connections.
| Action | Description |
|--------|-------------|
| **Copy** | Copies the selected information to the clipboard |
| **Export...** | Exports the selected or all results to a file |

Right-click on the result to copy or export the information.
### Keyboard shortcuts

:::
| Key | Action |
|-----|--------|
| `F5` | Refresh |
28 changes: 17 additions & 11 deletions Website/docs/application/discovery-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,38 +6,44 @@ keywords: [NETworkManager, LLDP, CDP, discovery protocol, network discovery, swi

# Discovery Protocol

In **Discovery Protocol** you can capture for LLDP (Link Layer Discovery Protocol) and/or CDP (Cisco Discovery Protocol) frames to see to which switch or router your device is connected. The information such as device name, port, VLAN, etc. are displayed in a table.
With **Discovery Protocol** you can capture LLDP (Link Layer Discovery Protocol) and CDP (Cisco Discovery Protocol) frames to see which switch or router your device is connected to. Device name, port, VLAN, and other information are shown in labeled fields.

:::info

The Link Layer Discovery Protocol (LLDP) is a vendor-neutral Layer 2 network protocol used by network devices, especially switches, to advertise their identity, capabilities, and neighbors on an IEEE 802 Local Area Network (LAN). If configured, LLDP messages are sent out periodically as frames with the destination MAC address of `01:80:c2:00:00:0e`. The default time interval is 30 seconds.

The Cisco Discovery Protocol (CDP) is a proprietary Layer 2 protocol used by Cisco Systems to exchange information about network devices. If configured, CDP messages are sent out periodically as frames with the destination MAC address `01:00:0c:cc:cc`. The default time interval is 60 seconds.
The Cisco Discovery Protocol (CDP) is a proprietary Layer 2 protocol used by Cisco Systems to exchange information about network devices. If configured, CDP messages are sent out periodically as frames with the destination MAC address `01:00:0c:cc:cc:cc`. The default time interval is 60 seconds.

:::

:::warning

If you are using a hypervisor like Hyper-V with a virtual switch configured as "External network" which is shared with host where NETworkManager is running, you may not receive any packets. This is because the virtual switch does not forward the LLDP or CDP frames to the host. You may temporarily change the virtual switch to "Internal network" or "Private network", if you want to use the Discovery Protocol to see which switch or router your device is connected to. You can also verify this behavior by using Wireshark.
If you are using a hypervisor like Hyper-V with a virtual switch configured as "External network" which is shared with the host where NETworkManager is running, you may not receive any packets. This is because the virtual switch does not forward the LLDP or CDP frames to the host. You may temporarily change the virtual switch to "Internal network" or "Private network" if you want to use Discovery Protocol to see which switch or router your device is connected to. You can also verify this behavior by using Wireshark.

:::

:::note
:::warning[Administrator privileges required]

Capturing network packets requires administrator privileges. If the application is not running as administrator, capturing is not available. Use the **Restart as administrator** button to relaunch the application with elevated rights.
Without administrator privileges, capturing is not available. Use the **Restart as administrator** button to relaunch the application with elevated rights.

:::

![Discovery Protocol](../img/discovery-protocol.png)

In addition, further actions can be performed using the buttons at the bottom right:
### Toolbar

- **Export...** - Export the information to a CSV, XML or JSON file.
| Button | Description |
|--------|-------------|
| **Export...** | Exports the information to a CSV, XML, or JSON file |

:::note
### Context menu

With `F5` or `Enter` you can start capturing network packets.
| Action | Description |
|--------|-------------|
| **Copy** | Copies the selected information to the clipboard |

Right-click on the result to copy the information.
### Keyboard shortcuts

:::
| Key | Action |
|-----|--------|
| `F5` / `Enter` | Start capturing |
41 changes: 23 additions & 18 deletions Website/docs/application/firewall.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,34 +14,39 @@ Windows Firewall (Windows Defender Firewall) is a built-in host-based firewall i

:::

:::note

Adding, editing, enabling, disabling, or deleting firewall rules requires administrator privileges. If the application is not running as administrator, the view is in read-only mode. Use the **Restart as administrator** button to relaunch the application with elevated rights.
:::warning[Administrator privileges required]

Rules created by NETworkManager use the prefix `NETworkManager_` in their display name to distinguish them from system-managed or third-party rules. Only rules with this prefix are shown in the Firewall view.
Without administrator privileges, the view is read-only. Use the **Restart as administrator** button to relaunch the application with elevated rights.

:::

![Firewall](../img/firewall.png)

:::note

In addition, further actions can be performed using the buttons below:

- **Add rule...** - Opens a dialog to create a new firewall rule.
- **Windows Firewall Settings** - Opens the Windows Firewall management console (`WF.msc`).
### Toolbar

:::
| Button | Description |
|--------|-------------|
| **Add rule...** | Opens a dialog to create a new firewall rule |
| **Windows Firewall Settings** | Opens the Windows Firewall management console (`WF.msc`) |

:::note
### Context menu

With `F5` you can refresh the firewall rules.
| Action | Description |
|--------|-------------|
| **Enable** | Enables the selected rule |
| **Disable** | Disables the selected rule |
| **Edit** | Opens the edit dialog for the selected rule |
| **Delete** | Removes the selected rule |
| **Copy** | Copies the rule information to the clipboard |
| **Export** | Exports the rule to a file |

Right-click on a rule to `enable`, `disable`, `edit`, or `delete` it, or to `copy` or `export` the information.
### Keyboard shortcuts

You can also use the Hotkeys `F2` (`edit`) or `Del` (`delete`) on a selected rule.

:::
| Key | Action |
|-----|--------|
| `F5` | Refresh |
| `F2` | Edit selected rule |
| `Del` | Delete selected rule |

## Add rule

Expand Down Expand Up @@ -288,4 +293,4 @@ Network profiles the rule applies to. At least one profile must be selected.

The last enabled profile cannot be unchecked — at least one profile must remain selected.

:::
:::
2 changes: 0 additions & 2 deletions Website/docs/application/hosts-file-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ The application automatically creates a daily backup of the `hosts` file, retain

:::

## Actions

### Toolbar

| Button | Description |
Expand Down
26 changes: 15 additions & 11 deletions Website/docs/application/ip-geolocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,30 @@ IP geolocation data is provided by [ip-api.com](https://ip-api.com/) and the API

:::note

The free API endpoint is limited to 45 requests per minute, supports only the `http` protocol and is available for non-commercial use only.
The free API endpoint is limited to 45 requests per minute, supports only the `HTTP` protocol and is available for non-commercial use only.

:::

Example inputs:

- `borntoberoot.net`
- `1.1.1.1`

![IPGeolocation](../img/ip-geolocation.png)

In addition, further actions can be performed using the buttons at the bottom right:
### Example inputs

- **Export...** - Export the information to a CSV, XML or JSON file.
| Input | Description |
|-------|-------------|
| `borntoberoot.net` | Fully qualified domain name (FQDN) |
| `1.1.1.1` | Public IP address |

:::note
### Toolbar

Right-click on the result to copy the information.
| Button | Description |
|--------|-------------|
| **Export...** | Exports the information to a CSV, XML, or JSON file |

:::
### Context menu

| Action | Description |
|--------|-------------|
| **Copy** | Copies the selected information to the clipboard |

## Profile

Expand Down
21 changes: 16 additions & 5 deletions Website/docs/application/listeners.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,25 @@ keywords: [NETworkManager, listeners, listening ports, open ports, network liste

# Listeners

In **Listeners** you can see all the listeners with IP addresses and port that are currently running on your computer.
The **Listeners** view shows all active network listeners with their bound IP addresses and ports that are currently running on your computer.

:::info

A network listener is a socket bound to a specific local IP address and port that waits to receive incoming data or connections. TCP listeners accept incoming connections; UDP listeners receive datagrams. Applications use listeners to offer services over a network.

:::

![Listeners](../img/listeners.png)

:::note
### Context menu

With `F5` you can refresh the listeners.
| Action | Description |
|--------|-------------|
| **Copy** | Copies the selected information to the clipboard |
| **Export...** | Exports the selected or all results to a file |

Right-click on the result to copy or export the information.
### Keyboard shortcuts

:::
| Key | Action |
|-----|--------|
| `F5` | Refresh |
26 changes: 14 additions & 12 deletions Website/docs/application/lookup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,42 @@ keywords: [NETworkManager, OUI lookup, MAC address lookup, port lookup, manufact

# Lookup

In **Lookup** you can search for information about [OUIs](#oui) (Organizationally Unique Identifiers) and [ports](#port).
With **Lookup** you can search for information about [OUIs](#oui) (Organizationally Unique Identifiers) and [ports](#port).

## OUI

On the **OUI** tab, you can search the manufacturer of a network interface card (NIC) by entering the first 24 bits of the MAC address. You can also search by vendor name to get all registered MAC addresses of the vendor.
On the **OUI** tab, you can search for the manufacturer of a network interface card (NIC) by entering the first 24 bits of the MAC address. You can also search by vendor name to get all registered MAC addresses of the vendor.

:::info

The OUI (Organizationally Unique Identifier) is a 24-bit number that is assigned to a network interface card (NIC) by the IEEE Registration Authority. The OUI is used to identify the manufacturer of a network interface card. The OUI is the first 24 bits of the MAC address.
The OUI (Organizationally Unique Identifier) is a 24-bit number assigned by the IEEE Registration Authority to identify network interface card manufacturers. It forms the first 24 bits of a MAC address.

:::

![Lookup - OUI](../img/lookup--oui.png)

:::note
### Context menu

Right-click on the result to copy or export the information.

:::
| Action | Description |
|--------|-------------|
| **Copy** | Copies the selected information to the clipboard |
| **Export...** | Exports the selected or all results to a file |

## Port

On the **Port** tab, you can search for a port number to get information about the service and the protocol used by the port. You can also search by service name to get all registered port numbers of the service.

:::info

A port is a logical construct that identifies a specific process to which network traffic is to be forwarded. Ports are identified by a 16-bit number, known as a port number. Port numbers range from 0 to 65535, but only ports numbers 0 to 1023 are designated as well-known ports. Well-known ports are those registered with IANA for common services such as HTTP (port 80), HTTPS (port 443), FTP (port 21), and SSH (port 22).
A port is a logical construct that identifies a specific process to which network traffic is to be forwarded. Ports are identified by a 16-bit number, known as a port number. Port numbers range from 0 to 65535, but only port numbers 0 to 1023 are designated as well-known ports. Well-known ports are those registered with IANA for common services such as HTTP (port 80), HTTPS (port 443), FTP (port 21), and SSH (port 22).

:::

![Lookup - Port](../img/lookup--port.png)

:::note
### Context menu

Right-click on the result to copy or export the information.

:::
| Action | Description |
|--------|-------------|
| **Copy** | Copies the selected information to the clipboard |
| **Export...** | Exports the selected or all results to a file |
32 changes: 18 additions & 14 deletions Website/docs/application/neighbor-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,30 +18,34 @@ Both protocols are susceptible to spoofing/poisoning attacks that can manipulate

:::

:::note
:::warning[Administrator privileges required]

Adding and deleting neighbor entries requires administrator privileges. If the application is not running as administrator, the view is in read-only mode. Use the **Restart as administrator** button to relaunch the application with elevated rights.
Without administrator privileges, the view is read-only. Use the **Restart as administrator** button to relaunch the application with elevated rights.

:::

![Neighbor Table](../img/neighbor-table.png)

:::note

Additional actions are available via the buttons below the table:

- **Add entry...** – Opens a dialog to add a permanent static neighbor entry.
- **Delete table** – Removes all dynamic entries (permanent entries are preserved).
### Toolbar

:::
| Button | Description |
|--------|-------------|
| **Add entry...** | Opens a dialog to add a permanent static neighbor entry |
| **Delete table** | Removes all dynamic entries (permanent entries are preserved) |

:::note
### Context menu

Press `F5` to refresh the neighbor table.
| Action | Description |
|--------|-------------|
| **Copy** | Copies the selected information to the clipboard |
| **Export...** | Exports the selected or all results to a file |
| **Delete** | Removes the selected entry |

Right-click on a row to copy or export individual values, or to delete the selected entry.
### Keyboard shortcuts

:::
| Key | Action |
|-----|--------|
| `F5` | Refresh |

## Columns

Expand Down Expand Up @@ -118,4 +122,4 @@ The network interface on which the entry is created.

Adding a static entry requires administrator privileges. Internally, NETworkManager uses `New-NetNeighbor` (PowerShell `NetTCPIP` module) to create the entry with state `Permanent`.

:::
:::
Loading
Loading