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

NAME

6       gvmd - Greenbone Vulnerability Manager daemon
7

SYNOPSIS

9       gvmd OPTIONS
10

DESCRIPTION

12       The  Greenbone  Vulnerability Manager is the central management service
13       between security scanners and the user clients.
14
15       It manages the storage of any vulnerability  management  configurations
16       and of the scan results. Access to data, control commands and workflows
17       is offered via the XML-based Greenbone Management Protocol  (GMP).  The
18       primary  scanner  'OpenVAS Scanner' is controlled directly via protocol
19       OTP while any other remote scanner is coupled  with  the  Open  Scanner
20       Protocol (OSP).
21

OPTIONS

23       -h, --help
24              Show help options.
25
26       --check-alerts
27              Check SecInfo alerts.
28
29       --client-watch-interval=NUMBER
30              Check if client connection was closed every NUMBER seconds. 0 to
31              disable. Defaults to 1 second.
32
33       --create-scanner=SCANNER
34              Create global scanner SCANNER and exit.
35
36       --create-user=USERNAME
37              Create admin user USERNAME and exit.
38
39       -d, --database=NAME
40              Use NAME as database for PostgreSQL.
41
42       --delete-scanner=SCANNER-UUID
43              Delete scanner SCANNER-UUID and exit.
44
45       --delete-user=USERNAME
46              Delete user USERNAME and exit.
47
48       --dh-params=FILE
49              Diffie-Hellman parameters file
50
51       --disable-cmds=COMMANDS
52              Disable comma-separated COMMANDS.
53
54       --disable-encrypted-credentials
55              Do not encrypt or decrypt credentials.
56
57       --disable-password-policy
58              Do not restrict passwords to the policy.
59
60       --disable-scheduling
61              Disable task scheduling.
62
63       --encrypt-all-credentials
64              (Re-)Encrypt all credentials.
65
66       -f, --foreground
67              Run in foreground.
68
69       --get-scanners
70              List scanners and exit.
71
72       --get-users
73              List users and exit.
74
75       --gnutls-priorities=PRIORITIES-STRING
76              Sets the GnuTLS priorities for the Manager socket.
77
78       --inheritor=USERNAME
79              Have USERNAME inherit from deleted user.
80
81       -a, --listen=ADDRESS
82              Listen on ADDRESS.
83
84       --listen2=ADDRESS
85              Listen also on ADDRESS.
86
87       --listen-group=STRING
88              Group of the unix socket
89
90       --listen-mode=STRING
91              File mode of the unix socket
92
93       --listen-owner=STRING
94              Owner of the unix socket
95
96       --max-email-attachment-size=NUMBER
97              Maximum size of alert email attachments, in bytes.
98
99       --max-email-include-size=NUMBER
100              Maximum size of inlined content in alert emails, in bytes.
101
102       --max-email-message-size=NUMBER
103              Maximum size of user-defined message text in  alert  emails,  in
104              bytes.
105
106       --max-ips-per-target=NUMBER
107              Maximum number of IPs per target.
108
109       -m, --migrate
110              Migrate the database and exit.
111
112       --modify-scanner=SCANNER-UUID
113              Modify scanner SCANNER-UUID and exit.
114
115       --modify-setting=UUID
116              Modify setting UUID and exit.
117
118       --new-password=PASSWORD
119              Modify user's password and exit.
120
121       --new-password=PASSWORD
122              Modify user's password and exit.
123
124       --optimize=NAME
125              Run  an  optimization:  vacuum,  analyze,  cleanup-config-prefs,
126              cleanup-port-names, cleanup-report-formats, cleanup-result-nvts,
127              cleanup-result-severities,    cleanup-schedule-times,   migrate-
128              relay-sensors, rebuild-report-cache or update-report-cache.
129
130       --osp-vt-update=SCANNER-SOCKET
131              Unix socket for OSP NVT update. Defaults  to  the  path  of  the
132              'OpenVAS Default' scanner if it is an absolute path.
133
134       --password=PASSWORD
135              Password, for --create-user.
136
137       -p, --port=NUMBER
138              Use port number NUMBER.
139
140       --port2=NUMBER
141              Use port number NUMBER for address 2.
142
143       --rebuild-scap=TYPE
144              Rebuild   SCAP  data  of  type  TYPE  (currently  only  supports
145              'ovaldefs').
146
147       --relay-mapper=FILE
148              Executable for mapping scanner hosts to  relays.  Use  an  empty
149              string  to explicitly disable. If the option is not given, $PATH
150              is checked for gvm-relay-mapper.
151
152       --role=ROLE
153              Role for --create-user and --get-users.
154
155       --scanner-ca-pub=SCANNER-CA-PUB
156              Scanner CA Certificate path for --[create|modify]-scanner.
157
158       --scanner-credential=SCANNER-CREDENTIAL
159              Scanner credential for --create-scanner and --modify-scanner.
160
161              Can be blank to unset or a credential UUID. If  omitted,  a  new
162              credential can be created instead.
163
164       --scanner-host=SCANNER-HOST
165              Scanner host for --create-scanner and --modify-scanner.
166
167       --scanner-key-priv=SCANNER-KEY-PRIVATE
168              Scanner   private  key  path  for  --[create|modify]-scanner  if
169              --scanner-credential is not given.
170
171       --scanner-key-pub=SCANNER-KEY-PUBLIC
172              Scanner  Certificate  path  for   --[create|modify]-scanner   if
173              --scanner-credential is not given.
174
175       --scanner-name=NAME
176              Name for --modify-scanner.
177
178       --scanner-port=SCANNER-PORT
179              Scanner port for --create-scanner and --modify-scanner.
180
181       --scanner-type=SCANNER-TYPE
182              Scanner type for --create-scanner and --modify-scanner.
183
184              Either 'OpenVAS', 'OSP', 'GMP', 'OSP-Sensor' or a number as used
185              in GMP.
186
187       --schedule-timeout=TIME
188              Time out tasks that are more than TIME minutes  overdue.  -1  to
189              disable, 0 for minimum time.
190
191       --secinfo-commit-size=NUMBER
192              During  CERT and SCAP sync, commit updates to the database every
193              NUMBER items, 0 for unlimited.
194
195       --slave-commit-size=NUMBER
196              During slave updates, commit after every NUMBER updated  results
197              and hosts, 0 for unlimited.
198
199       -c, --unix-socket=FILENAME
200              Listen on UNIX socket at FILENAME.
201
202       --user=USERNAME
203              User for --new-password.
204
205       --value=VALUE
206              User for --new-password.
207
208       --verbose
209              Has no effect. See INSTALL.md for logging config.
210
211       --verify-scanner=SCANNER-UUID
212              Verify scanner SCANNER-UUID and exit.
213
214       --version
215              Print version and exit.
216

SIGNALS

218       SIGHUP  causes  gvmd  to rebuild the database with information from the
219       Scanner (openvassd).
220

EXAMPLES

222       gvmd --port 1241
223
224       Serve GMP clients on port 1241 and connect to an  OpenVAS  scanner  via
225       the default OTP file socket.
226

SEE ALSO

228       openvassd(8), gsad(8), gvm-cli(8),
229

MORE INFORMATION ABOUT GREENBONE VULNERABILITY MANAGEMENT

231       The  canonical  places  where  you will find more information about the
232       Greenbone Vulnerability Manager are:
233
234       https://community.greenbone.net (Community portal)
235
236       https://github.com/greenbone (Development Platform)
237
238       https://greenbone.net (Greenbone website)
239

COPYRIGHT

241       The Greenbone Vulnerability Manager is released under the GNU GPL, ver‐
242       sion 2, or, at your option, any later version.
243
244
245
246Manuals                              User                              gvmd(8)