effectivelywild.technitium_dns.technitium_dns_create_group module – Create a group in 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_create_group.

New in effectivelywild.technitium_dns 0.4.0

Synopsis

  • Create a new group in Technitium DNS server using its API.

  • This will not update existing groups; it only creates new ones (see technitium_dns_set_group_details).

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

The description text for the group

group

string / required

The name of the group to create

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_groups

List all groups from 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: Create a group
  technitium_dns_create_group:
    api_url: "http://localhost"
    api_token: "myapitoken"
    group: "Test Group"
    description: "Test group for development"

- name: Create group without description
  technitium_dns_create_group:
    api_url: "http://localhost"
    api_token: "myapitoken"
    group: "Simple Group"

- name: Create group in check mode
  technitium_dns_create_group:
    api_url: "http://localhost"
    api_token: "myapitoken"
    group: "Check Group"
    description: "Check mode group"
  check_mode: true

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

The core data payload from the API

Returned: always

description

string

Description of the created group

Returned: always

Sample: "Test group for development"

name

string

Name of the created group

Returned: always

Sample: "Test Group"

status

string

API response status

Returned: always

Sample: "ok"

changed

boolean

Whether the module made changes to create a new group

Returned: always

Sample: true

failed

boolean

Whether the module failed to complete the group creation

Returned: always

Sample: false

msg

string

Human-readable message describing the group creation result

Returned: always

Sample: "Group 'Test Group' created."

Authors

  • Frank Muise (@effectivelywild)