powerdns integration pack

StackStorm intergratation for the PowerDNS API. https://powerdns.com/

Configuration

The following options are required to be configured for the pack to work correctly.

Option	Type	Required	Secret	Description
api_key	string	True	True	PowerDNS API Key
api_url	string	True	False	URL to PowerDNS API.

Actions

The pack provides the following actions:

get_servers

List PowerDNS servers

Parameter	Type	Required	Secret	Description
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.

create_records

Create resource record sets

Parameter	Type	Required	Secret	Description
rrset_comments	array	False	default	list of Comments instances for this RRSet
rrset_ttl	number	False	default	Record time to live
rrset_records	array	False	default	List of Str or Tuple(content_str, disabled_bool) or Dict with the keys “content” and optionally “disabled”.
rrset_rtype	string	False	default	Record type
rrset_name	string	False	default	Record name
rrset_changetype	string	False	default	API keyword DELETE or REPLACE
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.
zone_name	string	True	default	Zone's canonical name to get details.

restore_zone

Restore a zone from a json file produced by PDNSZone.backup()

Parameter	Type	Required	Secret	Description
json_file	string	True	default	json_file
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.

get_zone

Get zone by name

Parameter	Type	Required	Secret	Description
name	string	True	default	name
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.

get_record

Get record data

Parameter	Type	Required	Secret	Description
name	string	True	default	name
zone_name	string	True	default	Zone's canonical name to get details.
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.

notify

Trigger notification for zone updates

Parameter	Type	Required	Secret	Description
zone_name	string	True	default	Zone's canonical name to get details.
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.

suggest_zone

Suggest best matching zone from existing zone

Parameter	Type	Required	Secret	Description
r_name	string	True	default	r_name
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.

backup

Backup zone data to json file

Parameter	Type	Required	Secret	Description
pretty_json	boolean	False	default	Enable pretty json display
filename	string	False	default	Json file name
directory	string	True	default	Directory to store json file
zone_name	string	True	default	Zone's canonical name to get details.
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.

get_details

Get zone’s detailed data

Parameter	Type	Required	Secret	Description
zone_name	string	True	default	Zone's canonical name to get details.
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.

get_config

Server configuration from PowerDNS API

Parameter	Type	Required	Secret	Description
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.

search

Search term using API search endpoint

Parameter	Type	Required	Secret	Description
max_result	number	False	default	__
search_term	string	True	default	__
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.

delete_records

Delete resource record sets

Parameter	Type	Required	Secret	Description
rrset_comments	array	False	default	list of Comments instances for this RRSet
rrset_ttl	number	False	default	Record time to live
rrset_records	array	False	default	List of Str or Tuple(content_str, disabled_bool) or Dict with the keys “content” and optionally “disabled”.
rrset_rtype	string	False	default	Record type
rrset_name	string	False	default	Record name
rrset_changetype	string	False	default	API keyword DELETE or REPLACE
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.
zone_name	string	True	default	Zone's canonical name to get details.

create_zone

Create or update a (new) zone

Parameter	Type	Required	Secret	Description
rrset_comments	array	False	default	list of Comments instances for this RRSet
rrset_ttl	number	False	default	Record time to live
rrset_records	array	False	default	List of Str or Tuple(content_str, disabled_bool) or Dict with the keys “content” and optionally “disabled”.
rrset_rtype	string	False	default	Record type
rrset_name	string	False	default	Record name
rrset_changetype	string	False	default	API keyword DELETE or REPLACE
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.
update	boolean	False	default	If the zone need to be updated or created
servers	array	False	default	List of forwarded-to servers (recursor only)
masters	array	False	default	Zone masters
nameservers	array	True	default	Name servers
kind	string	True	default	Type of zone
name	string	True	default	Name of zone

get_records

Get zone’s records

Parameter	Type	Required	Secret	Description
zone_name	string	True	default	Zone's canonical name to get details.
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.

run_all_actions

Run all actions in this pack.

Parameter	Type	Required	Secret	Description

delete_zone

Delete a zone

Parameter	Type	Required	Secret	Description
name	string	True	default	name
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.

get_zones

List of DNS zones on a PowerDNS server

Parameter	Type	Required	Secret	Description
response_timeout	number	False	default	Time to wait for a response from PowerDNS
server_id	string	True	default	Server name to query.

Sensors

There are no sensors available for this pack.

Authentication

• To be advised.

Limitations

• Records can only be created or enitrely updated. No partial record updates are currently supported.

References

• This pack uses python-powerdns.

Thanks to

• Denis 'jawa' Pompilio for the python-powerdns project.
• The PowerDNS project team.

_{Documentation generated using pack2md}