effectivelywild.technitium_dns.technitium_dns_disable_dhcp_scope module – Disable a DHCP scope

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

Synopsis

  • Disable a DHCP scope, stopping any further lease allocations.

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

name

string / required

The name of the DHCP scope to disable

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_dhcp_scopes

List all DHCP scopes

effectivelywild.technitium_dns.technitium_dns_get_dhcp_scope

Get DHCP scope details

effectivelywild.technitium_dns.technitium_dns_set_dhcp_scope

Set DHCP scope configuration

effectivelywild.technitium_dns.technitium_dns_enable_dhcp_scope

Enable a DHCP scope

effectivelywild.technitium_dns.technitium_dns_delete_dhcp_scope

Delete a DHCP scope

Examples

- name: Disable a DHCP scope
  technitium_dns_disable_dhcp_scope:
    api_url: "http://localhost"
    api_token: "myapitoken"
    name: "Default"

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

Sample: {}

status

string

API response status

Returned: always

Sample: "ok"

changed

boolean

Whether the module made changes to disable the DHCP scope

Returned: always

Sample: true

failed

boolean

Whether the module failed to disable the DHCP scope

Returned: always

Sample: false

msg

string

Human-readable message describing the result of disabling the DHCP scope

Returned: always

Sample: "DHCP scope 'Default' disabled."

Authors

  • Frank Muise (@effectivelywild)