.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "GDNSD-PLUGIN-STATIC 8"
.TH GDNSD-PLUGIN-STATIC 8 2024-03-15 "gdnsd 3.8.2" gdnsd
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
gdnsd\-plugin\-static \- gdnsd static plugin
.SH SYNOPSIS
.IX Header "SYNOPSIS"
Example static resources config for resolution:
.PP
.Vb 7
\&  plugins => {
\&    static => {
\&      foo => 192.0.2.1
\&      bar => 2001:db8::1
\&      baz => something.example.org.
\&    }
\&  }
.Ve
.PP
Example static service_types config for monitoring:
.PP
.Vb 8
\&  service_types => {
\&    my_static_mon => {
\&      plugin => static,
\&      ttl => 123,
\&      state => UP,
\&      # ... other generic service_type params (ignored)
\&    }
\&  }
.Ve
.PP
Zonefile RRs using static plugin resolution, in zone example.com:
.PP
.Vb 3
\&  foo 300 DYNA static!foo
\&  bar 300 DYNC static!bar
\&  baz 300 DYNC static!baz
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBgdnsd-plugin-static\fR is a combined monitoring and resolution
plugin that returns static data.  It is generally useless in
real scenarios, and mostly serves only as an example/test plugin.
.PP
For resolution, the configuration is a simple key/value hash
where the keys are resource names and the values can be a single
IP address (v4 or v6) or a domainname.  The domainname form can
only be used with \f(CW\*(C`DYNC\*(C'\fR, while the address form can be used with
either \f(CW\*(C`DYNA\*(C'\fR or \f(CW\*(C`DYNC\*(C'\fR.
.PP
For monitoring configuration as a service_type, the only two useful
parameters are \f(CW\*(C`ttl\*(C'\fR and \f(CW\*(C`state\*(C'\fR, which set a fixed TTL and state
for this static monitor result.  The other standard monitoring
parameters (e.g. interval, timeout) are ignored, as static sets its
states once at startup and never runs again.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBgdnsd.config\fR\|(5), \fBgdnsd.zonefile\fR\|(5), \fBgdnsd\fR\|(8)
.PP
The gdnsd manual.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2014 Brandon L Black <blblack@gmail.com>
.PP
This file is part of gdnsd.
.PP
gdnsd is free software: you can redistribute it and/or
modify it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
.PP
gdnsd is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with gdnsd.  If not, see
<http://www.gnu.org/licenses/>.