Welcome to GL.iNet Router Management Script 👋

📋 Introduction

This repository provides a script to manage GL.iNet routers, including controlling VPN connections, obtaining system status, and more. The script supports both WireGuard and OpenVPN configurations. It also provides the possibility to manage the router through Home Assistant.

Note: This script is based on the 4.x API of GL.iNet routers. At the time of writing, these APIs are offline and were retrieved using the Wayback Machine: GL.iNet 4.x API.

🚀 Installation

1. Set up a fresh environment with necessary dependencies:
   • Ensure you have curl, jq, and mkpasswd installed.
2. Download the script using wget:

   wget https://raw.githubusercontent.com/angolo40/GLiNet_managment/main/gl_inet.sh -O gl_inet.sh
   

3. Edit the script gl_inet.sh with your router's credentials and IP address:

   nano gl_inet.sh
   

   Modify the following variables:

   username='root'
   password='your_password'
   host='your_router_ip'
   

4. Ensure the script has executable permissions:

   chmod +x gl_inet.sh
   

🛠️ Script Overview

The script supports the following commands:

• status: Prints the status of the active VPN.
• stop: Stops all active VPN connections.
• get_all_config_wg: Retrieves all WireGuard VPN configurations.
• get_all_config_ovpn: Retrieves all OpenVPN configurations.
• get_system_status: Gets the system status of the router.
• get_system_info: Gets detailed system information.
• get_system_reboot: Reboots the router.
• get_disk_info: Retrieves disk usage information.
• check_firmware_online: Checks if a firmware update is available.
• start_vpn [VPN_NAME]: Starts a specified VPN.
• stop_vpn [VPN_NAME]: Stops a specified VPN.

Key Features

• Supports only VPN client functions (WireGuard and OpenVPN), not VPN server functions.
• When using the start_vpn command, it refers to the VPN configuration name saved on the system.
• The script can be executed directly with ./gl_inet.sh, presenting a dynamic menu, so it can be used without Home Assistant.
• Each command returns a JSON output for easy readability and manipulation.

Development and Testing

• Working on a custom integration for Home Assistant.
• Initiated this project to quickly and easily activate/deactivate VPNs without using the app.
• Tested on:
  • Model: GL-MT300N-V2
  • Firmware version: 4.3.11

🏠 Home Assistant Integration

To integrate this script with Home Assistant, add the following configurations to your configuration.yaml file and put the script in Home Assistant folder /config/scripts/:

shell_command:
  glinet_vpn_albania: "bash /config/scripts/gl_inet.sh start_vpn Albania_37_Tirana"
  glinet_vpn_italia: "bash /config/scripts/gl_inet.sh start_vpn Italy_223_Milan"
  glinet_vpn_svizzera: "bash /config/scripts/gl_inet.sh start_vpn Switzerland_373_Zurich"
  glinet_vpn_status: "bash /config/scripts/gl_inet.sh status"
  glinet_vpn_stop: "bash /config/scripts/gl_inet.sh stop"
  glinet_get_system_status: "bash /config/scripts/gl_inet.sh get_system_status"
  glinet_get_system_info: "bash /config/scripts/gl_inet.sh get_system_info"
  glinet_get_system_reboot: "bash /config/scripts/gl_inet.sh get_system_reboot"
  glinet_get_disk_info: "bash /config/scripts/gl_inet.sh get_disk_info"
  glinet_check_firmware_online: "bash /config/scripts/gl_inet.sh check_firmware_online"

command_line:
  - sensor:
      name: "VPN Status"
      command: "bash /config/scripts/gl_inet.sh status"
      scan_interval: 10
      value_template: >-
        {% if value_json.status == 1 %}
          Attiva
        {% else %}
          Non attiva
        {% endif %}
      json_attributes:
        - group_id
        - client_id
        - peer_id
        - rx_bytes
        - tx_bytes
        - name
        - ipv4
        - domain

  - sensor:
      name: "System Status"
      command: "bash /config/scripts/gl_inet.sh get_system_status"
      scan_interval: 600
      value_template: "OK"
      json_attributes:
        - network
        - wifi
        - service
        - client
        - system

  - sensor:
      name: "Disk Info"
      command: "bash /config/scripts/gl_inet.sh get_disk_info"
      scan_interval: 600
      value_template: "OK"
      json_attributes:
        - root
        - tmp

  - sensor:
      name: "System Info"
      command: "bash /config/scripts/gl_inet.sh get_system_info"
      scan_interval: 600
      value_template: "OK"
      json_attributes:
        - mac
        - disable_guest_during_scan_wifi
        - hardware_version
        - country_code
        - sn_bak
        - software_feature
        - vendor
        - hardware_feature
        - cpu_num
        - board_info
        - firmware_date
        - model
        - ddns
        - sn
        - firmware_type
        - firmware_version

