aboutsummaryrefslogtreecommitdiffstats
path: root/doc/mod/ipcalc.md
blob: a3e7fc8b323d705e1835ace60949928661dc7163 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
IP address calculation
======================

[◀ Go back to main README](../../README.md)

> ℹ️️ **Info**: This module can not be used on its own but requires the base
> installation. See [main README](../../README.md) for details.

Description
-----------

This module adds functions for IP address calculation.

Requirements and installation
-----------------------------

Just install the module:

    $ScriptInstallUpdate mod/ipcalc;

Usage and invocation
--------------------

### IPCalc

The function `$IPCalc` prints information to terminal, including:

* address
* netmask
* network in CIDR notation
* minimum host address
* maximum host address
* broadcast address

It expects an IP address in CIDR notation as argument.

    $IPCalc 192.168.88.1/24;

![IPCalc](ipcalc.d/ipcalc.avif)

### IPCalcReturn

The function `$IPCalcReturn` expects an IP address in CIDR notation as
argument as well. But it does not print to terminal, instead it returns
the information in a named array.

    :put ([ $IPCalcReturn  192.168.88.1/24 ]->"broadcast");

![IPCalcReturn](ipcalc.d/ipcalcreturn.avif)

---
[◀ Go back to main README](../../README.md)  
[▲ Go back to top](#top)