effectivelywild.technitium_dns.technitium_dns_delete_session module – Delete a user session

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

New in effectivelywild.technitium_dns 0.5.0

Synopsis

  • Delete a specified user session.

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

partialToken

string / required

The partial token of the session to delete that was returned by the list of sessions

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_sessions

List active user sessions

effectivelywild.technitium_dns.technitium_dns_create_token

Create an API token for a user

Examples

- name: Delete a user session
  technitium_dns_delete_session:
    api_url: "http://localhost"
    api_token: "myapitoken"
    partialToken: "ddfaecb8e9325e77"

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 (empty for delete operations)

Returned: always

Sample: {}

status

string

API response status

Returned: always

Sample: "ok"

changed

boolean

Whether the module made changes to delete the session

Returned: always

Sample: true

failed

boolean

Whether the module failed to complete the session deletion

Returned: always

Sample: false

msg

string

Human-readable message describing the session deletion result

Returned: always

Sample: "Session with partial token 'ddfaecb8e9325e77' deleted."

Authors

  • Frank Muise (@effectivelywild)