effectivelywild.technitium_dns.technitium_dns_set_group_details module – Set group details

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

New in effectivelywild.technitium_dns 0.4.0

Synopsis

  • Change group details.

  • Allows modifying description, renaming groups, and setting group members.

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

description

string

A new group description

group

string / required

The name of the group to modify

members

list / elements=string

A list of usernames to set as the group’s members

newGroup

string

A new group name to rename the group

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

effectivelywild.technitium_dns.technitium_dns_delete_group

Delete a group

effectivelywild.technitium_dns.technitium_dns_get_group_details

Get group details

effectivelywild.technitium_dns.technitium_dns_list_groups

List all groups

Examples

- name: Update group description
  technitium_dns_set_group_details:
    api_url: "http://localhost"
    api_token: "myapitoken"
    group: "testgroup"
    description: "Updated test group description"

- name: Rename group
  technitium_dns_set_group_details:
    api_url: "http://localhost"
    api_token: "myapitoken"
    group: "oldname"
    newGroup: "newname"

- name: Set group members
  technitium_dns_set_group_details:
    api_url: "http://localhost"
    api_token: "myapitoken"
    group: "testgroup"
    members:
      - "user1"
      - "user2"

- name: Update multiple properties
  technitium_dns_set_group_details:
    api_url: "http://localhost"
    api_token: "myapitoken"
    group: "testgroup"
    description: "New description"
    members:
      - "admin"

Return Values

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

Key

Description

api_response

dictionary

Complete raw API response from Technitium DNS

Returned: always

response

dictionary

Updated group details from the API

Returned: always

description

string

Description of the group

Returned: always

Sample: "Updated test group description"

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: "testgroup"

status

string

API response status

Returned: always

Sample: "ok"

changed

boolean

Whether the module made changes

Returned: always

Sample: true

diff

dictionary

Dictionary showing what changed, with current and desired values

Returned: when changes are made

Sample: {"description": {"current": "Old description", "desired": "New description"}, "members": {"current": ["user1"], "desired": ["user1", "user2"]}}

failed

boolean

Whether the module failed

Returned: always

Sample: false

msg

string

Human readable message describing the result

Returned: always

Sample: "Group details updated successfully."

Authors

  • Frank Muise (@effectivelywild)