Introduction

The Duckfone platform is an enterprise 4G LTE cellular gateway and connectivity solution, designed to provide cellular connectivity and remote access to enterprise, retail, branch, and remote locations.

This manual documents administration of the device – the configuration, status, and commands – using the command line interface (CLI) and the web interface.

Hardware

• Global 4G LTE module
• 2 × SIM slots
• 4 × RJ45 serial ports
• 1 × 10/100/1000 Ethernet port

Accessing the device

The device's default configuration allows logging in to the device with the following credentials:

• Username: admin
• Password: see unique password on device label

Additionally, if the device is connected to the internet and can access Gearlinx ZERO, a user permitted to access the device via ZERO can log in locally with their ZERO credentials.

Network services

Network services are accessible on the device's internal network interfaces. The device's hostname is set as its serial number, and the device's IP address can be resolved with mDNS. For example, NR4448-0000123456789.local.

The following network services are available:

• SSH to the device at <serial>.local.
• Enter https://<serial>.local in your browser to access the web interface.
• Access the device's web interface via Gearlinx ZERO.

Serial console

The device's serial port labelled Console runs a login. Connect to the serial port with settings 115200 / 8N1.

Resource menu

After logging in to the device over a terminal interface such as SSH or the serial console, you will be presented with the resource menu.

The resource menu shows the textual resources that the authenticated user is given access to, such as serial ports and system logs. The CLI is available to users with the Administration permission under the option System / CLI.

When accessing the web interface, the resource menu can be found under the Connect menu in the page header. Users with the Administration permission will find the Administration menu on the navigation bar on the left of the page. This menu provides access to the same configuration, status, and command functionality as the CLI.

CLI

The command line interface (CLI) is used to perform administration tasks when accessing the device over a terminal interface. Administration tasks include changing configuration, viewing status, and running commands.

The structure of the CLI commands and printed data is consistent with the structure of the web interface's administration pages. See the Administration reference section of this manual for documentation on the structure and content of this data.

Using the CLI

When the CLI starts, the main prompt is printed:

(cli)>

Typing ? shows contextual information and suggestions for autocompletion:

Gearlinux CLI

config  Enter configuration mode.
show    Enter show mode.
run     Run a command.
exit    Exit the CLI.

Pressing the TAB key also shows the suggestions list, and will autocomplete the word if the start of a word already entered prefixes one of the suggestions. The CLI supports line editing.

Configuration and status data is printed in YAML format. Output text that exceeds the height of the terminal is paged. When paged, pressing the space key shows the next page of text, pressing r prints the remaining text, and q cancels the pager without printing.

Basic configuration command

The CLI can be used to inspect and change the device's configuration. While at the main CLI prompt, the config command interacts with the device's current configuration, and is updated automatically when the device's configuration changes by automations or other administration sessions.

To print configuration, enter config keyword and the administration path, then press enter.

(cli)> config <PATH>

For example, to print details of the device at path system info:

(cli)> config system info
name: null
location: null
contact: null

To make simple configuration changes to string, integer, boolean, selection, and reference data types, append a value to the print command.

(cli)> config <PATH> <VALUE>

For example, to set the device's name system info name to nr44-bay18

(cli)> config system info name nr44-bay18

Multiple values can be set in one command by adding another path (relative to the previous set field) and value.

(cli)> config system info name nr44-bay18 location "Data center 1"

The changes are applied and saved to disk if they pass validation.

Configuration mode

Configuration mode allows advanced configuration changes, including adding or deleting items of a list, reverting configuration to defaults, and applying configuration changes without saving them to disk, require using the configuration mode. In configuration mode, a copy of the device's current configuration is made available for editing so that multiple operations can be performed before saving.

Enter configuration mode by running config with no parameters.

(cli)> config

The syntax of the basic configuration command, without the leading config keyword, is used to show and change the configuration.

(config)> system info name nr44-bay18

(config)> system info
name: nr44-bay18
location: null
contact: null

The following commands are available:

add       Add an item.
delete    Delete an item or value.
cd        Change data path.
validate  Validate the configuration.
apply     Apply the configuration.
save      Save the configuration to disk.
default   Revert to default.
discard   Discard the configuration changes.
changes   Show unapplied changes.
exit      Leave configuration mode without saving.

Enter the command keyword followed by ? to view help for the command.

When the configuration has been edited as required, run the save command to apply the configuration changes and save them to disk. The save command will fail if any configuration fields are invalid.

(config)> save

Run the exit command to return to the main CLI prompt.

(config)> exit
(cli)>

Show state command (configuration and status)

The CLI can be used to inspect the device's state. While at the main CLI prompt, the show command prints the device's current configuration and status, and is updated automatically.

To print state, enter the show keyword and the administration path, then press enter.

(cli)> show <PATH>

For example, to print details of the device at path system info:

(cli)> show system info
name: null
hostname: NR4416-0110923000657
mac: d4:c3:b0:01:03:b0
serial: NR4416-0110923000657
location: null
contact: null

Running commands

The CLI can be used to run administrative operation commands.

To run a command, enter the run keyword and the administration path, then parameters using the configuration set path/value syntax.

For example, backing up the configuration to the local configuration store with the name backup 2023-06-15:

(cli)> run system config save-to-store name "backup 2023-06-15"

Command succeeded.

To run a command with no parameters, or default parameters (if available), omit the parameters. For example, restart the device by running the command:

(cli)> run system operations restart

System restarting.

Serial ports

The device's serial ports.

Default Serial port items cannot be deleted.

Serial port

• TCP - Settings for serial over TCP.
• Communications settings - The communications settings used for serial data and signaling.
• Signals
• Statistics
• Direct access
• Logging
• Connected users

Properties

Enable

Enable the serial port for use.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config serial <key> enable

Label

The label used to describe and locate this serial port.

Whenever this serial port is displayed the label will be used in preference, or addition to, the serial port number. The Label is also added as a tag allowing it to be located easily is searching and configuration.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config serial <key> label

Device type

• Data type: string select
• Default: tty
• Configuration
• Required

CLI: (cli)> config serial <key> type

Resource tags

Apply these tags to resources associated with this serial port.

Tagging provides a convenient method for finding single and group resources. The serial port label is automatically added to the ports tags.

• Data type: string list
• Configuration

CLI: (cli)> config serial <key> tags

Mode

The mode of operation for this serial port.

The serial port mode determines how serial port is accessed and what options are allowed when connected.

• Data type: string select
• Default: remote
• Configuration
• Required

CLI: (cli)> config serial <key> mode

Escape character (ASCII character code)

The escape character to enter for menu and command access.

Enter the escape character followed by a command character while connected to a serial port in order to access the menu or serial port commands. The following sequences are possible:

 Escape-Char 'q' : quit
 Escape-Char 'b' : send serial break
 Escape-Char 'd' : list or disconnect other sessions
 Escape-Char 's' : port history (graphical terminal only)
 Escape-Char '?' : help

The table below lists the decimal values for the escape character, control characters are prefixed with '^'.

• Data type: integer
• Default: 30
• Minimum: 1
• Maximum: 255
• Configuration
• Required

CLI: (cli)> config serial <key> escape-character

Single user mode

Allow only one user at a time.

The port will allow a single user to connect. While a user is connected, all other connection requests will be rejected and logged.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config serial <key> single-user

TCP

Settings for serial over TCP.

Properties

Hostname

• Data type: string
• Configuration
• Required

CLI: (cli)> config serial <key> tcp hostname

Port

• Data type: integer
• Minimum: 1
• Maximum: 65535
• Configuration
• Required

CLI: (cli)> config serial <key> tcp port

Communications settings

The communications settings used for serial data and signaling.

Properties

Baud

The serial baud rate for this port.

The Baud rate determines the speed of the serial port. It is expressed in bits-per-second (bps). Communicating devices must be set to the same baud rate. The higher the baud rate the faster the connection. 9600 or 115200 are commonly used settings.

• Data type: string select
• Default: 115200
• Configuration
• Required

CLI: (cli)> config serial <key> comms baud

Data bits

The number of data bits in each character transmitted or received.

8 data bits is by far the most common setting, only choose 7 data bits if it is required by the connected device.

• Data type: string select
• Default: 8
• Configuration
• Required

CLI: (cli)> config serial <key> comms data-bits

Stop bits

The number of bits signifying the end of data.

1 stop bit is most commonly used with 8 data bits, other options should only be chosen when the communicating equipment is known to required specific settings.

• Data type: string select
• Default: 1
• Configuration
• Required

CLI: (cli)> config serial <key> comms stop-bits

Parity

Parity checking is used to detect errors in the communication.

No parity checking is commonly used, only on specific use cases will another parity setting be required.

• Data type: string select
• Default: none
• Configuration
• Required

CLI: (cli)> config serial <key> comms parity

Flow control

Flow control is used to pause communications when required.

No flow control is often used for low bandwidth interactive connections. A suitable flow control option should be chosen for higher throughput communications or when it is desirable to tell the peer to pause transmission to prevent overflows while the currently received data is processed.

• Data type: string select
• Default: none
• Configuration
• Required

CLI: (cli)> config serial <key> comms flow-control

Pinout

Select the Pinout of the serial connector.

This port has the ability to change the pinout it uses to help with communications to different devices.

• Data type: string select
• Default: straight
• Configuration
• Required

CLI: (cli)> config serial <key> comms pinout

Signals

Properties

CTS

CTS pin state.

• Data type: boolean
• Status

CLI: (cli)> show serial <key> signal cts

RTS

RTS pin state.

• Data type: boolean
• Status

CLI: (cli)> show serial <key> signal rts

DTR

DTR pin state.

• Data type: boolean
• Status

CLI: (cli)> show serial <key> signal dtr

DSR

DSR pin state.

• Data type: boolean
• Status

CLI: (cli)> show serial <key> signal dsr

DCD

DCD pin state.

• Data type: boolean
• Status

CLI: (cli)> show serial <key> signal dcd

Statistics

Properties

Received bytes

Total number of bytes received on the serial port.

• Data type: integer
• Units: bytes
• Status

CLI: (cli)> show serial <key> statistics rx-bytes

Transmitted bytes

Total number of bytes transmitted on the serial port.

• Data type: integer
• Units: bytes
• Status

CLI: (cli)> show serial <key> statistics tx-bytes

Framing errors

Total number of framing errors detected on the serial port.

A framing error occurs when the receiver does not see a clean start bit/stop bit data frame. It can be caused by incorrect settings or corruption.

• Data type: integer
• Status

CLI: (cli)> show serial <key> statistics framing-errors

Parity errors

Total number of parity errors detect on the serial port.

A parity error occurs when a bit in a data frame is corrupted.It can be caused by incorrect settings or corruption. Parity checking is a very rudimentary form of error checking and only detects some simple errors.

