Добавлен файл
This commit is contained in:
@@ -0,0 +1,122 @@
|
|||||||
|
# TrueNAS Tools
|
||||||
|
|
||||||
|
## Описание
|
||||||
|
Инструменты для мониторинга и управления TrueNAS (WTR PRO, 192.168.31.100) через REST API v2.0.
|
||||||
|
|
||||||
|
**Версия TrueNAS:** 25.10.5 (Goldeye)
|
||||||
|
|
||||||
|
## Настройки по умолчанию
|
||||||
|
- **TrueNAS URL:** `http://192.168.31.100`
|
||||||
|
- **API Key:** задаётся в настройках (Valves)
|
||||||
|
- **Кэширование:** 30 секунд (0 = без кэша)
|
||||||
|
|
||||||
|
## Особенности
|
||||||
|
- Автоматический перебор альтернативных путей API (v2.0)
|
||||||
|
- Кэширование запросов для снижения нагрузки
|
||||||
|
- Диагностика соединения (HTTP/HTTPS, SSL, таймауты)
|
||||||
|
|
||||||
|
## Доступные функции
|
||||||
|
|
||||||
|
### get_debug_info()
|
||||||
|
Диагностика соединения с TrueNAS: проверяет базовый URL, HTTP/HTTPS, код ответа и текст ошибки для system/info.
|
||||||
|
|
||||||
|
**Использование:** когда API 'недоступен' и нужно понять, на каком этапе рвётся запрос.
|
||||||
|
|
||||||
|
**Возвращает:** отчёт о проверке подключения, включая пробу HTTP/HTTPS вариантов.
|
||||||
|
|
||||||
|
### clear_cache()
|
||||||
|
Очистка кэша запросов.
|
||||||
|
|
||||||
|
### get_system_status()
|
||||||
|
Статус системы TrueNAS: версия, аптайм, процессор, load average.
|
||||||
|
|
||||||
|
**Возвращает:**
|
||||||
|
```
|
||||||
|
🖥️ TrueNAS: X.Y.Z
|
||||||
|
⏱️ Uptime: Xд Xч Xм
|
||||||
|
🔧 Процессор: <модель>
|
||||||
|
📊 Load Average: 1мин: X.XX, 5мин: X.XX, 15мин: X.XX
|
||||||
|
```
|
||||||
|
|
||||||
|
### get_pools_status()
|
||||||
|
Статус пулов ZFS.
|
||||||
|
|
||||||
|
**Возвращает:** список пулов с статусом, размером, процентом занятости.
|
||||||
|
- ✅ — пул здоров
|
||||||
|
- ⚠️ — проблемы с пулом
|
||||||
|
|
||||||
|
**Пример:**
|
||||||
|
```
|
||||||
|
✅ 'tank' | ONLINE | 0.45 TiB, 16.2% занято
|
||||||
|
✅ 'backup' | ONLINE | 1.81 TiB, 23.9% занято
|
||||||
|
```
|
||||||
|
|
||||||
|
### get_disks_temp_and_info()
|
||||||
|
Информация о дисках: тип, модель, серийный номер, размер.
|
||||||
|
|
||||||
|
**Возвращает:** список дисков с основными параметрами.
|
||||||
|
|
||||||
|
### get_apps_status()
|
||||||
|
Список установленных приложений (TrueNAS Apps, docker compose).
|
||||||
|
|
||||||
|
**Статусы:**
|
||||||
|
- 🟢 RUNNING
|
||||||
|
- ⚪ STOPPED
|
||||||
|
- 🟡 DEPLOYING
|
||||||
|
- 🔴 CRASHED
|
||||||
|
- 🟠 STOPPING
|
||||||
|
|
||||||
|
### get_vms_status()
|
||||||
|
Список виртуальных машин (libvirt/KVM).
|
||||||
|
|
||||||
|
**Возвращает:** имя, статус, vCPU, RAM, автозапуск.
|
||||||
|
|
||||||
|
### get_containers_status()
|
||||||
|
Лёгкие контейнеры / инстансы (incus/virt, LXC-подобные).
|
||||||
|
|
||||||
|
**Возвращает:** имя, тип, статус, образ.
|
||||||
|
|
||||||
|
### get_active_alerts()
|
||||||
|
Активные алерты системы.
|
||||||
|
|
||||||
|
**Уровни:**
|
||||||
|
- 🔴 CRITICAL
|
||||||
|
- 🟡 WARNING
|
||||||
|
- 🔵 INFO
|
||||||
|
|
||||||
|
**Возвращает:** `✅ Все системы работают штатно.` или список алертов.
|
||||||
|
|
||||||
|
### get_full_report()
|
||||||
|
Полный отчёт по всей системе TrueNAS.
|
||||||
|
|
||||||
|
**Включает:**
|
||||||
|
- Система (статус, аптайм, CPU, load)
|
||||||
|
- Пулы ZFS
|
||||||
|
- Диски
|
||||||
|
- Приложения
|
||||||
|
- Виртуальные машины
|
||||||
|
- Контейнеры
|
||||||
|
- Алерты
|
||||||
|
|
||||||
|
## Текущая конфигурация системы
|
||||||
|
|
||||||
|
### Пools
|
||||||
|
| Pool | Диски | Занято |
|
||||||
|
|------|-------|--------|
|
||||||
|
| `tank` | 1x WD05PURX 465.8GB (sda) | 16.2% |
|
||||||
|
| `backup` | 1x WD20EFAX 2TB (sdb) | 23.9% |
|
||||||
|
| `ssd` | mirror: nvme0n1 (ADATA 1.9TB) + nvme2n1 (Samsung 2TB) | 8.0% |
|
||||||
|
| `video` | 1x WD05PURX 465.8GB (sda) | 0.45 TiB |
|
||||||
|
|
||||||
|
### Дополнительные диски
|
||||||
|
- `nvme1n1` — CUSU CV3500M 512GB, свободен, не привязан к пулу
|
||||||
|
|
||||||
|
### Репликации (активные)
|
||||||
|
- `tank/media` → `backup/media`
|
||||||
|
- `tank/nextcloud` → `backup/document`
|
||||||
|
- `tank/movies` → `backup/movies`
|
||||||
|
- `ssd/virtual` → `backup/virtual`
|
||||||
|
- `ssd/virtual-iso` → `backup/virtual-iso`
|
||||||
|
- `ssd/apps` → `backup/apps`
|
||||||
|
|
||||||
|
Все репликации успешны.
|
||||||
Reference in New Issue
Block a user