Командная строка Staffcop

Многие операции, связанные с администрированием, имеют удобную и лаконичную систему команд, выполняемых из командной строки.

Вывод доступных команд

sudo staffcop help [command|django]

Выберите django для вывода команд из командной строки Django.

Активация ключа через командную строку

sudo staffcop activate [ключ]

Добавление правил мониторинга в глобальную конфигурацию

sudo staffcop acl <RULE> <VALUE>

Подробный список правил представлен здесь

Бэкап базы данных и настроек

sudo staffcop backup_db [PATH_TO_BACKUP]

По умолчанию бэкап сохраняется в /var/lib/staffcop/staffcop_backup.

Восстановление базы данных из бэкапа

Примечание

Восстановление базы данных должно выполняться в той же версии Staffcop, в которой был создан бэкап. В противном случае не гарантируется работоспособность системы.

sudo staffcop restore_db [PATH_TO_BACKUP]

По умолчанию обращается по адресу /var/lib/staffcop/staffcop_backup.

Удаление базы данных

Предупреждение

Команда удаляет всю базу данных.

sudo staffcop drop staffcop

Если вы уверены в своих действиях, подтвердите удаление с помощью клавиши y в ответ на вопрос сервера.

После удаления сервер восстановит настройки сервера с помощью команды sudo staffcop init.

Удаление всех файлов и скриншотов старше, чем значение DAYS

sudo staffcop cleandata <DAYS>

Удаление из базы данных всех файлов и событий кроме последних DAYS

sudo staffcop cleanup <DAYS>

Примечание

Чтобы механизм очистки отработал быстро и легко, необходимо свободное дисковое пространство (не менее 15% от размера текущей базы данных).

Эта команда удалит только записи, но физически не освободит место на жёстком диске. Процесс очистки жёсткого диска описан в отдельной инструкции.

Управление ClickHouse

sudo staffcop clickhouse [install|init|reinit|pump|test|start|stop|restart]

Установка и активация базы данных сlickhouse

sudo staffcop clickhouse install

Апгрейд базы данных ClickHouse до стабильной версии

staffcop upgrade clickhouse

Cтавит последнюю известную стабильную версию ClickHouse. Иногда избавляет от проблем нестабильных версий ClickHouse, обычно более новых.

Загрузка данных из PostgreSQL в ClickHouse

sudo staffcop clickhouse pump

Примечание

Эта команда не должна выполняться просто так! Запускайте только если знаете, что делаете!

Тестирование системы выгрузки из PostgreSQL в ClickHouse нужно для диагностики

sudo staffcop clickhouse test

Перезапись всех данных ClickHouse

sudo staffcop clickhouse reinit

Перезапуск сервера ClickHouse

sudo staffcop clickhouse restart

Запуск серврера ClickHouse

sudo staffcop clickhouse start

Остановка сервера ClickHouse

sudo staffcop clickhouse stop

Тест отправки данных от клиента до сервера и вывод конфигурации агента.

sudo staffcop client [SERVER]

Копирование базы данных и файлов с удаленного до локального сервера (PostgreSQL)

sudo staffcop clone <SSH-USER>@<REMOTE-HOST> [ssh options]

Очистка незанятого места и дефрагментация базы данных

sudo staffcop compact

Удаление всех данных по выбранному измерению

sudo staffcop delete [--type agent|account|event] [--days N] [--keep-files] [--compact] <NAME>

--type        Удаление данных по агенту, имени пользователя или типу событий
--days N      Оставить данные за N дней
--compact     Дефрагментация базы данных
--keep-files  Оставить файлы
--keep-events Оставить события
--use-id      Удаление данных по id (значения можно найти в БД)

Доступный список event для команды:

DiskDrive         | Внешние диски
FileOperation     | Операции с файлами
SystemLog         | Системный лог
UserActivity      | Алерт
WebcamSnapshot    | Снимок с веб-камеры
MicRecording      | Запись звука
DevInventory      | Реестр оборудования
AppInventory      | Реестр софта
WebSearch         | Поисковый запрос
DesktopVideo      | Видео рабочего стола
FormData          | Данные формы
WLan              | Беспроводное подключение
InterceptedFile   | Перехваченный файл
Keyboard          | Ввод с клавиатуры
Run               | Запуск приложения
Exit              | Завершение приложения
Screenshot        | Снимок экрана
NetworkConnection | Сеть
AppInstallation   | Установка ПО
Web               | Посещение сайтов
Im                | Интернет-пейджер
Mail              | Почта
FTP               | FTP
PrintDoc          | Печать документов
UserLogon         | Вход/выход из системы
Clipboard         | Буфер обмена
Device            | Устройства
Stat              | Время активности
File              | Файловый сканер

Примечание

Эта команда чувствительна к регистру имени компьютера, будьте пожалуйста внимательны!

Управление специальными разрешениями администраторов

Usage: staffcop special [options] list | grant <user> <permission|all> | revoke <user> <permission|all>

Special permission management

Avaiable permissions:
 can_access_terminal        Имеет доступ к WEB-терминалу
 can_delete_shard           Может удалять данные из БД (помесячно)
 can_delete_event           Может удалять отдельные события
 can_delete_agent           Может удалять компьютеры и пользователей
 can_delete_global_config   Может удалять правила из Глобальной конфигурации
 all                        Все разрешения

Options:
--password            Параметр позволяет задать дополнительный пароль, который будет запрошен перед исполнением операции в веб-консоле.

Дать разрешение:

staffcop special grant [USER] [PERMISSION]

Отозвать разрешение:

staffcop special revoke [USER] [PERMISSION]

