https://github.com/infrasonar/unificontroller-probe

InfraSonar UniFi Controller probe (API)
https://github.com/infrasonar/unificontroller-probe

cesbit infrasonar monitoring unifi unifi-controller

Last synced: 5 months ago
JSON representation

InfraSonar UniFi Controller probe (API)

• Host: GitHub
• URL: https://github.com/infrasonar/unificontroller-probe
• Owner: infrasonar
• License: gpl-3.0
• Created: 2023-08-30T11:07:54.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-11-17T22:22:03.000Z (7 months ago)
• Last Synced: 2025-11-18T00:16:15.542Z (7 months ago)
• Topics: cesbit, infrasonar, monitoring, unifi, unifi-controller
• Language: Python
• Homepage:
• Size: 46.9 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![CI](https://github.com/infrasonar/unificontroller-probe/workflows/CI/badge.svg)](https://github.com/infrasonar/unificontroller-probe/actions)

[![Release Version](https://img.shields.io/github/release/infrasonar/unificontroller-probe)](https://github.com/infrasonar/unificontroller-probe/releases)

# InfraSonar UniFi Controller Probe

## Environment variable

Variable            | Default                        | Description

------------------- | ------------------------------ | ------------

`AGENTCORE_HOST`    | `127.0.0.1`                    | Hostname or Ip address of the AgentCore.

`AGENTCORE_PORT`    | `8750`                         | AgentCore port to connect to.

`INFRASONAR_CONF`   | `/data/config/infrasonar.yaml` | File with probe and asset configuration like credentials.

`MAX_PACKAGE_SIZE`  | `500`                          | Maximum package size in kilobytes _(1..2000)_.

`MAX_CHECK_TIMEOUT` | `300`                          | Check time-out is 80% of the interval time with `MAX_CHECK_TIMEOUT` in seconds as absolute maximum.

`DRY_RUN`           | _none_                         | Do not run demonized, just return checks and assets specified in the given yaml _(see the [Dry run section](#dry-run) below)_.

`LOG_LEVEL`         | `warning`                      | Log level (`debug`, `info`, `warning`, `error` or `critical`).

`LOG_COLORIZED`     | `0`                            | Log using colors (`0`=disabled, `1`=enabled).

`LOG_FMT`           | `%y%m%d %H:%M:%S`              | Log format prefix.

## Docker build

```

docker build -t unificontroller-probe . --no-cache

```

## Dry run

Available checks:

- `sites`

- `system`

Create a yaml file, for example _(test.yaml)_:

```yaml

asset:

  name: "foo.local"

  check: "unificontroller"

  config:

    address: "192.168.1.2"

    port: 443

    ssl: false

    site: "default"

```

Run the probe with the `DRY_RUN` environment variable set the the yaml file above.

```

DRY_RUN=test.yaml python main.py

```