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

Общая справка и помощь

Вывод справки по всем командам

sudo staffcop help

Активация ключа

Активация лицензионного ключа

sudo staffcop activate [ключ]

При успешной активации появится сообщение:

nginx has been restarted {"message": "Activation successful", "message_class": "success"}

Сервер Staffcop

Инициализация

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

Инициализирует системные компоненты Staffcop при первом запуске.

sudo staffcop init

Запуск и остановка сервиса

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

Используйте после остановки службы сервера Staffcop.

sudo staffcop start

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

Останавливает и затем перезапускает сервер. Применимо после изменения конфигурации сервера.

sudo staffcop restart

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

Корректно завершает работу сервера и всех связанных компонентов.

sudo staffcop stop

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

sudo staffcop upgrade

Диагностика и мониторинг

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

sudo staffcop info

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

Показывает наиболее активные и ресурсоемкие процессы Staffcop.

sudo staffcop top

Отчеты

Перестройка отчетов

Перестройка отчетов

staffcop rebuild_sessions [N [M]]

Перестраивает отчеты, начиная N месяцев назад от текущего месяца. М — количество месяцев, по которым перестроить отчеты (опциональный).

Примечание

Команда staffcop rebuild_sessions 2 перестроит отчеты за текущий, прошлый и позапрошлый месяц.

Команда staffcop rebuild_sessions 2 1 перестроит отчеты только за позапрошлый месяц.

Опасно

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

Процесс перестройки отчетов замедляет работу веб-интерфейса, а доступ к отчетам полностью блокируется. Дождитесь окончания процесса, чтобы вернуться к полноценной работе веб-интерфейса. Во время перестройки запрещены любые действия с политиками: их нельзя добавлять, изменять или удалять.

Сброс и восстановление

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

sudo staffcop reinit [full]

Опциональный параметр [full] удаляет все пользовательские фильтры.

Осторожно

Сброс исключает сервер из текущего кластера.

Опасно

При выполнении на мастер-сервере команда разрушает всю кластерную структуру и приводит к потере связей между серверами.

Восстановление настроек сервера

Повторно применяет настройки сервера. Используйте для восстановления после изменений или сбоев.

sudo staffcop init

Пользователи

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

sudo staffcop passwd NEW_PASSWORD

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

sudo staffcop createsuperuser

Администрирование и права

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

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

Доступные разрешения:

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

Опции:

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

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

staffcop special grant [USER] [PERMISSION]

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

staffcop special revoke [USER] [PERMISSION]

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

staffcop special list

Включение консоли Linux

Чтобы предоставить администратору доступ к Linux-консоли на сервере, выдайте права.

Все права:

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

Только доступ к консоли:

staffcop special grant <user> can_access_terminal

Примечание

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

Вывод статистики по почтовому ящику пользователя

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

Базы данных

Бэкап и восстановление

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

sudo staffcop backup_db [PATH_TO_BACKUP]

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

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

sudo staffcop restore_db [PATH_TO_BACKUP]

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

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

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

Работа с базой данных PostgreSQL

Вход в SQL-консоль Staffcop

sudo staffcop sql

Просмотр долгих или зависших SQL-запросов

sudo staffcop prof

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

sudo staffcop postgresql upgrade

Диагностика

Информация о сервере и диске

sudo staffcop info

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

staffcop check

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

staffcop dynamic [options]

Примечание

Чтобы посмотреть доступные опции и краткую справку по команде, выполните staffcop dynamic без параметров.

Устранение ошибок фильтров в консоли браузера

sudo staffcop rebuild_mptt

Используйте команду, если при открытии веб-интерфейса в консоли браузера возникают ошибки, связанные с отображением или работой фильтров. Команда восстанавливает структуру дерева для корректной работы фильтров.

Шардирование

Все команды шардирования

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

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

sudo staffcop shard install

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

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

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

sudo staffcop shard init

Просмотр текущих шардов

sudo staffcop shard list

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

sudo staffcop shard drop agent_event_2021_01_01

Формат имени: agent_event_ГГГГ_ММ_01 (год, месяц, первый день месяца). В примере удаляются данные, накопленные за январь 2021 года.

Опасно

Операция необратима, выполняйте с осторожностью.

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

Примечание

Для удаления данных администратор должен иметь соответствующие разрешения.

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

sudo staffcop compact

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

Полностью удаляет события, агенты (компьютеры) и пользователей. Не затрагивает политики и настройки мониторинга (конфигурации).