Посмотреть разрешения:

staffcop special list

Восстановление дерева фильтров

sudo staffcop rebuild_mptt

Выполните команду, если у вас наблюдаются ошибки при открытии веб-интерфейса в консоли JS

Экспорт фильтров и конфигураций

sudo staffcop export FILE_TO_EXPORT.json

Экспорт производится в файл FILE_TO_EXPORT.json. Указывайте полный путь до файла.

Импорт фильтров и конфигураций

sudo staffcop import FILE_TO_IMPORT.json

При выполнении команды указывайте полный путь до файла.

Текущие фильтры будут сохранены.

Вывод информации о сервере и занятом месте на диске

sudo staffcop info

Инициализация или восстановление настроек сервера

sudo staffcop init

Установка агента с сервера Staffcop

sudo staffcop install [options] ip-address

--domain=DOMAIN       | Домен
--user=USER           | Имя пользователя
--password=PASSWORD   | Пароль
--server=SERVER_HOST  | IP-адрес сервера staffcop
--port=SERVER_PORT    | Порт сервера staffcop
--dry-run             | Проверка возможности установки
--reinstall           | Переустановка агента
--traceback           | Вывод trace ошибок
--uninstall           | Удаление агента
--language=LANGUAGE   | Выбор языка (en, ru)
--log                 | Показать лог установки
--version             | Вывод версии программы

Где, ip-address - это IP-адрес того ПК на котором вы хотите установить агента. В качестве адреса ПК - может выступать и имя рабочей станции, в этом случае у вас должен быть корректно настроен DNS-сервер в параметрах сетевых подключений системы.

Запуск mule в высоком приоритете

sudo staffcop mule <MULE_NAME>

Распознавание текста в изображениях или pdf

sudo staffcop ocr <image or pdf file>

Вывод статистики по ящику

staffcop grab --server=<server> --login=<login> --password=<password>

Установка нового пароля для пользователя

sudo staffcop passwd NEW_PASSWORD

Вывод текущих SQL-запросов и план выполнения

sudo staffcop prof

Удаление пользователей и агентов, которые не имеют событий

sudo staffcop prune

Вывод процессов staffcop

sudo staffcop ps

Перестройка отчетов за N месяцев

sudo staffcop rebuild_sessions MONTHS

Сброс к настройкам сервера по умолчанию

sudo staffcop reinit [full]

Если выбрать параметр «full», также удаляет все пользовательские фильтры

Перезапуск сервиса staffcop

sudo staffcop restart

Создание суперпользовтеля в веб-интерфейсе

sudo staffcop createsuperuser

Объединение событий агентов или аккаунтов с идентичными именами

staffcop sane          | объединяются агенты и аккаунты
staffcop sane agents   | объединяются только агенты
staffcop sane accounts | объединяются только аккаунты

Проверка индексов, включая первичные ключи и шардированные таблицы

staffcop check

Управление шардированием

sudo staffcop shard [init|install|list|ddl|index|copy|drop]

Создание шарда для текущего месяца

sudo staffcop shard init

Включение фунционала шардирования базы данных

sudo staffcop shard install

Предупреждение

Необратимая операция! Команда работает в PostgreSQL версии 11 и выше, требуется 50% дискового пространства.

Вывод списка текущих шардов

sudo staffcop shard list

Удаление части шардированной базы данных

sudo staffcop shard drop agent_event_2021_01_01

Удалить часть БД, которая накопилась за январь 2021 года

Доступ к SQL-консоли staffcop

sudo staffcop sql

Добавление, удаление и отображение динамических полей в модели куба

staffcop dynamic [options]

Примечание

Для вывода краткой справки по этой команде, напишите просто staffcop dynamic

Создание и обновление профиля пользователя из AD

staffcop ad_sync - синхронизация всех аккаунтов
staffcop ad_sync --exists - синхронизация только существующего аккаунта
staffcop ad_sync --user USER_NAME@DOMAIN - синхронизация конкретного пользователя

Примечание

Использует настройки AD указанные в Web-интерфейсе

Синхронизация по указанному домену

sudo staffcop ad_sync --domain DOMAIN.local

Статистика синхронизации

sudo staffcop ad_sync --stats

Присвоение конфигурации для пользователя или агента

staffcop config --[user|agent] <AgentName|UserName> <ComputerConfigurationName|UserConfigurationName>

Примечание

Если название конфигурации состоит из нескольких слов, тогда следует использовать кавычки «Computer Config».

Включение на сервере нового механизма присвоения конфигурации

Начиная с версии 5.4 доступен новый механизм назначения конфигурации агенту. Он необязателен для использования, но может повысить скорость взаимодействия агента и сервера.

staffcop enable rustsrv

Примечание

Механизм меняет процесс присвоения конфигурации агентам из группы Active Directory.

Запуск сервиса staffcop

sudo staffcop start

Остановка сервиса staffcop

sudo staffcop stop

Вывод топовых процессов staffcop

sudo staffcop top

Удаление всех данных

sudo staffcop truncate

Обновление до последней версии

sudo staffcop upgrade

Обновление PostgreSQL до версии 15

sudo staffcop postgresql upgrade

Дополнительные возможности веб-интерфейса

Чтобы включить Linux-консоль на сервере и опцию удаления данных от агентов нужно выполнить команду:

sudo staffcop special grant <user> <permission|all>

Чтобы выключить Linux-консоль на сервере, и опцию удаления данных от агентов нужно выполнить команду:

sudo staffcop special revoke <user> <permission|all>

Примечание

По умолчанию эти меню отключены в веб-интерфейсе.