Skip to content

Commit

Permalink
Docs: Ping monitor added
Browse files Browse the repository at this point in the history
  • Loading branch information
BornToBeRoot committed Jan 4, 2024
1 parent b9ddb64 commit 2b0567c
Show file tree
Hide file tree
Showing 3 changed files with 112 additions and 2 deletions.
Binary file added Website/docs/application/img/ping-monitor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
112 changes: 111 additions & 1 deletion Website/docs/application/ping-monitor.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,115 @@
---
sidebar_position: 6
sidebar_position: 5
---

# Ping Monitor

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

Example inputs:

| Host | Description |
| -------------------------------- | ----------------------------------------------------------------------------------------- |
| `10.0.0.1` | Single IP address (`10.0.0.1`) |
| `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`) |
| `10.0.0.0/23` | All IP addresses in a subnet (`10.0.0.0`, ..., `10.0.1.255`) |
| `10.0.0.0/255.255.254.0` | All IP addresses in a subnet (`10.0.0.0`, ..., `10.0.1.255`) |
| `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`) |
| `borntoberoot.net` | Single IP address resolved from a host (`10.0.0.1`) |
| `borntoberoot.net/24` | All IP addresses in a subnet resolved from a host (`10.0.0.0`, ..., `10.0.0.255`) |
| `borntoberoot.net/255.255.255.0` | All IP addresses in a subnet resolved from a host (`10.0.0.0`, ..., `10.0.0.255`) |

:::note

Multiple inputs can be combined with a semicolon (`;`).

Example: `10.0.0.0/24; 10.0.[10-20]1`

:::

![PingMonitor](06_PingMonitor.png)

:::note

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

:::

## Profile

### Inherit host from general

Inherit the host from the general settings.

**Type:** `Boolean`

**Default:** `Enabled`

:::note

If this option is enabled, the [Host](#host) is overwritten by the host from the general settings and the [Host](#host) is disabled.

:::

### Host

Hostname or IP address to ping.

**Type:** `String`

**Default:** `Empty`

**Example:**

- `server-01.borntoberoot.net`
- `1.1.1.1`

## Settings

### Timeout (ms)

Timeout in milliseconds for the icmp packet after which the packet is considered lost.

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

**Default:** `4000`

### Buffer

Buffer size of the icmp packet.

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

**Default:** `32`

### TTL

Time to live of the icmp packet.

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

**Default:** `64`

### Don't fragment

Don't fragment the icmp packet.

**Type:** `Boolean`

**Default:** `true`

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

Time in milliseconds to wait between each ping.

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

**Default:** `1000`

### Expand host view

Expand the host view to show more information when the host is added.

**Type:** `Boolean`

**Default:** `false`
2 changes: 1 addition & 1 deletion Website/docs/application/port-scanner.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 4
---

# Port Scanner
Expand Down

0 comments on commit 2b0567c

Please sign in to comment.