Wiki

• FrontPage
• RecentChanges
• FindPage
• HelpContents
• ru/OpenL2TP/l2tpconfig

OpenL2TP >> l2tpconfig

l2tpconfig - это приложение для управления из командной строки программой OpenL2TP. "l2tpconfig" взаимодействует с демоном программы OpenL2TP - "openl2tpd" по IP (Internet Protocol). Интерфейс командной строки (command-line interface, CLI) утилиты l2tpconfig запоминает ранее набранные команды, умеет завершать синтаксис команд клавишей "Tab" и поддерживает контекстно-зависимую справку по командам (наберите знак вопроса - "?").

Если вы поменяли параметры при настройке программы OpenL2TP через утилиту "l2tpconfig", то это действие можно сохранить в указанный вами файл с настройками при помощи одной простой команды, это делается для того, чтобы не редактировать параметры настраивая OpenL2TP каждый раз. Пользователям рекомендуется использовать интерактивные команды утилиты l2tpconfig для того, чтобы первоначально один раз настроить программу OpenL2TP так как вам угодно, а затем сохранить настройки в файл для того, чтобы настройки могли быть загружены при следующем запуске демона openl2tpd.

НАЗВАНИЕ

• l2tpconfig - настройка OpenL2TP под управлением из командной строки

РЕЗЮМЕ

• l2tpconfig [-q] [-R ] [-t] [command]

ОПИСАНИЕ

• OpenL2TP управляется с использованием интерфейса Вызова Удалённых Процедур (Remote Procedure Call, RPC), задокументированном в openl2tp_rpc(4). l2tpconfig - это приложение RPC-клиент, реализованное на интерфейсе RPC, предоставляя пользователю интуитивно понятный и доступный интерфейс под управлением в командной строке. Для получения общей информации о возможностях OpenL2TP, пожалуйста, обратитесь к странице руководства openl2tp(7).

ПАРАМЕТРЫ:

• -q
  • Тихий режим. Подавляет информационные сообщения, такие как "Создаётся xyz".
  -t
  • Режим TCP. Для связи с openl2tpd используется TCP, вместо UDP (значение по-умолчанию). Используйте этот параметр при очень большом количестве сеансов, обрабатываемых демоном openl2tpd. У TCP есть преимущество перед UDP, заключающееся в том, что размер RPC-пакетов может быть больше чем 8 килобайт; в случае, когда вывод команды "list" содержит очень много элементов, то для того чтобы отобразить перечисление элементов списка "list" становится недостаточно пространства в 8 килобайт, поэтому для их перечисления используется TCP, что позволяет избегать RPC-ошибок в команде "list" утилиты l2tpconfig. Недостаток TCP - это задержки медленного TCP протокола. Заметьте, что этот параметр влияет только на протокол управления между "l2tpconfig" и "openl2tpd", и это вообще абсолютно никак не касается L2TP. Этот параметр предназначен в основном обычно для использования в провайдерской среде, где элементами списка "list" обычно является множество подключённых абонентов провайдера.

  -R <IP-адрес>

  • Отправляет команды программе openl2tpd, запущенной на IP-адресе <IP-адрес>, а не на локальном хосте. Этот параметр позволяет удалённо управлять программой openl2tpd на удалённом хосте. В значении <IP-адрес> может быть указан как IP-адрес, так и имя хоста (hostname).

  <команда>

  • выполняется указанная команда, и затем "l2tpconfig" завершает работу. В случае, если никакая команда не указана, то "l2tpconfig" переходит в интерактивный режим работы, перенаправляя пользователя в свой собственный интерфейс командной строки (Command Line Interface, CLI), с возможностью редактирования ввода различных команд, контекстно-зависимой справкой (наберите знак вопроса - "?") и завершением синтаксиса команд по нажатию на клавишу "Tab" (Табуляция).

ОКРУЖАЮЩАЯ СРЕДА

• прежде, чем дана первая команда утилиты "l2tpconfig", должен быть запущен "openl2tpd". Программа OpenL2TP и её компоненты для связи с "openl2tpd" используют технологию Remote Procedure Call (RPC) от Sun, поэтому на системе должен быть установлен и настроен RPC.

КОМАНДЫ

• Команды сгруппированы по типу объекта; объектом можно управлять уже потом, позже, в ходе работы программы OpenL2TP.

Общий формат команды

• [параметр1[=значение1]]...

• Примечание: Независимо от того, является ли параметр обязательным или дополнительным, синтаксис для указания и тех и других параметров - одинаковый. Параметры указываются в любом порядке.

Каждый объект всех различных типов поддерживает одну или более из следующих операций:

• CREATE
  • Создаёт один экземпляр выбранного типа объекта. Параметры, указанные далее, обязательно должны содержать название типа объекта, по которому создаётся экземпляр. Дополнительными параметрами можно указать значения, которые будут использоваться при создании экземпляра вместо значений по-умолчанию.
  DELETE
  • Удаляет экземпляр объекта различных типов. Параметры, указанные далее, обязательно должны содержать _название_экземпляра_ объекта выбранного типа.
  MODIFY
  • Изменяет существующий экземпляр объекта различных типов. Параметры, указанные далее, помимо атрибутов и изменяемых значений, обязательно должны содержать _название_экземпляра_ объекта выбранного типа.
  SHOW
  • Показать подробную информацию об экземпляре объекта какого то конкретно одного типа. Параметры, указанные далее, помимо атрибутов и изменяемых значений, обязательно должны содержать _название_экземпляра_ объекта выбранного типа.
  LIST
  • Вывести список всех имеющихся на данный момент экземпляров объекта какого то конкретно одного типа. Возможно, этой команде потребуются дополнительные параметры; в зависимости от того, список чего именно вы хотите вывести, экземпляры объекта какого типа? (от контекста), дополнительные параметры для операции "LIST" предоставит контекстно-зависимая справка (наберите знак вопроса - "?").
  UNSET
  • Операция "UNSET" применяется только для экземпляров объекта типа "profile" (профиль). Операция "UNSET" удаляет установленные или изменённые ранее значения параметров у экземпляра объекта типа "profile" (профиль), то есть устанавливает значения параметров в значения по-умолчанию. Операция "UNSET" нужна так как параметры у экземпляра объекта типа "profile" (профиль) могут наследоваться. Удаление значения параметра у экземпляра объекта типа "profile" (профиль) означает, что удалённое значение параметра не будет наследоваться другим (следующим) созданным экземпляром объекта типа "profile" (профиль).

В одной команде возможна только одна, из перечисленных выше, операция с объектом; в случае операций "CREATE" и "MODIFY", одна команда может содержать множество параметров. При вызове нескольких последовательных друг за другом операций на объект, в параметрах обязательно должно быть указано _название_экземпляра_ объекта какого то конкретно одного типа. (Исключение - "LIST", потому что в зависимости от контекста, для этой операции, возможно, не потребуются параметры.)

ТИПЫ ОБЪЕКТОВ

• В программе OpenL2TP существуют следующие типы объектов:
  • SYSTEM - СИСТЕМА
  Содержит атрибуты, которые предназначены для управления системным поведением программы OpenL2TP, т. н. указывать лимиты для максимального количества на создание экземпляров объекта типа "tunnel" (туннель), номер UDP-порта для прослушивания во время ожидания сервером подключения L2TP-клиентов и проч. Всегда есть один экземпляр объекта типа "SYSTEM"; экземпляры объекта типа "SYSTEM" нельзя создавать или удалять.
  • TUNNEL PROFILE - ПРОФИЛЬ ТУННЕЛЯ
  Предоставляет возможность пользователю руками установить набор различных параметров для L2TP-туннеля, тем самым формируя "Профиль туннеля". Использовать данный профиль (то есть руками указывая на название экземпляра объекта типа "TUNNEL PROFILE" (Профиль туннеля)) можно при создании туннелей локально, или в случае, когда туннели создаются от удалённых запросов.
  • SESSION PROFILE - ПРОФИЛЬ СЕССИИ
  Предоставляет возможность пользователю руками установить набор различных параметров для L2TP-сессии, тем самым формируя "Профиль сессии". Использовать данный профиль (то есть руками указывая на название экземпляра объекта типа "SESSION PROFILE" (Профиль сессии)) можно при создании сессий локально, или в случае, когда сессии создаются от удалённых запросов.
  • PPP PROFILE - ПРОФИЛЬ PPP
  Предоставляет возможность пользователю руками установить набор различных параметров для PPP, тем самым формируя "Профиль PPP". Данный профиль будет применён (вашими руками указан явно) при создании PPP-сессий в L2TP-сеccиях.
  • PEER PROFILE - ПРОФИЛЬ ПАРТНЁРА
  Предоставляет возможность пользователю руками установить набор различных параметров для L2TP-партнёра (L2TP-peer) при подключении. Peer идентифицируется только по имени или IP-адресу/сетевой маске. Параметры "PEER PROFILE" (Профиля партнёра) по-умолчанию назначаются (наследуются) экземплярами объекта следующих типов: "TUNNEL" (туннель), "SESSION" (сессия) и "PPP PROFILE" (Профиль партнёра), которые должны использоваться для конкретного партнёра (peer), если поведение по-умолчанию для "PEER PROFILE" (Профиля партнёра) не изменено другими параметрами при настройке.
  • TUNNEL - ТУННЕЛЬ
  Здесь размещены различные параметры настройки для L2TP-туннеля, такие как секретный ключ туннеля, сокрытие "AVP", "L2TP hello time-out" и проч. Туннель идентифицируется уникальным для системы 16-разрядным идентификатором "tunnel_id", который генерируется автоматически. Обратите внимание, что для каждого L2TP-туннеля существует один экземпляр объекта типа "TUNNEL" (туннель).
  • SESSION - СЕССИЯ
  Здесь размещены различные параметры настройки для L2TP-сессии, такие как, использовать ли "упорядочивание данных"? Сессия идентифицируется уникальным внутри/для каждого существующего L2TP-туннеля (имеющим свой "tunnel_id") 16-разрядным идентификатором "session_id". Обратите внимание, что один экземпляр объекта этого типа существует для каждого установленного сеанса L2TP. Для каждой (установленной) L2TP-сессии существует один экземпляр объекта типа "SESSION" (сессия).