switch:
  - platform: template
    switches:
      vpn_albania:
        friendly_name: "VPN Albania"
        value_template: "{{ state_attr('sensor.vpn_status', 'name') is not none and 'Albania_37_Tirana' in state_attr('sensor.vpn_status', 'name') }}"
        turn_on:
          service: shell_command.glinet_vpn_albania
        turn_off:
          service: shell_command.glinet_vpn_stop
      vpn_italia:
        friendly_name: "VPN Italia"
        value_template: "{{ state_attr('sensor.vpn_status', 'name') is not none and 'Italy_223_Milan' in state_attr('sensor.vpn_status', 'name') }}"
        turn_on:
          service: shell_command.glinet_vpn_italia
        turn_off:
          service: shell_command.glinet_vpn_stop
      vpn_svizzera:
        friendly_name: "VPN Svizzera"
        value_template: "{{ state_attr('sensor.vpn_status', 'name') is not none and 'Switzerland_373_Zurich' in state_attr('sensor.vpn_status', 'name') }}"
        turn_on:
          service: shell_command.glinet_vpn_svizzera
        turn_off:
          service: shell_command.glinet_vpn_stop

script:
  glinet_system_reboot:
    alias: "System Reboot"
    sequence:
      - service: shell_command.glinet_get_system_reboot
  glinet_system_info:
    alias: "System Info"
    sequence:
      - service: shell_command.glinet_get_system_info
  glinet_system_status:
    alias: "System Status"
    sequence:
      - service: shell_command.glinet_get_system_status
  glinet_disk_info:
    alias: "Disk Info"
    sequence:
      - service: shell_command.glinet_get_disk_info
  glinet_check_firmware_online:
    alias: "Check Firmware"
    sequence:
      - service: shell_command.glinet_check_firmware_online

Example Home Assistant Card

To create a card for the VPN switches in Home Assistant, add the following to your Lovelace dashboard configuration:

type: vertical-stack
cards:
  - type: entities
    entities:
      - sensor.vpn_status
      - type: attribute
        entity: sensor.vpn_status
        icon: mdi:vpn
        attribute: name
        name: Nome VPN
      - type: attribute
        entity: sensor.vpn_status
        icon: mdi:vpn
        attribute: domain
        name: Endpoint
      - type: attribute
        entity: sensor.vpn_status
        icon: mdi:vpn
        attribute: ipv4
        name: IP Address
      - type: attribute
        entity: sensor.vpn_status
        icon: mdi:vpn
        attribute: rx_bytes
        name: RX
      - type: attribute
        entity: sensor.vpn_status
        icon: mdi:vpn
        attribute: tx_bytes
        name: TX
  - type: vertical-stack
    cards:
      - type: entities
        entities:
          - switch.vpn_albania
          - switch.vpn_italia
          - switch.vpn_svizzera
        show_header_toggle: false
      - type: entities
        title: System Controls
        entities:
          - script.glinet_system_reboot
          - script.glinet_system_info
          - script.glinet_system_status
          - script.glinet_disk_info
          - script.glinet_check_firmware_online

👤 Author

Giuseppe Trifilio

• Website
• GitHub

🤝 Contributing

Contributions, issues, and feature requests are welcome! Check the issues page.

🌟 Show Your Support

Give a ⭐️ if this project helped you!

---

📝 Note

This README is a work in progress. More details and instructions will be added soon.

• This script is currently in beta as many functionalities are missing.
• I will likely stop development here to start the custom integration for Home Assistant since the current features meet my needs.
• Try it out and let me know if it works for you!