d5f4fc63122a7e2eb5a6cc1fb0bbcc82c2166ab4
[strongswan.git] / src / swanctl / swanctl.8.in
1 .TH SWANCTL 8 "2014-04-28" "@PACKAGE_VERSION@" "strongSwan"
2 .SH NAME
3 swanctl \- strongSwan configuration, control and monitoring command line interface.
4 .SH SYNOPSIS
5 .SY "swanctl"
6 .I command
7 .RI [ option\~ .\|.\|.]
8 .YS
9 .
10 .SY "swanctl"
11 .B \-h
12 |
13 .B \-\-help
14 .YS
15 .
16 .SH DESCRIPTION
17 swanctl is a cross-platform command line utility to configure, control and
18 monitor the strongSwan IKE daemon. It is a replacement for the aging
19 .BR starter ,
20 .B ipsec
21 and
22 .B stroke
23 tools.
24
25 swanctl uses a configuration file called
26 .BR swanctl.conf (5)
27 to parse configurations and credentials. Private keys, certificates and other
28 PKI related credentials are read from specific directories.
29
30 To communicate with the IKE daemon, swanctl uses the VICI protocol, the
31 Versatile IKE Configuration Interface. This stable interface is usable by
32 other tools and is often preferable than scripting swanctl and parsing its
33 output.
34
35 .SH COMMANDS
36 .TP
37 .B "\-i, \-\-initiate"
38 initiate a connection
39 .TP
40 .B "\-t, \-\-terminate"
41 \-\-terminate\fR
42 terminate a connection
43 .TP
44 .B "\-p, \-\-install"
45 install a trap or shunt policy
46 .TP
47 .B "\-u, \-\-uninstall"
48 uninstall a trap or shunt policy
49 .TP
50 .B "\-l, \-\-list\-sas"
51 list currently active IKE_SAs
52 .TP
53 .B "\-P, \-\-list\-pols"
54 list currently installed policies
55 .TP
56 .B "\-L, \-\-list\-conns"
57 list loaded configurations
58 .TP
59 .B "\-x, \-\-list\-certs"
60 list stored certificates
61 .TP
62 .B "\-A, \-\-list\-pools"
63 list loaded pool configurations
64 .TP
65 .B "\-c, \-\-load\-conns"
66 (re\-)load connection configuration
67 .TP
68 .B "\-s, \-\-load\-creds"
69 (re\-)load credentials
70 .TP
71 .B "\-a, \-\-load\-pools"
72 (re\-)load pool configuration
73 .TP
74 .B "\-T, \-\-log"
75 trace logging output
76 .TP
77 .B "\-S, \-\-stats"
78 show daemon infos and statistics
79 .TP
80 .B "\-v, \-\-version"
81 show daemon version information
82 .TP
83 .B "\-h, \-\-help"
84 show usage information
85 .SH SEE ALSO
86 .BR swanctl.conf (5)