effectivelywild.technitium_dns.technitium_dns_get_group_details module – Get group details 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_get_group_details.

New in effectivelywild.technitium_dns 0.4.0

Synopsis

  • Retrieve detailed information about a group from Technitium DNS server.

  • Returns group name, description, and user membership information.

  • Users information is always included in the response.

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

group

string / required

The name of the group to get details for

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_list_groups

List all groups from Technitium DNS server

effectivelywild.technitium_dns.technitium_dns_set_group_details

Set group details in Technitium DNS server

Examples

- name: Get Administrators group details
  technitium_dns_get_group_details:
    api_url: "http://localhost"
    api_token: "myapitoken"
    group: "Administrators"
  register: result

- debug:
    var: result.group_details

- name: Get details for a custom group
  technitium_dns_get_group_details:
    api_url: "http://localhost"
    api_token: "myapitoken"
    group: "Custom Group"
  register: result

- debug:
    var: result.group_details

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 get operations)

Returned: always

Sample: false

failed

boolean

Whether the module failed

Returned: always

Sample: false

group_details

dictionary

Complete group details and membership information

Returned: always

description

string

Description of the group

Returned: always

Sample: "Super administrators"

members

list / elements=string

List of usernames that are members of this group

Returned: always

Sample: ["admin"]

name

string

Name of the group

Returned: always

Sample: "Administrators"

users

list / elements=string

List of all usernames that have access to this group

Returned: always

Sample: ["admin", "user1"]

Authors

  • Frank Muise (@effectivelywild)