### Example Interface Configuration Command Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/ip-interface-context/ip-priority An example of another interface configuration command, demonstrating usage within interface context. ```CLI ip arp-spoof on ``` -------------------------------- ### Islandrouter LLMs: Help Command Usage Example Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/help Provides an example of how to use the 'help' command without any parameters to display a summary of all available commands in the Islandrouter LLMs project. ```cli help ``` -------------------------------- ### Generate Client Configuration Example Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/vpn-peer/vpn-peer-generate-client An example demonstrating how to generate a VPN client configuration for a specific client named 'terry-laptop', including only local routes. ```shell vpn peer auto generate client name terry-laptop local-only ``` -------------------------------- ### CLI Examples: show ip recommendations Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/show-ip-recommendations Illustrates various ways to use the 'show ip recommendations' command. These examples demonstrate how to view recommendations for all interfaces, a specific interface, or with the 'no-disabled' option. ```cli show ip recommendations show ip recommendations en2 show ip recommendations no-disable ``` -------------------------------- ### Example NTP Server Configuration Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/ntp Demonstrates how to set a specific NTP server for the Island router. ```CLI ntp pool.ntp.org ``` -------------------------------- ### Island Router `write network` Examples Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/write/write-network Provides examples of using the `write network` command to save system backups to a network location, demonstrating different options for specifying history days and destinations. ```shell write network days 3 url sftp://jane:password@my.example.com/jane-island-backup ``` ```shell write network days 30 size ``` -------------------------------- ### Example Usage Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/packet-level An example demonstrating how to set the minimum severity level to 7 (verbose debugging). ```CLI packet level 7 ``` -------------------------------- ### Show Installed Packages Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/show-packages Lists all currently installed software packages on the Island Router system. The optional 'detail' argument can be provided to show more information about each package. ```cli show packages ``` -------------------------------- ### show log Command Usage Examples Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/show-log Demonstrates practical usage of the 'show log' command. Examples include displaying the default recent log entries, filtering logs to show entries associated with a specific module ('pkteng'), and searching for log entries containing a particular timestamp or identifier. ```cli show log ``` ```cli show log where 00:53:19:A3:89:F1 ``` ```cli show log module pkteng ``` -------------------------------- ### Example ip autoconfig Usage Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/ip-interface-context/ip-autoconfig Demonstrates common usage patterns for setting the interface autoconfiguration mode. ```cli ip autoconfig lan ip autoconfig static-wan ``` -------------------------------- ### SSH Connection Example Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/ssh Demonstrates how to initiate an SSH connection to a remote server using a specific username and hostname. ```shell ssh jane@server.example.com ``` -------------------------------- ### Telnet Command Usage Example Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/telnet Demonstrates how to use the telnet command to connect to a specific server by its domain name. ```shell telnet server.example.com ``` -------------------------------- ### Show IP Interface Command Syntax and Example Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/show-ip-interface Displays detailed information about a specified IP interface. The command requires the interface name as an argument. No default interface is used, and the interface name must be explicitly provided. ```cli show ip interface ``` ```cli show ip interface en0 ``` -------------------------------- ### System Status and Information Display Commands Source: https://context7_llms Commands used to display various system status, configuration, and operational information. This includes details about hardware, interfaces, IP neighbors, routing tables, logs, and installed packages. ```APIDOC 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 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. ``` -------------------------------- ### Set Terminal Width Example Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/terminal/terminal-width An example demonstrating how to set the terminal width to 120 columns. ```shell terminal width 120 ``` -------------------------------- ### General System Management Commands Source: https://context7_llms Provides essential commands for system operation and configuration. This includes compacting the database, setting interface descriptions, managing configuration contexts, accessing help, and handling CLI sessions. ```APIDOC compact - Compacts the internal database to reclaim unusable space. configure terminal - Enters configuration mode. description - Sets optional description text for an interface. end - Exits interface context and returns to global context. exit - Exit interface context or disconnect the CLI session. help - Displays a summary of available commands, or help for a specific command. ``` -------------------------------- ### Example: Enable VPN Server Auto-Trust Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/vpn-server/vpn-server-auto-trust An example demonstrating how to enable the auto-trust feature for VPN servers managed by IslandExpress. ```cli vpn server auto-trust on ``` -------------------------------- ### Example: Set Syslog Level to 2 Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/syslog/syslog-level An example demonstrating how to set the minimum syslog severity level to 2 (less severe error). ```CLI syslog level 2 ``` -------------------------------- ### Islandrouter LLMs: Help Command Syntax Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/help Displays the syntax for the 'help' command, including its parameters and their descriptions. This helps users understand how to invoke the command correctly. ```cli help ``` -------------------------------- ### Show Interface API Documentation Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/show-interface Provides detailed documentation for the 'show interface' command, including parameter descriptions, optional arguments, and usage guidelines. It outlines how to display physical network interface information and transceiver details. ```APIDOC show interface [transceiver] - Displays information about a physical network interface. - Parameters: - iface: The name of the interface. (Required) - transceiver: (Optional) Display information on the installed transceiver, if any. - Defaults: The interface name must be specified. - Usage Guidelines: This command displays detailed information about a physical network interface. If the optional `transceiver` argument is specified, information about the transceiver installed on the interface is displayed instead. - Examples: show interface en0 - Related Commands: show-interface-summary show-interface-transceivers show-ip-interface ``` -------------------------------- ### Enable DHCP Monitor Service Example Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/ip-interface-context/ip-dhcp-monitor An example command to enable the DHCP monitor service on the current interface. The DHCP monitor service watches for rogue DHCP servers and issues a warning if one is found. ```CLI ip dhcp-monitor on ``` -------------------------------- ### System Management and Utility Commands Source: https://context7_llms Commands for managing system settings, performing diagnostics, and controlling system operations. This includes setting LED brightness, formatting MAC addresses, configuring NTP, managing packages, and rebooting the system. ```APIDOC led level Set the brightness of the Island's LED. 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 Startup Configuration Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/show-startup-config Displays the Island's startup configuration stored in non-volatile memory. This is the configuration that is loaded when the system boots. The command takes no arguments. ```cli show startup-config ``` -------------------------------- ### Island Router LED Level Command Syntax and Example Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/led-level Provides the syntax for the 'led level' command, which sets the Island's LED brightness, and an example of its usage. The command requires an integer argument 'n' representing brightness from 0 to 100. ```cli led level ``` ```cli led level 30 ``` -------------------------------- ### Show System Information Commands Source: https://context7_llms Commands to display various system-related information, including SSH keys, startup configuration, statistics, logs, user connections, VPN status, and version details. ```APIDOC show ssh-client-keys - Description: Display the user’s SSH public keys. show startup-config - Description: Display the saved (startup) system configuration. show stats - Description: Display various internal system information and statistics. show syslog - Description: Display the contents of a system log file. show users - Description: Display a list of management connections. show vpns - Description: Display the list of configured VPNs. show version - Description: Display the system hardware and firmware model and version information. ``` -------------------------------- ### Island Router Update Command Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/update The 'update' command downloads and installs firmware updates or installable packages onto the Island router. If no URL is provided, it defaults to fetching the most recent Island firmware. If a simple filename is given as the URL, the file is downloaded from the Island software distribution site. ```APIDOC update [] Description: Downloads and installs Island firmware updates and installable packages. Parameters: url (optional): The URL of the update file. If omitted, the command fetches the latest Island firmware. If a simple filename, it's downloaded from the Island software distribution site. Usage: This command loads new firmware or an installable software package onto the Island. Examples: update update pingurl Related Commands: rollback ``` -------------------------------- ### Disable IP Firewall Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/ip-global-context/ip-firewall Example command to disable the Island's inbound Internet firewall. ```cli ip firewall off ``` -------------------------------- ### Telnet Command Syntax Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/telnet Shows the basic syntax for initiating a telnet connection, specifying the target host. ```shell ssh ``` -------------------------------- ### Example History Interval Command Source: https://docs.islandrouter.com/island-router-cli-2.3.2/commands/history/history-interval Demonstrates how to set the history interval for a specific instance. ```CLI history myhist2 interval 3600 ```