dns

This module creates and controls a BIND DNS server in an Alpine instance.

Each server has a primary zone that is configured at the creation of the server. This name is used by the module to automatically determine where DNS names should go. Servers can have multiple zones, but then you cannot use the automatic server detection and have to manually indicate where a domain name needs to go.

A domain name must have a zone defined for it, otherwise it will fail to allocate. e.g. if you don’t have a server that has the nope zone, you will unable to create a domain of something.nope.

See Parameter Types for parameter types.

list

View all DNS servers

remove_server

Delete a DNS server

Parameters

Name

Type

id

INTEGER

add_server

Add a DNS server

Parameters

Name

Type

ip_addr

IP

description

TEXT

domain

TEXT

add_zone

Add a DNS zone

Parameters

Name

Type

id

INTEGER

zone

TEXT

direction

[‘fwd’, ‘rev’]

smart_add_record

Add a record to a DNS server, detecting server and zone

Parameters

Name

Type

direction

[‘fwd’, ‘rev’]

type

TEXT

fqdn

TEXT

value

ADVTEXT

autocreate

BOOLEAN

smart_remove_record

Add a record to a DNS server, detecting server and zone

Parameters

Name

Type

direction

[‘fwd’, ‘rev’]

type

TEXT

fqdn

TEXT

value

ADVTEXT

add_record

Add a record to a DNS server

Parameters

Name

Type

id

INTEGER

zone

TEXT

direction

[‘fwd’, ‘rev’]

type

TEXT

name

TEXT

value

ADVTEXT

remove_record

Remove a record from a DNS server

Parameters

Name

Type

id

INTEGER

zone

TEXT

direction

[‘fwd’, ‘rev’]

type

TEXT

name

TEXT

value

ADVTEXT

add_host

Add a host to a DNS server

Parameters

Name

Type

fqdn

TEXT

ip_addr

IP_ADDR

remove_host

Remove a host to a DNS server

Parameters

Name

Type

fqdn

TEXT

ip_addr

IP_ADDR

start_server

Start a DNS server

Parameters

Name

Type

id

INTEGER

stop_server

Stop a DNS server

Parameters

Name

Type

id

INTEGER

get_server

Get info on a DNS server

Parameters

Name

Type

id

INTEGER

list_forwarders

View forwarders for DNS server

Parameters

Name

Type

id

INTEGER

add_forwarder

Add forwarder to DNS server

Parameters

Name

Type

id

INTEGER

ip_addr

IP_ADDR

remove_forwarder

Remove forwarder from DNS server

Parameters

Name

Type

id

INTEGER

ip_addr

IP_ADDR

smart_add_subdomain_server

Add subdomain server, automatically setting up root server to point to it

Parameters

Name

Type

fqdn

TEXT

ip_addr

IP_ADDR

smart_remove_subdomain_server

Remove subdomain server, automatically deleting entries in the parent server

Parameters

Name

Type

id

INTEGER

smart_add_root_server

Add a new root domain server (e.g. .com or .net), automatically setting up root server to point to it

Parameters

Name

Type

root_name

TEXT

ip_addr

IP_ADDR

smart_remove_root_server

Remove root domain server (e.g. .com or .net), automatically deleting entries in the parent server

Parameters

Name

Type

id

INTEGER

smart_add_external_subdomain

Add subdomain that points to an external DNS server

Parameters

Name

Type

fqdn

TEXT

ip_addr

IP_ADDR

smart_remove_external_subdomain

Add subdomain that points to an external DNS server

Parameters

Name

Type

fqdn

TEXT

ip_addr

IP_ADDR