PS-Pi-Hole 1.0.0

dotnet add package PS-Pi-Hole --version 1.0.0

NuGet\Install-Package PS-Pi-Hole -Version 1.0.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="PS-Pi-Hole" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add PS-Pi-Hole --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: PS-Pi-Hole, 1.0.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install PS-Pi-Hole as a Cake Addin
#addin nuget:?package=PS-Pi-Hole&version=1.0.0

// Install PS-Pi-Hole as a Cake Tool
#tool nuget:?package=PS-Pi-Hole&version=1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

PS-Pi-Hole

Module for interacting with pi-hole using the REST API. Used all possible endpoints at the time of release module.

🚀 Install

Download and run the script Deploy-Invoke-Pi-Hole.ps1

🔐 Token

Get Token (ssh): sudo cat /etc/pihole/setupVars.conf | grep WEBPASSWORD
Server and Token can be set in module parameters (line 28 and 29)

🔑 Keys

✅ Invoke-Pi-Hole -Server 192.168.1.253 -Token 5af9bd44aebce0af6206fc8ad4c3750b6bf2dd38fa59bba84ea9570e16a05d0f -Status
✅ Invoke-Pi-Hole -Enable Enable Blocking
✅ Invoke-Pi-Hole -Disable Disable Blocking
✅ Invoke-Pi-Hole -Stats Blocking work status
✅ Invoke-Pi-Hole -TopClient
✅ Invoke-Pi-Hole -TopPermittedDomains
✅ Invoke-Pi-Hole -TopPermittedDomains -Count 100
✅ Invoke-Pi-Hole -LastBlockedDomain
✅ Invoke-Pi-Hole -ForwardServer Upstream servers
✅ Invoke-Pi-Hole -QueryTypes
✅ Invoke-Pi-Hole -QueryLog
✅ Invoke-Pi-Hole -Data Number of requests for every 10 minutes during the last 24 hours
✅ Invoke-Pi-Hole -Versions Current and Latest versions
✅ Invoke-Pi-Hole -Releases Current (last) version and date from the GitHub repository
✅ Invoke-Pi-Hole -AdList Status Hosts List (StevenBlack)

🎉 Examples

Connect to Pi-Hole server for get stats (it is not necessary to use a token)

Image alt

Enable/Disable Blocking (using filters) and get status

Image alt

Get full Query Log (comparison of raw and parsing output)

Image alt

Top local clients and permitted (available) domains destination

Image alt

View versions for monitoring and update

Image alt

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
1.0.0	129	2/3/2024