Reference Guides¶

These chapters contain extensive information on all functions and object available in dnsdist.

Rule Actions
Configuration Reference
- Functions and Types
- Global configuration
- Servers
  - Server Functions
- Pools
  - PacketCache
- Client State
  - ClientState functions
- Status, Statistics and More
- Dynamic Blocks
- Outgoing TLS tickets cache management
- Other functions
Constants
- OPCode
- DNSClass
- RCode
- EDNSOptionCode
- DNS Packet Sections
- DNSAction
- DNSQType
- DNSResponseAction
ComboAddress
Netmask
NetmaskGroup
DNSName objects
- Functions and methods of a DNSName
DNSNameSet objects
- Functions and methods of a DNSNameSet
The DNSQuestion (dq) object
DNSResponse object
DNSHeader (dh) object
EDNSOptionView object
AsynchronousObject object
eBPF functions and objects
DNSCrypt objects and functions
- Certificates
- Certificate Pairs
- Context
DNS Parser
- DNSPacketOverlay
DNSRecord object
Protobuf Logging Reference
dnstap Logging Reference
Carbon export
SNMP reporting
Tuning related functions
Key Value Store functions and objects
Logging
Webserver-related objects
Rules management
- Incoming queries
- Cache misses
- Responses
- Cache hits
- Cache inserted
- Self-answered responses
- XFR
- Convenience Functions
Rule selectors
- Combining Rules
- Objects
SVCRecordParameters
Custom Metrics
XSK / AF_XDP functions and objects
YAML configuration reference
- GlobalConfiguration
- BackendConfiguration
- BindConfiguration
- CacheSettingsConfiguration
- CarbonConfiguration
- CdbKvStoreConfiguration
- ConsoleConfiguration
- CustomLoadBalancingPolicyConfiguration
- DnstapLoggerConfiguration
- DohTuningConfiguration
- DynamicRuleConfiguration
- DynamicRulesConfiguration
- DynamicRulesSettingsConfiguration
- EbpfConfiguration
- EbpfMapConfiguration
- EdnsClientSubnetConfiguration
- GeneralConfiguration
- HealthCheckConfiguration
- HttpCustomResponseHeaderConfiguration
- HttpResponsesMapConfiguration
- IncomingDnscryptCertificateKeyPairConfiguration
- IncomingDnscryptConfiguration
- IncomingDohConfiguration
- IncomingDoqConfiguration
- IncomingQuicConfiguration
- IncomingTcpConfiguration
- IncomingTlsCertificateKeyPairConfiguration
- IncomingTlsConfiguration
- KeyValueStoresConfiguration
- KvsLookupKeyQnameConfiguration
- KvsLookupKeySourceIpConfiguration
- KvsLookupKeySuffixConfiguration
- KvsLookupKeyTagConfiguration
- KvsLookupKeysConfiguration
- LazyHealthCheckConfiguration
- LmdbKvStoreConfiguration
- LoadBalancingPoliciesConfiguration
- LoggingConfiguration
- MetricsConfiguration
- OutgoingAutoUpgradeConfiguration
- OutgoingDohConfiguration
- OutgoingTcpConfiguration
- OutgoingTlsConfiguration
- PacketCacheConfiguration
- PoolConfiguration
- ProtoBufMetaConfiguration
- ProtobufLoggerConfiguration
- ProxyProtocolConfiguration
- ProxyProtocolValueConfiguration
- QueryCountConfiguration
- QueryRuleConfiguration
- RemoteLoggingConfiguration
- ResponseRuleConfiguration
- RingBuffersConfiguration
- SecurityPollingConfiguration
- SnmpConfiguration
- StructuredLoggingConfiguration
- TcpTuningConfiguration
- TlsEngineConfiguration
- TlsTuningConfiguration
- TuningConfiguration
- UdpTuningConfiguration
- WebserverConfiguration
- XskConfiguration
YAML selector reference
- AllSelector
- AndSelector
- ByNameSelector
- DNSSECSelector
- DSTPortSelector
- EDNSOptionSelector
- EDNSVersionSelector
- ERCodeSelector
- HTTPHeaderSelector
- HTTPPathSelector
- HTTPPathRegexSelector
- KeyValueStoreLookupSelector
- KeyValueStoreRangeLookupSelector
- LuaSelector
- LuaFFISelector
- LuaFFIPerThreadSelector
- MaxQPSSelector
- MaxQPSIPSelector
- NetmaskGroupSelector
- NotSelector
- OpcodeSelector
- OrSelector
- PayloadSizeSelector
- PoolAvailableSelector
- PoolOutstandingSelector
- ProbaSelector
- ProxyProtocolValueSelector
- QClassSelector
- QNameSelector
- QNameLabelsCountSelector
- QNameSetSelector
- QNameSuffixSelector
- QNameWireLengthSelector
- QTypeSelector
- RCodeSelector
- RDSelector
- RE2Selector
- RecordsCountSelector
- RecordsTypeCountSelector
- RegexSelector
- SNISelector
- TagSelector
- TCPSelector
- TrailingDataSelector
YAML action reference
- AllowAction
- ContinueAction
- DelayAction
- DnstapLogAction
- DropAction
- SetEDNSOptionAction
- ERCodeAction
- HTTPStatusAction
- KeyValueStoreLookupAction
- KeyValueStoreRangeLookupAction
- LogAction
- LuaAction
- LuaFFIAction
- LuaFFIPerThreadAction
- NegativeAndSOAAction
- NoneAction
- PoolAction
- QPSAction
- QPSPoolAction
- RCodeAction
- RemoteLogAction
- SetAdditionalProxyProtocolValueAction
- SetDisableECSAction
- SetDisableValidationAction
- SetECSAction
- SetECSOverrideAction
- SetECSPrefixLengthAction
- SetExtendedDNSErrorAction
- SetMacAddrAction
- SetMaxReturnedTTLAction
- SetNoRecurseAction
- SetProxyProtocolValuesAction
- SetSkipCacheAction
- SetTagAction
- SetTempFailureCacheTTLAction
- SNMPTrapAction
- SpoofAction
- SpoofCNAMEAction
- SpoofPacketAction
- SpoofRawAction
- SpoofSVCAction
- TCAction
- TeeAction
YAML response-action reference
- AllowResponseAction
- ClearRecordTypesResponseAction
- DelayResponseAction
- DnstapLogResponseAction
- DropResponseAction
- LimitTTLResponseAction
- LogResponseAction
- LuaResponseAction
- LuaFFIResponseAction
- LuaFFIPerThreadResponseAction
- RemoteLogResponseAction
- SetExtendedDNSErrorResponseAction
- SetMaxReturnedTTLResponseAction
- SetMaxTTLResponseAction
- SetMinTTLResponseAction
- SetReducedTTLResponseAction
- SetSkipCacheResponseAction
- SetTagResponseAction
- SNMPTrapResponseAction
- TCResponseAction
YAML support structures
- ResponseConfig
- SOAParams
- SVCRecordAdditionalParams
- SVCRecordParameters