prol2tpctl

 

NAME

prol2tpctl - command-line management application for ProL2TP  

SYNOPSIS

prol2tpctl [-w] -c -t <name> [options]
prol2tpctl [-w] -c -s <name> -t <name> [options]
prol2tpctl [-w] -d -t <name|@id>
prol2tpctl [-w] -d -s <name|@id> -t <name|@id>
prol2tpctl -r
prol2tpctl -m <message>  

DESCRIPTION

ProL2TP's prol2tpctl command line utility is used to create or delete L2TP tunnels and sessions. It is designed for use by other applications or system startup scripts to create and delete L2TP tunnels and sessions on demand. Most prol2tp users will configure such settings in prol2tpd's config file and send prol2tpd a SIGHUP signal to have it reparse the config file.

Refer to prol2tp(7) for a general description of the ProL2TP package. Use the following command to access that page instead of this one.

# man 7 prol2tp
 

ENVIRONMENT

prol2tpd must be running before the first prol2tpctl command is issued. ProL2TP uses private Unix sockets to communicate with prol2tpd, so the system must be capable of running Unix sockets. If prol2tpd is not running when prol2tp is invoked, an error will occur.  

OPTIONS

 

COMMON OPTIONS

-c , --create
Tells prol2tpctl to create a new tunnel or session. The tunnel name must be specified when creating tunnels. Both the tunnel name and session name are required when creating sessions.
-d , --delete
Tells prol2tpctl to delete a tunnel or session. The tunnel or session name / id must be specified.
-w , --wait
Tells prol2tpctl to wait for the operation to complete. When creating or deleting tunnels or sessions, this causes prol2tpctl to wait for the tunnel or session to be created or deleted in the network before returning control to the user. Without this argument, the requested operation is simply started.
-r , --reset-stats
Resets counters maintained by prol2tpd. This can be useful to see which counters are increasing in a given period.
-m , --message
Tells prol2tpctl to send the message text to prol2tpd, which will be logged as a debug message. This may be useful to synchronise configuration activity in the debug log output.
 

TUNNEL OPTIONS

-t TUNNEL-NAME, --tunnel=TUNNEL-NAME
Set the tunnel name or id. This is a required argument when creating or deleting tunnels. To specify a numeric id, prefix the value with @, e.g. -t @42.
-p PEER-IP, --to=PEER-IP
Set the peer IP address for the new tunnel.
-T PROFILE-NAME, --tunnel-profile=PROFILE-NAME
Sets the tunnel profile to be used when creating the tunnel.
-Z, --persist
Marks the tunnel as persisting. ProL2TP will try to restablish the tunnel automatically if it fails. All locally created sessions in the tunnel will also be automatically reestablished if the tunnel recovers.
 

SESSION OPTIONS

-s SESSION-NAME, --session=SESSION-NAME
Set the session name or id. To specify a numeric id, prefix the value with @, e.g. -s @42. This is a required argument when creating or deleting sessions.
-S PROFILE-NAME, --session-profile=PROFILE-NAME
Sets the session profile to be used when creating the session.
-P PROFILE-NAME, --ppp-profile=PROFILE-NAME
Sets the PPP profile to be used when creating the PPP instance.
-E PROFILE-NAME, --eth-profile=PROFILE-NAME
Sets the ethernet profile to be used when creating ethernet pseudowires (L2TPv3 only).
-u USERNAME, --user=USERNAME
Sets the PPP username.
-x PASSWORD, --password=PASSWORD
Sets the PPP password.
-W PWTYPE, --pwtype=PWTYPE
Sets the pseudowire type. Valid values are ppp, eth. Default is determined by the session profile.
-y SESSION-TYPE, --session-type=SESSION-TYPE
Sets the L2TP session type. Valid values are laic (LAC Incoming Call) and lnoc (LNS Outgoing Call). Default is determined by the whether the local tunnel endpoint is the LAC or LNS. The ability to create LAIC sessions at an LNS or LNOC sessions at a LAC is to support L2TPv3 LAC-LAC and LNS-LNS configuration models. This option should be used only for L2TPv3 tunnels.
 

EXAMPLES

Create L2TP tunnel to peer 10.1.1.42

prol2tpctl -c -t one -p 10.1.1.42
Create L2TP session in tunnel

prol2tpctl -c -t one -s one -u myuser -p mypass
Create L2TP session and create tunnel if it does not already exist

prol2tpctl -c -w -t two -p 10.1.1.42 -s two -u myuser -p mypass
Delete tunnel

prol2tpctl -d -w -t one
Delete session

prol2tpctl -d -w -t two -s two
 

SEE ALSO


prol2tp(1), prol2tp(7), prol2tpd(8), prol2tpd.conf(5).


 

Index

NAME
SYNOPSIS
DESCRIPTION
ENVIRONMENT
OPTIONS
COMMON OPTIONS
TUNNEL OPTIONS
SESSION OPTIONS
EXAMPLES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 13:49:50 GMT, August 24, 2017