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. De‐
25 faults to the value of the environment variable OPENDMARC_DB‐
26 HOST, or "localhost" if the environment variable is not set.
27 --dbname=name
29 Specifies the SQL database name to be accessed. Defaults to the
30 value of the environment variable OPENDMARC_DB, or "opendmarc"
31 if the environment variable is not set.
32 --dbpasswd=password
34 Specifies the password for the SQL database to be accessed. De‐
35 faults to the value of the environment variable OPENDMARC_PASS‐
36 WORD, or "opendmarc" if the environment variable is not set.
37 --dbport=port
39 Specifies the TCP port on which the SQL server is expected to be
40 listening. Defaults to the value of the environment variable
41 OPENDMARC_PORT, or 3306 if the environment variable is not set.
42 --dbuser=user
44 Specifies the SQL user to be used to access the database. De‐
45 faults to the value of the environment variable OPENDMARC_USER,
46 or "opendmarc" if the environment variable is not set.
47 --domain=name
49 Generates a report (if one is due) for the named domain, rather
50 than checking all of them.
51 --help Prints a help message and terminates.
53 --interval=secs
55 Generates reports only for hosts that have not had a report gen‐
56 erated in at least the last secs seconds.
57 --nodomain=name
59 Skips generating a report for the named domain. Can be speci‐
60 fied multiple times to skip multiple reporting domains.
61 --noupdate
63 Suppresses marking the time of the transmission of the report in
64 the database. Normally this would be done to prevent reports
65 from being sent too close together.
66 --report-email=addr
68 Generates reports using the specified address, which is used in
69 the report content and in the SMTP transaction. The default is
70 "postmaster@HOSTNAME" where HOSTNAME is replaced by the hostname
71 of the host generating the report.
72 --report-org=domain
74 Generates reports using the specified domain name as the organi‐
75 zation responsible for the report. This is used to create the
76 archive filename and is included in the report content. The de‐
77 fault is the hostname of the host generating the report.
78 --smtp-host=host
80 Causes reports to be sent by transmitting them using SMTP to the
81 named host which can be an IP address or a hostname. The de‐
82 fault is "127.0.0.1".
83 --smtp-port=port
85 Causes reports to be sent by transmitting them using SMTP to the
86 specified port. The default is 25.
87 --utc Instructs the database to change to the UTC timezone when gener‐
89 ating output. Otherwise, the database default is used.
90 --verbose
92 Increase the amount of verbosity written to standard output.
93 --version
95 Print version number and exit.
96
98 This man page covers the version of opendmarc-reports that shipped with
99 version 1.4.1 of OpenDMARC.
100
102 Copyright (c) 2012, 2014, 2015, The Trusted Domain Project. All rights
103 reserved.
104
106 opendmarc(8), opendmarc.conf(5), opendmarc-import(8)
107 The Trusted Domain Project opendmarc-reports(8)