Island Router Documentation

Island Documentation Introduction

• Welcome to Island

Island Router CLI Reference Guide 2.3.2

• Overview: This is the Command Line Interface (CLI) reference guide for Island Router firmware version 2.3.2.
• Context Sensitive Help
• URL Format
• Password Encryption and Public Key Authentication
• Command Scheduler
• Commands
• auto-update
• auto-update days: Set the day(s) of the week to perform automatic updates of the system firmware
• auto-update time: Set the time of day to perform automatic updates of the system firmware
• backup
• backup interval: Sets how often an automatic system backup is performed.
• backup url: Enables the automatic backup function and specifies the destination of the backup file.
• clear connections: Delete all existing firewall state table entries.
• clear dhcp-client: Force a renewal of all IP addresses learned from DHCP.
• clear dump: Deletes a crash dump file, or all crash dump files.
• clear everything: Returns an Island to factory-default condition.
• clear log: Clears the internal system log.
• clear network: Resets all network interface options and places the interfaces into automatic configuration mode.
• clear package: Removes an installable package from the system.
• clear pin: Deletes the PIN used to access Island from the app.
• clear ssh client-keys: Regenerates local SSH client keys.
• clear ssh host-keys: Regenerates the local ssh host keys.
• clear ssh known-hosts: Delete the SSH host key for a remote host or for all remote hosts.
• clear syslog: Deletes a system log file.
• clear update: Stop and clean up from an incomplete update.
• clear vpn-keys: Regenerates the public/private key pair used for VPNs.
• compact: Compacts the internal database to reclaim unusable space.
• configure authorized-keys: Edits the list of authorized public keys for authentication of incoming SSH connections.
• configure known-hosts: Edits the list of known SSH keys for remote hosts.
• configure network: Restores the system from a backup file.
• configure terminal: Enters configuration mode
• description: Sets optional description text for an interface.
• duplex: Sets the duplex mode of an Ethernet interface.
• end: Exits interface context and returns to global context.
• ethernet polling: Specify the number of CPU cores dedicated to Ethernet polling.
• exit: Exit interface context or disconnect the CLI session.
• help: Displays a summary of available commands, or help for a specific command.
• history: Manage a history file instance.
• history empty: Controls whether empty history files are to be created.
• history filter: Restricts the types of activities logged to history files.
• history interval: Enables the generation of history files, and sets how often a new history file is created.
• history output-format: Sets the output format for history log records.
• history rename: Rename an existing history instance.
• history url: Specifies a remote directory to which history files will be written.
• history utc: Causes history file names and the timestamps contained within to be in UTC.
• hostname: Specifies a name for the Island.
• interface: Selects an interface and places the CLI into interface context, or deconfigures an interface.
• ip (interface context)
• ip address: Assigns an IP address to an interface.
• ip autoconfig: Sets the configuration mode for an interface.
• ip autovlan: Enables or disables automatic VLAN provisioning for an interface.
• ip arp-scan: Enables or disables periodic ARP scanning an interface.
• ip arp-spoof: Enables or disables ARP spoofing on an interface.
• ip priority: Defines the priority of a WAN connection relative to other WAN connections.
• ip dhcp6-client: Enables or disables the DHCPv6 client on an interface.
• ip dhcp6-server: Enables or disables the DHCPv6 server on an interface.
• ip dhcp-client: Enables or disables the DHCP client on an interface.
• ip dhcp-lease: Sets the DHCP lease time on an interface.
• ip dhcp-monitor: Enables or disables the DHCP monitor service on an interface.
• ip dhcp-scope: Defines the range of IPv4 addresses available to DHCP clients.
• ip dhcp-server: Enables or disables the DHCP server on an interface.
• ip ident4: Enables or disables fingerprinting of IPv4 devices on an interface.
• ip ident6: Enables or disables fingerprinting of IPv6 devices on an interface.
• ip mtu: Sets the maximum transmission unit (MTU) on an interface.
• ip nat4: Enables or disables IPv4 Network Address Translation (NAT) on an interface.
• ip nat6: Enables or disables IPv6 Network Address Translation (NAT) on an interface.
• ip router-advertise: Enables or disables the sending of IPv6 Router Advertisement (RA) packets on an interface.
• ip router-solicit: Enables or disables the sending of IPv6 Router Solicitation (RS) packets on an interface.
• ip (global context)
• ip ddns name: Establishes a dynamic DDNS host name for the Island.
• ip ddns ipv6: Determines whether IPv6 AAAA records are generated for DDNS.
• ip dhcp-reserve: Assigns a dedicated IP address to a device.
• ip dns local-only: Determines whether the DNS server intercepts all recursive DNS requests or only those directed at the Island.
• ip dns mode: Sets the method Island uses to resolve DNS requests.
• ip firewall: Enable or disable Island's inbound Internet firewall.
• ip ipv6: Globally enable or disable IPv6.
• ip load-sharing: Select the algorithm used to balance traffic between equal-priority WAN interfaces.
• ip max-clients: Sets the maximum number of IP addresses Island will recognize.
• ip port-forward: Create a permanent Destination Network Address Translation (DNAT) entry.
• ip route: Create a static route within the Island.
• led level: Set the brightness of the Island's LED.
• login confirm: Enables or disables CLI confirmation prompots.
• login console: Sets whether a username and password is required to access the CLI through the serial port.
• login remote: Enables or disables remote access.
• login support: Enables or disables remote access by Island Support personnel.
• mac output-format: Specify the format for displaying MAC addresses.
• ntp: Specify NTP servers.
• package: Define a configuration parameter for an installed package.
• packet level: Set the minimum severity level of messages logged by the low-level packet handler.
• parent: Specify the parent interface for a VLAN interface.
• password: Set, change, or remove a password.
• ping: Send an ICMP Echo Request to a host and waits for a reply.
• reload: Reboot the system.
• rollback: Restore the system firmware and configuration to a previously stored checkpoint.
• show clock: Display the current system date and time.
• show config authorized-keys: Display the authorized SSH public keys for a user.
• show config known-hosts: Display the list of known SSH hosts and their public keys.
• show dumps: Display a list of system crash dump files.
• show free-space: Display information about internal storage space.
• show hardware: Display a summary of the system hardware configuration.
• show history: Display history records.
• show interface: Display information about a physical network interface.
• show interface summary: Display information about a physical network interface.
• show interface transceivers: Display information about a physical network interface.
• show ip dhcp-reservations: Display all DHCP IP address reservations.
• show ip interface: Display information about an IP interface.
• show ip neighbors: Display information about IP neighbors.
• show ip recommendations: Display a list of the recommended autoconfiguration mode for each interface.
• show ip routes: Display the IP routing table.
• show ip sockets: Display active local IP sockets.
• show log: Display the system or kernel log.
• show ntp: Display information about the Network Time Protocol (NTP) process.
• show packages: List all installed software packages on the system.
• show public-key: Display the Island's public key.
• show running-config: Display the active system configuration.
• show ssh-client-keys: Display the user’s SSH public keys.
• show startup-config: Display the saved (startup) system configuration.
• show stats: Display various internal system information and statistics.
• show syslog: Display the contents of a system log file.
• show users: Display a list of management connections.
• show vpns: Display the list of configured VPNs.
• show version: Display the system hardware and firmware model and version information.
• speed: Sets the speed of an Ethernet interface.
• ssh: Opens a Secure Shell connection to a remote host.
• stats: This is an alias for the "show stats" command.
• syslog
• syslog level: Specifies the minimum severity of messages sent to a syslog server.
• syslog protocol: Specifies whether TCP or UDP is used to communicate with an external syslog server.
• syslog server: Enables the sending of system log messages to an external syslog server, and specifies the host and port number of the syslog server.
• telnet: Opens a telnet connection to a remote host.
• terminal: The following "terminal" commands are used to set the characteristics of the current CLI session.
• terminal length: Specifies the number of rows on the terminal screen for the current CLI session.
• terminal terminal-type: Specifies the type of terminal for the current CLI session.
• terminal width: Specifies the number of characters on each line of the terminal screen for the current CLI session.
• timezone: Sets the system time zone.
• update: Downloads and installs Island firmware updates and installable packages.
• vpn key-exchange: Exchange VPN keys and establish a VPN with a remote Island running the IslandExpress service.
• vpn peer: The following "vpn peer" commands are used to create and configure VPNs on the Island.
• vpn peer generate client: Creates a VPN and generates a configuration suitable for import into a WireGuard VPN client.
• vpn peer host: Specify the host name or IP address of a VPN peer.
• vpn peer local-ip: Controls the assignment of a local IP address to the VPN for network address translation (NAT).
• vpn peer mac: Specify the host name or IP address of a VPN peer.
• vpn peer name: Specify a description name for a VPN peer.
• vpn peer public-key: Specify a VPN peer's public key.
• vpn peer remote-ip: Assigns an IP address to a VPN peer.
• vpn peer route: Assigns a route to a VPN.
• vpn peer shutdown: Disbles a VPN.
• vpn peer unapproved: Disables a VPN and marks it as "unapproved".
• vpn peer visible: Controls whether the Island's management plane can send traffic over a VPN.
• vpn port: Set the UDP port number for incoming WireGuard connections.
• vpn renumber: Assignes new IP addresses to VPNs from the VPN address pool.
• vpn route: Defines a route to announce to Island VPN peers.
• vpn server: The following "vpn server" commands are used to enable and configure the IslandExpress VPN service.
• vpn server auto-trust: Controls whether VPNs created by IslandExpress are automatically enabled.
• vpn server auto-visible: Controls the initial value of vpn server auto-visible on VPNs created by IslandExpress.
• vpn server no-local: Controls whether new IslandExpress VPNs will accept a local IP address assignment from the report peer.
• vpn server pool: Defines a pool of IP addresses to be assigned to new IslandExpress VPN peers.
• vpn server secret: Enable the IslandExpress service and define the shared secret peers use to authenticate to it.
• vpn sort: Rearrange all VPNs in alphabetical order according to the VPN name.
• write: The following "write" commands copy various system data or configuration files to internal or external storage.
• write dump: Copy a crash dump file to a network location
• write memory: Copy the running configuration to the startup configuration
• write network: Saves a backup of the system to a network location
• write syslog: Copy a system log file to a network location
• write terminal: Displays the running configuration.

Agent Instructions: Querying This Documentation

If you need additional information, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on a page URL with the ask query parameter:

GET https://docs.islandrouter.com/welcome-to-island.md?ask=<question>

The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.