• Data type: integer
• Status

CLI: (cli)> show serial <key> statistics parity-errors

FIFO overruns

Total number of fifo overruns.

Fifo overruns occur when to much data is received for the serial port hardware to process and some data is discarded. This can caused by incorrect or no flow control settings.

• Data type: integer
• Status

CLI: (cli)> show serial <key> statistics fifo-overruns

Buffer overruns

Total number of buffer overruns.

Buffer overruns occur when to much data is received for the receiving application to process and the systems buffers have filled and extra data is discarded. This can caused by incorrect or no flow control settings preventing the receiving system from informing the transmitting system to pause transmission.

• Data type: integer
• Status

CLI: (cli)> show serial <key> statistics buffer-overruns

Serial breaks

Total number breaks.

A break on a serial port means a special 'non-data' bit sequence was received. Breaks are often used to send a special event or notification outside of the normal serial communications.

• Data type: integer
• Status

CLI: (cli)> show serial <key> statistics serial-breaks

Direct access

• SSH - Allow direct connection to the serial port using SSH.
• Telnet - Allow direct connection to the serial port using telnet.

SSH

Allow direct connection to the serial port using SSH.

Access the serial port with an encrypted SSH session using a command similar to:

ssh -p <port> <username>@<ip address of device>

Use the SSH escape character to control the SSH session.

• Access control list

Properties

Enable

Enable the network service.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config serial <key> access ssh enable

Port

The IP port the service operates on.

• Data type: integer
• Minimum: 1
• Maximum: 65535
• Configuration
• Optional

CLI: (cli)> config serial <key> access ssh port

Access control list

The set of interfaces that the service is accessible from.

Set both Interfaces and Zones to empty to remove interface restrictions.

Properties

Interfaces

Allow the service to be accessed over interfaces in this list.

• Data type: reference list
• Configuration

CLI: (cli)> config serial <key> access ssh acl interface

Zones

Allow the service to be accessed over interfaces in the zones in this list.

• Data type: reference list
• Configuration

CLI: (cli)> config serial <key> access ssh acl zone

Telnet

Allow direct connection to the serial port using telnet.

Access the serial port with telnet using a command similar to:

telnet <ip address of device> <port>

