effectivelywild.technitium_dns.technitium_dns_list_permissions module – List all permissions

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

New in effectivelywild.technitium_dns 0.5.0

Synopsis

  • Retrieve a list of all permissions.

  • This includes both user permissions and group permissions for each section.

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_get_permission_details

Get permission details for a specific section

effectivelywild.technitium_dns.technitium_dns_set_permission_details

Set permission details for a specific section

effectivelywild.technitium_dns.technitium_dns_list_users

List all users

effectivelywild.technitium_dns.technitium_dns_list_groups

List all groups

Examples

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

- debug:
    var: result.permissions

- name: List permissions on a specific cluster node
  technitium_dns_list_permissions:
    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

permissions

list / elements=dictionary

List of permissions from the Technitium DNS server

Returned: always

groupPermissions

list / elements=dictionary

List of group permissions for this section

Returned: always

canDelete

boolean

Whether the group can delete from this section

Returned: always

Sample: true

canModify

boolean

Whether the group can modify this section

Returned: always

Sample: true

canView

boolean

Whether the group can view this section

Returned: always

Sample: true

name

string

Name of the group

Returned: always

Sample: "Administrators"

section

string

The permission section name

Returned: always

Sample: "Dashboard"

userPermissions

list / elements=dictionary

List of user permissions for this section

Returned: always

canDelete

boolean

Whether the user can delete from this section

Returned: always

Sample: true

canModify

boolean

Whether the user can modify this section

Returned: always

Sample: true

canView

boolean

Whether the user can view this section

Returned: always

Sample: true

username

string

Username of the user

Returned: always

Sample: "frank"

Authors

  • Frank Muise (@effectivelywild)