ALEOS AF API Reference Guide 1.3
- Jul 1, 2016
- Author: Sierra Wireless
This provides detailed API documentation of all the Lua modules in ALEOS AF.
LAN segmentation, and the process of adding LAN segments, is used for advanced networking scenarios when LAN traffic must be partitioned.
An instance where LAN segmentation can be utilized is when providing public Internet access to Wi-Fi users, such as bus passengers. In this scenario, it is important to ensure that private onboard equipment connected to the router's Ethernet ports, such as fare boxes, remains inaccessible to Wi-Fi users. Multiple LAN segments are useful for specifying different network policies or routing rules on each segment.
The router comes with a single LAN segment (Default-LAN) and you can create additional network segments under Network > Zones Settings > LAN Segments.
System LAN segments are those defined automatically by the system. The System LAN segments are not directly configurable and are used in firewall rules, Multi-WAN rules or IP Passthrough, to name a few.
You can define your own User LAN segments.
To configure a User LAN segment:
1.Go to Networking > Zones Settings > LAN Segments.
2.Under the USER LAN SEGMENTS table, click CREATE to create a new LAN segment, or click Edit (
) in the table to update an existing LAN segment.
3.Begin configuring the LAN segment. Refer to the table below for details of individual settings.
Setting | Description | Range | Default |
|---|---|---|---|
NAME | Name assigned to this LAN segment Required for all LAN segments | n/a | n/a |
IPV4 ADDRESS | Default gateway LAN address for this LAN segment Required for all LAN segments | IPv4 address | n/a |
IPV4 PREFIX | Specifies how many bits of the IP address for this LAN segment are used for the network ID Required for all LAN segments | 0–32 | 24 |
IPV6 ADDRESS | Default gateway LAN address for this LAN segment | Double-colon notation. Leave blank to disable IPv6. | n/a |
IPV6 PREFIX | Specifies how many bits of the IP address for this LAN segment are used for the network ID. | 0–128 Leave blank to disable IPv6. | 64 |
•DHCP Server: DHCP request is assigned by the router. Either DHCPV4 SERVER or DHCPV6 SERVER has to be On. •DHCP Relay: The router forwards the DHCP request to the DHCP server for assignment. Either DHCP RELAY IPV4 SERVER ADDRESS or DHCP RELAY IPV6 SERVER ADDRESS has to be entered. •None | DHCP SERVER | ||
Appears when DHCP MODE is set to DHCP Relay. The DHCP RELAY IPv4 SERVER forwards DHCP requests from IPv4 clients to a DHCP server, which may be on the same local network or on a different one. | IPv4 address | Blank | |
Appears when DHCP MODE is set to DHCP Relay, and can be configured when an IPV6 ADDRESS is entered. The DHCP RELAY IPv6 SERVER forwards DHCP requests from IPv6 clients to a DHCP server, which may be on the same local network or on a different one. | IPv6 address | Blank | |
Specifies if there is a DHCP server for IPv4 addresses. When DHCPV4 SERVER is On, the following settings appear. •IPV4 POOL STARTING ADDRESS •IPV4 POOL ENDING ADDRESS | On, Off | On | |
IPV4 POOL STARTING ADDRESS | If DHCPV4 SERVER is On, enter the starting IPv4 address of the pool of IP addresses available for DHCP Required for all LAN segments. | IPv4 address | n/a |
IPV4 POOL ENDING ADDRESS | If DHCPV4 SERVER is On, enter the ending IPv4 address of the pool of IP addresses available for DHCP Required for all LAN segments. | IPv4 address | n/a |
IPV4 LEASE TIME (IN MINS) | Length of time that the DHCP server will reserve an IPv4 address for a client device. This is added on to the remaining lease time of the device. | 2–65535 mins | 1 day |
Specifies if there is a DHCP server for IPv6 addresses When DHCPV6 SERVER is On, the following settings appear. •IPv6 POOL STARTING ADDRESS •IPv6 POOL ENDING ADDRESS | On, Off | Off | |
IPv6 POOL STARTING ADDRESS | If DHCPV6 SERVER is On, enter the starting IPv6 address of the pool of IP addresses available for DHCP | Double-colon notation Leave blank to disable IPv6. | n/a |
IPv6 POOL ENDING ADDRESS | If DHCPV6 SERVER is On, enter the ending IPv6 address of the pool of IP addresses available for DHCP | Double-colon notation Leave blank to disable IPv6. | n/a |
IPV6 LEASE TIME (IN MINS) | Length of time that the DHCP server will reserve an IPv6 address for a client device. This is added on to the remaining lease time of the device. | 2–65535 mins | 1 day |
IPV6 SLAAC | When enabled, SLAAC will use the device's MAC address to create a unique interface identifier, which when combined with a network prefix forms a complete IPv6 address. | On, Off | Off |
IPV6 PROXY | When enabled, allows IPv6 traffic between clients on this LAN that are connected to different interface types. For example, allowing a USBnet client to talk to an Ethernet Client. | On, Off | Off |
BROADCAST FORWARDING | Pv4 packet forwarding for broadcast traffic. Specifies if the system will forward broadcast packets it receives on one network interface to other interfaces, allowing broadcast traffic to reach other subnets or networks. | On, Off | Off |
DHCP CLIENT DOMAIN NAME | Enter a domain name that applies to all clients connected to this LAN segment. DHCP clients can be reached via this locally qualified domain name with the hostname as the first label. For example, hostname.client-domain-name. Using DHCP CLIENT DOMAIN NAME on different LAN segments, clients on different LAN segments can reach each other using different hostnames (for example, one LAN segment using hostname.domain.local and another LAN segment using hostname2.domain.local). | Any valid local domain name format | Blank |
DOMAIN SEARCH LIST | Enter a list of domains used to create a FQDN from a relative name (DHCP Option 119). Each device connected to this LAN segment will have a default search domain added to their resolution when looking up names. For example, if a lookup of “somedevice” was made on domain.local, the router's DNS server will look for somedevice.domain.local. | Comma-separated list of search domain names | Blank |
DHCP DNS SERVER | Select the DHCP DNS server to provide DNS resolution to LAN clients. DNS servers can be acquired through WAN links or by manually specifying primary and secondary DNS settings. | •None: LAN clients will use the router for DNS resolution. The router will act as a DNS caching sever, and will use the DNS of the current active WAN for resolution. •Auto: LAN clients will be given the DNS of the currently active WAN interface. This is not recommended to be used in Multi-WAN scenarios as the WAN can change at any time and clients may have stale DNS servers. This is usable in a single WAN environment. •Manual: Select Manual to enter IPv4 or IPv6 primary and secondary DNS Server settings (see below) •Or manually select any available WAN interface to use for DNS resolution such as Wi-Fi, Cellular or Ethernet. Use with caution: if the interface is down or the interface DNS changes, it is up to the client to renew. | None |
IPv4 PRIMARY DNS | Appears when DHCP DNS Server is set to Manual. Enter the IP address of primary Domain Name System (DNS) server. | IPv4 address | n/a |
IPv4 SECONDARY DNS | Appears when DHCP DNS Server is set to Manual. Enter the IP address of secondary Domain Name System (DNS) server. | IPv4 address | n/a |
IPv6 PRIMARY DNS | Appears when DHCP DNS Server is set to Manual. Enter the double-colon notation of primary Domain Name System (DNS) server. | Double-colon notation | n/a |
IPv6 SECONDARY DNS | Appears when DHCP DNS Server is set to Manual. Enter the double-colon notation of secondary Domain Name System (DNS) server. | Double-colon notation | n/a |
Comment
Forum