Use the telnet escape character to control the session (traditionally ^[).

• Access control list

Properties

Enable

Enable the network service.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config serial <key> access telnet enable

Port

The IP port the service operates on.

• Data type: integer
• Minimum: 1
• Maximum: 65535
• Configuration
• Optional

CLI: (cli)> config serial <key> access telnet port

Access control list

The set of interfaces that the service is accessible from.

Set both Interfaces and Zones to empty to remove interface restrictions.

Properties

Interfaces

Allow the service to be accessed over interfaces in this list.

• Data type: reference list
• Configuration

CLI: (cli)> config serial <key> access telnet acl interface

Zones

Allow the service to be accessed over interfaces in the zones in this list.

• Data type: reference list
• Configuration

CLI: (cli)> config serial <key> access telnet acl zone

Logging

• File based log settings - Control how serial information is logged to a file.
• Syslog - Configure how serial port logs are distinguished within log files.

Properties

Mode

Customize the serial information that is logged.

Choose the level of detail that is logged for this serial port. The more types of information that are logged the larger the quantity of data logged.

• Data type: string select
• Default: events+rx
• Configuration
• Required

CLI: (cli)> config serial <key> logging log-mode

Destination

Direct serial logs to different log stores.

• Data type: string select
• Default: file
• Configuration
• Required

CLI: (cli)> config serial <key> logging log-destination

File based log settings

Control how serial information is logged to a file.

Properties

Store logs on File System

• Data type: reference path
• References instances of: Storage / Filesystems
• Default: /storage/volume/serial-logs
• Configuration
• Required

CLI: (cli)> config serial <key> logging file-settings file-system

Maximum log file size (kB)

• Data type: integer
• Default: 256
• Minimum: 1
• Configuration
• Required

CLI: (cli)> config serial <key> logging file-settings log-file-size

Number of allowed rotations

• Data type: integer
• Default: 3
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config serial <key> logging file-settings num-rotations

Syslog

Configure how serial port logs are distinguished within log files.

Properties

Log facility

The syslog 'log' facility used in serial port logs.

• Data type: string select
• Default: 16
• Configuration
• Required

CLI: (cli)> config serial <key> logging syslog-settings log-facility

Log severity

The syslog 'log' severity used in serial port logs.

• Data type: string select
• Default: 6
• Configuration
• Required

CLI: (cli)> config serial <key> logging syslog-settings log-severity

Connected users

Session details

Active session details for connections to this port.

Properties

Username

The username used to authenticate when connecting to this port.

• Data type: string
• Status

CLI: (cli)> show serial <key> connected-user <index> username

Session start time

The time at which this user session started.

• Data type: integer
• Units: seconds since epoch
• Status

CLI: (cli)> show serial <key> connected-user <index> session-start

Source address

The address the user is connecting from.

• Data type: string
• Status

CLI: (cli)> show serial <key> connected-user <index> src-address

Access method

Method used by user to access the serial port.

A serial port may be accessed by many methods. The method used by each connected user will be shown

• Data type: string select
• Status

CLI: (cli)> show serial <key> connected-user <index> access-method

User has locked port

Access to the port is locked by this user.

A port that is set to single user mode will be locked while this user is connected and other users will be prevented from accessing the port.

• Data type: boolean
• Status

CLI: (cli)> show serial <key> connected-user <index> user-locked-port

Storage

• Volumes
• Disks - The device's internal storage disks.
• Downloads - Download files to the device's storage.

Volumes

New Volume items can be added.

Volume

An object for the storage of data.

• Volume size - Information on the capacity of the volume.

Properties

Label

The label used to describe and locate this filesystem.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config storage volume <key> label

Resource tags

Apply these tags to resources associated with this filesystem.

• Data type: string list
• Configuration

CLI: (cli)> config storage volume <key> tags

Disk

The disk that the volume's contents will be stored on.

• Data type: reference path
• References instances of: Storage / Disks
• Default: /storage/disk/user-data
• Configuration
• Required

CLI: (cli)> config storage volume <key> disk

Volume size

Information on the capacity of the volume.

Properties

Space used

The disk space occupied by the files contained in the volume.

• Data type: integer
• Units: bytes
• Minimum: 0
• Status

CLI: (cli)> show storage volume <key> size used

Space available

The remaining space available on the disk.

• Data type: integer
• Units: bytes
• Minimum: 0
• Status

CLI: (cli)> show storage volume <key> size available

Disks

The device's internal storage disks.

Default Disk items cannot be deleted. New Disk items can be added.

Disk

Define a disk for use by the system.

• Match disk - Use the attached disk that matches the criteria.
• Match partition - Use the disk partition that matches the criteria.
• Disk size - Information on the size of the disk.

Properties

Enable

Enable this disk.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config storage disk <key> enable

Label

The label used to describe and locate this disk.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config storage disk <key> label

Resource tags

Apply these tags to resources associated with this filesystem.

• Data type: string list
• Configuration

CLI: (cli)> config storage disk <key> tags

Status

The status of this disk.

• Data type: string
• Status

CLI: (cli)> show storage disk <key> status

Match disk

Use the attached disk that matches the criteria.

If no match criteria is configured, then any unused disk will match.

Match partition

Use the disk partition that matches the criteria.

If no match criteria is configured, then any unused disk partition will match.

Properties

Match partition label

The partition on the matched disk with this label will be used.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config storage disk <key> match-partition label

Match partition index

The partition on the matched disk with this index will be used.

• Data type: integer
• Minimum: 1
• Configuration
• Optional

CLI: (cli)> config storage disk <key> match-partition index

Disk size

Information on the size of the disk.

Properties

Partition size

The total size of the partition/disk

• Data type: integer
• Units: bytes
• Minimum: 0
• Status

CLI: (cli)> show storage disk <key> size total

Space used

The amount of storage space currently occupied on the partition/disk.

• Data type: integer
• Units: bytes
• Minimum: 0
• Status

CLI: (cli)> show storage disk <key> size used

Space available

The amount of storage space available for use on the partition/disk.

• Data type: integer
• Units: bytes
• Minimum: 0
• Status

CLI: (cli)> show storage disk <key> size available

Downloads

Download files to the device's storage.

Downloaded files can be used with other device functionality, such as as virtual machine disk images, and firmware images for provisioning other devices with TFTP.

New Download items can be added.

Download

A file to download to the device's storage.

• Download progress - Information showing the download progress.

Properties

Enable

Enable this download.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config storage download <key> enable

File ready

Download is successful and complete.

• Data type: boolean
• Status

CLI: (cli)> show storage download <key> ready

Status

Current download status.

• Data type: string
• Status

CLI: (cli)> show storage download <key> status

URL

The URL to download.

• Data type: string
• Configuration
• Required

CLI: (cli)> config storage download <key> url

Destination filesystem

Download the file to this filesystem.

• Data type: reference path
• References instances of: Storage / Filesystems
• Default: /storage/disk/user-data
• Configuration
• Required

CLI: (cli)> config storage download <key> filesystem

Destination path

Path relative to the destination filesystem.

May contain "/" path separators to download to a subdirectory. Terminate with a path separator character to preserve the original filename.

• Data type: string
• Default: /
• Configuration
• Required

CLI: (cli)> config storage download <key> path

Read only

Downloaded file will be set read-only.

If the file is set as read-only and is modified, the hash check will fail and the file will be re-downloaded.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config storage download <key> read-only

Hash method

Check the downloaded file's integrity with a hash.

Select the hashing method for checking the downloaded file.

• Data type: string select
• Default: none
• Configuration
• Required

CLI: (cli)> config storage download <key> hash-method

Hash

The hash used to check the downloaded file's integrity.

• Data type: string
• Configuration
• Required

CLI: (cli)> config storage download <key> hash

Download progress

Information showing the download progress.

Properties

Downloaded

The percentage of the download completed.

• Data type: integer
• Units: %
• Minimum: 0
• Maximum: 100
• Status

CLI: (cli)> show storage download <key> progress percent

Elapsed time

The elapse time since the download started.

• Data type: integer
• Units: seconds
• Minimum: 0
• Status

CLI: (cli)> show storage download <key> progress time-elapsed

Estimated time remaining

The estimated time until the download completes.

• Data type: integer
• Units: seconds
• Minimum: 0
• Status

CLI: (cli)> show storage download <key> progress time-remaining

Downloaded size

The number of bytes downloads so far.

• Data type: integer
• Units: bytes
• Minimum: 0
• Status

CLI: (cli)> show storage download <key> progress downloaded-size

File size

The full size of the download in progress.

• Data type: integer
• Units: bytes
• Minimum: 0
• Status

CLI: (cli)> show storage download <key> progress file-size

Average speed

The average download speed this download is achieving.

• Data type: integer
• Units: bytes/second
• Minimum: 0
• Status

CLI: (cli)> show storage download <key> progress average-speed

Network

• Cellular
• Ethernet - The device's ethernet interfaces.
• VLANs - 802.1Q encapsulation for VLAN interfaces over Layer 2 network interfaces.
• Flow - Control packet routing, filtering and forwarding with flow rules and zones.

Cellular

• Connections
• Signal
• Network - Information on current network connection.
• SIM
• Details - Cellular Details

Connections

Connection

• APNs - Configured Access Point Names for this connection.
• IPv4
• IPv6
• Interface

Properties

Enable

Enable this connection.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network cellular connection <index> enable

Label

The Label used to help identify and find a connection.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network cellular connection <index> label

Connected

The network connection status.

• Data type: boolean
• Status

CLI: (cli)> show network cellular connection <index> connected

Status

Network connection status state.

• Data type: string
• Status

CLI: (cli)> show network cellular connection <index> status

Connection attempts

The current number of attempts to establish the conneciton.

• Data type: integer
• Status

CLI: (cli)> show network cellular connection <index> attempts

Configured APN

The user configured APN for this connection.

• Data type: string
• Status

CLI: (cli)> show network cellular connection <index> apn-config

Activated APN

The APN that is currently active for this connection.

• Data type: string
• Status

CLI: (cli)> show network cellular connection <index> apn-activated

Metric

The network metric used for routing this connection.

• Data type: integer
• Default: 10
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> metric

APNs

Configured Access Point Names for this connection.

APN

Settings for this APN.

Properties

APN

The Access Point Name.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> apn <index> apn

Authentication method

The authentication needed by this APN.

• Data type: string select
• Default: none
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> apn <index> auth

Username

The username for authentication requests.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> apn <index> username

Password

The password for authentication requests.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> apn <index> password

IPv4

Static or fixed IPv4 address.

• DNS servers - The DNS servers provided by this connection

Properties

Enable

Enable this IPv4 Address for use.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network cellular connection <index> ipv4 enable

Connected

Network connection status state.

• Data type: boolean
• Status

CLI: (cli)> show network cellular connection <index> ipv4 connected

Status

Network connection status state.

• Data type: string
• Status

CLI: (cli)> show network cellular connection <index> ipv4 status

Address

The static IPv4 Address/Network prefix using CIDR notation.

Specify the IPv4 address using the usual dotted quad (A.B.C.D) followed by the network prefix, for example 192.168.0.1/24.

• Data type: string
• Status

CLI: (cli)> show network cellular connection <index> ipv4 address

Gateway

The upstream IPv4 address for the default routing of packets.

• Data type: string
• Status

CLI: (cli)> show network cellular connection <index> ipv4 gateway

DNS servers

The DNS servers provided by this connection

DNS server

Properties

DNS server address

• Data type: string
• Status

CLI: (cli)> show network cellular connection <index> ipv4 dns <index> address

IPv6

Static or fixed IPv6 address.

• Network prefix
• DNS servers

Properties

Enable

Enable this IPv6 Address for use.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network cellular connection <index> ipv6 enable

Connected

• Data type: boolean
• Status

CLI: (cli)> show network cellular connection <index> ipv6 connected

Status

• Data type: string
• Status

CLI: (cli)> show network cellular connection <index> ipv6 status

Address

The static IPv6 Address/Network prefix using CIDR notation.

• Data type: string
• Status

CLI: (cli)> show network cellular connection <index> ipv6 address

Gateway

The upstream IPv6 address for the default routing of packets.

• Data type: string
• Status

CLI: (cli)> show network cellular connection <index> ipv6 gateway

Network prefix

IPv6 prefix.

Properties

Prefix network

The network for the prefix.

• Data type: string
• Status

CLI: (cli)> show network cellular connection <index> ipv6 prefix network

DNS servers

DNS server

Properties

DNS server address

• Data type: string
• Status

CLI: (cli)> show network cellular connection <index> ipv6 dns <index> address

Interface

• Statistics - Network interface statistics
• Connectivity testing - Check interface connectivity to ensure its status is a true reflection of its operational capacity.

Properties

Source NAT

Replace the source address of packets leaving this interface.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network cellular connection <index> interface snat

Weight

The weight for this interface when part of a multipath route reflecting its relative bandwidth or quality.

The weight should reflect the relative bandwidth or quality of this interface. The larger the weight, the better bandwidth or quality an interface provides. For example if interface A has twice the bandwidth of interface B, respectively using the weights 2 and 1 would reflect this.

• Data type: integer
• Default: 100
• Minimum: 0
• Maximum: 10000
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> interface weight

State

• Data type: string select
• Status

CLI: (cli)> show network cellular connection <index> interface state

MTU

Maximum Transmission Unit.

• Data type: integer
• Units: bytes
• Status

CLI: (cli)> show network cellular connection <index> interface mtu

Statistics

Network interface statistics

Properties

Received bytes

The total number of received bytes.

• Data type: integer
• Units: bytes
• Status

CLI: (cli)> show network cellular connection <index> interface statistics rx-bytes

Transmitted bytes

The total number of transmitted bytes.

• Data type: integer
• Units: bytes
• Status

CLI: (cli)> show network cellular connection <index> interface statistics tx-bytes

Received packets

The total number of received packets.

• Data type: integer
• Units: packets
• Status

CLI: (cli)> show network cellular connection <index> interface statistics rx-packets

Transmitted packets

The total number of transmitted packets.

• Data type: integer
• Units: packets
• Status

CLI: (cli)> show network cellular connection <index> interface statistics tx-packets

Connectivity testing

Check interface connectivity to ensure its status is a true reflection of its operational capacity.

• Tests - Tests to run in order to determine if interface is ready.

Commands

• Run tests - Run the configured tests now.

Properties

Enable

Enable connectivity testing.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config network cellular connection <index> interface connectivity enable

Interface ready

The interface is ready when it is passing its connectivity tests.

• Data type: boolean
• Status

CLI: (cli)> show network cellular connection <index> interface connectivity ready

Last pass at

The last time this connectivity test passed.

• Data type: integer
• Units: seconds since epoch
• Status

CLI: (cli)> show network cellular connection <index> interface connectivity last-pass

Last fail at

The last time this connectivity test failed.

• Data type: integer
• Units: seconds since epoch
• Status

CLI: (cli)> show network cellular connection <index> interface connectivity last-fail

Status

A Description of the current connectivity testing status.

• Data type: string
• Status

CLI: (cli)> show network cellular connection <index> interface connectivity status

Test interval

The time to wait between connectivity tests.

• Data type: integer
• Units: seconds
• Default: 60
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> interface connectivity interval

Tests

Tests to run in order to determine if interface is ready.

Tests are executed in order until a test result determines the state of the interface, or, all tests have run and at least one passed.

Test

A single interface test.

• Ping test - Check the interface with an ICMP echo request/reply.
• HTTP/HTTPS/FTP file fetch test - Check the interface by downloading a file over HTTP, HTTPS, or FTP.
• DNS test - Check the interface by performing a DNS lookup.

Properties

Condition

• Data type: string select
• Default: required
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> interface connectivity test <index> condition

Number of runs

The number of times in a row that this test must run succesfully to pass. If a run fails the test fails immediately.

• Data type: integer
• Default: 3
• Minimum: 1
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> interface connectivity test <index> runs

Run interval

The time to wait between test runs.

• Data type: integer
• Units: seconds
• Default: 1
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> interface connectivity test <index> interval

Timeout period

Consider the run failed if it does not receive a successful response within a set period of time.

• Data type: integer
• Units: seconds
• Default: 3
• Minimum: 1
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> interface connectivity test <index> timeout

Test type

• Data type: string select
• Default: ping
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> interface connectivity test <index> type

Ping test

Check the interface with an ICMP echo request/reply.

Properties

Host

Host to ping during testing.

An ICMP echo-request will be sent to the provided host and the the coresponding ICMP echo-reply checked. A hostname or IP may be provided to test against.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> interface connectivity test <index> ping host

Payload size

The size of the packets used for testing.

Tuning the payload size of ping tests can be important for bandwidth sensitive applications.i The test interval in combination with the payload size allows the bandwidth consumption of the tests to be calculated and adjusted if required.

• Data type: integer
• Units: bytes
• Default: 20
• Minimum: 1
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> interface connectivity test <index> ping payload-size

HTTP/HTTPS/FTP file fetch test

Check the interface by downloading a file over HTTP, HTTPS, or FTP.

Properties

URL

The URL of the file to fetch.

Connectivity testing will check that it can download the file at the provided URL and receive a successful response. The URL may use the HTTP, HTTPS, or FTP protocol.

• http://www.not-a-real-site.com/
• https://www.not-a-real-site.com/
• ftp://ftp.not-a-real-site.com/

• Data type: string
• Configuration
• Required

CLI: (cli)> config network cellular connection <index> interface connectivity test <index> fetch url

DNS test

Check the interface by performing a DNS lookup.

Properties

DNS server address

The DNS server to test.

DNS testing will use the DNS server discovered on the interface if this is left blank. If a specific DNS server is required, its address or hostname should be entered here.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network cellular connection <index> interface connectivity test <index> dns address

Run tests

Run the configured tests now.

The command takes no parameters.

Signal

• Automation

Properties

Signal level

• Data type: integer
• Units: / 5
• Minimum: 0
• Maximum: 5
• Status

CLI: (cli)> show network cellular signal level

RSSI

Received Signal Strength Indicator.

• Data type: integer
• Units: dBm
• Status

CLI: (cli)> show network cellular signal rssi

RSRP

Reference Signal Receive Power.

• Data type: integer
• Units: dBm
• Status

CLI: (cli)> show network cellular signal rsrp

RSRQ

Reference Signal Receive Quality.

• Data type: integer
• Units: dB
• Status

CLI: (cli)> show network cellular signal rsrq

SNR

Signal-to-Noise Ratio.

• Data type: integer
• Units: dB
• Status

CLI: (cli)> show network cellular signal snr

Ec/Io

Energy per chip to Interference power ratio.

• Data type: integer
• Units: dBm
• Status

CLI: (cli)> show network cellular signal ecio

Io

Interference power ratio.

• Data type: integer
• Units: dBm
• Status

CLI: (cli)> show network cellular signal io

SINR

Signal to Interference and Noise Ratio.

• Data type: integer
• Units: dB
• Status

CLI: (cli)> show network cellular signal sinr

Frequency band

The current band in use.

• Data type: string
• Status

CLI: (cli)> show network cellular signal band

Access technology

Network access scheme in use.

• Data type: string
• Status

CLI: (cli)> show network cellular signal access-tech

Automation

Automations provide a method to automate tasks and action.

• Trigger data - The model data that will tripper (start) this automation.

Commands

• Start - Start this automation.
• Stop - Stop this automation.

Properties

Enable

Enable this automation.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network cellular signal led enable

Label

The label used to describe and locate this automation.

• Data type: string
• Default: Signal strength LEDs
• Configuration
• Optional

CLI: (cli)> config network cellular signal led label

Running

The run status of this automation.

• Data type: boolean
• Status

CLI: (cli)> show network cellular signal led running

Error

The error associated with the recent failed run.

• Data type: string
• Status

CLI: (cli)> show network cellular signal led error

Script

The javascript automation source.

• Data type: string
• Default: `const platform = await import('@dryjs/platform');

const level = data;

for (let i = 1; i <= 5; i++) { await platform.setLED(signal${i}, level >= i); } `

• Configuration
• Required

CLI: (cli)> config network cellular signal led script

Run schedule

Run the automation action on a schedule.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network cellular signal led schedule

Run on start

Run the automation action immediately after boot up or the automation is added.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network cellular signal led run-on-start

Trigger data

The model data that will tripper (start) this automation.

Properties

Data path

Run the automation action when configuration or status data changes.

• Data type: string
• Default: /network/cellular/signal/level
• Configuration
• Optional

CLI: (cli)> config network cellular signal led data path

Include data subpaths

Filter the data to include the listed subpaths.

• Data type: string list
• Configuration

CLI: (cli)> config network cellular signal led data include

Exclude data subpaths

Filter the data to exclude the listed subpaths.

• Data type: string list
• Configuration

CLI: (cli)> config network cellular signal led data exclude

Start

Start this automation.

The command takes no parameters.

Stop

Stop this automation.

The command takes no parameters.

Network

Information on current network connection.

• 4G network
• 3G network
• Automation

Properties

Cellular generation

• Data type: string select
• Status

CLI: (cli)> show network cellular network generation

Radio access network (RAN)

The Radio access network in use.

• Data type: string
• Status

CLI: (cli)> show network cellular network ran

Operator

The provider of the network in use.

• Data type: string
• Status

CLI: (cli)> show network cellular network operator

MCC

Mobile Country Code.

• Data type: string
• Status

CLI: (cli)> show network cellular network mcc

MNC

Mobile Network Code.

• Data type: string
• Status

CLI: (cli)> show network cellular network mnc

4G network

Properties

Registered

Has the device registered on a network.

• Data type: boolean
• Status

CLI: (cli)> show network cellular network 4g registered

Status

The current status of the connection.

• Data type: string select
• Status

CLI: (cli)> show network cellular network 4g status

Tracking Area Code (TAC)

Combines with CID to provide serving tower location.

• Data type: string
• Status

CLI: (cli)> show network cellular network 4g tac

Cell ID (CID)

Combines with TAC to provide serving tower location.

• Data type: string
• Status

CLI: (cli)> show network cellular network 4g cell-id

3G network

Properties

Registered

Has the device registered on a network.

• Data type: boolean
• Status

CLI: (cli)> show network cellular network 3g registered

Status

The current status of the connection.

• Data type: string select
• Status

CLI: (cli)> show network cellular network 3g status

Location area code (LAC)

Combines with CID to provide serving tower location.

• Data type: string
• Status

CLI: (cli)> show network cellular network 3g lac

Cell ID (CID)

Combines with LAC to provide serving tower location.

• Data type: string
• Status

CLI: (cli)> show network cellular network 3g cell-id

Automation

Automations provide a method to automate tasks and action.

• Trigger data - The model data that will tripper (start) this automation.

Commands

• Start - Start this automation.
• Stop - Stop this automation.

Properties

Enable

Enable this automation.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network cellular network led enable

Label

The label used to describe and locate this automation.

• Data type: string
• Default: Network status LED
• Configuration
• Optional

CLI: (cli)> config network cellular network led label

Running

The run status of this automation.

• Data type: boolean
• Status

CLI: (cli)> show network cellular network led running

Error

The error associated with the recent failed run.

• Data type: string
• Status

CLI: (cli)> show network cellular network led error

Script

The javascript automation source.

• Data type: string
• Default: `const platform = await import('@dryjs/platform');

if (data.active === false) return;

const connected = data.connection && Object.values(data.connection || {}).some(c => c.connected); let colour;

if (data.sim[data.sim.active]?.ready) { colour = { '5G': 'purple', '4G': 'blue', '3G': 'green', }[data.network.generation] || 'white'; } else { colour = 'red'; }

await platform.setLED(data.plugin ? 'plugin' : 'cell', colour, !connected); `

• Configuration
• Required

CLI: (cli)> config network cellular network led script

Run schedule

Run the automation action on a schedule.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network cellular network led schedule

Run on start

Run the automation action immediately after boot up or the automation is added.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network cellular network led run-on-start

Trigger data

The model data that will tripper (start) this automation.

Properties

Data path

Run the automation action when configuration or status data changes.

• Data type: string
• Default: /network/cellular
• Configuration
• Optional

CLI: (cli)> config network cellular network led data path

Include data subpaths

Filter the data to include the listed subpaths.

• Data type: string list
• Configuration

CLI: (cli)> config network cellular network led data include

Exclude data subpaths

Filter the data to exclude the listed subpaths.

• Data type: string list
• Configuration

CLI: (cli)> config network cellular network led data exclude

Start

Start this automation.

The command takes no parameters.

Stop

Stop this automation.

The command takes no parameters.

SIM

• SIM1
• SIM2
• Failover

Commands

• Switch SIM slot - Switch the active SIM slot now.

Properties

Active SIM

The currently active SIM.

• Data type: string select
• Status

CLI: (cli)> show network cellular sim active

Preferred SIM

Force the use of a specific SIM.

• Data type: string select
• Configuration
• Optional

CLI: (cli)> config network cellular sim preferred

SIM1

Properties

Present

The SIM is present.

• Data type: boolean
• Status

CLI: (cli)> show network cellular sim sim1 present

Ready

The SIM is ready for use.

• Data type: boolean
• Status

CLI: (cli)> show network cellular sim sim1 ready

Operator

The provider of the SIM in use.

• Data type: string
• Status

CLI: (cli)> show network cellular sim sim1 operator

IMSI

International Mobile Subscriber Identity.

• Data type: string
• Status

CLI: (cli)> show network cellular sim sim1 imsi

ICCID

Integrated Circuit Card ID.

• Data type: string
• Status

CLI: (cli)> show network cellular sim sim1 iccid

Phone number

The provisioned phone number for this SIM.

All active SIMs will have a phone number, however, it is not always possible to retrieve the number as it depends on the provisioning process for the SIM.

• Data type: string
• Status

CLI: (cli)> show network cellular sim sim1 number

Modem configuration

Modem configuration chosen for this SIM.

• Data type: string
• Status

CLI: (cli)> show network cellular sim sim1 config

Modem configuration version

Modem configuration version chosen for this SIM.

• Data type: string
• Status

CLI: (cli)> show network cellular sim sim1 config-version

SIM2

Properties

Present

The SIM is present.

• Data type: boolean
• Status

CLI: (cli)> show network cellular sim sim2 present

Ready

The SIM is ready for use.

• Data type: boolean
• Status

CLI: (cli)> show network cellular sim sim2 ready

Operator

The provider of the SIM in use.

• Data type: string
• Status

CLI: (cli)> show network cellular sim sim2 operator

IMSI

International Mobile Subscriber Identity.

• Data type: string
• Status

CLI: (cli)> show network cellular sim sim2 imsi

ICCID

Integrated Circuit Card ID.

• Data type: string
• Status

CLI: (cli)> show network cellular sim sim2 iccid

Phone number

The provisioned phone number for this SIM.

All active SIMs will have a phone number, however, it is not always possible to retrieve the number as it depends on the provisioning process for the SIM.

• Data type: string
• Status

CLI: (cli)> show network cellular sim sim2 number

Modem configuration

Modem configuration chosen for this SIM.

• Data type: string
• Status

CLI: (cli)> show network cellular sim sim2 config

Modem configuration version

Modem configuration version chosen for this SIM.

• Data type: string
• Status

CLI: (cli)> show network cellular sim sim2 config-version

Failover

Automations provide a method to automate tasks and action.

• Trigger data - The model data that will tripper (start) this automation.

Commands

• Start - Start this automation.
• Stop - Stop this automation.

Properties

Enable

Enable this automation.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network cellular sim failover enable

Label

The label used to describe and locate this automation.

• Data type: string
• Default: SIM failover
• Configuration
• Optional

CLI: (cli)> config network cellular sim failover label

Running

The run status of this automation.

• Data type: boolean
• Status

CLI: (cli)> show network cellular sim failover running

Error

The error associated with the recent failed run.

• Data type: string
• Status

CLI: (cli)> show network cellular sim failover error

Script

The javascript automation source.

• Data type: string
• Default: `const active = await model.pull('/network/cellular/sim/active'); const alt = active === 'sim1' ? 'sim2' : 'sim1';

/* Don't switch to the alternative SIM slot if it is absent. */ if (!data.sim[alt].present) return;

const maxAttempts = 5; const maxAttemptsExceeded = Object.values(data.connection || {}).some(con => con.attempts > maxAttempts);

/* Switch slot if the current SIM is absent, or a connection has exceeded the

• maximum number of connection attempts. */ if (!data.sim[active].present || maxAttemptsExceeded) { console.log(Switching from ${active.toUpperCase()} to ${alt.toUpperCase()}); await model.runCommand('/network/cellular/sim/switch'); } `

• Configuration
• Required

CLI: (cli)> config network cellular sim failover script

Run schedule

Run the automation action on a schedule.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network cellular sim failover schedule

Run on start

Run the automation action immediately after boot up or the automation is added.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network cellular sim failover run-on-start

Trigger data

The model data that will tripper (start) this automation.

Properties

Data path

Run the automation action when configuration or status data changes.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network cellular sim failover data path

Include data subpaths

Filter the data to include the listed subpaths.

• Data type: string list
• Configuration

CLI: (cli)> config network cellular sim failover data include

Exclude data subpaths

Filter the data to exclude the listed subpaths.

• Data type: string list
• Configuration

CLI: (cli)> config network cellular sim failover data exclude

Start

Start this automation.

The command takes no parameters.

Stop

Stop this automation.

The command takes no parameters.

Switch SIM slot

Switch the active SIM slot now.

The command takes no parameters.

Details

Cellular Details

Properties

IMEI

The International Mobile Equipment Identity (IMEI) of the cellular modem.

• Data type: string
• Status

CLI: (cli)> show network cellular details imei

Serial number

The serial number of the cellular modem.

• Data type: string
• Status

CLI: (cli)> show network cellular details serial

Software revision

The software revision of the cellular modem.

• Data type: string
• Status

CLI: (cli)> show network cellular details revision

Platform

The platform reported by the cellular modem.

• Data type: string
• Status

CLI: (cli)> show network cellular details platform

Platform version

The platform version reported by the cellular modem.

• Data type: string
• Status

CLI: (cli)> show network cellular details platform-version

Ethernet

The device's ethernet interfaces.

Default Ethernet interface items cannot be deleted.

Ethernet interface

• Interface
• IPv4
• IPv6

Properties

Enable

Enable this Layer 2 interface.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network ethernet <key> enable

Label

The label used to describe and locate this ethernet interface.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> label

Speed

The negotiated (or fixed) speed of the connection

• Data type: integer
• Units: Mb/s
• Status

CLI: (cli)> show network ethernet <key> speed

Duplex

The duplex status of the interface.

• Data type: string select
• Status

CLI: (cli)> show network ethernet <key> duplex

Interface

• Statistics - Network interface statistics
• Connectivity testing - Check interface connectivity to ensure its status is a true reflection of its operational capacity.

Properties

Source NAT

Replace the source address of packets leaving this interface.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config network ethernet <key> interface snat

Weight

The weight for this interface when part of a multipath route reflecting its relative bandwidth or quality.

The weight should reflect the relative bandwidth or quality of this interface. The larger the weight, the better bandwidth or quality an interface provides. For example if interface A has twice the bandwidth of interface B, respectively using the weights 2 and 1 would reflect this.

• Data type: integer
• Default: 100
• Minimum: 0
• Maximum: 10000
• Configuration
• Required

CLI: (cli)> config network ethernet <key> interface weight

State

• Data type: string select
• Status

CLI: (cli)> show network ethernet <key> interface state

Carrier

Carrier indicated that an interface is physically able to pass traffic.

• Data type: boolean
• Status

CLI: (cli)> show network ethernet <key> interface carrier

MAC address

Media Access Control address.

The MAC address is a unique identifier assigned to this interface for use as a network address in communications with a network segment.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> interface mac

MTU

Maximum Transmission Unit.

• Data type: integer
• Units: bytes
• Status

CLI: (cli)> show network ethernet <key> interface mtu

Statistics

Network interface statistics

Properties

Received bytes

The total number of received bytes.

• Data type: integer
• Units: bytes
• Status

CLI: (cli)> show network ethernet <key> interface statistics rx-bytes

Transmitted bytes

The total number of transmitted bytes.

• Data type: integer
• Units: bytes
• Status

CLI: (cli)> show network ethernet <key> interface statistics tx-bytes

Received packets

The total number of received packets.

• Data type: integer
• Units: packets
• Status

CLI: (cli)> show network ethernet <key> interface statistics rx-packets

Transmitted packets

The total number of transmitted packets.

• Data type: integer
• Units: packets
• Status

CLI: (cli)> show network ethernet <key> interface statistics tx-packets

Connectivity testing

Check interface connectivity to ensure its status is a true reflection of its operational capacity.

• Tests - Tests to run in order to determine if interface is ready.

Commands

• Run tests - Run the configured tests now.

Properties

Enable

Enable connectivity testing.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config network ethernet <key> interface connectivity enable

Interface ready

The interface is ready when it is passing its connectivity tests.

• Data type: boolean
• Status

CLI: (cli)> show network ethernet <key> interface connectivity ready

Last pass at

The last time this connectivity test passed.

• Data type: integer
• Units: seconds since epoch
• Status

CLI: (cli)> show network ethernet <key> interface connectivity last-pass

Last fail at

The last time this connectivity test failed.

• Data type: integer
• Units: seconds since epoch
• Status

CLI: (cli)> show network ethernet <key> interface connectivity last-fail

Status

A Description of the current connectivity testing status.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> interface connectivity status

Test interval

The time to wait between connectivity tests.

• Data type: integer
• Units: seconds
• Default: 60
• Configuration
• Required

CLI: (cli)> config network ethernet <key> interface connectivity interval

Tests

Tests to run in order to determine if interface is ready.

Tests are executed in order until a test result determines the state of the interface, or, all tests have run and at least one passed.

Test

A single interface test.

• Ping test - Check the interface with an ICMP echo request/reply.
• HTTP/HTTPS/FTP file fetch test - Check the interface by downloading a file over HTTP, HTTPS, or FTP.
• DNS test - Check the interface by performing a DNS lookup.

Properties

Condition

• Data type: string select
• Default: required
• Configuration
• Required

CLI: (cli)> config network ethernet <key> interface connectivity test <index> condition

Number of runs

The number of times in a row that this test must run succesfully to pass. If a run fails the test fails immediately.

• Data type: integer
• Default: 3
• Minimum: 1
• Configuration
• Required

CLI: (cli)> config network ethernet <key> interface connectivity test <index> runs

Run interval

The time to wait between test runs.

• Data type: integer
• Units: seconds
• Default: 1
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network ethernet <key> interface connectivity test <index> interval

Timeout period

Consider the run failed if it does not receive a successful response within a set period of time.

• Data type: integer
• Units: seconds
• Default: 3
• Minimum: 1
• Configuration
• Required

CLI: (cli)> config network ethernet <key> interface connectivity test <index> timeout

Test type

• Data type: string select
• Default: ping
• Configuration
• Required

CLI: (cli)> config network ethernet <key> interface connectivity test <index> type

Ping test

Check the interface with an ICMP echo request/reply.

Properties

Host

Host to ping during testing.

An ICMP echo-request will be sent to the provided host and the the coresponding ICMP echo-reply checked. A hostname or IP may be provided to test against.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network ethernet <key> interface connectivity test <index> ping host

Payload size

The size of the packets used for testing.

Tuning the payload size of ping tests can be important for bandwidth sensitive applications.i The test interval in combination with the payload size allows the bandwidth consumption of the tests to be calculated and adjusted if required.

• Data type: integer
• Units: bytes
• Default: 20
• Minimum: 1
• Configuration
• Required

CLI: (cli)> config network ethernet <key> interface connectivity test <index> ping payload-size

HTTP/HTTPS/FTP file fetch test

Check the interface by downloading a file over HTTP, HTTPS, or FTP.

Properties

URL

The URL of the file to fetch.

Connectivity testing will check that it can download the file at the provided URL and receive a successful response. The URL may use the HTTP, HTTPS, or FTP protocol.

• http://www.not-a-real-site.com/
• https://www.not-a-real-site.com/
• ftp://ftp.not-a-real-site.com/

• Data type: string
• Configuration
• Required

CLI: (cli)> config network ethernet <key> interface connectivity test <index> fetch url

DNS test

Check the interface by performing a DNS lookup.

Properties

DNS server address

The DNS server to test.

DNS testing will use the DNS server discovered on the interface if this is left blank. If a specific DNS server is required, its address or hostname should be entered here.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> interface connectivity test <index> dns address

Run tests

Run the configured tests now.

The command takes no parameters.

IPv4

• Static IP addresses
• Static routes
• DHCP
• Link-local address
• Automation

Static IP addresses

Static IP address

Static or fixed IPv4 address.

Properties

Enable

Enable this IPv4 Address for use.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network ethernet <key> ipv4 static <index> enable

Address

The static IPv4 Address/Network prefix using CIDR notation.

Specify the IPv4 address using the usual dotted quad (A.B.C.D) followed by the network prefix, for example 192.168.0.1/24.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 static <index> address

Gateway

The upstream IPv4 address for the default routing of packets.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv4 static <index> gateway

Metric

The network metric used for routing this network.

• Data type: integer
• Default: 0
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 static <index> metric

Static routes

Route

A route to a host or network.

Properties

Enable

Enable this route.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network ethernet <key> ipv4 route <index> enable

Destination

The destination host or network that is the files destination for this route.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 route <index> dst

Gateway address

The upstream gateway for routes associated with this connection.

• Data type: string
• Default: 0.0.0.0
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv4 route <index> gateway

Metric

The network metric assigned to routes associated with this connection.

• Data type: integer
• Default: 0
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 route <index> metric

DHCP

• DHCP client
• DHCP server
• DHCP relay
• Passthrough

Properties

DHCP mode

• Data type: string select
• Default: none
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 dhcp mode

DHCP client

Request addressing from a DHCP server connect via this interface.

• Lease - The current lease details.

Properties

Metric

The network metric used for routing this network.

• Data type: integer
• Default: 0
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 dhcp client metric

Client identifier

The identifier sent in DHCP requests.

Include this string value in the DHCP client identifier option (number 61) instead of the interface's MAC address.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv4 dhcp client client-identifier

Lease

The current lease details.

• DNS servers - The DNS servers provided by the current lease.
• NTP servers - The NTP servers provided by the current lease.

Properties

Lease address

The address provided by the current lease.

Specify the IPv4 address using the usual dotted quad (A.B.C.D) followed by the network prefix, for example 192.168.0.1/24.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp client lease address

Gateway

The gateway provided by the current lease.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp client lease gateway

DNS servers

The DNS servers provided by the current lease.

DNS server

Properties

DNS server address

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp client lease dns <index> address

Source address

• Data type: reference path
• References instances of: Network / ip / Addresses
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp client lease dns <index> src

NTP servers

The NTP servers provided by the current lease.

NTP server

The NTP server used for time synchronization.

Properties

Address

The network address of the NTP server.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp client lease ntp <index> address

Authentication key index

• Data type: integer
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp client lease ntp <index> auth-key-idx

Server pool

Server address is a pool of servers.

• Data type: boolean
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp client lease ntp <index> pool

Protocol version

• Data type: string select
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp client lease ntp <index> version

DHCP server

A DHCP server instance.

• Lease pool - A group of IP address that can be issued to clients requesting an address.
• Static leases - Lock a specific lease address to a known host.
• Active leases - Leases that have been provided or renewed with the previous lease time period.
• DHCP options - DHCP options can be used to fine tune a DHCP server for a particular deployment scenario.

Properties

Lease time

The time this lease will remain valid for when issued.

• Data type: integer
• Units: seconds
• Default: 43200
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv4 dhcp server lease-time

Lease pool

A group of IP address that can be issued to clients requesting an address.

More than one lease pool can be provided. Addresses will be allocated from the combination of all pools.

Lease range

The range of addresses to add to the pool.

Range start and Range end are included in the pool.

Properties

Range start

The first address of the range.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 dhcp server lease-pool <index> start

Range end

The final address of the range.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 dhcp server lease-pool <index> end

Static leases

Lock a specific lease address to a known host.

Static leases are used to ensure essential servers like servers always use the same address.

Static lease

A single static lease.

Properties

MAC

The MAC address of the client this lease applies to.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv4 dhcp server static-lease <index> mac

Hostname

• Data type: string
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 dhcp server static-lease <index> hostname

Address

• Data type: string
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 dhcp server static-lease <index> address

Active leases

Leases that have been provided or renewed with the previous lease time period.

Lease

Properties

Hostname

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp server active-lease <index> hostname

Address

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp server active-lease <index> address

MAC

The MAC address of the client receiving the address.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp server active-lease <index> mac

Expires at

The time at which this lease expires.

• Data type: integer
• Units: seconds since epoch
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp server active-lease <index> expires

Relay address

The address of the upstream DHCP server that provided the lease.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp server active-lease <index> relay

DHCP options

DHCP options can be used to fine tune a DHCP server for a particular deployment scenario.

• DNS servers - Provide the client with the listed DNS servers
• NTP servers - Provide the client with the listed NTP servers
• WINS servers - Provide the client with the listed WINS servers
• BOOT File - Provide a boot file to the client.
• Custom DHCP options - Arbitary custom DHCP server options

Properties

Gateway

Provide the client with a default route via this gateway address.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv4 dhcp server option gateway

MTU

Instruct the client to set its MTU to the provided value.

• Data type: integer
• Units: bytes
• Default: 1500
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 dhcp server option mtu

DNS servers

Provide the client with the listed DNS servers

Properties

DNS option mode

Controls how DNS servers are provided to clients.

When the DNS server is enabled and Automatic DNS servers is selected, the DHCP server provides clients with the address of this DNS server rather than the upstream DNS servers.

• Data type: string select
• Default: auto
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 dhcp server option dns mode

Custom DNS servers

Clients are provided the listed DNS servers.

• Data type: string list
• Configuration

CLI: (cli)> config network ethernet <key> ipv4 dhcp server option dns custom

NTP servers

Provide the client with the listed NTP servers

Properties

Custom NTP servers

Clients are provided the listed NTP servers.

• Data type: string list
• Configuration

CLI: (cli)> config network ethernet <key> ipv4 dhcp server option ntp custom

WINS servers

Provide the client with the listed WINS servers

Properties

Custom WINS servers

Clients are provided the listed WINS servers.

• Data type: string list
• Configuration

CLI: (cli)> config network ethernet <key> ipv4 dhcp server option wins custom

BOOT File

Provide a boot file to the client.

Properties

BOOT filename

The name of the file the client should load.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv4 dhcp server option boot filename

TFTP server address

The address of the TFTP server hosting the file.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv4 dhcp server option boot server

Custom DHCP options

Arbitary custom DHCP server options

There are a huge number of DHCP options, many of which are rarely used. If the option required is not listed above, most other options can be manually configure using the following paramaters.

Option

Properties

Option number

The RFC2939 option number.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 dhcp server option custom <index> number

Value

The value for this option.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 dhcp server option custom <index> value

Always send to client

Send this option in all communications with a client when enabled.

Without Always send to client enabled, the option is only sent if requested by the client.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config network ethernet <key> ipv4 dhcp server option custom <index> always-send

DHCP relay

Properties

DHCP relay servers

Relay DHCP requests to these DHCP servers.

• Data type: string list
• Configuration

CLI: (cli)> config network ethernet <key> ipv4 dhcp relay server

Passthrough

Properties

Source address

The address to passthrough.

• Data type: reference path
• References instances of: Network / ipv4 / Static IP addresses
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 dhcp passthrough address

Client MAC address

The MAC address of the client receiving the passthrough address.

Provide the lease of the passthrough address to the client with this MAC address.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv4 dhcp passthrough mac

Link-local address

Properties

Enable

Enable Link-local address on this interface.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config network ethernet <key> ipv4 link-local enable

Address

The Link-local address obtained this interface.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv4 link-local address

Metric

The network metric assigned to routes associated with this connection.

• Data type: integer
• Default: 100
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 link-local metric

Automation

Automations provide a method to automate tasks and action.

• Trigger data - The model data that will tripper (start) this automation.

Commands

• Start - Start this automation.
• Stop - Stop this automation.

Properties

Enable

Enable this automation.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network ethernet <key> ipv4 dhcp-client-link-local-fallback enable

Label

The label used to describe and locate this automation.

• Data type: string
• Default: DHCP client / link-local address fallback
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv4 dhcp-client-link-local-fallback label

Running

The run status of this automation.

• Data type: boolean
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp-client-link-local-fallback running

Error

The error associated with the recent failed run.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv4 dhcp-client-link-local-fallback error

Script

The javascript automation source.

• Data type: string
• Default: if (data.mode === 'client') { const enable = !data.client.lease.address; console.log(${enable ? 'Enabling' : 'Disabling'} IPv4 link-local address) await model.push('../link-local/enable', enable); }
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv4 dhcp-client-link-local-fallback script

Run schedule

Run the automation action on a schedule.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv4 dhcp-client-link-local-fallback schedule

Run on start

Run the automation action immediately after boot up or the automation is added.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network ethernet <key> ipv4 dhcp-client-link-local-fallback run-on-start

Trigger data

The model data that will tripper (start) this automation.

Properties

Data path

Run the automation action when configuration or status data changes.

• Data type: string
• Default: ../dhcp
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv4 dhcp-client-link-local-fallback data path

Include data subpaths

Filter the data to include the listed subpaths.

• Data type: string list
• Configuration

CLI: (cli)> config network ethernet <key> ipv4 dhcp-client-link-local-fallback data include

Exclude data subpaths

Filter the data to exclude the listed subpaths.

• Data type: string list
• Configuration

CLI: (cli)> config network ethernet <key> ipv4 dhcp-client-link-local-fallback data exclude

Start

Start this automation.

The command takes no parameters.

Stop

Stop this automation.

The command takes no parameters.

IPv6

• Static IP addresses
• Prefix assignments
• Static routes
• SLAAC/DHCPv6 client
• RA/DHCPv6 server

Static IP addresses

Static IP address

Static or fixed IPv6 address.

Properties

Enable

Enable this IPv6 Address for use.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network ethernet <key> ipv6 static <index> enable

Address

The static IPv6 Address/Network prefix using CIDR notation.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv6 static <index> address

Gateway

The upstream IPv6 address for the default routing of packets.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv6 static <index> gateway

Metric

The network metric used for routing this network.

• Data type: integer
• Default: 0
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv6 static <index> metric

Prefix assignments

Prefix assignment

An IPv6 prefix assignment.

Properties

Enable

Enable this IPv6 Address for use.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network ethernet <key> ipv6 prefix-assignment <index> enable

Address

The static IPv6 Address/Network prefix using CIDR notation.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv6 prefix-assignment <index> address

Metric

The network metric used for routing this network.

• Data type: integer
• Default: 0
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv6 prefix-assignment <index> metric

Source prefix

The source network prefix.

• Data type: reference path
• References instances of: Network / ipv6 / Prefixes
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv6 prefix-assignment <index> prefix

Subnet

The IPv6 subnet.

• Data type: string
• Default: 0:0:0:0::/64
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv6 prefix-assignment <index> subnet

Static routes

Route

A route to a host or network.

Properties

Enable

Enable this route.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network ethernet <key> ipv6 route <index> enable

Destination

The destination host or network that is the files destination for this route.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv6 route <index> dst

Gateway address

The upstream gateway for routes associated with this connection.

• Data type: string
• Default: ::
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv6 route <index> gateway

Metric

The network metric assigned to routes associated with this connection.

• Data type: integer
• Default: 0
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv6 route <index> metric

SLAAC/DHCPv6 client

Configuration for a SLAAC/DHCPv6 client on this interface.

• IPv6 addresses - The IPv6 addresses obtained.
• Request prefix delegation - Acquired prefix delegations.
• DNS servers - Provided DNS servers.
• Routes - Provided routes.
• NTP servers - Provided NTP servers.

Properties

Enable

Enable this SLAAC/DHCPv6 client.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config network ethernet <key> ipv6 client enable

Metric

The network metric assigned to routes associated with this connection.

• Data type: integer
• Default: 0
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv6 client metric

IPv6 addresses

The IPv6 addresses obtained.

Static IP address

Static or fixed IPv6 address.

Properties

Address

The static IPv6 Address/Network prefix using CIDR notation.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv6 client address <index> address

Address Type

The source of this assigned address.

• Data type: string select
• Status

CLI: (cli)> show network ethernet <key> ipv6 client address <index> address-type

Request prefix delegation

Acquired prefix delegations.

Delegated prefix

An acquired prefix delegation.

Properties

Prefix network

The network for the prefix.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv6 client prefix <index> network

DNS servers

Provided DNS servers.

DNS server

Properties

DNS server address

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv6 client dns <index> address

Routes

Provided routes.

Route

A route to a host or network.

Properties

Enable

Enable this route.

• Data type: boolean
• Status

CLI: (cli)> show network ethernet <key> ipv6 client route <index> enable

Destination

The destination host or network that is the files destination for this route.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv6 client route <index> dst

Gateway address

The upstream gateway for routes associated with this connection.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv6 client route <index> gateway

Metric

The network metric assigned to routes associated with this connection.

• Data type: integer
• Minimum: 0
• Status

CLI: (cli)> show network ethernet <key> ipv6 client route <index> metric

NTP servers

Provided NTP servers.

NTP server

The NTP server used for time synchronization.

Properties

Address

The network address of the NTP server.

• Data type: string
• Status

CLI: (cli)> show network ethernet <key> ipv6 client ntp <index> address

Authentication key index

• Data type: integer
• Status

CLI: (cli)> show network ethernet <key> ipv6 client ntp <index> auth-key-idx

Server pool

Server address is a pool of servers.

• Data type: boolean
• Status

CLI: (cli)> show network ethernet <key> ipv6 client ntp <index> pool

Protocol version

• Data type: string select
• Status

CLI: (cli)> show network ethernet <key> ipv6 client ntp <index> version

RA/DHCPv6 server

RA/DHCPv6 server configurtion for an interace.

• DHCPv6 options - Optional configuration provided by DHCPv6 server to clients.

Properties

Enable

Enable this RA/DHCPv6 server.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config network ethernet <key> ipv6 server enable

Lease time

The lease time assigned to client leases.

• Data type: integer
• Units: seconds
• Default: 43200
• Configuration
• Optional

CLI: (cli)> config network ethernet <key> ipv6 server lease-time

DHCPv6 options

Optional configuration provided by DHCPv6 server to clients.

• DNS servers - Provide the client with these DNS servers.
• NTP servers - Provide the client with the listed NTP servers
• Custom DHCP options - Arbitary custom DHCP server options

DNS servers

Provide the client with these DNS servers.

Properties

DNS option mode

Controls how DNS servers are provided to clients.

When the DNS server is enabled and Automatic DNS servers is selected, the DHCP server provides clients with the address of this DNS server rather than the upstream DNS servers.

• Data type: string select
• Default: auto
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv6 server option dns mode

Custom DNS servers

Clients are provided the listed DNS servers.

• Data type: string list
• Configuration

CLI: (cli)> config network ethernet <key> ipv6 server option dns custom

NTP servers

Provide the client with the listed NTP servers

Properties

Custom NTP servers

Custom NTP servers

• Data type: string list
• Configuration

CLI: (cli)> config network ethernet <key> ipv6 server option ntp custom

Custom DHCP options

Arbitary custom DHCP server options

There are a huge number of DHCP options, many of which are rarely used. If the option required is not listed above, most other options can be manually configure using the following paramaters.

Option

Properties

Option number

The RFC2939 option number.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv6 server option custom <index> number

Value

The value for this option.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network ethernet <key> ipv6 server option custom <index> value

Always send to client

Send this option in all communications with a client when enabled.

Without Always send to client enabled, the option is only sent if requested by the client.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config network ethernet <key> ipv6 server option custom <index> always-send

VLANs

802.1Q encapsulation for VLAN interfaces over Layer 2 network interfaces.

New VLAN items can be added.

VLAN

• Interface
• IPv4
• IPv6

Properties

Enable

Enable this VLAN.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network vlan <key> enable

Label

The label used to describe and locate this VLAN.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network vlan <key> label

Parent interface

The interface the VLAN will operate on.

• Data type: reference path
• References instances of: Network / Layer 2 interfaces
• Configuration
• Required

CLI: (cli)> config network vlan <key> parent-interface

VLAN ID

The ID for this VLAN.

Devices participating on the VLAN must have the same ID.

• Data type: integer
• Default: 1
• Minimum: 0
• Maximum: 4095
• Configuration
• Required

CLI: (cli)> config network vlan <key> vlan-id

Interface

• Statistics - Network interface statistics
• Connectivity testing - Check interface connectivity to ensure its status is a true reflection of its operational capacity.

Properties

Source NAT

Replace the source address of packets leaving this interface.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config network vlan <key> interface snat

Weight

The weight for this interface when part of a multipath route reflecting its relative bandwidth or quality.

The weight should reflect the relative bandwidth or quality of this interface. The larger the weight, the better bandwidth or quality an interface provides. For example if interface A has twice the bandwidth of interface B, respectively using the weights 2 and 1 would reflect this.

• Data type: integer
• Default: 100
• Minimum: 0
• Maximum: 10000
• Configuration
• Required

CLI: (cli)> config network vlan <key> interface weight

State

• Data type: string select
• Status

CLI: (cli)> show network vlan <key> interface state

Carrier

Carrier indicated that an interface is physically able to pass traffic.

• Data type: boolean
• Status

CLI: (cli)> show network vlan <key> interface carrier

MAC address

Media Access Control address.

The MAC address is a unique identifier assigned to this interface for use as a network address in communications with a network segment.

• Data type: string
• Status

CLI: (cli)> show network vlan <key> interface mac

MTU

Maximum Transmission Unit.

• Data type: integer
• Units: bytes
• Status

CLI: (cli)> show network vlan <key> interface mtu

Statistics

Network interface statistics

Properties

Received bytes

The total number of received bytes.

• Data type: integer
• Units: bytes
• Status

CLI: (cli)> show network vlan <key> interface statistics rx-bytes

Transmitted bytes

The total number of transmitted bytes.

• Data type: integer
• Units: bytes
• Status

CLI: (cli)> show network vlan <key> interface statistics tx-bytes

Received packets

The total number of received packets.

• Data type: integer
• Units: packets
• Status

CLI: (cli)> show network vlan <key> interface statistics rx-packets

Transmitted packets

The total number of transmitted packets.

• Data type: integer
• Units: packets
• Status

CLI: (cli)> show network vlan <key> interface statistics tx-packets

Connectivity testing

Check interface connectivity to ensure its status is a true reflection of its operational capacity.

• Tests - Tests to run in order to determine if interface is ready.

Commands

• Run tests - Run the configured tests now.

Properties

Enable

Enable connectivity testing.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config network vlan <key> interface connectivity enable

Interface ready

The interface is ready when it is passing its connectivity tests.

• Data type: boolean
• Status

CLI: (cli)> show network vlan <key> interface connectivity ready

Last pass at

The last time this connectivity test passed.

• Data type: integer
• Units: seconds since epoch
• Status

CLI: (cli)> show network vlan <key> interface connectivity last-pass

Last fail at

The last time this connectivity test failed.

• Data type: integer
• Units: seconds since epoch
• Status

CLI: (cli)> show network vlan <key> interface connectivity last-fail

Status

A Description of the current connectivity testing status.

• Data type: string
• Status

CLI: (cli)> show network vlan <key> interface connectivity status

Test interval

The time to wait between connectivity tests.

• Data type: integer
• Units: seconds
• Default: 60
• Configuration
• Required

CLI: (cli)> config network vlan <key> interface connectivity interval

Tests

Tests to run in order to determine if interface is ready.

Tests are executed in order until a test result determines the state of the interface, or, all tests have run and at least one passed.

Test

A single interface test.

• Ping test - Check the interface with an ICMP echo request/reply.
• HTTP/HTTPS/FTP file fetch test - Check the interface by downloading a file over HTTP, HTTPS, or FTP.
• DNS test - Check the interface by performing a DNS lookup.

Properties

Condition

• Data type: string select
• Default: required
• Configuration
• Required

CLI: (cli)> config network vlan <key> interface connectivity test <index> condition

Number of runs

The number of times in a row that this test must run succesfully to pass. If a run fails the test fails immediately.

• Data type: integer
• Default: 3
• Minimum: 1
• Configuration
• Required

CLI: (cli)> config network vlan <key> interface connectivity test <index> runs

Run interval

The time to wait between test runs.

• Data type: integer
• Units: seconds
• Default: 1
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network vlan <key> interface connectivity test <index> interval

Timeout period

Consider the run failed if it does not receive a successful response within a set period of time.

• Data type: integer
• Units: seconds
• Default: 3
• Minimum: 1
• Configuration
• Required

CLI: (cli)> config network vlan <key> interface connectivity test <index> timeout

Test type

• Data type: string select
• Default: ping
• Configuration
• Required

CLI: (cli)> config network vlan <key> interface connectivity test <index> type

Ping test

Check the interface with an ICMP echo request/reply.

Properties

Host

Host to ping during testing.

An ICMP echo-request will be sent to the provided host and the the coresponding ICMP echo-reply checked. A hostname or IP may be provided to test against.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network vlan <key> interface connectivity test <index> ping host

Payload size

The size of the packets used for testing.

Tuning the payload size of ping tests can be important for bandwidth sensitive applications.i The test interval in combination with the payload size allows the bandwidth consumption of the tests to be calculated and adjusted if required.

• Data type: integer
• Units: bytes
• Default: 20
• Minimum: 1
• Configuration
• Required

CLI: (cli)> config network vlan <key> interface connectivity test <index> ping payload-size

HTTP/HTTPS/FTP file fetch test

Check the interface by downloading a file over HTTP, HTTPS, or FTP.

Properties

URL

The URL of the file to fetch.

Connectivity testing will check that it can download the file at the provided URL and receive a successful response. The URL may use the HTTP, HTTPS, or FTP protocol.

• http://www.not-a-real-site.com/
• https://www.not-a-real-site.com/
• ftp://ftp.not-a-real-site.com/

• Data type: string
• Configuration
• Required

CLI: (cli)> config network vlan <key> interface connectivity test <index> fetch url

DNS test

Check the interface by performing a DNS lookup.

Properties

DNS server address

The DNS server to test.

DNS testing will use the DNS server discovered on the interface if this is left blank. If a specific DNS server is required, its address or hostname should be entered here.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network vlan <key> interface connectivity test <index> dns address

Run tests

Run the configured tests now.

The command takes no parameters.

IPv4

• Static IP addresses
• Static routes
• DHCP
• Link-local address
• Automation

Static IP addresses

Static IP address

Static or fixed IPv4 address.

Properties

Enable

Enable this IPv4 Address for use.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network vlan <key> ipv4 static <index> enable

Address

The static IPv4 Address/Network prefix using CIDR notation.

Specify the IPv4 address using the usual dotted quad (A.B.C.D) followed by the network prefix, for example 192.168.0.1/24.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 static <index> address

Gateway

The upstream IPv4 address for the default routing of packets.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network vlan <key> ipv4 static <index> gateway

Metric

The network metric used for routing this network.

• Data type: integer
• Default: 0
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 static <index> metric

Static routes

Route

A route to a host or network.

Properties

Enable

Enable this route.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network vlan <key> ipv4 route <index> enable

Destination

The destination host or network that is the files destination for this route.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 route <index> dst

Gateway address

The upstream gateway for routes associated with this connection.

• Data type: string
• Default: 0.0.0.0
• Configuration
• Optional

CLI: (cli)> config network vlan <key> ipv4 route <index> gateway

Metric

The network metric assigned to routes associated with this connection.

• Data type: integer
• Default: 0
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 route <index> metric

DHCP

• DHCP client
• DHCP server
• DHCP relay
• Passthrough

Properties

DHCP mode

• Data type: string select
• Default: none
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 dhcp mode

DHCP client

Request addressing from a DHCP server connect via this interface.

• Lease - The current lease details.

Properties

Metric

The network metric used for routing this network.

• Data type: integer
• Default: 0
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 dhcp client metric

Client identifier

The identifier sent in DHCP requests.

Include this string value in the DHCP client identifier option (number 61) instead of the interface's MAC address.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network vlan <key> ipv4 dhcp client client-identifier

Lease

The current lease details.

• DNS servers - The DNS servers provided by the current lease.
• NTP servers - The NTP servers provided by the current lease.

Properties

Lease address

The address provided by the current lease.

Specify the IPv4 address using the usual dotted quad (A.B.C.D) followed by the network prefix, for example 192.168.0.1/24.

• Data type: string
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp client lease address

Gateway

The gateway provided by the current lease.

• Data type: string
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp client lease gateway

DNS servers

The DNS servers provided by the current lease.

DNS server

Properties

DNS server address

• Data type: string
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp client lease dns <index> address

Source address

• Data type: reference path
• References instances of: Network / ip / Addresses
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp client lease dns <index> src

NTP servers

The NTP servers provided by the current lease.

NTP server

The NTP server used for time synchronization.

Properties

Address

The network address of the NTP server.

• Data type: string
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp client lease ntp <index> address

Authentication key index

• Data type: integer
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp client lease ntp <index> auth-key-idx

Server pool

Server address is a pool of servers.

• Data type: boolean
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp client lease ntp <index> pool

Protocol version

• Data type: string select
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp client lease ntp <index> version

DHCP server

A DHCP server instance.

• Lease pool - A group of IP address that can be issued to clients requesting an address.
• Static leases - Lock a specific lease address to a known host.
• Active leases - Leases that have been provided or renewed with the previous lease time period.
• DHCP options - DHCP options can be used to fine tune a DHCP server for a particular deployment scenario.

Properties

Lease time

The time this lease will remain valid for when issued.

• Data type: integer
• Units: seconds
• Default: 43200
• Configuration
• Optional

CLI: (cli)> config network vlan <key> ipv4 dhcp server lease-time

Lease pool

A group of IP address that can be issued to clients requesting an address.

More than one lease pool can be provided. Addresses will be allocated from the combination of all pools.

Lease range

The range of addresses to add to the pool.

Range start and Range end are included in the pool.

Properties

Range start

The first address of the range.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 dhcp server lease-pool <index> start

Range end

The final address of the range.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 dhcp server lease-pool <index> end

Static leases

Lock a specific lease address to a known host.

Static leases are used to ensure essential servers like servers always use the same address.

Static lease

A single static lease.

Properties

MAC

The MAC address of the client this lease applies to.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network vlan <key> ipv4 dhcp server static-lease <index> mac

Hostname

• Data type: string
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 dhcp server static-lease <index> hostname

Address

• Data type: string
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 dhcp server static-lease <index> address

Active leases

Leases that have been provided or renewed with the previous lease time period.

Lease

Properties

Hostname

• Data type: string
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp server active-lease <index> hostname

Address

• Data type: string
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp server active-lease <index> address

MAC

The MAC address of the client receiving the address.

• Data type: string
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp server active-lease <index> mac

Expires at

The time at which this lease expires.

• Data type: integer
• Units: seconds since epoch
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp server active-lease <index> expires

Relay address

The address of the upstream DHCP server that provided the lease.

• Data type: string
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp server active-lease <index> relay

DHCP options

DHCP options can be used to fine tune a DHCP server for a particular deployment scenario.

• DNS servers - Provide the client with the listed DNS servers
• NTP servers - Provide the client with the listed NTP servers
• WINS servers - Provide the client with the listed WINS servers
• BOOT File - Provide a boot file to the client.
• Custom DHCP options - Arbitary custom DHCP server options

Properties

Gateway

Provide the client with a default route via this gateway address.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network vlan <key> ipv4 dhcp server option gateway

MTU

Instruct the client to set its MTU to the provided value.

• Data type: integer
• Units: bytes
• Default: 1500
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 dhcp server option mtu

DNS servers

Provide the client with the listed DNS servers

Properties

DNS option mode

Controls how DNS servers are provided to clients.

When the DNS server is enabled and Automatic DNS servers is selected, the DHCP server provides clients with the address of this DNS server rather than the upstream DNS servers.

• Data type: string select
• Default: auto
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 dhcp server option dns mode

Custom DNS servers

Clients are provided the listed DNS servers.

• Data type: string list
• Configuration

CLI: (cli)> config network vlan <key> ipv4 dhcp server option dns custom

NTP servers

Provide the client with the listed NTP servers

Properties

Custom NTP servers

Clients are provided the listed NTP servers.

• Data type: string list
• Configuration

CLI: (cli)> config network vlan <key> ipv4 dhcp server option ntp custom

WINS servers

Provide the client with the listed WINS servers

Properties

Custom WINS servers

Clients are provided the listed WINS servers.

• Data type: string list
• Configuration

CLI: (cli)> config network vlan <key> ipv4 dhcp server option wins custom

BOOT File

Provide a boot file to the client.

Properties

BOOT filename

The name of the file the client should load.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network vlan <key> ipv4 dhcp server option boot filename

TFTP server address

The address of the TFTP server hosting the file.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network vlan <key> ipv4 dhcp server option boot server

Custom DHCP options

Arbitary custom DHCP server options

There are a huge number of DHCP options, many of which are rarely used. If the option required is not listed above, most other options can be manually configure using the following paramaters.

Option

Properties

Option number

The RFC2939 option number.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 dhcp server option custom <index> number

Value

The value for this option.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 dhcp server option custom <index> value

Always send to client

Send this option in all communications with a client when enabled.

Without Always send to client enabled, the option is only sent if requested by the client.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config network vlan <key> ipv4 dhcp server option custom <index> always-send

DHCP relay

Properties

DHCP relay servers

Relay DHCP requests to these DHCP servers.

• Data type: string list
• Configuration

CLI: (cli)> config network vlan <key> ipv4 dhcp relay server

Passthrough

Properties

Source address

The address to passthrough.

• Data type: reference path
• References instances of: Network / ipv4 / Static IP addresses
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 dhcp passthrough address

Client MAC address

The MAC address of the client receiving the passthrough address.

Provide the lease of the passthrough address to the client with this MAC address.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network vlan <key> ipv4 dhcp passthrough mac

Link-local address

Properties

Enable

Enable Link-local address on this interface.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config network vlan <key> ipv4 link-local enable

Address

The Link-local address obtained this interface.

• Data type: string
• Status

CLI: (cli)> show network vlan <key> ipv4 link-local address

Metric

The network metric assigned to routes associated with this connection.

• Data type: integer
• Default: 100
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 link-local metric

Automation

Automations provide a method to automate tasks and action.

• Trigger data - The model data that will tripper (start) this automation.

Commands

• Start - Start this automation.
• Stop - Stop this automation.

Properties

Enable

Enable this automation.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network vlan <key> ipv4 dhcp-client-link-local-fallback enable

Label

The label used to describe and locate this automation.

• Data type: string
• Default: DHCP client / link-local address fallback
• Configuration
• Optional

CLI: (cli)> config network vlan <key> ipv4 dhcp-client-link-local-fallback label

Running

The run status of this automation.

• Data type: boolean
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp-client-link-local-fallback running

Error

The error associated with the recent failed run.

• Data type: string
• Status

CLI: (cli)> show network vlan <key> ipv4 dhcp-client-link-local-fallback error

Script

The javascript automation source.

• Data type: string
• Default: if (data.mode === 'client') { const enable = !data.client.lease.address; console.log(${enable ? 'Enabling' : 'Disabling'} IPv4 link-local address) await model.push('../link-local/enable', enable); }
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv4 dhcp-client-link-local-fallback script

Run schedule

Run the automation action on a schedule.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network vlan <key> ipv4 dhcp-client-link-local-fallback schedule

Run on start

Run the automation action immediately after boot up or the automation is added.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network vlan <key> ipv4 dhcp-client-link-local-fallback run-on-start

Trigger data

The model data that will tripper (start) this automation.

Properties

Data path

Run the automation action when configuration or status data changes.

• Data type: string
• Default: ../dhcp
• Configuration
• Optional

CLI: (cli)> config network vlan <key> ipv4 dhcp-client-link-local-fallback data path

Include data subpaths

Filter the data to include the listed subpaths.

• Data type: string list
• Configuration

CLI: (cli)> config network vlan <key> ipv4 dhcp-client-link-local-fallback data include

Exclude data subpaths

Filter the data to exclude the listed subpaths.

• Data type: string list
• Configuration

CLI: (cli)> config network vlan <key> ipv4 dhcp-client-link-local-fallback data exclude

Start

Start this automation.

The command takes no parameters.

Stop

Stop this automation.

The command takes no parameters.

IPv6

• Static IP addresses
• Prefix assignments
• Static routes
• SLAAC/DHCPv6 client
• RA/DHCPv6 server

Static IP addresses

Static IP address

Static or fixed IPv6 address.

Properties

Enable

Enable this IPv6 Address for use.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network vlan <key> ipv6 static <index> enable

Address

The static IPv6 Address/Network prefix using CIDR notation.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv6 static <index> address

Gateway

The upstream IPv6 address for the default routing of packets.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config network vlan <key> ipv6 static <index> gateway

Metric

The network metric used for routing this network.

• Data type: integer
• Default: 0
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv6 static <index> metric

Prefix assignments

Prefix assignment

An IPv6 prefix assignment.

Properties

Enable

Enable this IPv6 Address for use.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network vlan <key> ipv6 prefix-assignment <index> enable

Address

The static IPv6 Address/Network prefix using CIDR notation.

• Data type: string
• Status

CLI: (cli)> show network vlan <key> ipv6 prefix-assignment <index> address

Metric

The network metric used for routing this network.

• Data type: integer
• Default: 0
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv6 prefix-assignment <index> metric

Source prefix

The source network prefix.

• Data type: reference path
• References instances of: Network / ipv6 / Prefixes
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv6 prefix-assignment <index> prefix

Subnet

The IPv6 subnet.

• Data type: string
• Default: 0:0:0:0::/64
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv6 prefix-assignment <index> subnet

Static routes

Route

A route to a host or network.

Properties

Enable

Enable this route.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config network vlan <key> ipv6 route <index> enable

Destination

The destination host or network that is the files destination for this route.

• Data type: string
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv6 route <index> dst

Gateway address

The upstream gateway for routes associated with this connection.

• Data type: string
• Default: ::
• Configuration
• Optional

CLI: (cli)> config network vlan <key> ipv6 route <index> gateway

Metric

The network metric assigned to routes associated with this connection.

• Data type: integer
• Default: 0
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv6 route <index> metric

SLAAC/DHCPv6 client

Configuration for a SLAAC/DHCPv6 client on this interface.

• IPv6 addresses - The IPv6 addresses obtained.
• Request prefix delegation - Acquired prefix delegations.
• DNS servers - Provided DNS servers.
• Routes - Provided routes.
• NTP servers - Provided NTP servers.

Properties

Enable

Enable this SLAAC/DHCPv6 client.

• Data type: boolean
• Default: false
• Configuration

CLI: (cli)> config network vlan <key> ipv6 client enable

Metric

The network metric assigned to routes associated with this connection.

• Data type: integer
• Default: 0
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config network vlan <key> ipv6 client metric

IPv6 addresses

The IPv6 addresses obtained.

Static IP address

Static or fixed IPv6 address.

Properties

Address

The static IPv6 Address/Network prefix using CIDR notation.

• Data type: string
• Status

CLI: (cli)> show network vlan <key> ipv6 client address <index> address

Address Type

The source of this assigned address.

• Data type: string select
• Status

CLI: (cli)> show network vlan <key> ipv6 client address <index> address-type

Request prefix delegation

Acquired prefix delegations.

Delegated prefix

An acquired prefix delegation.

Properties

Prefix network

The network for the prefix.

• Data type: string
• Status

CLI: (cli)> show network vlan <key> ipv6 client prefix <index> network

DNS servers

Provided DNS servers.

DNS server

Properties

DNS server address

• Data type: string
• Status

CLI: (cli)> show network vlan <key> ipv6 client dns <index> address

Routes

Provided routes.

Route

A route to a host or network.

Properties

Enable

Enable this route.

• Data type: boolean
• Status