Skip to content

Commit e155369

Browse files
committed
Docs: Reformat docs
1 parent e90a1fb commit e155369

4 files changed

Lines changed: 129 additions & 80 deletions

File tree

Website/docs/application/ip-scanner.md

Lines changed: 44 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,34 @@
11
---
22
sidebar_position: 3
33
description: "Scan for active devices in your network using ICMP and TCP port checks. NETworkManager IP Scanner supports IP ranges, CIDR subnets, and hostnames."
4-
keywords: [NETworkManager, IP scanner, network scanner, ping sweep, host discovery, ICMP scanner, subnet scan]
4+
keywords:
5+
[
6+
NETworkManager,
7+
IP scanner,
8+
network scanner,
9+
ping sweep,
10+
host discovery,
11+
ICMP scanner,
12+
subnet scan,
13+
]
514
---
615

716
# IP Scanner
817

9-
With the **IP Scanner** you can scan for active devices based on the hostname or in IP ranges that are reachable via icmp or have a common tcp port open.
18+
With the **IP Scanner** you can scan for active devices based on the hostname or in IP ranges that are reachable via ICMP or have a common TCP port open.
1019

1120
Example inputs:
1221

13-
| Host | Description |
14-
| -------------------------------- | ----------------------------------------------------------------------------------------- |
15-
| `10.0.0.1` | Single IP address (`10.0.0.1`) |
16-
| `10.0.0.100 - 10.0.0.199` | All IP addresses in a given range (`10.0.0.100`, `10.0.0.101`, ..., `10.0.0.199`) |
17-
| `10.0.0.0/23` | All IP addresses in a subnet (`10.0.0.0`, ..., `10.0.1.255`) |
18-
| `10.0.0.0/255.255.254.0` | All IP addresses in a subnet (`10.0.0.0`, ..., `10.0.1.255`) |
19-
| `10.0.[0-9,20].[1-2]` | Multipe IP address like (`10.0.0.1`, `10.0.0.2`, `10.0.1.1`, ...,`10.0.9.2`, `10.0.20.1`) |
20-
| `borntoberoot.net` | Single IP address resolved from a host (`10.0.0.1`) |
21-
| `borntoberoot.net/24` | All IP addresses in a subnet resolved from a host (`10.0.0.0`, ..., `10.0.0.255`) |
22-
| `borntoberoot.net/255.255.255.0` | All IP addresses in a subnet resolved from a host (`10.0.0.0`, ..., `10.0.0.255`) |
22+
| Host | Description |
23+
| -------------------------------- | -------------------------------------------------------------------------------------------- |
24+
| `10.0.0.1` | Single IP address (`10.0.0.1`) |
25+
| `10.0.0.100 - 10.0.0.199` | All IP addresses in a given range (`10.0.0.100`, `10.0.0.101`, ..., `10.0.0.199`) |
26+
| `10.0.0.0/23` | All IP addresses in a subnet (`10.0.0.0`, ..., `10.0.1.255`) |
27+
| `10.0.0.0/255.255.254.0` | All IP addresses in a subnet (`10.0.0.0`, ..., `10.0.1.255`) |
28+
| `10.0.[0-9,20].[1-2]` | Multiple IP addresses like (`10.0.0.1`, `10.0.0.2`, `10.0.1.1`, ...,`10.0.9.2`, `10.0.20.1`) |
29+
| `borntoberoot.net` | Single IP address resolved from a host (`10.0.0.1`) |
30+
| `borntoberoot.net/24` | All IP addresses in a subnet resolved from a host (`10.0.0.0`, ..., `10.0.0.255`) |
31+
| `borntoberoot.net/255.255.255.0` | All IP addresses in a subnet resolved from a host (`10.0.0.0`, ..., `10.0.0.255`) |
2332

2433
:::note
2534

@@ -29,26 +38,30 @@ Example: `10.0.0.0/24; 10.0.[10-20]1`
2938

3039
:::
3140

