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