ansible-collection-mailserver/roles/opendkim/meta/argument_specs.yml

72 lines
2.7 KiB
YAML

---
argument_specs:
main:
version_added: "0.0.1"
short_description: Install and configure OpenDKIM.
description:
- Install and configure L(OpenDKIM,http://opendkim.org/).
- "Execution of this role can be limited using the following tags:"
- "C(role::opendkim:install): Install OpenDKIM"
- "C(role::opendkim:config): Render the OpenDKIM configuration file."
- "C(role::opendkim): Apply all of the above."
author: s3lph
options:
opendkim_syslog:
description:
- Log via calls to C(syslog(3)) any interesting activity.
type: bool
default: true
opendkim_syslog_success:
description:
- Log via calls to C(syslog(3)) additional entries indicating successful signing or verification of messages.
type: bool
default: true
opendkim_log_why:
description:
- >-
If logging is enabled, issues very detailed logging about the logic behind the filters decision to either
sign a message or verify it.
type: bool
default: false
opendkim_canonicalization:
description:
- Selects the canonicalization method(s) to be used when signing messages.
type: str
default: relaxed/relaxed
opendkim_mode:
description:
- Selects operating modes.
- The string is a concatenation of characters that indicate which mode(s) of operation are desired.
- Valid modes are C(s) (signer) and C(v) (verifier).
type: str
default: sv
opendkim_subdomains:
description:
- Sign subdomains of those listed by the Domain parameter as well as the actual domains.
type: bool
default: false
opendkim_oversign_headers:
description:
- >-
Specifies a set of header fields that should be included in all signature header lists once more than the
number of times they were actually present in the signed message.
type: str
default: From
opendkim_selector:
description:
- Defines the name of the selector to be used when signing messages.
type: str
default: mail
opendkim_socket:
description:
- Specifies the socket that should be established by the filter to receive connections from Postfix.
type: str
default: "local:/var/spool/postfix/opendkim/opendkim.sock"
opendkim_internal_hosts:
description:
- Identifies a set internal hosts whose mail should be signed rather than verified.
type: list
elements: str
default: ["127.0.0.0/8", "192.168.0.0/16", "10.0.0.0/8", "172.16.0.0/12"]