effectivelywild.technitium_dns.technitium_dns_list_store_apps module – List all available apps from Technitium DNS App Store

Note

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

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_store_apps.

New in effectivelywild.technitium_dns 0.9.0

Synopsis

  • Retrieve a list of all available apps from the DNS App Store.

  • Indicates which apps are already installed and if updates are 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

node

string

The node domain name for which this API call is intended

When unspecified, the current node is used

This parameter can be used only when Clustering is initialized

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_apps

List all installed apps from the DNS server

effectivelywild.technitium_dns.technitium_dns_download_and_install_app

Download and install an app from a URL

effectivelywild.technitium_dns.technitium_dns_download_and_update_app

Download and update an app from a URL

Examples

- name: List all available apps from DNS App Store
  technitium_dns_list_store_apps:
    api_url: "http://localhost"
    api_token: "myapitoken"
  register: result

- debug:
    var: result.store_apps

- name: Find apps that have updates available
  technitium_dns_list_store_apps:
    api_url: "http://localhost"
    api_token: "myapitoken"
  register: store_apps_result

- name: Show apps with updates
  debug:
    msg: "App {{ item.name }} has update from {{ item.installedVersion }} to {{ item.version }}"
  loop: "{{ store_apps_result.store_apps | selectattr('updateAvailable', 'equalto', true) | list }}"
  when: store_apps_result.store_apps | selectattr('updateAvailable', 'equalto', true) | list | length > 0

- name: List store apps on a specific cluster node
  technitium_dns_list_store_apps:
    api_url: "http://localhost"
    api_token: "myapitoken"
    node: "node1.cluster.example.com"
  register: result

Return Values

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

Key

Description

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

store_apps

list / elements=dictionary

List of available apps from the DNS App Store

Returned: always

description

string

Description of the app

Returned: always

Sample: "Returns A or AAAA records based on client continent"

installed

boolean

Whether the app is currently installed

Returned: always

Sample: false

installedVersion

string

Currently installed version (only if installed=true)

Returned: when installed

Sample: "1.0"

name

string

Name of the app

Returned: always

Sample: "Geo Continent"

size

string

Size of the app package

Returned: always

Sample: "2.01 MB"

updateAvailable

boolean

Whether an update is available (only if installed=true)

Returned: when installed

Sample: true

url

string

Download URL for the app

Returned: always

Sample: "https://download.technitium.com/dns/apps/GeoContinentApp.zip"

version

string

Latest version available in the store

Returned: always

Sample: "1.1"

Authors

  • Frank Muise (@effectivelywild)