l2tpconfig - это приложение командной строки для управления OpenL2TP. l2tpconfig взаимодействует с openl2tpd по IP. Интерфейс командной строки (command-line interface, CLI) поддерживает историю команд, завершение команд клавишей tab и контекстно-зависимую помощь.
В случае изменения настроек, они могут быть сохранены в файл настроек, использованием простой команды. Пользователям рекомендуется использовать интерактивные команды утилиты l2tpconfig для того, чтобы настроить систему, а затем сохранить настройки в файл для того, чтобы настройки могли быть загружены в следующий запуск openl2tpd.
НАЗВАНИЕ
РЕЗЮМЕ
- l2tpconfig [-q] [-R ] [-t] [command]
ОПИСАНИЕ
- OpenL2TP управляется с использованием интерфейса Вызова Удалённых Процедур (Remote Procedure Call, RPC), задокументированном в openl2tp_rpc(4). l2tpconfig - это приложение RPC-клиент, реализованное на этом интерфейсе, предоставляя пользователю интуитивно понятный интерфейс командной строки. Для получения информации об общих функциональных возможностяхOpenL2TP, пожалуйста, обратитесь к странице руководства openl2tp(7).
ПАРАМЕТРЫ:
- -q
- Тихий режим. Подавляет информационные сообщения, такие как "Создаётся xyz".
- Режим TCP. Для связи с openl2tpd используется TCP, вместо UDP (значение по-умолчанию). Используйте этот параметр при очень большом количестве сеансов, обрабатываемых openl2tpd. У TCP есть преимущество перед UDP, заключающееся в том, что размер RPC-пакетов может быть больше чем 8 килобайт; в случае, когда вывод команды "list" содержит очень много элементов, и для них недостаточно пространства в 8 килобайт, для их перечисления, то TCP позволяет избегать RPC-ошибок в команде "list" утилиты l2tpconfig. Недостаток TCP - это задержки медленного TCP протокола. Заметьте, что этот параметр влияет только на протокол управления между "l2tpconfig" и "openl2tpd", и это никак не касается L2TP. Этот параметр предназначен обычно, в основном, для использования в провайдерской среде.
-R <IP-адрес>
Отправляет команды программе openl2tpd, запущенной на IP-адресе <IP-адрес>, а не на локальном хосте. Этот параметр должен включить удалённое управление программой openl2tpd на удалённом хосте. В значении <IP-адрес> может быть указан как IP-адрес, так и имя хоста (hostname).
<команда>
- выполняется указанная команда, и затем "l2tpconfig" завершает работу. В случае, если никакая команда не указана, то "l2tpconfig" переходит в интерактивный режим работы, предоставляя пользователю интерфейс командной строки (Command Line Interface, CLI), с возможностью редактирования ввода, при наборе команды, контекстно-зависимой справкой и завершением команд по нажатию на клавишу Tab (табуляция).
ОКРУЖАЮЩАЯ СРЕДА
- прежде, чем дана первая команда утилиты "l2tpconfig", должен быть запущен "openl2tpd". Программа OpenL2TP для связи с "openl2tpd" использует технологию RPC от Sun, поэтому на системе должен быть установлен и настроен RPC.
КОМАНДЫ
- Команды сгруппированы по объектному типу, которым можно управлять в ходе работы. Общий формат команды
- [параметр1[=]]...
Каждый объектный тип поддерживает одну или более следующих операций:
- CREATE
- Создаёт один экземпляр выбранного типа объекта. Параметры, указанные далее, обязательно должны содержать название типа объекта, по которому создаётся экземпляр. Дополнительными параметрами можно указать значения, которые будут использоваться при создании экземпляра вместо значений по-умолчанию.
- Удаляет экземпляр объектного типа. Параметры, указанные далее, обязательно должны содержать _название_экземпляра_ объектного типа.
- Изменяет существующий экземпляр объектного типа. Параметры, указанные далее, помимо атрибутов и изменяемых значений, обязательно должны содержать _название_экземпляра_ объектного типа.
- Показать подробную информацию об экземпляре одного типа. Параметры, указанные далее, помимо атрибутов и изменяемых значений, обязательно должны содержать _название_экземпляра_ объектного типа.
- Вывести список всех имеющихся на данный момент экземпляров объектного типа. Возможно, этой команде потребуются дополнительные параметры; в зависимости от того, список чего именно вы хотите вывести (от контекста), дополнительные параметры предоставит контекстно-зависимая справка.
- Операция "UNSET" применяется только для экземпляров типа "профиль". Операция "UNSET" удаляет установленные или изменённые ранее значения параметров у экземпляра типа "профиль", то есть устанавливает значения параметров в значения по-умолчанию. Операция "UNSET" нужна так как параметры у экземпляра типа "профиль" могут наследоваться. Удаление значения параметра у экземпляра типа "профиль" означает, что удалённое значение параметра не будет наследовано от другого экземпляра типа "профиль".
В одной команде возможна только одна, из перечисленных выше, операция с объектом; в случае операций "CREATE" и "MODIFY", одна команда может содержать множество параметров. При вызове большинства операций на объект, в параметрах обязательно должно быть указано _название_экземпляра_ объектного типа. (Исключение - "LIST", потому что в зависимости от контекста, для этой операции, возможно, не потребуются параметры.)
ОБЪЕКТНЫЕ ТИПЫ
- В программе OpenL2TP существуют следующие типы объектов: SYSTEM
- Содержит атрибуты, которые могут использоваться, чтобы управлять системным поведением программы OpenL2TP, т.н. указывать лимиты для экземпляра типа "туннель", номер порта UDP и т.д. Всегда есть один экземляр типа "SYSTEM"; экземпляры типа "SYSTEM" не могут быть созданы или удалены.
- Предоставляет именованный набор параметров L2TP-тоннеля, который может локально (при создании тоннеля, указывая название экземпляра типа "TUNNEL PROFILE") использоваться при создании тоннелей, или в случае, когда тоннели создаются удалённым запросом.
- Предоставляет именованный набор параметров L2TP-сессии, который может локально (при создании сессии, указывая название экземпляра типа "SESSION PROFILE") использоваться при создании сессий, или в случае, когда сессии создаются удалённым запросом.
- Предоставляет именованный набор параметров PPP, которые должен использоваться при создании PPP-сессий в L2TP-сеccиях.
- Идентифицирует параметры, которые будут использоваться при соединении с L2TP-peer. Peer идентифицируется по имени или IP-адресу/сетевой маске. "PEER PROFILE" назначает тоннель по-умолчанию, сессию и имена экземпляров типа "PPP PROFILE", которые должны использоваться для peer, если не указано другими настройками.
- Содержит параметры L2TP-тоннеля, такие как секрет тоннеля, сокрытие "AVP", "L2TP hello time-out" и т.д. Тоннель идентифицируется уникальным для системы 16-разрядным идентификатором ("tunnel_id"), который генерируется автоматически. Для каждого L2TP-тоннеля существует один экземпляр типа "TUNNEL".
- Содержит параметры L2TP-сессии, такие как, использовать ли порядковые номера данных. Сессия идентифицируется уникальным для существующего L2TP-тоннеля 16-разрядным идентификатором (session_id) и tunnel_id туннеля. Один экземпляр этого объектного типа существует для каждого сеанса L2TP.Для каждой L2TP-сессии существует один экземпляр типа "SESSION".
ИНТЕРАКТИВНЫЙ РЕЖИМ
- l2tpconfig предоставляет контекстно-зависимый интерфейс командной строки (Command Line Interface, CLI). Вызов подсказки отображает список ключевых слов для применения в настоящий момент. Ввод нескольких букв ключевого слова и нажатие на клавишу TAB (табуляция) завершает ключевое слово (если возможно). Повторное нажатие на клавишу TAB (табуляция) снова покажет список следующих допустимых ключевых слов. Когда присутствуют правильные названия объектного типа и операции, будет показан список необходимых параметров для этой операции. Ввод нескольких букв параметра и нажатие на клавишу TAB (табуляция) завершает ввод названия параметра и добавляет знак '=' после названия параметра, если параметр принимает значение.
Ключ <?>, помимо такого же результата как и клавишей <TAB> (табуляция), где на экран выводятся возможные завершения ключевых слов, также выводит наглядную справку о каждом параметре.
ПРИВЯЗКА КЛАВИШ
- l2tpconfig предоставляет интуитивное редактирование в командной строке с историей. Привязка клавиш - остаётся как по-умолчанию в bash(1), хотя привязка клавиш может быть изменена, используя записи l2tpconfig в файле ".inputrc". Смотрите страницу руководства readline(3) для получения дополнительной информации. Обычно используемые привязки клавиш по-умолчанию:
начало строки
конец строки
стирание символов от курсора до конца строки
стирание символов перевода строки
переход по слову
переход по слову назад
- На клавиатурах без метаклавишы (Alt), может использоваться клавиша "Escape".
ИСТОРИЯ КОМАНД
- В интерактивном режиме работы утилита l2tpconfig записывает данные истории команд в файл "~/.l2tp_history" при выходе из приложения. Это позволяет запоминать набранные команды в предыдущем сеансе работы с утилитой l2tpconfig. При желании, переменная окружения "L2TP_HISTFILE" может использоваться для указания на альтернативный файл истории и "L2TP_HISTFILESIZE", может использоваться, чтобы ограничить файл истории nnn записями. В случае если значение переменной окружения "L2TP_HISTFILE" установлено в пустую строку, то запись истории в файл отключена.
ПОСТОЯННАЯ НАСТРОЙКА
- OpenL2TP не использует файлы настройки; вся настройка делается при помощи клиентского приложение RPC, такого как l2tpconfig. Тем не менее, будет полезно сохранять и восстанавливать время от времени настройки. l2tpconfig предоставляет для этой цели команды:
- config save file=
- config restore file=
СИНТАКСИС В КОНЕЧНОМ ИТОГЕ
Следующий вывод информации был взят из контекстно-зависимой справки в интерактивном режиме утилиты l2tpconfig. Используйте ключ <?> для запроса контекстно-зависимой справки.
- КОМАНДЫ В КОНЕЧНОМ ИТОГЕ
l2tp> ?
- exit - выйти из приложения
- peer - peer-команды
- ppp - ppp-команды
- session - команды сессий
- tunnel - команды тоннелей
- system - системные команды
- debug - команды отладки
- server - настройка сервера
- config - сохранить/восстановить настройки
- quit - выйти из приложения
l2tp> peer ?
- profile - команды профиля peer
l2tp> peer profile ?
- create - создать новый L2TP-peer профиль
- list - отобразить список всех L2TP-peer профилей
- show - показать подробную информацию о L2TP-peer профиле
- modify - изменить L2TP-peer профиль
- delete - удалить L2TP-peer профиль
- unset - удалить значения параметров у L2TP-peer профиля
l2tp> ppp ?
- profile - команды профиля ppp
l2tp> ppp profile ?
- create - создать новый L2TP-ppp профиль
- list - отобразить список всех L2TP-ppp профилей
- show - показать подробную информацию о L2TP-ppp профиле
- modify - изменить L2TP-ppp профиль
- delete - удалить L2TP-ppp профиль
- unset - удалить значения параметров у L2TP-ppp профиля
l2tp> tunnel ?
- create - создать новый L2TP-тоннель
- profile - команды профиля тоннеля
- list - отобразить список всех L2TP-тоннелей
- show - показать подробную информацию о L2TP тоннеле
- modify - изменить L2TP-тоннель
- delete - удалить L2TP-тоннель
l2tp> tunnel profile ?
- create - создать новый профиль L2TP-тоннеля
- list - отобразить список всех профилей L2TP-тоннелей
- show - показать подробную информацию о профиле L2TP-тоннеля
- modify - изменить профиль L2TP-тоннеля
- delete - удалить профиль L2TP-тоннеля
- unset - удалить значения параметров у профиля L2TP-тоннеля
l2tp> session ?
- create - создать новую L2TP-сессию
- profile - команды профиля L2TP-сессий
- list - отобразить список всех L2TP-сессий на указанном тоннеле
- show - показать подробную информацию о L2TP-сессии
- modify - изменить L2TP-сессию
- delete - удалить L2TP-сессию
l2tp> session profile ?
- create - создать новый профиль L2TP-сессии
- list - отобразить список всех профилей L2TP-сессий
- show - показать подробную информацию о профиле L2TP-сессии
- modify - изменить профиль L2TP-сессии
- delete - удалить профиль L2TP-сессии
- unset - удалить значения параметров у профиля L2TP-сессии
l2tp> system ?
- modify - изменить системные параметры
- show - показать подробную информацию о системной настройке и статистике
l2tp> debug ?
- modify - изменить настройки отладки
- show - показать подробную информацию о настройках отладки
l2tp> server ?
- modify - изменить параметры сервера
- show - показать подробную информацию о параметрах сервера
l2tp> config ?
- save - сохранить настройки в файл
- restore - восстановить настройки из файла
- PEER PROFILE CREATE / MODIFY / UNSET
l2tp> peer profile create ?
- profile_name - Название peer-профиля
- peer_ipaddr - IP-адрес peer
- peer_port - UDP порт для соединения с peer. По-умолчанию=1701.
- netmask - Сетевая маска для совпадения, для параметра peer_ipaddr. По-умолчанию=255.255.255.255.
- lac_lns - Взаимодействие по протоколу LAC, LNS или LAC и LNS.
- tunnel_profile_name - Название по-умолчанию для профиля тоннеля. По-умолчанию="default"
- session_profile_name - Название по-умолчанию для профиля сессии. По-умолчанию="default"
- ppp_profile_name - Название по-умолчанию для ppp-профиля. По-умолчанию="default"
- PEER PROFILE LIST
l2tp> peer profile list ?
- PEER PROFILE SHOW
l2tp> peer profile show ?
- profile_name - Название профиля peer.
- PEER PROFILE DELETE
l2tp> peer profile delete ?
- profile_name - Название профиля peer.
- PPP PROFILE CREATE / MODIFY / UNSET
l2tp> ppp profile create ?
- profile_name - Название ppp-профиля
- trace_flags - Флаги трассировки, для отладки проблем сети
- asyncmap - Асинхронная карта символов. Работает, только если PPP работает в асинхронном режиме.
- mtu - Maximum Transmit Unit (MTU) или максимальный размер блока (в байтах), иначе говоря, максимальное количество байт, которое интерфейс способен поддерживать за одну операцию приёма/передачи.
- mru - Maximum Receive Unit (MRU) или максимальный размер пакета.
- sync_mode - Разрешить PPP-операции sync/async.
- auth_pap - Разрешить PPP-аутентификацию методом PAP. По-умолчанию: YES
- auth_chap - Разрешить PPP-аутентификацию методом CHAP. По-умолчанию: YES
- auth_mschapv1 - Разрешить PPP-аутентификацию методом MSCHAP. По-умолчанию: YES
- auth_mschapv2 - Разрешить PPP-аутентификацию по методу MSCHAPV2. По-умолчанию: YES
- auth_eap - Разрешить PPP-аутентификацию по методу EAP. По-умолчанию: YES
- auth_none - Разрешить неаутентифицируемых peer. По-умолчанию: NO/YES (server/client)
- auth_peer - Аутентифицировать peer PPP-пользователя (server). По-умолчанию: YES/NO (server/client)
- chap_interval - Повторно перезапрашивать peer каждые chap_interval секунд. По-умолчанию=0 (не перезапрашивать повторно).
- chap_max_challenge - Максимальное количество CHAP запросов без успешного подтверждения авторизации, прежде чем объявить отказ в авторизации. По-умолчанию=10.
- chap_restart - Задержка между повторными запросами CHAP. По-умолчанию=3.
- pap_max_auth_reqs - Максимальное количество отправленных PAP-запросов на аутентификацию. По-умолчанию=10.
- pap_restart_interval - Задержка между повторными запросами PAP. По-умолчанию=3.
- pap_timeout - Максимальное время ожидания для самостоятельной аутентификации peer. По-умолчанию=0 (без лимита).
- idle_timeout - Отключить сессию, если простой более чем N секунд. По-умолчанию=0 (без лимита).
- ipcp_max_cfg_reqs - Maximum number of IPCP config-requests to transmit without successful acknowledgement before declaring a failure. Default=10.
- ipcp_max_cfg_naks - Maximum number of IPCP config-naks to allow before starting to send config-rejects instead. Default=10.
- ipcp_max_term_reqs - Maximum number of IPCP term-requests to send. Default=3.
- ipcp_retransmit_interval - IPCP retransmission timeout. Default=3.
- lcp_echo_fail_count- Number of LCP echo failures to accept before assuming peer is down. Default=5.
- lcp_echo_interval - Send LCP echo-request to peer every N seconds. Default=0 (don't send).
- lcp_max_cfg_reqs - Maximum number of LCP config-request transmissions. Default=10.
- lcp_max_cfg_naks - Maximum number of LCP config-requests to transmit without successful acknowledgement before declaring a failure. Default=10.
- lcp_max_term_reqs - Maximum number of LCP term-requests to send. Default=3.
- lcp_retransmit_interval - LCP retransmission timeout. Default=3.
- ipcp_max_cfg_reqs - Максимальное количество запросов настроек IPCP без успешного подтверждения, прежде чем объявить отказ. По-умолчанию=10.
- ipcp_max_cfg_naks - Максимальное количество IPCP конфигурируются-naks, чтобы позволить прежде, чем начать отправлять отклонения конфигурации вместо этого. Default=10.
- ipcp_max_term_reqs - Максимальное количество запросов термина IPCP, чтобы передаться. Default=3.
- ipcp_retransmit_interval - тайм-аут повторной передачи IPCP. Default=3.
- lcp_echo_fail_count-Число отказов эха LCP принять прежде, чем принять коллегу снижается. Default=5.
- lcp_echo_interval - Отправляют эхо-запрос LCP, чтобы взаимодействовать каждый секунды N. Default=0 (не передаются).
- lcp_max_cfg_reqs - Максимальное количество передач запроса конфигурации LCP. Default=10.
- lcp_max_cfg_naks - Максимальное количество запросов конфигурации LCP, чтобы передать без успешного подтверждения прежде, чем объявить отказ. Default=10.
- lcp_max_term_reqs - Максимальное количество запросов термина LCP, чтобы передаться. Default=3.
- lcp_retransmit_interval - тайм-аут повторной передачи LCP. Default=3.
- max_connect_time - Maximum connect time (in seconds) that the PPP session may stay in use.Default=0 (no limit)
- use_radius - Says whether to use RADIUS for user authentication. Support depends on the PPP implementation being used, since it is PPP that issues RADIUS requests, not OpenL2TP.
- radius_hint - An arbitrary text string that is passed to the RADIUS client. The meaning of such string is locally significant.
- ip_pool_name - The name of an IP pool. This name is passed to PPP which can use the information as it chooses. IP address pools are not controlled by OpenL2TP.
- default_route - Says whether the PPP link should be used as the system's default route. Default: no.
- multilink - Use multilink PPP. Default: no.
- local_name - Name to use for authentication with the peer, unless overridden by user_name.
- remote_name - Name to assume for the remote peer for authentication purposes.
ПРИМЕРЫ:
СМОТРИТЕ ТАКЖЕ
- openl2tp(7), openl2tpd(8), readline(3).
Ссылки
OpenL2TP — Официальный сайт "OpenL2TP"
OpenL2TP - l2tpconfig — Официальный сайт "OpenL2TP", l2tpconfig