summaryrefslogtreecommitdiff
path: root/src/swanctl/swanctl.8.in
blob: d7abae67a6d4ffba405e8830f64aa4abe377eec2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
.TH SWANCTL 8 "2014-04-28" "@PACKAGE_VERSION@" "strongSwan"
.SH NAME
swanctl \- strongSwan configuration, control and monitoring command line interface.
.SH SYNOPSIS
.SY "swanctl"
.I command
.RI [ option\~ .\|.\|.]
.YS
.
.SY "swanctl"
.B \-h
|
.B \-\-help
.YS
.
.SH DESCRIPTION
swanctl is a cross-platform command line utility to configure, control and
monitor the strongSwan IKE daemon. It is a replacement for the aging
.BR starter ,
.B ipsec
and
.B stroke
tools.

swanctl uses a configuration file called
.BR swanctl.conf (5)
to parse configurations and credentials. Private keys, certificates and other
PKI related credentials are read from specific directories.

To communicate with the IKE daemon, swanctl uses the VICI protocol, the
Versatile IKE Configuration Interface. This stable interface is usable by
other tools and is often preferable than scripting swanctl and parsing its
output.

.SH COMMANDS
.TP
.B "\-i, \-\-initiate"
initiate a connection
.TP
.B "\-t, \-\-terminate"
\-\-terminate\fR
terminate a connection
.TP
.B "\-p, \-\-install"
install a trap or shunt policy
.TP
.B "\-u, \-\-uninstall"
uninstall a trap or shunt policy
.TP
.B "\-l, \-\-list\-sas"
list currently active IKE_SAs
.TP
.B "\-P, \-\-list\-pols"
list currently installed policies
.TP
.B "\-L, \-\-list\-conns"
list loaded configurations
.TP
.B "\-x, \-\-list\-certs"
list stored certificates
.TP
.B "\-A, \-\-list\-pools"
list loaded pool configurations
.TP
.B "\-c, \-\-load\-conns"
(re\-)load connection configuration
.TP
.B "\-s, \-\-load\-creds"
(re\-)load credentials
.TP
.B "\-a, \-\-load\-pools"
(re\-)load pool configuration
.TP
.B "\-T, \-\-log"
trace logging output
.TP
.B "\-v, \-\-version"
show daemon version information
.TP
.B "\-h, \-\-help"
show usage information
.SH SEE ALSO
.BR swanctl.conf (5)