1OCCTL(8)                    System Manager's Manual                   OCCTL(8)
2
3
4

NAME

6       occtl - OpenConnect VPN server control tool
7

SYNOPSIS

9       occtl [´COMMAND´]
10

DESCRIPTION

12       This  a  control tool that can be used to send commands to ocserv. When
13       called without any arguments the tool can be used interactively,  where
14       each command is entered on a command prompt; alternatively the tool can
15       be called with the command specified as parameter. In the  latter  case
16       the  tool´s exit code will reflect the successful execution of the com‐
17       mand.
18

OPTIONS

20       -s, --socket-file=FILE
21              Specify the server´s occtl socket  file.  This  option  is  only
22              needed if you have multiple servers.
23
24       -j, --json
25              Output will be JSON formatted. This option can only be used with
26              non-interactive output, e.g., ´occtl --json show users´.
27
28       -n, --no-pager
29              No pager will be used over output data.
30
31       --debug
32              Provide more verbose information in some commands.
33
34       -h, --help
35              Display usage information and exit.
36
37       -v, --version
38              Output version of program and exit.
39

IMPLEMENTATION NOTES

41       This tool uses unix domain sockets to connect to ocserv.
42

EXAMPLES

44       The tool can be run interactively when run with no arguments. When  ar‐
45       guments are given they are interpreted as commands. For example:
46
47
48           $ occtl show users
49
50
51
52       Any  command line arguments to be used as options must precede the com‐
53       mand (if any), as shown below.
54
55
56           $ occtl --json show users
57
58
59

Exit status

61       0      Successful program execution.
62
63       1      The operation failed or the command syntax was not valid.
64

SEE ALSO

66       ocserv(8), ocpasswd(8)
67

69       Copyright (C) 2013-2017 Nikos Mavrogiannopoulos and others, all  rights
70       reserved.  This  program is released under the terms of the GNU General
71       Public License, version 2.
72

AUTHORS

74       Written by Nikos Mavrogiannopoulos. Many people have contributed to it.
75
76
77
78                                   June 2023                          OCCTL(8)
Impressum