https://github.com/sirkirby/ha-udm-rule-manager

Allows you to manage your UDM firewall and traffic rules in Home Assistant
https://github.com/sirkirby/ha-udm-rule-manager

home-assistant integration unifi

Last synced: 3 months ago
JSON representation

Allows you to manage your UDM firewall and traffic rules in Home Assistant

• Host: GitHub
• URL: https://github.com/sirkirby/ha-udm-rule-manager
• Owner: sirkirby
• License: mit
• Created: 2024-09-12T15:38:02.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-26T17:26:04.000Z (3 months ago)
• Last Synced: 2024-10-01T05:07:26.115Z (3 months ago)
• Topics: home-assistant, integration, unifi
• Language: Python
• Homepage:
• Size: 25.4 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Unifi Network Rules Custom Integration

Pulls firewall and traffic rules from your Unifi Dream Machine and allows you to enable/disable them in Home Assistant.

## Installation

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=sirkirby&repository=unifi-network-rules&category=integration)

OR

Copy the`custom_components/unifi_network_rules` directory to your `config/custom_components` directory.

THEN

1. Restart Home Assistant.

2. In the Home Assistant configuration page, click on "Integrations".

3. Click on the "+" button in the bottom right corner.

4. Search for "Unifi Network Rule Manager" and select it.

5. Enter credentials of a local admin user on your UDM and click on the "Submit" button.

## Configuration

**Host**: The IP address of your Unifi Dream Machine.

**Username**: The local admin account on the UDM.

**Password**: The password for the UDM account.

## Usage

Once you have configured the integration, you will be able to see the firewall rules configured on your Unifi Network as switches in Home Assistant. Add the switch to a custom dashboard or use it in automations just like any other Home Assistant switch.

## Local Development

To run the tests, you need to install the dependencies in the `requirements_test.txt` file.

```bash

python3 -m venv venv

source venv/bin/activate

pip install -r requirements_test.txt

```

Then run the tests:

```bash

pytest tests

```

## Limitations

The integration is currently limited to managing firewall and traffic rules. It does not currently support managing other types of rules.

## Contributions

Contributions are welcome! Please feel free to submit a PR.