effectivelywild.technitium_dns.technitium_dns_list_groups module – List all groups from Technitium DNS server

Note

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

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

New in effectivelywild.technitium_dns 0.4.0

Synopsis

• Retrieve a list of all groups from a Technitium DNS server.

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_create_group

Create a group in Technitium DNS server

effectivelywild.technitium_dns.technitium_dns_delete_group

Delete a group from Technitium DNS server

effectivelywild.technitium_dns.technitium_dns_get_group_details

Get group details from Technitium DNS server

effectivelywild.technitium_dns.technitium_dns_set_group_details

Set group details in Technitium DNS server

Examples

- name: List all groups from Technitium DNS
  technitium_dns_list_groups:
    api_url: "http://localhost"
    api_token: "myapitoken"
  register: result

- debug:
    var: result.groups

- name: Check if default groups exist
  technitium_dns_list_groups:
    api_url: "http://localhost"
    api_token: "myapitoken"
  register: groups_result

- name: Verify administrators group exists
  assert:
    that:
      - groups_result.groups | selectattr('name', 'equalto', 'Administrators') | list | length > 0
    fail_msg: "Administrators group not found"

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
groups list / elements=dictionary	List of groups from the Technitium DNS server Returned: always
description string	Description of the group Returned: always Sample: "Super administrators"
name string	Name of the group Returned: always Sample: "Administrators"

Authors

• Frank Muise (@effectivelywild)

Collection links

• Issue Tracker
• Repository (Sources)