1opendmarc-reports(8) System Manager's Manual opendmarc-reports(8)
2
6 opendmarc-reports - OpenDMARC aggregate report generation tool
7
9 opendmarc-reports [options]
10
12 opendmarc-reports pulls data from an OpenDMARC database and generates
13 periodic aggregate reports. The database is populated by a running
14 opendmarc-import(8) on a message history file generated by an opend‐
15 marc(8) filter as messages arrive and are processed. This includes the
16 collection of reporting URIs, which this script uses to make reports
17 available to those that request them.
18
20 --day Generate reports on day boundaries. Overrides the value of
21 --interval (see below).
22 --dbhost=hostname
24 Specifies the hostname on which the SQL server is running.
25 Defaults to the value of the environment variable OPEND‐
26 MARC_DBHOST, or "localhost" if the environment variable is not
27 set.
28 --dbname=name
30 Specifies the SQL database name to be accessed. Defaults to the
31 value of the environment variable OPENDMARC_DB, or "opendmarc"
32 if the environment variable is not set.
33 --dbpasswd=password
35 Specifies the password for the SQL database to be accessed.
36 Defaults to the value of the environment variable OPEND‐
37 MARC_PASSWORD, or "opendmarc" if the environment variable is not
38 set.
39 --dbport=port
41 Specifies the TCP port on which the SQL server is expected to be
42 listening. Defaults to the value of the environment variable
43 OPENDMARC_PORT, or 3306 if the environment variable is not set.
44 --dbuser=user
46 Specifies the SQL user to be used to access the database.
47 Defaults to the value of the environment variable OPEND‐
48 MARC_USER, or "opendmarc" if the environment variable is not
49 set.
50 --domain=name
52 Generates a report (if one is due) for the named domain, rather
53 than checking all of them.
54 --help Prints a help message and terminates.
56 --interval=secs
58 Generates reports only for hosts that have not had a report gen‐
59 erated in at least the last secs seconds.
60 --nodomain=name
62 Skips generating a report for the named domain. Can be speci‐
63 fied multiple times to skip multiple reporting domains.
64 --noupdate
66 Suppresses marking the time of the transmission of the report in
67 the database. Normally this would be done to prevent reports
68 from being sent too close together.
69 --report-email=addr
71 Generates reports using the specified address, which is used in
72 the report content and in the SMTP transaction. The default is
73 "postmaster@HOSTNAME" where HOSTNAME is replaced by the hostname
74 of the host generating the report.
75 --report-org=domain
77 Generates reports using the specified domain name as the organi‐
78 zation responsible for the report. This is used to create the
79 archive filename and is included in the report content. The
80 default is the hostname of the host generating the report.
81 --smtp-host=host
83 Causes reports to be sent by transmitting them using SMTP to the
84 named host which can be an IP address or a hostname. The
85 default is "127.0.0.1".
86 --smtp-port=port
88 Causes reports to be sent by transmitting them using SMTP to the
89 specified port. The default is 25.
90 --utc Instructs the database to change to the UTC timezone when gener‐
92 ating output. Otherwise, the database default is used.
93 --verbose
95 Increase the amount of verbosity written to standard output.
96 --version
98 Print version number and exit.
99
101 This man page covers the version of opendmarc-reports that shipped with
102 version 1.3.2 of OpenDMARC.
103
105 Copyright (c) 2012, 2014, 2015, The Trusted Domain Project. All rights
106 reserved.
107
109 opendmarc(8), opendmarc.conf(5), opendmarc-import(8)
110 The Trusted Domain Project opendmarc-reports(8)