ИНТЕРАКТИВНЫЙ РЕЖИМ

• l2tpconfig предоставляет контекстно-зависимый интерфейс командной строки (Command Line Interface, CLI). Вызов подсказки отображает список ключевых слов для окончания ввода команды в настоящий момент. Ввод нескольких букв ключевого слова и нажатие на клавишу TAB (табуляция) завершает ключевое слово (в том случае, где это возможно). Повторное нажатие на клавишу TAB (табуляция) снова покажет список следующих допустимых ключевых слов. Когда присутствуют правильные названия объектов различных типов и операции, будет показан список необходимых параметров применяемых соответственно к этой операции. Ввод нескольких букв параметра и нажатие на клавишу TAB (табуляция) завершает ввод названия параметра и добавляет знак '=' после названия параметра в том случае, если параметр принимает значение.

  Ключ <?>, помимо такого же результата как и клавишей <TAB> (табуляция), где на экран выводятся возможные завершения ключевых слов, также выводит наглядную справку о каждом параметре.

ПРИВЯЗКА КЛАВИШ

• l2tpconfig предоставляет интуитивное редактирование в командной строке с поддержкой истории ранее введённых команд. Привязка клавиш остаётся такой же как по-умолчанию в bash(1), но в то же время привязку клавиш можно легко поменять, используя записи "l2tpconfig" в файле ".inputrc". Для получения дополнительной информации, пожалуйста, обратитесь к странице руководства. По-умолчанию обычно используются следующие привязки клавиш:

начало строки; конец строки;

стирание символов от курсора до конца строки; стирание символов перевода строки

переход по слову; переход по слову назад

• Примечание: На клавиатурах без метаклавиши (Alt), может использоваться клавиша "Escape".

ИСТОРИЯ КОМАНД

• В интерактивном режиме работы утилита l2tpconfig записывает данные из журнала истории команд в файл "~/.l2tp_history" при выходе из приложения. Что очень удобно, так как это позволяет запоминать набранные команды в предыдущем сеансе работы с утилитой l2tpconfig. При желании, переменная окружения "L2TP_HISTFILE" может использоваться для указания на альтернативный файл истории, а переменная окружения "L2TP_HISTFILESIZE" - чтобы ограничить файл истории nnn записями. В том случае, если значение переменной окружения "L2TP_HISTFILE" установлено в пустую строку, то запись журнала истории в файл отключена.

ПОСТОЯННАЯ НАСТРОЙКА

• Файлы с настройками для программы OpenL2TP не используются (!); Программа OpenL2TP полностью настраивается при помощи клиентского приложения по интерфейсу RPC, то есть при помощи "l2tpconfig". Тем не менее, очень полезно сохранять и восстанавливать время от времени настройки, введённые в интерфейсе командной строки утилиты "l2tpconfig". Для этих целей у "l2tpconfig" имеется две следующие команды:
  • config save file=путь_до_файла
  и
  • config restore file=путь_до_файла
  Данные о параметрах настроек пишутся в указанный вами файл простым текстом (plaintext), поэтому, при желании, вы можете отредактировать файл с параметрами настроек вручную. Обратите внимание, что данная возможность реализована не в демоне "openl2tpd", а непосредственно в самой утилите "l2tpconfig". В будущие версии программы OpenL2TP возможно будет добавлен новый интерфейс RPC для того, чтобы клиентское RPC-приложение могло сохранять и восстанавливать параметры настроек в бинарном формате.

ПОЛНЫЙ СИНТАКСИС ВСЕХ КОМАНД

• Следующая ниже информация была взята из контекстно-зависимой справки в интерактивном режиме утилиты "l2tpconfig". Используйте ключ <?> для запроса контекстно-зависимой справки.

  • ПОЛНЫЙ СИНТАКСИС КОМАНД

Ссылки

• OpenL2TP — Официальный сайт "OpenL2TP"

• OpenL2TP - l2tpconfig — Официальный сайт "OpenL2TP", l2tpconfig

• wiki.debian.org/ru/OpenL2TP