effectivelywild.technitium_dns.technitium_dns_list_apps module – List all installed apps

Note

This module is part of the effectivelywild.technitium_dns collection (version 0.9.1).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install effectivelywild.technitium_dns.

To use it in a playbook, specify: effectivelywild.technitium_dns.technitium_dns_list_apps.

New in effectivelywild.technitium_dns 0.9.0

Synopsis

  • Retrieve a list of all installed apps.

  • If the DNS server has Internet access and can retrieve data from DNS App Store, the API will also return if a store app has updates available.

Parameters

Parameter

Comments

api_port

integer

Port for the Technitium DNS API. Defaults to 5380

Default: 5380

api_token

string / required

API token for authenticating with the Technitium DNS API

api_url

string / required

Base URL for the Technitium DNS API

validate_certs

boolean

Whether to validate SSL certificates when making API requests.

Choices:

  • false

  • true ← (default)

See Also

See also

effectivelywild.technitium_dns.technitium_dns_list_store_apps

List all available apps from the DNS App Store

effectivelywild.technitium_dns.technitium_dns_download_and_install_app

Download and install an app from a URL

effectivelywild.technitium_dns.technitium_dns_uninstall_app

Uninstall an app from the DNS server

effectivelywild.technitium_dns.technitium_dns_get_app_config

Get app configuration

Examples

- name: List all installed apps from Technitium DNS
  technitium_dns_list_apps:
    api_url: "http://localhost"
    api_token: "myapitoken"
  register: result

- debug:
    var: result.apps

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

apps

list / elements=dictionary

List of installed DNS apps from the Technitium DNS server

Returned: always

dnsApps

list / elements=dictionary

List of DNS application components

Returned: always

classPath

string

Class path of the DNS app component

Returned: always

Sample: "BlockPageWebServer.App"

description

string

Description of the DNS app component

Returned: always

Sample: "Serves a block page from a built-in web server"

isAppRecordRequestHandler

boolean

Whether this is an APP record request handler

Returned: always

Sample: false

isAuthoritativeRequestHandler

boolean

Whether this is an authoritative request handler

Returned: always

Sample: false

isPostProcessor

boolean

Whether this is a post processor

Returned: always

Sample: false

isQueryLogger

boolean

Whether this is a query logger

Returned: always

Sample: false

isRequestBlockingHandler

boolean

Whether this is a request blocking handler

Returned: always

Sample: false

isRequestController

boolean

Whether this is a request controller

Returned: always

Sample: false

name

string

Name of the app

Returned: always

Sample: "Block Page"

version

string

Version of the installed app

Returned: always

Sample: "1.0"

changed

boolean

Whether the module made changes (always false for list operations)

Returned: always

Sample: false

failed

boolean

Whether the module failed

Returned: always

Sample: false

Authors

  • Frank Muise (@effectivelywild)