Serverové příkazy
UCS podporuje následující shell příkazy
ucs-api
Spustí API metodu UCS.
| Argument | Význam |
|---|---|
| -h | nápověda |
| -j | všechny argumenty mají formát JSON |
| -f | nevyžadovat potvrzení před spuštěním metody |
| -d | zobrazit výstup metody i v případě úspěšného volání |
| -s název.souboru | název souboru do kterého budou uložena výstupní data metody (může být použit vícekrát) |
| method | název metody, která má být zavolána |
| [arg ...] | jednotlivé argumenty metody (může být použit vícekrát) |
# příklad výpisu uživatelů
ucs-api -f -d config.users.list
ucs-db-backup
Pomocný script pro provádění pravidelných denních záloh databáze na serveru UCS. Script je spouštěn každý den v 0:01 pomocí cronu /etc/cron.d/ucs.
Nastavení se načítá z /etc/ucs/ucs.conf
| Parametr | Výchozí hodnota | Význam |
|---|---|---|
| DB_BACKUP_DIR | /opt/backups/db | adresář do kterého se ukládají zálohy DB |
| DB_BACKUP_KEEP | 30 | počet dní po kterém se rotují zálohy |
ucs-db-dump
Script, kterým se provádí zálohování databáze UCS.
| Argument | Význam |
|---|---|
| -h | nápověda |
| -c | použít jiný konfigurační soubor než /etc/ucs/ucs.conf |
| -x | zálohovat pouze konfiguraci |
| -d | zálohovat pouze data (CDR, statistiky, atp.) |
| [ucs.sql] | název souboru do kterého bude provedena záloha |
# záloha nastavení a dat UCS do souboru ucs.sql
ucs-db-dump
# záloha nastavení do souboru config.sql
ucs-db-dump -x config.sql
# záloha dat do souboru data.sql
ucs-db-dump -d data.sql
ucs-db-master-here
Na daném node v clusteru (serveru) nastaví databázi jako master (primární).
Pouze pro clusterovou instalaci UCS.
ucs-db-restore
Obnoví databázi z dumpu. Script před obnovou DB zastaví UCS a po obnovení opět UCS spustí. Pro provedení obnovy se musí potvrdit spuštění zadáním YES (velkými písmeny).
| Argument | Význam |
|---|---|
| -h | nápověda |
| -B | nepřejmenovávat původní DB na ucs_YYYYMMDDTHHMMSS |
| [ucs.sql] | název souboru ze kterého bude databáze obnovena |
# obnova databáze UCS ze souboru ucs.sql
ucs-db-restore
# obnova databáze UCS ze souboru prod.sql bez ponechání původní DB
ucs-db-restore -B prod.sql
ucs-db-slave-here
Na daném node v clusteru (serveru) provede synchronizaci databáze z primárního node.
Pouze pro clusterovou instalaci UCS.
ucs-delete-data
Vymaže data (CDR, statistiky, atp.) z databáze UCS. Pro provedení obnovy se musí potvrdit spuštění zadáním YES I KNOW WHAT I AM DOING a následně navíc potvrdit DELETE DATA (velkými písmeny).
ucs-factory-reset
Vymaže nastavení data (CDR, statistiky, atp.) z databáze UCS. Pro provedení obnovy se musí potvrdit spuštění zadáním YES I KNOW WHAT I AM DOING a následně navíc potvrdit DELETE CONFIG AND DATA (velkými písmeny).
ucs-logrotate
Pomocný script pro rotování logů UCS. Script přjmenuje soubor na YYYY-MM-DD_soubor.log a následně zabalí pomocí gzip. Script je spouštěn každý den v 0:00 pomocí cronu /etc/cron.d/ucs.
Nastavení se načítá z /etc/ucs/ucs.conf
| Parametr | Výchozí hodnota | Význam |
|---|---|---|
| LOGDIR | /var/log/ucs | adresář do kterého loguje UCS |
| LOG_LOGROTATE_ADD | názvy dalších souborů, které mají být v logovacím adresáři UCS rotovány |
ucs-operator-deploy
Provede instalaci operátorské aplikace podle parametrů v adresáři /etc/ucs/operator. Stávající operátorská aplikace je zálohována do /opt/backups/YYYY-MM-DD_HH-MM-SS_operator.tar.gz (datum čas je okamžik spuštění instalace).
| Argument | Význam |
|---|---|
| -h | nápověda |
| -f | nevyžadovat potvrzení před spuštěním instalace |
| -s operator.tar.gz | zdrojový soubor nebo URL, ze kterého bude provedena instalace |
| -c /etc/ucs/operator/deploy.yaml | konfigurační soubor instalace |
| [operator.tar.gz] | zdrojový soubor nebo URL, ze kterého bude provedena instalace |
ucs-psql
Spustí PostgreSQL shell podle nastavení v /etc/ucs/ucs.conf
ucs-reload-plugin
Znovu načte UCS plugin. Pokud nebyl ještě plugin nahrán, pak ho poprvé nahraje.
| Argument | Význam |
|---|---|
| plugin | název pluginu, který má být (znovu)načten |
# (znovu)načtení pluginu /opt/ucs/server/plugins/zakaznik.py
ucs-reload-plugin zakaznik
ucs-set-parameter
Nastaví konfigurační parametr UCS.
| Argument | Význam |
|---|---|
| -h | nápověda |
| -r soubor.txt | nařte parametr ze souboru |
| -f | nevyžadovat potvrzení před nastavením parametru |
| -l | vypíše názvy podporovaných parametrů s popisem |
| key | název parametru, který má být změněn |
| [value] | nová hodnota parametru |
# změna NTP serveru na IP 1.2.3.4
ucs-set-parameter NTP_SERVER 1.2.3.4
# změna SSL certifikátu a klíče
ucs-set-parameter SSL_CRT -r ucs.crt
ucs-set-parameter SSL_KEY -r ucs.key