X-Git-Url: https://git.stg.codes/stg.git/blobdiff_plain/6b6d9b29e9e9e91f79507a8bf193fb30de311dcc..4a1a62fae847eab4e83fdd61a5c801e9ec99529e:/doc/help/ch8.xml diff --git a/doc/help/ch8.xml b/doc/help/ch8.xml index bb608a0d..be6a00c8 100644 --- a/doc/help/ch8.xml +++ b/doc/help/ch8.xml @@ -1,4 +1,65 @@ - Описание работы с консольным конфигуратором - Консольный конфигуратор позволяет добавлять, удалять пользователей, получать и устанавливать некоторые параметры пользователя и отправлять ему текстовые сообщения. Общий формат вызова для получения значения параметра: - + Описание работы с консольным конфигуратором + Консольный конфигуратор позволяет добавлять, удалять пользователей, получать и устанавливать некоторые параметры пользователя и отправлять ему текстовые сообщения. Общий формат вызова для получения значения параметра: + +sgconf get -s <server> -p <port> -a <admin> -w <admin_password> -u <user> <options> + + + server — адрес сервера; + port — порт конфигуратора на сервере; + admin — логин администратора на сервере; + admin_password — пароль администратора на сервере. + user — логин пользователя на сервере. + + Общий формат вызова для установки параметра, добавления или удаления пользователя: + +sgconf get -s <server> -p <port> -a <admin> -w <admin_password> -u <user> <options> + + Параметры вызова — такие-же, что и при получении значения параметра. + + -c <add_cash[:log_message]> — добавление денег на счет пользователя. add_cash — добавляемая сумма, log_message — опциональный коментарий для записи в лог. + -v <set_cash[:log_message]> — установка денег на счету пользователя. set_cash — устанавливаемая сумма, log_message — опциональный коментарий для записи в лог. + -c — при использовании без параметра возвращает состояние счета пользователя. + -t <tariff:now|delayed> — смена тарифа пользователя. tariff — название тарифа, now — изменить немедленно, delayed — изменить в конце месяца. + -t — при использовании без параметра возвращает текущий тариф пользователя. + -r <credit> — предоставление пользователю кредита в размере credit. + -r — при использовании без параметров возвращает текущий кредит. + -E <YYYY-MM-DD> — указание срока истечения кредита пользователю. + -E — при использовании без параметров возвращает текущий срок истечения кредита пользователю. + -o <new_password> — установка пользователю пароля new_password. + -o — при использовании без параметра возвращает текущий пароль пользователя. + -e <prepaid> — установка количества предоплаченного трафика. + -e — при использовании без параметра возвращает количество оставшегося предоплаченного трафика. + -I <*ip_addr[,ip_addr]> — установка IP-адреса пользователя (одного, нескольких или произвольного). + -I — при использовании без параметра возвращает текущий IP-адрес пользователя. + -A <name> — установка реального имени пользователя. + -A — при использовании без параметра возвращает реальное имя пользователя. + -N <note> — установка коментария к пользователю. + -N — при использовании без параметров возвращает коментарий к пользователю. + -D <address> — установка реального адреса пользователя. + -D — при использовании без параметра возвращает адрес пользователя. + -L <email> — установка email-адреса пользователя. + -L — при использовании без параметра возвращает адрес Email пользователя. + -P <phone> — установка телефона пользователя. + -P — при использовании без параметров возвращает телефон пользователя. + -G <group> — установка группы пользователя. + -G — при использовании без параметра возвращает текущую группу пользователя. + -d <1|0> — включение/выключение пользователя. + -d — при использовании без параметров возвращает текущее состояние пользователя (включен/выключен, а не online/offline). + -i <1|0> — «заморозка»/«разморозка» пользователя. + -i — при использовании без параметра возвращает текущее состояние пользователя («заморожен»/«разморожен»). + --disable-stat <1|0> — включение/выключение ведения детальной статистики для пользователя. + --disable-stat — при использовании без параметра возвращает состояние флага ведения детальной статистики для пользователя. + --always-online <1|0> — включение/выключение режима Always Online для пользователя. + --always-online — при использовании без параметра возвращает режим пользователя. + --u0 <traff> [--u1 <traff> ...] — установка количества исходящего трафика за месяц по направлениям (0 — 9). + --u0 [--u1 ...] — при использовании без параметров возвращает количество исходящего трафика по направлениям. + --d0 <traff> [--d1 <traff> ...] — установка количества входящего трафика за месяц по направлениям (0 — 9). + --d0 [--d1 ...] — при использовании без параметров возвращает количество входящего трафика по направлениям. + --ud0 <userdata> [--ud1 <userdata> ...] — установка полей UserData<0-9>. + --ud0 [--ud1 ...] — при использовании без параметра возвращает поля UserData<0-9>. + -m <message> — отправляет пользователю сообщение. + -n — добавляет нового «пустого» пользователя. + -l — удаляет пользователя. + + \ No newline at end of file