Merge branch 'kernel-policies'
[strongswan.git] / src / swanctl / swanctl.8.in
1 .TH SWANCTL 8 "2015-11-20" "@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 "\-d, \-\-redirect"
45 \-\-redirect\fR
46 redirect an IKE_SA
47 .TP
48 .B "\-p, \-\-install"
49 install a trap or shunt policy
50 .TP
51 .B "\-u, \-\-uninstall"
52 uninstall a trap or shunt policy
53 .TP
54 .B "\-l, \-\-list\-sas"
55 list currently active IKE_SAs
56 .TP
57 .B "\-P, \-\-list\-pols"
58 list currently installed policies
59 .TP
60 .B "\-b, \-\-load\-authorities"
61 (re\-)load certification authorities information
62 .TP
63 .B "\-L, \-\-list\-conns"
64 list loaded configurations
65 .TP
66 .B "\-B, \-\-list\-authorities"
67 list loaded certification authorities information
68 .TP
69 .B "\-x, \-\-list\-certs"
70 list stored certificates
71 .TP
72 .B "\-A, \-\-list\-pools"
73 list loaded pool configurations
74 .TP
75 .B "\-g, \-\-list\-algs"
76 list loaded algorithms and their implementation
77 .TP
78 .B "\-q, \-\-load\-all"
79 (re\-)load credentials, pools, authorities and connections
80 .TP
81 .B "\-c, \-\-load\-conns"
82 (re\-)load connection configuration
83 .TP
84 .B "\-s, \-\-load\-creds"
85 (re\-)load credentials
86 .TP
87 .B "\-a, \-\-load\-pools"
88 (re\-)load pool configuration
89 .TP
90 .B "\-T, \-\-log"
91 trace logging output
92 .TP
93 .B "\-S, \-\-stats"
94 show daemon infos and statistics
95 .TP
96 .B "\-r, \-\-reload-settings"
97 reload strongswan.conf(5) configuration
98 .TP
99 .B "\-v, \-\-version"
100 show daemon version information
101 .TP
102 .B "\-h, \-\-help"
103 show usage information
104 .SH SEE ALSO
105 .BR swanctl.conf (5)