sudo staffcop truncate

Опасно

Необратимая операция, используйте с осторожностью.

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

sudo staffcop drop staffcop

Опасно

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

Подтвердите действие клавишей y:

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

Удаление файлов и скриншотов старше N дней

sudo staffcop cleandata <DAYS>

Удаление всех данных, кроме последних N дней

sudo staffcop cleanup <DAYS>

Примечание

Чтобы механизм очистки отработал быстро и легко, на диске должно быть не менее 15% свободного пространства.

Эта команда удалит только записи, но физически не освободит место на жестком диске — см. Как очистить жесткий диск.

Удаление пользователей и агентов без событий

sudo staffcop prune

Удаление всех данных по событиям

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              | Файловый сканер

Примечание

Команда чувствительна к регистру имени компьютера! Убедитесь, что написание совпадает с именем в базе.

Интеграция с ClickHouse

Все команды ClickHouse

Запуск общей команды управления ClickHouse с указанием нужного действия.

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

Установка и активация ClickHouse

sudo staffcop clickhouse install

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

Иногда новые версии ClickHouse могут содержать баги или нестабильные изменения. Команда устанавливает последнюю проверенную стабильную версию ClickHouse.

staffcop upgrade clickhouse

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

sudo staffcop clickhouse start

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

Перезапускает сервис для применения изменений или решения проблем.

sudo staffcop clickhouse restart

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

sudo staffcop clickhouse stop

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

sudo staffcop clickhouse test

Запускает диагностическую проверку механизма экспорта данных из PostgreSQL в ClickHouse. Команда не вносит изменений в данные, но позволяет убедиться, что все готово для последующей миграции.

Миграция данных из PostgreSQL

sudo staffcop clickhouse pump

Опасно

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

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

Полный сброс и повторная инициализация ClickHouse с удалением всех данных.

sudo staffcop clickhouse reinit

Агенты

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

sudo staffcop install [options] ip-address

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

Опции:

--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             | Вывод версии программы

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

staffcop sane                             | объединяются агенты и аккаунты
staffcop sane agents                      | объединяются только агенты
staffcop sane accounts                    | объединяются только аккаунты
staffcop sane -l <количество дублей>      | позволяет обрабатывать только часть дублей за запуск — например, 500 из 3000
staffcop sane --limit <количество дублей> | идентично staffcop sane -l
staffcop sane --help                      | вызов справки

Active Directory

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

staffcop ad_sync                # синхронизация всех аккаунтов
staffcop ad_sync --exists      # только существующие аккаунты
staffcop ad_sync --user user@domain  # конкретный пользователь

Примечание

Команда использует настройки AD, указанные в веб-интерфейсе.

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

sudo staffcop ad_sync --domain DOMAIN.local

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

sudo staffcop ad_sync --stats

Конфигурация

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

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

Примечание

Если название конфигурации состоит из нескольких слов, используйте кавычки, например: "Computer Config".

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

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

staffcop enable rustsrv

Примечание

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

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

sudo staffcop client [SERVER]

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

sudo staffcop acl <RULE> <VALUE>

Подробный список правил представлен в статье Добавление правил в конфигурацию из командной строки.

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

sudo staffcop export FILE_TO_EXPORT.json

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

Нажмите для просмотра списка данных из файла

• django_content_type
• auth.permission
• auth.group
• auth.user
• accounts.specialpermission
• agent.account
• agent.accountacl
• agent.accountconfig
• agent.acl
• agent.agent
• agent.config
• analytics.adsettings
• analytics.emailsetup
• analytics.filter
• django_settings.agentdefaultconfig
• django_settings.agentgroupingattr
• django_settings.agentreporttimeformat
• django_settings.appdimensionsetting
• django_settings.booleansetting
• django_settings.defaultlanguagesetting
• django_settings.dimensionsetting
• django_settings.email
• django_settings.integer
• django_settings.positiveinteger
• django_settings.setting
• django_settings.string
• password_store.passwordstore
• task.scheduledtask
• work_calendar.calendarevent
• work_calendar.dayschedule
• work_calendar.weekschedule
• work_calendar.weekscheduledimension
• analytics_dictionary
• agent_userprofile
• agent_groupprofile

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

sudo staffcop import FILE_TO_IMPORT.json

Команда добавляет фильтры без удаления существующих. Указывайте полный путь к файлу.

Примечание

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

Работа с данными

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

sudo staffcop ocr <image or pdf file>