{toc}
h1. Команды для xge shell
Вызывать можно несколькими способами:
# Явно, через radclient в запросах.
# В radius-атрибутах в ответах radius-сервера.
# Вручную через коммандную строку передавая как параметры xgesh внутри контейнера /app/xge.
h2. Описание всех команд
h3. Глобальные команды
# h4. Разрешить всем абонентам доступ в интернет без проверки состояния сбонента
Пример для командной строки:{code}
xgesh global access allow
{code}
Пример для radclient:{code}
echo "Filter-Id=\"global access allow\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Проверить наличие правила, разрешающего доступ в интернет без проверки
Пример для командной строки:{code}
xgesh global access allow check
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh global access allow check\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Удалить правила, разрешающего доступ в интернет без проверки
Пример для командной строки:{code}
xgesh global access allow cancel
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh global access allow cancel\"" | radclient -x 10.10.20.1 coa superpsw
{code}
h3. Команды управления сессиями абонентов
# h4. Получить список ip адресов всех абогнентов на XGE
Пример для командной строки:{code}
xgesh session list
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session list\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Получить список всех сессий в формате: ip username snat rate lists mac class_id state type terminate_cause
Пример для командной строки:{code}
xgesh session dump
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session dump\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Получить информацию о сессии с адресом 10.10.20.100
Пример для командной строки:{code}
xgesh session 10.10.20.100 info
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 info\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Запустить диагностику абонента(может выполняться до нескольких минут)
Пример для командной строки:{code}
xgesh session 10.10.20.100 test
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 test\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Создать новую сессию с типом IPOE (поддерживаемые типы: IPoE, PPP, WEB)
Пример для командной строки:{code}
xgesh session 10.10.20.100 start IPOE
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 start IPOE\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Остановить сессию абонента (удаляет у сессии скорость и удаляет сессию из всех ACL)
Пример для командной строки:{code}
xgesh session 10.10.20.100 stop Coa-Disconnect
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 stop Coa-Disconnect\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Установить на абонента редирект 80 трафика на информационную страницу указанного типа(negbal - отрицительный баланс, blocked - добровольная блокировка или блокировка администратором)
Пример для командной строки:{code}
xgesh session 10.10.20.100 redirect negbal
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 redirect negbal\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Удалить с абонента редирект
Пример для командной строки:{code}
xgesh session 10.10.20.100 redirect negbal cancel
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 redirect negbal cancel\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Установить абоненту SNAT ip 1.2.3.4
Пример для командной строки:{code}
xgesh session 10.10.20.100 nat 1.2.3.4
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 nat 1.2.3.4\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. отключить абоненту SNAT
Пример для командной строки:{code}
xgesh session 10.10.20.100 nat cancel
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 nat cancel\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Установить абоненту скорость (rate_in/rate_out - гарантированная входящая/исходящая, ceil_in/ceil_out - максимальная входящая/исходящая, burst_in/burst_outi), можно указывать только rate или только rate и ceil. Формат: rate set in <rate_in> <ceil_in> <burst_in> out <rate_out> <ceil_out> <burst_out>
Пример для командной строки:{code}
xgesh session 10.10.20.100 rate set in 1024 5000 100000 out 2048 5000 100000
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 rate set in 1024 5000 100000 out 2048 5000 100000\"" | radclient -x 10.10.20.1 coa superpsw
{code}
Пример для командной строки:{code}
xgesh session 10.10.20.100 rate set 1024 5000 out 2048 5000
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 rate set 1024 5000 out 2048 5000\"" | radclient -x 10.10.20.1 coa superpsw
{code}
Пример для командной строки:{code}
xgesh session 10.10.20.100 rate set 1024 out 2048
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 rate set 1024 out 2048\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Удалить ограничение скорости
Пример для командной строки:{code}
xgesh session 10.10.20.100 rate remove
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 rate remove\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Отключить сессию(пересоздает IPOE и WEB сессию, отключает соединение по PPP)
Пример для командной строки:{code}
xgesh session 10.10.20.100 disconnect
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 disconnect\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Удалить целиком абонентскую сесию
Пример для командной строки:{code}
xgesh session 10.10.20.100 remove
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 remove\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Получить MAC адрес абонента(возможно только поле его установки или после того, как сервер получил первые пакетв от абонента, ПОКА НЕ БЫЛО НИ ОДНОГО ПАКЕТА ОЛТ АБОНЕНТА XGE НЕ ЗНАЕТ ЕГО MAC адрес)
Пример для командной строки:{code}
xgesh session 10.10.20.100 mac get
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 mac get\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Установить фиксированное соответствие MAC и IP адресов абонента
Пример для командной строки:{code}
xgesh session 10.10.20.100 mac set e2:a8:f3:b2:79:80
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 mac set e2:a8:f3:b2:79:80\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Очистить арп запись абонента и удалить мак привязку
Пример для командной строки:{code}
xgesh session 10.10.20.100 mac remove
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 mac remove\"" | radclient -x 10.10.20.1 coa superpsw
{code}
h1. Команды для xge shell
Вызывать можно несколькими способами:
# Явно, через radclient в запросах.
# В radius-атрибутах в ответах radius-сервера.
# Вручную через коммандную строку передавая как параметры xgesh внутри контейнера /app/xge.
h2. Описание всех команд
h3. Глобальные команды
# h4. Разрешить всем абонентам доступ в интернет без проверки состояния сбонента
Пример для командной строки:{code}
xgesh global access allow
{code}
Пример для radclient:{code}
echo "Filter-Id=\"global access allow\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Проверить наличие правила, разрешающего доступ в интернет без проверки
Пример для командной строки:{code}
xgesh global access allow check
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh global access allow check\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Удалить правила, разрешающего доступ в интернет без проверки
Пример для командной строки:{code}
xgesh global access allow cancel
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh global access allow cancel\"" | radclient -x 10.10.20.1 coa superpsw
{code}
h3. Команды управления сессиями абонентов
# h4. Получить список ip адресов всех абогнентов на XGE
Пример для командной строки:{code}
xgesh session list
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session list\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Получить список всех сессий в формате: ip username snat rate lists mac class_id state type terminate_cause
Пример для командной строки:{code}
xgesh session dump
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session dump\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Получить информацию о сессии с адресом 10.10.20.100
Пример для командной строки:{code}
xgesh session 10.10.20.100 info
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 info\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Запустить диагностику абонента(может выполняться до нескольких минут)
Пример для командной строки:{code}
xgesh session 10.10.20.100 test
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 test\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Создать новую сессию с типом IPOE (поддерживаемые типы: IPoE, PPP, WEB)
Пример для командной строки:{code}
xgesh session 10.10.20.100 start IPOE
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 start IPOE\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Остановить сессию абонента (удаляет у сессии скорость и удаляет сессию из всех ACL)
Пример для командной строки:{code}
xgesh session 10.10.20.100 stop Coa-Disconnect
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 stop Coa-Disconnect\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Установить на абонента редирект 80 трафика на информационную страницу указанного типа(negbal - отрицительный баланс, blocked - добровольная блокировка или блокировка администратором)
Пример для командной строки:{code}
xgesh session 10.10.20.100 redirect negbal
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 redirect negbal\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Удалить с абонента редирект
Пример для командной строки:{code}
xgesh session 10.10.20.100 redirect negbal cancel
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 redirect negbal cancel\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Установить абоненту SNAT ip 1.2.3.4
Пример для командной строки:{code}
xgesh session 10.10.20.100 nat 1.2.3.4
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 nat 1.2.3.4\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. отключить абоненту SNAT
Пример для командной строки:{code}
xgesh session 10.10.20.100 nat cancel
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 nat cancel\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Установить абоненту скорость (rate_in/rate_out - гарантированная входящая/исходящая, ceil_in/ceil_out - максимальная входящая/исходящая, burst_in/burst_outi), можно указывать только rate или только rate и ceil. Формат: rate set in <rate_in> <ceil_in> <burst_in> out <rate_out> <ceil_out> <burst_out>
Пример для командной строки:{code}
xgesh session 10.10.20.100 rate set in 1024 5000 100000 out 2048 5000 100000
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 rate set in 1024 5000 100000 out 2048 5000 100000\"" | radclient -x 10.10.20.1 coa superpsw
{code}
Пример для командной строки:{code}
xgesh session 10.10.20.100 rate set 1024 5000 out 2048 5000
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 rate set 1024 5000 out 2048 5000\"" | radclient -x 10.10.20.1 coa superpsw
{code}
Пример для командной строки:{code}
xgesh session 10.10.20.100 rate set 1024 out 2048
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 rate set 1024 out 2048\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Удалить ограничение скорости
Пример для командной строки:{code}
xgesh session 10.10.20.100 rate remove
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 rate remove\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Отключить сессию(пересоздает IPOE и WEB сессию, отключает соединение по PPP)
Пример для командной строки:{code}
xgesh session 10.10.20.100 disconnect
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 disconnect\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Удалить целиком абонентскую сесию
Пример для командной строки:{code}
xgesh session 10.10.20.100 remove
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 remove\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Получить MAC адрес абонента(возможно только поле его установки или после того, как сервер получил первые пакетв от абонента, ПОКА НЕ БЫЛО НИ ОДНОГО ПАКЕТА ОЛТ АБОНЕНТА XGE НЕ ЗНАЕТ ЕГО MAC адрес)
Пример для командной строки:{code}
xgesh session 10.10.20.100 mac get
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 mac get\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Установить фиксированное соответствие MAC и IP адресов абонента
Пример для командной строки:{code}
xgesh session 10.10.20.100 mac set e2:a8:f3:b2:79:80
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 mac set e2:a8:f3:b2:79:80\"" | radclient -x 10.10.20.1 coa superpsw
{code}
# h4. Очистить арп запись абонента и удалить мак привязку
Пример для командной строки:{code}
xgesh session 10.10.20.100 mac remove
{code}
Пример для radclient:{code}
"Filter-Id=\"xgesh session 10.10.20.100 mac remove\"" | radclient -x 10.10.20.1 coa superpsw
{code}