Chapter 4:
GUI
& CLI Tools
44
v3.3-a 12/07/2022
o
Disabled:
Currently disabled, writing will not apply anything, and the value read
value might be invalid.
•
Visibility
: Expert parameters are by default hidden unless toggling the expert mode.
Then, the disabled parameters are meaningless and thus temporary hidden to improve
legibility.
•
Status
: Current status of a parameter.
o
Warning:
The current value within a given situation corresponds to a warning
alert.
o
Critical:
The current value within a given situation corresponds to a critical alert.
o
Out-of-Sync:
The current value could not be synchronized and is outdated.
o
Unlicensed:
This parameter is invalid/unusable without the proper license.
o
Unknown:
The whole module that handles the parameter is down.
•
Events
: Some relevant parameters are associated to events when they change their
value (Tracked) or when their value enters an alert range (Warning, Critical) or a smart
alert.
WRZ-OS API Guide
The list of all modules and corresponding parameters together with the value of their
attributes can be found in the WRZ-OS API guide.
4.1.1 Table representation
Then for each specific feature explained through the user-guide, the following table format will
be employed to describe the corresponding parameters along with their relevant attributes.
An example is given for the network interface where the same directory has been separated into
two tables to follow the same structure as the web GUI panels. The first table (Table 4:1)
corresponds to the parameters related to the configuration of the network interface.
OID
name
Value Type
Description
1.xxx0.x /net/<iface>/xxx
Directory related to the <iface> name where OIDs
follow the given pattern: wr0 → 20
1
x, wr1 → 21
1x, ...,
wr15
→ 36
1
x & eth0 → 68
0
x, eth1 → 69
0x.
0.xxx0.7
DHCP
<Bool>
Enable/Disable the DHCP IPv4 discovery.
0.xxx0.3
IPv4 Address
<Array> [4 x u8]
IPv4 address of <iface>
(format: [0-255].[0-255].[0-255].[0-255]).
0.xxx0.4
IPv4 Netmask
<Array> [4 x u8]
Subnet mask.of <iface>
(format: [0-255].[0-255].[0-255].[0-255]).
0.xxx0.5
IPv4 Gateway
<Array> [4 x u8]
Default gateway for <iface>
(format: [0-255].[0-255].[0-255].[0-255]).