32-
The button to the left of the `Scan` button determines the IP address and subnet mask of the network interface
33-
currently in use in order to scan the local subnet for active devices.
41+
![IP Scanner](../img/ip-scanner.png)
42+
43+
### Toolbar
44+
45+
| Button | Description |
46+
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------- |
47+
| **Detect local subnet** | Populates the host field with the IP address and subnet mask of the current network interface to scan the local subnet |
3448

3549
:::note
3650

37-
The local IP address (and subnet mask) is determined by trying to route to a public IP address. If this fails (e.g.
51+
The local IP address (and subnet mask) is determined by trying to route to a public IP address. If this fails (e.g.
3852
no network connection), NETworkManager iterates over active network adapters and selects the first valid IPv4 address,
3953
with link-local addresses (`169.254.x.x`) given lower priority.
4054

4155
:::
4256

43-
If you right-click on a selected result, you can forward the device information to other applications (e.g. Port Scanner, Remote Desktop, etc), create a new profile with this information or execute a [custom command](#custom-commands).
44-
45-
![IP Scanner](../img/ip-scanner.png)
46-
47-
:::note
57+
### Context menu
4858

49-
Right-click on the result to copy or export the information.
59+
Right-clicking a result allows forwarding device information to another tool (e.g. [Port Scanner](./port-scanner), Remote Desktop), creating a new profile, or executing a [custom command](#custom-commands).
5060

51-
:::
61+
| Action | Description |
62+
| ------------- | ------------------------------------------------ |
63+
| **Copy** | Copies the selected information to the clipboard |
64+
| **Export...** | Exports the selected or all results to a file |
5265

5366
## Profile
5467

@@ -97,23 +110,23 @@ Show the scan result for all IP addresses and ports including the ones that are
97110

98111
### Attempts
99112

100-
Attempts how often an icmp request is retried for each IP address if the request has timed out.
113+
Number of times an ICMP request is retried for each IP address if the request has timed out.
101114

102115
**Type:** `Integer` [Min `1`, Max `10`]
103116

104117
**Default:** `2`
105118

106119
### Timeout (ms)
107120

108-
Timeout in milliseconds for each icmp request and after which the packet is considered lost.
121+
Timeout in milliseconds for each ICMP request, after which the packet is considered lost.
109122

110123
**Type:** `Integer` [Min `100`, Max `15000`]
111124

112125
**Default:** `4000`
113126

114127
### Buffer
115128

116-
Size of the buffer for each icmp request in bytes.
129+
Size of the buffer for each ICMP request in bytes.
117130

118131
**Type:** `Integer` [Min `1`, Max `65535`]
119132

@@ -129,15 +142,15 @@ Resolve the hostname (PTR) for each IP address.
129142

130143
### Scan ports
131144

132-
Scan each IP address for open `tcp` ports.
145+
Scan each IP address for open TCP ports.
133146

134147
**Type:** `Boolean`
135148

136149
**Default:** `Enabled`
137150

138151
### Ports
139152

140-
List of `tcp` ports to scan for each IP address.
153+
List of TCP ports to scan for each IP address.
141154

142155
**Type:** `String`
143156

@@ -218,7 +231,7 @@ You can also use the Hotkeys `F2` (`edit`) or `Del` (`delete`) on a selected cus
218231

219232
### Max. concurrent host threads
220233

221-
Maximal number of threads used to scan for active hosts (1 thread = 1 host/ip address).
234+
Maximum number of threads used to scan for active hosts (1 thread = 1 host / IP address).
222235

223236
**Type:** `Integer` [Min `1`, Max `512`]
224237

@@ -234,13 +247,13 @@ Too many threads can also cause performance problems on the device.
234247

235248
:::note
236249

237-
This setting only change the maximum number of concurrently executed threads per host scan. See also the [General](../settings/general#threadpool-additional-min-threads) settings to configure the application wide thread pool.
250+
This setting only changes the maximum number of concurrently executed threads per host scan. See also the [General](../settings/general#threadpool-additional-min-threads) settings to configure the application-wide thread pool.
238251

239252
:::
240253

241254
### Max. concurrent port threads
242255

243-
Maximal number of threads that are used to scan for open ports for each host (IP address).
256+
Maximum number of threads that are used to scan for open ports for each host (IP address).
244257

245258
**Type:** `Integer` [Min `1`, Max `10`]
246259

@@ -256,6 +269,6 @@ Too many threads can also cause performance problems on the device.
256269

257270
:::note
258271

259-
This setting only change the maximum number of concurrently executed threads per port scan. See also the [General](../settings/general#threadpool-additional-min-threads) settings to configure the application wide thread pool.
272+
This setting only changes the maximum number of concurrently executed threads per port scan. See also the [General](../settings/general#threadpool-additional-min-threads) settings to configure the application-wide thread pool.
260273

261274
:::

Website/docs/application/ping-monitor.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ keywords: [NETworkManager, ping monitor, ICMP ping, host monitoring, network upt
66

77
# Ping Monitor
88

9-
With the **Ping Monitor** you can monitor one or multiple hosts with ICMP echo requests to determine if the specific host is reachable.
9+
With the **Ping Monitor** you can monitor one or multiple hosts with ICMP echo requests to determine whether each host is reachable.
1010

1111
Example inputs:
1212

13-
| Host | Description |
14-
| -------------------------------- | ----------------------------------------------------------------------------------------- |
15-
| `10.0.0.1` | Single IP address (`10.0.0.1`) |
16-
| `10.0.0.100 - 10.0.0.199` | All IP addresses in a given range (`10.0.0.100`, `10.0.0.101`, ..., `10.0.0.199`) |
17-
| `10.0.0.0/23` | All IP addresses in a subnet (`10.0.0.0`, ..., `10.0.1.255`) |
18-
| `10.0.0.0/255.255.254.0` | All IP addresses in a subnet (`10.0.0.0`, ..., `10.0.1.255`) |
19-
| `10.0.[0-9,20].[1-2]` | Multipe IP address like (`10.0.0.1`, `10.0.0.2`, `10.0.1.1`, ...,`10.0.9.2`, `10.0.20.1`) |
20-
| `borntoberoot.net` | Single IP address resolved from a host (`10.0.0.1`) |
21-
| `borntoberoot.net/24` | All IP addresses in a subnet resolved from a host (`10.0.0.0`, ..., `10.0.0.255`) |
22-
| `borntoberoot.net/255.255.255.0` | All IP addresses in a subnet resolved from a host (`10.0.0.0`, ..., `10.0.0.255`) |
13+
| Host | Description |
14+
| -------------------------------- | ------------------------------------------------------------------------------------------ |
15+
| `10.0.0.1` | Single IP address (`10.0.0.1`) |
16+
| `10.0.0.100 - 10.0.0.199` | All IP addresses in a given range (`10.0.0.100`, `10.0.0.101`, ..., `10.0.0.199`) |
17+
| `10.0.0.0/23` | All IP addresses in a subnet (`10.0.0.0`, ..., `10.0.1.255`) |
18+
| `10.0.0.0/255.255.254.0` | All IP addresses in a subnet (`10.0.0.0`, ..., `10.0.1.255`) |
19+
| `10.0.[0-9,20].[1-2]` | Multiple IP addresses like (`10.0.0.1`, `10.0.0.2`, `10.0.1.1`, ...,`10.0.9.2`, `10.0.20.1`) |
20+
| `borntoberoot.net` | Single IP address resolved from a host (`10.0.0.1`) |
21+
| `borntoberoot.net/24` | All IP addresses in a subnet resolved from a host (`10.0.0.0`, ..., `10.0.0.255`) |
22+
| `borntoberoot.net/255.255.255.0` | All IP addresses in a subnet resolved from a host (`10.0.0.0`, ..., `10.0.0.255`) |
2323

2424
:::note
2525

@@ -29,14 +29,21 @@ Example: `10.0.0.0/24; 10.0.[10-20]1`
2929

3030
:::
3131

32-
![Ping Monitor](../img/ping-monitor.png)
33-
34-
:::note
32+
:::info
3533

36-
Right-click on the result to copy or export the information.
34+
ICMP (Internet Control Message Protocol) is a network-layer protocol used to send diagnostic and control messages. An ICMP echo request (commonly known as a ping) asks a remote host to send back an echo reply, confirming it is reachable on the network.
3735

3836
:::
3937

38+
![Ping Monitor](../img/ping-monitor.png)
39+
40+
### Context menu
41+
42+
| Action | Description |
43+
|--------|-------------|
44+
| **Copy** | Copies the selected information to the clipboard |
45+
| **Export...** | Exports the selected or all results to a file |
46+
4047
## Profile
4148

4249
### Inherit host from general
@@ -70,35 +77,35 @@ Hostname or IP address to ping.
7077

7178
### Timeout (ms)
7279

73-
Timeout in milliseconds for the icmp packet after which the packet is considered lost.
80+
Timeout in milliseconds for each ICMP packet, after which the packet is considered lost.
7481

7582
**Type:** `Integer` [Min `100`, Max `15000`]
7683

7784
**Default:** `4000`
7885

7986
### Buffer
8087

81-
Buffer size of the icmp packet.
88+
Buffer size of the ICMP packet.
8289

8390
**Type:** `Integer` [Min `1`, Max `65535`]
8491

8592
**Default:** `32`
8693

8794
### TTL
8895

89-
Time to live of the icmp packet.
96+
Time to live of the ICMP packet.
9097

9198
**Type:** `Integer` [Min `1`, Max `255`]
9299

93100
**Default:** `64`
94101

95102
### Don't fragment
96103

97-
Don't fragment the icmp packet.
104+
Don't fragment the ICMP packet.
98105

99106
**Type:** `Boolean`
100107

101-
**Default:** `true`
108+
**Default:** `Enabled`
102109

103110
### Time (ms) to wait between each ping
104111

@@ -114,4 +121,4 @@ Expand the host view to show more information when the host is added.
114121

115122
**Type:** `Boolean`
116123

117-
**Default:** `false`
124+
**Default:** `Disabled`

Website/docs/application/port-scanner.md

Lines changed: 40 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,34 @@
11
---
22
sidebar_position: 4
33
description: "Scan for open TCP ports on network hosts. NETworkManager Port Scanner supports flexible host and port range inputs for comprehensive port scanning."
4-
keywords: [NETworkManager, port scanner, TCP port scan, open ports, network security, port checker, port scanning tool]
4+
keywords:
5+
[
6+
NETworkManager,
7+
port scanner,
8+
TCP port scan,
9+
open ports,
10+
network security,
11+
port checker,
12+
port scanning tool,
13+
]
514
---
615

716
# Port Scanner
817

9-
With the **Port Scanner** you can scan for open `tcp` ports on one or multiple hosts to determine which services are running.
18+
With the **Port Scanner** you can scan for open TCP ports on one or multiple hosts to determine which services are running.
1019

1120
Example inputs:
1221

13-
| Host | Description |
14-
| -------------------------------- | ----------------------------------------------------------------------------------------- |
15-
| `10.0.0.1` | Single IP address (`10.0.0.1`) |
16-
| `10.0.0.100 - 10.0.0.199` | All IP addresses in a given range (`10.0.0.100`, `10.0.0.101`, ..., `10.0.0.199`) |
17-
| `10.0.0.0/23` | All IP addresses in a subnet (`10.0.0.0`, ..., `10.0.1.255`) |
18-
| `10.0.0.0/255.255.254.0` | All IP addresses in a subnet (`10.0.0.0`, ..., `10.0.1.255`) |
19-
| `10.0.[0-9,20].[1-2]` | Multipe IP address like (`10.0.0.1`, `10.0.0.2`, `10.0.1.1`, ...,`10.0.9.2`, `10.0.20.1`) |
20-
| `borntoberoot.net` | Single IP address resolved from a host (`10.0.0.1`) |
21-
| `borntoberoot.net/24` | All IP addresses in a subnet resolved from a host (`10.0.0.0`, ..., `10.0.0.255`) |
22-
| `borntoberoot.net/255.255.255.0` | All IP addresses in a subnet resolved from a host (`10.0.0.0`, ..., `10.0.0.255`) |
22+
| Host | Description |
23+
| -------------------------------- | -------------------------------------------------------------------------------------------- |
24+
| `10.0.0.1` | Single IP address (`10.0.0.1`) |
25+
| `10.0.0.100 - 10.0.0.199` | All IP addresses in a given range (`10.0.0.100`, `10.0.0.101`, ..., `10.0.0.199`) |
26+
| `10.0.0.0/23` | All IP addresses in a subnet (`10.0.0.0`, ..., `10.0.1.255`) |
27+
| `10.0.0.0/255.255.254.0` | All IP addresses in a subnet (`10.0.0.0`, ..., `10.0.1.255`) |
28+
| `10.0.[0-9,20].[1-2]` | Multiple IP addresses like (`10.0.0.1`, `10.0.0.2`, `10.0.1.1`, ...,`10.0.9.2`, `10.0.20.1`) |
29+
| `borntoberoot.net` | Single IP address resolved from a host (`10.0.0.1`) |
30+
| `borntoberoot.net/24` | All IP addresses in a subnet resolved from a host (`10.0.0.0`, ..., `10.0.0.255`) |
31+
| `borntoberoot.net/255.255.255.0` | All IP addresses in a subnet resolved from a host (`10.0.0.0`, ..., `10.0.0.255`) |
2332

2433
| Port | Description |
2534
| --------------------- | -------------------------------------------------- |
@@ -34,13 +43,26 @@ Example: `10.0.0.0/24; 10.0.[10-20]1` or `1-1024; 8080; 8443`
3443

3544
:::
3645

46+
:::info
47+
48+
TCP (Transmission Control Protocol) is a connection-oriented transport-layer protocol. Establishing a connection requires a three-way handshake between client and server. Port scanning tests whether this handshake can be initiated on a given port, which indicates a listening service.
49+
50+
:::
51+
3752
![Port Scanner](../img/port-scanner.png)
3853

39-
:::note
54+
### Toolbar
4055

41-
Right-click on the result to copy or export the information.
56+
| Button | Description |
57+
| ----------------------- | ------------------------------------------------------------------------------- |
58+
| **Select port profile** | Opens a dialog to select a pre-defined port profile to populate the ports field |
4259

43-
:::
60+
### Context menu
61+
62+
| Action | Description |
63+
| ------------- | ------------------------------------------------ |
64+
| **Copy** | Copies the selected information to the clipboard |
65+
| **Export...** | Exports the selected or all results to a file |
4466

4567
## Profile
4668

@@ -101,7 +123,7 @@ See also the [Port Scanner](./port-scanner) example inputs for more information
101123

102124
### Port profiles
103125

104-
List of common `tcp` ports to scan for.
126+
List of common TCP ports to scan for.
105127

106128
**Type:** `List<NETworkManager.Models.Network.PortProfileInfo>`
107129

@@ -171,7 +193,7 @@ Too many threads can also cause performance problems on the device.
171193

172194
:::note
173195

174-
This setting only change the maximum number of concurrently executed threads per host scan. See also the [General](../settings/general#threadpool-additional-min-threads) settings to configure the application wide thread pool.
196+
This setting only changes the maximum number of concurrently executed threads per host scan. See also the [General](../settings/general#threadpool-additional-min-threads) settings to configure the application-wide thread pool.
175197

176198
:::
177199

@@ -193,6 +215,6 @@ Too many threads can also cause performance problems on the device.
193215

194216
:::note
195217

196-
This setting only change the maximum number of concurrently executed threads per host scan. See also the [General](../settings/general#threadpool-additional-min-threads) settings to configure the application wide thread pool.
218+
This setting only changes the maximum number of concurrently executed threads per port scan. See also the [General](../settings/general#threadpool-additional-min-threads) settings to configure the application-wide thread pool.
197219

198220
:::

0 commit comments

Comments
 (0)