{"id":2233,"date":"2025-04-10T12:24:27","date_gmt":"2025-04-10T16:24:27","guid":{"rendered":"https:\/\/enterpriseadmins.org\/blog\/?p=2233"},"modified":"2025-04-10T12:24:27","modified_gmt":"2025-04-10T16:24:27","slug":"how-to-create-a-pi-hole-management-pack-in-aria-operations","status":"publish","type":"post","link":"https:\/\/enterpriseadmins.org\/blog\/uncategorized\/how-to-create-a-pi-hole-management-pack-in-aria-operations\/","title":{"rendered":"How to Create a Pi-Hole Management Pack in Aria Operations"},"content":{"rendered":"\n

Two years ago, I documented<\/a> the integration of Pi-Hole with VMware Aria Operations using the Aria Operations Management Pack Builder (MPB) and Pi-Hole\u2019s API. Since then, both tools have undergone significant updates: MPB has a revamped 2.0 interface, and Pi-Hole 6 introduced a completely new API with formal documentation and session-based authentication. In this updated guide, I\u2019ll walk you through building a Pi-Hole Management Pack using these modern tools, highlighting key changes and providing a detailed, hands-on tutorial for tech enthusiasts and system admins.<\/p>\n\n\n\n

What\u2019s New with the Pi-Hole API?<\/h2>\n\n\n\n

Formal Documentation and Accessibility<\/h3>\n\n\n\n

With the release of Pi-Hole 6, the API has been overhauled to be more robust and user-friendly. Official documentation is now available at http:\/\/pi.hole\/api\/docs<\/a>, which resolves to your local Pi-Hole server to ensure version compatibility. If you haven\u2019t installed Pi-Hole yet, you can explore the documentation for all branches online, such as the Pi-Hole API documentation (master branch)<\/a>. Additionally, Pi-Hole provides a built-in UI at https:\/\/YourPi-holeServerName\/api\/docs\/<\/code> where you can test API requests directly\u2014a fantastic feature for developers.<\/p>\n\n\n\n

Session ID Authentication: A Shift from Tokens<\/h3>\n\n\n\n

One major change in Pi-Hole 6 is the move from token-based to session ID-based authentication. I discovered this shift when my existing Management Pack stopped collecting data after upgrading to version 6. The API authentication documentation<\/a> outlines several authentication options, I opted for the App Password method. Here\u2019s how to set it up:<\/p>\n\n\n\n

    \n
  1. In the Pi-Hole Admin UI, navigate to the Web Interface \/ API section of Settings, make sure the interface is toggled from Basic to Expert and click Configure App Password<\/strong>.<\/li>\n\n\n\n
  2. The UI will display a one-time App Password\u2014copy it immediately, as it won\u2019t be shown again. Store it securely (e.g., in a password manager).<\/li>\n<\/ol>\n\n\n\n
    \"\"<\/a><\/figure>\n\n\n\n

    To verify the new authentication method, I used the API UI (https:\/\/YourPi-holeServerName\/api\/docs\/<\/a>) to test a request with my App Password. After clicking Try<\/strong>, I received a session.sid<\/code>, confirming successful authentication.<\/p>\n\n\n\n

    \"\"<\/a><\/figure>\n\n\n\n

    I then tested the \/stats\/summary<\/code> endpoint (used in my original article) with the session ID, ensuring it returned the expected data. I now had a basic enough understanding of the API to apply it to building a Management Pack.<\/p>\n\n\n\n

    Introducing Aria Operations Management Pack Builder 2.0<\/h2>\n\n\n\n

    Released in October 2024, version 2.0 of the Aria Operations Management Pack Builder brings a refreshed UI and improved functionality. While MPs from version 1 can be imported, the Pi-Hole API changes require a fresh build for this example. I\u2019ll assume you\u2019ve already deployed the MPB appliance (refer to the official MPB deployment guide<\/a>) and are ready to start.<\/p>\n\n\n\n

    Step 1: Configure the Connection in MPB<\/h2>\n\n\n\n

    First, connect MPB to your Aria Operations server:<\/p>\n\n\n\n

      \n
    1. Access the MPB Web UI.<\/li>\n\n\n\n
    2. Navigate to the VMware Aria Operations Connection<\/strong> tab.<\/li>\n\n\n\n
    3. Create and test a connection to your Aria Operations server.<\/li>\n<\/ol>\n\n\n\n
      \"\"<\/a><\/figure>\n\n\n\n

      With the connection established, you\u2019re ready to build your Management Pack.<\/p>\n\n\n\n

      Step 2: Define the Source<\/h2>\n\n\n\n

      The Source defines the environment (your Pi-Hole server) that MPB will interact with. Here\u2019s how to set it up:<\/p>\n\n\n\n

        \n
      1. In the Designs<\/strong> tab, click Create<\/strong>.<\/li>\n\n\n\n
      2. Name your Management Pack (e.g., \u201cPi-Hole MP\u201d) and add a description, then click Save<\/strong>.<\/li>\n\n\n\n
      3. Configure the Source:\n