diff --git a/.github/workflows/manual-editions.yml b/.github/workflows/manual-editions.yml index 27d75aa5..69a4e79f 100644 --- a/.github/workflows/manual-editions.yml +++ b/.github/workflows/manual-editions.yml @@ -85,3 +85,46 @@ jobs: manual-artifacts/ if-no-files-found: warn retention-days: 14 + publish: + # The build job runs third-party tooling with a read-only token. Only this + # job, which runs no repository code, can write the release assets. + name: Publish development manual editions + needs: editions + if: github.ref == 'refs/heads/develop' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch') + runs-on: ubuntu-24.04 + timeout-minutes: 10 + permissions: + contents: write + concurrency: + group: manual-editions-publish + cancel-in-progress: false + env: + GH_TOKEN: ${{ github.token }} + GH_REPO: ${{ github.repository }} + RELEASE_TAG: manuals-develop + steps: + - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 + with: + name: cacti-manual-editions-attempt-${{ github.run_attempt }} + path: built + - name: Stage release assets under stable names + run: | + set -euo pipefail + mkdir assets + cp built/resource/pdf/cacti-manual.pdf assets/ + cp built/resource/pdf/build_manifest.json assets/cacti-manual-manifest.json + cp built/resource/manuals/build-manifest.json assets/editions-manifest.json + for file in built/resource/manuals/*.pdf built/resource/manuals/*.txt built/resource/manuals/*.sql; do + cp "$file" assets/ + done + test "$(find assets -type f | wc -l)" -eq 21 + - name: Replace the development release assets + run: | + set -euo pipefail + notes="Development (Cacti 1.3) manual editions built and verified from ${GITHUB_SHA::12}. Rebuilt after each change to develop." + if ! gh release view "$RELEASE_TAG" >/dev/null 2>&1; then + gh release create "$RELEASE_TAG" --target "$GITHUB_SHA" --prerelease --latest=false \ + --title 'Development manual editions' --notes "$notes" + fi + gh release upload "$RELEASE_TAG" assets/* --clobber + gh release edit "$RELEASE_TAG" --notes "$notes" diff --git a/.gitignore b/.gitignore index f20c96a3..0d35cbf2 100644 --- a/.gitignore +++ b/.gitignore @@ -26,3 +26,7 @@ html-artifacts/ /manual-artifacts/ navigation-report.json !.gitattributes +# Generated manual editions are published as release assets +/resource/manuals/ +/resource/pdf/cacti-manual.pdf +/resource/pdf/build_manifest.json diff --git a/Development-and-Testing.md b/Development-and-Testing.md index 93d8af5e..341aa2ed 100644 --- a/Development-and-Testing.md +++ b/Development-and-Testing.md @@ -69,7 +69,7 @@ Check Markdown style, spelling, navigation targets, image paths, and heading fragments. Preserve public page names and existing fragment links when reorganizing a page. Generated manuals must follow the same chapter order and record their source revision and checksums in the -[download manifest](resource/pdf/build_manifest.json). +[download manifest](https://github.com/Cacti/documentation/releases/download/manuals-develop/cacti-manual-manifest.json). [standards]: Manual-Index.md#development-standards [contributing]: https://github.com/Cacti/cacti/blob/develop/CONTRIBUTING.md diff --git a/Downloads.md b/Downloads.md index 38db0940..a02e4136 100644 --- a/Downloads.md +++ b/Downloads.md @@ -2,7 +2,7 @@ ## PDF Manuals -- [Cacti development manual](resource/pdf/cacti-manual.pdf): A snapshot of the +- [Cacti development manual][manual-pdf]: A snapshot of the current development manual, with a contents list, bookmarks, screenshots, and links between chapters. It documents the unreleased Cacti 1.3 series. - [ReportIt 3.0 development manual](resource/pdf/manual_reportit_3.0.pdf): @@ -13,7 +13,7 @@ [The original ReportIt 0.6.1 PDF](resource/pdf/manual_reportit.pdf) remains available as a historical reference. -The [build manifest](resource/pdf/build_manifest.json) records source hashes, +The [build manifest][pdf-manifest] records source hashes, build date, tool versions, and PDF checksums. It identifies the documentation base and the exact Markdown content used, including changes in this branch. Use the [online manual](README.md) for subsequent documentation updates. @@ -78,6 +78,8 @@ native libraries. [traffic-template]: resource/xml/cacti_data_query_php_interface_traffic.xml [reportit-source]: +[manual-pdf]: https://github.com/Cacti/documentation/releases/download/manuals-develop/cacti-manual.pdf +[pdf-manifest]: https://github.com/Cacti/documentation/releases/download/manuals-develop/cacti-manual-manifest.json --- diff --git a/Other-Manuals.md b/Other-Manuals.md index c6a4d627..ba1e31fe 100644 --- a/Other-Manuals.md +++ b/Other-Manuals.md @@ -8,9 +8,9 @@ styles. They do not import the website's visual design. ## Complete maintained manuals -- [PDF manual](resource/pdf/cacti-manual.pdf), with all current main chapters, +- [PDF manual][manual-pdf], with all current main chapters, bookmarks, screenshots, and links between chapters. -- [UTF-8 text manual](resource/manuals/manual.txt), with the same main chapters, +- [UTF-8 text manual][manual-text], with the same main chapters, command examples, image descriptions, and full link destinations. - [HTML manual publication](resources/build/HTML-Manual.md), including all chapters and legacy chapter URLs. @@ -27,14 +27,14 @@ welcome; platform checks and runtime limitations still apply. | Guide | Read online | PDF | Text | | --- | --- | --- | --- | -| German installation and operation | [Deutsch](resources/manuals/Guide-de.md) | [PDF](resource/manuals/cacti-guide-de.pdf) | [Text](resource/manuals/cacti-guide-de.txt) | -| Turkish installation and operation | [Türkçe](resources/manuals/Guide-tr.md) | [PDF](resource/manuals/cacti-guide-tr.pdf) | [Text](resource/manuals/cacti-guide-tr.txt) | -| Linux installation | [English](resources/manuals/Install-linux.md) | [PDF](resource/manuals/install-linux.pdf) | [Text](resource/manuals/install-linux.txt) | -| Russian UNIX installation | [Русский](resources/manuals/Install-ru-unix.md) | [PDF](resource/manuals/install-ru-unix.pdf) | [Text](resource/manuals/install-ru-unix.txt) | -| Russian Windows installation | [Русский](resources/manuals/Install-ru-windows.md) | [PDF](resource/manuals/install-ru-windows.pdf) | [Text](resource/manuals/install-ru-windows.txt) | -| Windows installation | [English](Installing-Under-Windows.md) | [PDF](resource/manuals/install-windows.pdf) | [Text](resource/manuals/install-windows.txt) | -| Migration from Solaris | [English](resources/manuals/Migrate-solaris.md) | [PDF](resource/manuals/migrate-solaris.pdf) | [Text](resource/manuals/migrate-solaris.txt) | -| Development database schema | [Reference](resources/manuals/Schema-Reference.md) | [PDF](resource/manuals/schema-reference.pdf) | [Text](resource/manuals/schema-reference.txt) | +| German installation and operation | [Deutsch](resources/manuals/Guide-de.md) | [PDF](https://github.com/Cacti/documentation/releases/download/manuals-develop/cacti-guide-de.pdf) | [Text](https://github.com/Cacti/documentation/releases/download/manuals-develop/cacti-guide-de.txt) | +| Turkish installation and operation | [Türkçe](resources/manuals/Guide-tr.md) | [PDF](https://github.com/Cacti/documentation/releases/download/manuals-develop/cacti-guide-tr.pdf) | [Text](https://github.com/Cacti/documentation/releases/download/manuals-develop/cacti-guide-tr.txt) | +| Linux installation | [English](resources/manuals/Install-linux.md) | [PDF](https://github.com/Cacti/documentation/releases/download/manuals-develop/install-linux.pdf) | [Text](https://github.com/Cacti/documentation/releases/download/manuals-develop/install-linux.txt) | +| Russian UNIX installation | [Русский](resources/manuals/Install-ru-unix.md) | [PDF](https://github.com/Cacti/documentation/releases/download/manuals-develop/install-ru-unix.pdf) | [Text](https://github.com/Cacti/documentation/releases/download/manuals-develop/install-ru-unix.txt) | +| Russian Windows installation | [Русский](resources/manuals/Install-ru-windows.md) | [PDF](https://github.com/Cacti/documentation/releases/download/manuals-develop/install-ru-windows.pdf) | [Text](https://github.com/Cacti/documentation/releases/download/manuals-develop/install-ru-windows.txt) | +| Windows installation | [English](Installing-Under-Windows.md) | [PDF](https://github.com/Cacti/documentation/releases/download/manuals-develop/install-windows.pdf) | [Text](https://github.com/Cacti/documentation/releases/download/manuals-develop/install-windows.txt) | +| Migration from Solaris | [English](resources/manuals/Migrate-solaris.md) | [PDF](https://github.com/Cacti/documentation/releases/download/manuals-develop/migrate-solaris.pdf) | [Text](https://github.com/Cacti/documentation/releases/download/manuals-develop/migrate-solaris.txt) | +| Development database schema | [Reference](resources/manuals/Schema-Reference.md) | [PDF](https://github.com/Cacti/documentation/releases/download/manuals-develop/schema-reference.pdf) | [Text](https://github.com/Cacti/documentation/releases/download/manuals-develop/schema-reference.txt) | The German and Turkish appendices include every current main manual chapter. Installation editions include the complete platform, first-graph, @@ -44,7 +44,7 @@ guide rather than an unverified new-install procedure. The Windows guides explain the current development dependency restriction before any install instructions. -The [schema SQL](resource/manuals/cacti-schema.sql) contains only the pinned +The [schema SQL][schema-sql] contains only the pinned upstream `CREATE TABLE` statements. It is a reference, not an installer or upgrade script. It has no seed data and does not describe plugin tables. Use the schema supplied with your exact Cacti release for installation. @@ -85,17 +85,27 @@ documents are not copied or translated into the new guides. Follow [manual publication][publication] to rebuild and validate every edition. The [edition manifest][editions-manifest] records exact sources and checksums. The PDF builder also records its locked -toolchain in [the PDF manifest](resource/pdf/build_manifest.json). +toolchain in [the PDF manifest][pdf-manifest]. -CI publishes review artifacts; it does not deploy the public file host. -Maintainers should publish the new editions under distinct versioned names, -link this index from the download page, and retain the original archive URLs. +CI rebuilds and verifies every edition after each change to `develop` and +publishes the results as assets of the +[development manual editions release][release]. The generated files are not +committed to this repository. + +Maintainers who mirror the editions on the public file host should publish +them under distinct versioned names, link this index from the download page, +and retain the original archive URLs. Publish the main manual separately from the historic `manual.pdf` and `manual.txt` names so an existing archive citation keeps its meaning. [publication]: resources/build/Other-Manuals.md +[release]: https://github.com/Cacti/documentation/releases/tag/manuals-develop +[pdf-manifest]: https://github.com/Cacti/documentation/releases/download/manuals-develop/cacti-manual-manifest.json +[manual-pdf]: https://github.com/Cacti/documentation/releases/download/manuals-develop/cacti-manual.pdf +[manual-text]: https://github.com/Cacti/documentation/releases/download/manuals-develop/manual.txt +[schema-sql]: https://github.com/Cacti/documentation/releases/download/manuals-develop/cacti-schema.sql [inventory]: resources/manuals/archive-inventory.json -[editions-manifest]: resource/manuals/build-manifest.json +[editions-manifest]: https://github.com/Cacti/documentation/releases/download/manuals-develop/editions-manifest.json [stable]: https://github.com/Cacti/documentation/blob/1.2.x/README.md [old-de]: https://files.cacti.net/docs/contrib/Cacti-Doku_german.pdf [old-tr]: https://files.cacti.net/docs/contrib/Cacti-El-Kitab.pdf diff --git a/resource/manuals/build-manifest.json b/resource/manuals/build-manifest.json deleted file mode 100644 index dd43d9dd..00000000 --- a/resource/manuals/build-manifest.json +++ /dev/null @@ -1,559 +0,0 @@ -{ - "source_revision": "e80276e25ea4", - "manual_version": "unreleased Cacti 1.3 develop", - "build_date": "2026-11-18", - "schema_source": { - "repository": "https://github.com/Cacti/cacti", - "branch": "develop", - "revision": "883b334debc61c436e6ba140cf91863c7d6686b7", - "path": "cacti.sql", - "sha256": "213c3d929c1bd643e6f5a9c84f61cab21b476144088bc91a0fe778a2827f86c6" - }, - "schema_tables": 127, - "build_inputs": { - "bin/build_other_manuals.py": "e790098a27548a57668c7b312fa75926aea2941e9cb438281bc373f782b51df1", - "bin/build_pdf_docs.py": "b4ae314f15a98cb3b615c6e2a10d923d35fbb284580e5bbd5c90b2a7a8cc541e", - "bin/build_pdf_docs.py.lock": "4b5333f4b4aba1d08ead0b9441494aadd991386e8ffd2c42d46c6d8647e82ca2", - "bin/check_navigation.py": "8f825c79c96297e4b7d4471904db25ffe03950194bebba8e57bbdfd596bb6b47", - "resources/css/pdf.css": "172a8d4b17e011b0e966e1ac2453412e5fc8f3edc0cb6ce33a92139ca7a2f98c", - "resources/manuals/editions.json": "7e1947580750f88181e3c43d325e8d4d0e02062b58b9115aafd82409d724b06a", - "resources/manuals/archive-inventory.json": "6a2c3035a16badb156211ed439a8ba3246581d2bf69db9a594314f1e17ff0ce8" - }, - "editions": { - "manual": { - "language": "en", - "sources": { - "README.md": "ab91ca51628fdc80b6d9b5d3c194dbfb335867ebbcf9339e6fffb0da967a20f5", - "Manual-Index.md": "4c12f6314c5bbf05d94176a85e3c6450cd0daa46b528af681985ccb02b68d3ff", - "Other-Manuals.md": "dbb5aa728e01d59acbd5d63bb9ea2a0eb81dd092c43e64269e2c71941ef28c50", - "Requirements.md": "c08df21877aa928095eaccb1d5866cf117312aff9be6606706baf5fc99c3ffcb", - "General-Installing-Instructions.md": "83be1191b4bb4cd8ee04604e47a21243ee3744d0dc022fd6e48474eb31a910d6", - "Install-Under-Enterprise-Linux-LAMP.md": "13be72575e89183147ac41e79b463d3bb0b41957d8a33bd9cafb7074013f1b38", - "Installing-Under-Ubuntu-Debian.md": "761ab637c614cabaa6315172fc29d7eb9d25c04ab30a763bb733e9ff5ed7755e", - "Installing-Under-Windows.md": "37bc088d4de0e74b16d0c15f688a72a0059264628c3320fd48d59023eae97fe2", - "Upgrading-Cacti.md": "4d8a547eaf9d4d34d75b7bd6fb71864714121fbf339e2e2df42a93685123ee4d", - "Upgrading-Cacti-Under-Windows.md": "b79bb339c03470358823910c1e34953f119a7b56095f9a9125975cc896440696", - "Upgrading-Cacti-Under-FreeBSD.md": "f83f853b7c571b56460ceacb7a23c5362b694645db84a423c5cb8dd074c96f1c", - "Hardening-Cacti-Installation.md": "d9662eaf0a493fe7aa073e3cef775eafa1df9fe47f093d75dfd22f9992d9163c", - "Cacti-SSL-Configuration.md": "8e2f53cf9696f27f3650179f991c8dac07446a5c2d9cc01c629750db3d8d8a24", - "Version-Specific-Release-Notes.md": "91ed5e11a4428aede3a704c5e0e227c33b3a463226ab05d80ee906a902712e90", - "Navigating-The-User-Interface.md": "55283b484c8ed9a46de1570e49157cc10e8b5231a103e96db3a55fd6b8dea40a", - "Themes.md": "0c8eb8d1bf06150646ca15a5267356356b9778e797a6356acf2ba0a9ade2ad17", - "Principles-of-Operation.md": "a38949896e7110787ecc5487032f25817debd99f36c245d29a3ee00bc94bfbc0", - "How-to-Graph-Your-Network.md": "dd77c2c6acb89e975484ee59a952acbd6662cbff56c1767092d8c1628123dca6", - "Devices.md": "b998f231887865cd644865806b66d7a62ba1772918eb927a44ad5f8301927e50", - "Graph-Overview.md": "af6f170389a89f9cec1dc548b2e15f600e63a0c8d23350eb139022c1e4d8e2fb", - "Graphs.md": "7357603235540171119e31b3a46905b4562d6a910e350e8e03cc0653495767c3", - "Viewing-Graphs.md": "2ebc7aeee341763291fac969be5e6c68e60c6b93d3b0fc3504af62a69c1fefbd", - "Graph-a-Single-SNMP-OID.md": "d6c1d71c578c5dd958c06c64cb9aceee51e05f26380ad92b4f9a36876969fe7f", - "Sites.md": "182bf78af0eceef6685fdfd2437b6ac24a5b50a355730fb6e23a1d23ec093039", - "Trees.md": "eea5d9f3e3113c372b5abe96c9a123caa927271f609f94c9ce3a2f93ec1a05a2", - "Data-Sources.md": "400e49e11b6442064a75a20cb7d299b296e1257cd1876802a570f15dfc1e6b1a", - "Aggregates.md": "13a59d2e6c6db2e662905053338f756ea64e66243304010fbc8dc933b436c761", - "Automation-Networks.md": "8eaa4ebc5f12879cc1571c7bb60f06aa92e3f3197d1f238555c7000bda0b3784", - "Discovered-Devices.md": "de23c940754e7874dbfeb2dd6eb702ad78e50a5771ebcc48172469e660ac9be8", - "Device-Rules.md": "e831948f6e452e6a9e3919ff5152d493a081bcd946615470b0117b7b7b4f1059", - "Graph-Rules.md": "f69614d251d934d389134a07788e0c8924f77085abf3b755b077b086b3f59a1a", - "Tree-Rules.md": "9e542224bd0489d71a6fad203310ad6b1a6f85cb773e3736aa77079bd82605c5", - "SNMP-Options.md": "ea80a7f6510e45c4280a28ae6348ab85636df2a84f4debcd18b628394606fd30", - "User-Management.md": "1275bbe329f9e71537f539acc5bdaf730492c41a546b30eade5d851465a86861", - "User-Group-Management.md": "4394064241ebf65003534ee1caf14fd07e13e5a21cd72c392055b937a7183865", - "Login-Providers.md": "bd0e094a5ce86cf2b4b91f04620a24912574ddae0e1d1462b62a82fa17dc3052", - "User-Domains.md": "57a9048f19ddf79039a7deae3cf33c5ebf8dd7dcf8e4a9ac1283ddcced1b9e71", - "Reports-Admin.md": "669631aedfd93b6565786662ea497e57f12235999bb16ab7cc127c5cb38a1d36", - "Reports-User.md": "92231cc5965a7ac41f9d0ca241819dc5d6f8080714d25d78ad233df9fb7de310", - "Reports-Items.md": "669187afa8fecdc8e241040770172b287d009da1889907c63b21807f481b9727", - "Reports-Preview.md": "cb7e1e6b7d74d2296aafa159b09c439d1119b695d4d5501fbd3615a5013da865", - "Reports-Events.md": "0e32cd09e1acc10f6e853b51f83b565cefa454f6453fc00fd4f561153a6be0a3", - "Reports-Other-Options.md": "6e89261231b645675a0ccfff9ed1fcfb15f86125810f940819d6b8d78774d2f4", - "System-Utilities.md": "8ba7a0ce99a457cd7f7f8a0ea394eaea7d3b9143599f1c5587659a4d4e10389d", - "Data-Collectors.md": "6c58c72e37bafdb2ff428b7f202cbe9bcf48b5d2b884693a7a1d5f07a0d1de3d", - "Spine.md": "84e4ca696d8eea1662facceeba987f55fc75d2f7c3b950df781b944301c26afd", - "Settings-Poller.md": "1100c33b4bb5d06f16aeefb3b89b4c103a5a30dc34e91bea40a72d487a5b9ee0", - "PHP-Script-Server.md": "3bc1ddfca59267c100fc7387b841c59b916abd67e87e760b93846f0b9b93e0b2", - "Boost.md": "2659f7eef28ee890b613c2e8f69a56091b6d4b27814d3b9218104eed2ae4a46c", - "RRDproxy.md": "343231bf0cbe89ccc8d2895f47c54889924723af392aeed8730d8d00d0473175", - "How-To-Setup-Remote-Pollers.md": "9597533d76658e2f727a53767423384064612aeb0724bc0ff8d329c94c2ab76a", - "How-To-Poller-5-to-1-min.md": "a743a57c618eed4d0c5a53c4c1c4b0ebb6ca995bcf3a8f275949ee0d49423bb3", - "How-To-SSH-Tunnels.md": "4a3c952f529cdf765527b60106e65c97c9e42c3bb5526ef5d8c17be6def5963c", - "How-To-SNMP-Custom-Script.md": "fdc16fc24c9c3b08b71ab9601d1b21dee3eb2baccfa219e3adae59eb3c0a74d8", - "Templates.md": "2b4e1b0102780f5b8cb73b0378166725f6c7df0163b181eca03ce6051892135a", - "How-To-Work-With-Templates.md": "912904ecf1fc983d29185cea11b8a162ab576143fbe98ac641717f5d5d9c3790", - "Device-Templates.md": "6970088d584488cfbd995a3459b91067527ae1b7139cfb76b1ba37af20342815", - "Graph-Templates.md": "19b1635529912bd8ec68285b44f83ed01c1b4c259600112e1f29d5795afb032d", - "Data-Source-Templates.md": "9cfebb40d09531734540d8abc90db7dcfd5de72b53202bef3770b02e1a6c37c5", - "Aggregate-Templates.md": "d1a153357f890d1f8f9b71829748b5ed931950ee9e03c468069bdc9ad327312d", - "Color-Templates.md": "37a731e1914c82e8e4efd692f1e865aede9c884c3c5373ab9d7ca8fa8922b3f8", - "Data-Input-Methods.md": "18e2a8ea1b1194d6db50654507c7c0b5e5d4a531b025192e2c838bfe87a45048", - "How-To-Create-Data-Input-Method.md": "27d6e1a8ed0f36fecef131fe57b21c4f2299ff82ad21fb9cb3cce29662723c0d", - "Data-Queries.md": "5a80c9a6b002087ea0431f087f4a9856d142077d4d0b22525190d9db56aa1dde", - "How-To-Data-Queries.md": "f2a48e39f0f0285a3a051631f66d40e8498c7fa9f48f672706297c99ccce14df", - "How-To-Existing-SNMP-Data-Queries.md": "9cdb4501e6fcf98b74701ac3a51ae7205a8c5d3e4c88716804e02945616379c1", - "How-To-New-SNMP-Data-Queries.md": "598061ef92928f9fd632852e78905f0817df95ee21be971df7207237b99fb767", - "How-To-Script-Data-Queries.md": "29b253e528c2c3a0deb07995ba43b769856c00e0752b7c7efbac366e18ef7635", - "How-To-Determine-Template-Version.md": "a1ff321240472ba51d28e4d73451660587d603b2de3e2807cdd59b31ee19bdfb", - "Import-Packages.md": "a3550a31ed8f3232b66e49e9c676fe2187aed74f0f77ab32d5af4c4ca4ffeef4", - "Import-Template.md": "33d0c15b7252788fe01d3ba00f70f659b083c9d9813227e0e1d2a8b0b0d19473", - "Export-Template.md": "5c3fcd2792117dbd6ee7f75d5860f218b32ca156600ced1278bcc208158f6bd8", - "Create-Packages.md": "c63f3173503fe8bac2d8d77faef3342271333ca7024ea017400204e04b287bf8", - "Package-Repositories.md": "aaaa3670007f167a8f8a2fa98a7dae16d2866190c10e0d70c8de96288c798922", - "Public-Keys.md": "d0ff80dd9a95edb465a93ec74b3479fe4c8cf0021e9e2752529f23eeb1706996", - "template_apache_config.md": "825e79c0a58b1117004ec6037634c6b39fcf398b51349e3d25d8ac8351c31532", - "template_esxi_config.md": "4f2e3bf61c0ab75404892f1c616852e2adc412ea5d00f673f4acc67c2d1b0db4", - "device-template-specific-proxmox.md": "eea7171dcca476837c85764275389b74839fabb6eb6ff3837176c9752027dd6c", - "Plugins.md": "b52fbd587e3bdc17609a0adf9cf84aa5935154fe93affb7d929d22d337fe0adc", - "supported-plugins.md": "fe00cd02194f36970cf35b0da8340abaadec63e8cdc9ddb26628e4f6094b66bd", - "Plugin-Syslog.md": "09394305cdc89df9769777432ceaa0f7b8f27aa06c54982da348e6c8d6ce16a9", - "Plugin-Mactrack.md": "5d252f41edd11b0775b56814aefd8c3434eda5c419d6dc1d4d8104a8f1429adb", - "Plugin-Development.md": "69b936a151b5f9239efbcf462604bc6084ba9c931c4c35cc6159ad2ec383908e", - "Plugin-Guidelines.md": "6ce7e64cf29bdf0760b8d5ce6bce65259c46b61c4c677df1cd959e5e44cb46ad", - "Plugin-Creating-Plugins.md": "b8ed2d4f2d263b8899d652cc6e4c1fa5b1298ab1eba71b296e9b0e91831bbeae", - "Plugin-Reference.md": "17c9c8583487e31b3bef13d6e7f67196fadda356a9980f32d32c94abd106e3bb", - "Plugin-Hook-API-Ref.md": "dc5d1de6b1d7cf394c0aa88274c683e834396ad59af0dd90f76422019b0aee9f", - "Data-Debug.md": "da6c390e0da7d1ac7fd41402f771ac88ace9ce84762d3e33e1c95688426e5cf9", - "Cacti-Log.md": "6b610eea19de9eb9cbcda3dd0134c71e0dcf413c6b4c071a89bbb01bf4a55506", - "Debugging.md": "a9711b8fe9123f916f9e11cd86276067017d05b42041403abfb323e5a299fb9a", - "Frequently-Asked-Questions.md": "83a1b2f47fb41b0fdd8c6ca249249373d1e75352e3e24a7ea06122c32a152a13", - "Known-Issues.md": "675aa579aca96122f4902d16c19915e862a0b71577bbca9fb18ca9500aaddf56", - "Spikekill.md": "2e3cb9db1e9ea31572a31bce7192ca2d3d004e755af439bc28de4443ee5136d9", - "Settings.md": "1d03ead82e83f3ef46e8b226cc8839e9fdf768997409df5a32412de9c8ff6fa5", - "Settings-General.md": "62340dfa42c966727677476130260d2ff8bcb09e1d3bc30142f61db8fb28b6dc", - "Settings-Paths.md": "b5253f2326842e42a8a0e17761c4df7832da3d369e855e1dd9362c6cc65b5155", - "Settings-Device-Defaults.md": "6a452a88458a771f9f93b23a0096ba3b129ad02b497f80b1d25b0abbd8511a1f", - "Settings-Data.md": "1952adfbf76a472e8f7b0baee51da6ae3391ffb3d523d70fff862404c49bb336", - "Settings-Visual.md": "307d7b6e486e1fd1a0828db83d07e8437c0fa506b0626c72d8ef6c1af7e893ce", - "Settings-Performance.md": "ddbe52d8e42317f7bdeb803d7458b3849d30a002d5af3dc4a497372dbc889c6f", - "Settings-Spikes.md": "cc70fb948725d84b7cd5d5e64dfbcf9e955a05c6c6f876be9f3d1c4b54b7cbbb", - "Settings-Mail-Reporting-DNS.md": "14237b8d81df084e8415273488f10c4f6afbab099f892fcebb783b49de29ec13", - "Settings-Auth.md": "a5b0e12bd897a9923f467a3574302dc0c4ed34fd2233426a6864296a1c8bd338", - "Settings-Auth-Local.md": "fb00ffb5344aff835ce5c91a8d46bd051e436de96f8c494b3a89cf988013aec7", - "Settings-Auth-LDAP.md": "41bdd3d9eb77678f76fdc86c8fc3cf5fd983dd9f8786d5f31914a621339d74f5", - "Settings-Auth-Basic.md": "1a31d818b402c8c279cc88d23faff8e5cdb9d391815b34500048ecec163dffa0", - "Settings-Domains.md": "d7d2ba7169e967644f479aeff45968482cab7756755c7d27c56fd51d07d4256e", - "Settings-Users-Groups-Domains.md": "51d953fa6206a69eaf9f23eabf93b359419f0d49e46100f09b752ab15afbd48c", - "Data-Profiles.md": "f0497f4d4aa12c40a7242d2514476625e9d29087527c31c52a2b5ff8da967a91", - "CDEFs.md": "96ea3b4792512be51ed81dc5a0128f37ca7b6ce53d921174af082de365fc27e9", - "VDEFs.md": "e53d1faa106a9c751b918d1c1c6a34a57575a2390f77e4f0bbd3ab1decae0563", - "Colors.md": "5bef1607cd4c73aee0f29d964cc8ee932f5fb933a6dae34ec4e9f831dec3608c", - "GPRINTs.md": "3fb809c23c1d8bd670e3835b7bd9276f29b6b65cbf763e448dbe87bfcb4cc2e8", - "Variables.md": "d61c6502a7d4f208ecba25ebfc0e3bf6a45fb38b32b327a946ef3cb57193faeb", - "RRDtool-Specific-Features.md": "a8dc18fff893b7b28809ccc48eb05c8587dfe66e835b71283e59d4110626ffce", - "Command-Line-Scripts.md": "fcb25a345128914e28110dcf26a6b49711f23a0a93b15201fe897b0af5919470", - "Contributing.md": "25c89a7ccae8ebac99d1d3fef31fe4f6c81869054e80f97712e505bf28d4a5c3", - "Development-and-Testing.md": "61a49da30c145e32cceb16b53c6ded2a576a6e68c37272b59eb8333be9d5e973", - "Contributing-Translations.md": "f2b33c3a2958a7302eed055d0ed6718490dade8f0aaf9eae09e73d681ebebd36", - "Standards-Documentation.md": "2704222edadd0224c8dffeeae7a7f53876dfcdfe9c881c4a1111dd81955bdc59", - "Standards-Code-Formatting.md": "9083a666b2e2e5d8d53f70b0bc91c7be1f95d537235f6abf065334f62832b637", - "Standards-PHP-Spec-Constructs.md": "2db90a19ff240908208d9a94c1750c0d9e99aa61a31b5d28657d173cf274b8a8", - "Standards-FileSystem-Layout.md": "7cd0c18b903f36fc1c62c91820145885cf7169f224057d68cd575d9bc79ec242", - "Standards-Patch-Creation.md": "1a384736263fea3d6db2acff68fffc309e8fd7178f99077009b35d42eb5de980", - "Standards-SQL.md": "ae18dd2175177964ac705a464651e49b5635622f967f178f77c984df3126e92a", - "Standards-Security.md": "61bfff0e348a43cfda49a67de5d054370ff3d8c1514af8c980d3f185ca943219", - "Architecture-Decisions.md": "e93ad44046c40e0ba1af2d8a1a9a951cec27e38787b9246e0dcae5fd3e488741", - "Architecture/0001-bounded-contexts.md": "8f9e713040116a2adeb906e733d9c6c1162d3d1656f8aaceb3731cec2b9aba7c", - "Architecture/0002-durable-install-runs.md": "e2addd65b378ac89f065031d06074daa8c3aea3aa58fa78a460f0e8b067218d3", - "Downloads.md": "3a8068ba48e268b642ce895b47c3828c5ce46c2b56a5858f77270f5fccf7e6a2", - "Project-Information.md": "761c26946281c8e624f4fcd115f259d5fb110fef654ee06458c2a3fff6b08734", - "External-Links.md": "bf09ffa4f194f5cbb5e9f0ef1641195d1516a6ef015bb39d4c148c0ad6e76b33", - "Install-Under-CentOS_LAMP.md": "ea8fbd8fe17a17dcf7fd64f4007bf292975aa1ba3e8acbfc798df232c7934051", - "Install-Under-CentOS_LEMP.md": "dd32dd8b763b1d92066d1025611cd38b7e47dd63a9458c7b901271aa35a5e4f0", - "Install-Under-Enterprise-Linux-LEMP.md": "ac3cd7c44e42451390a5f9b5ddfb8a203e9bcab9911043aac010b1f9bb38048c", - "Installing-Under-Ubuntu-LEMP.md": "8ea69673bb5b0d28616488bc7a79aefcea01994b1e367e962997b392a58b752e", - "convert-from-package-to-source-debian-ubuntu.md": "f9454bf43285f5989cf40859d52cee695994b610e5426cccf4f8a00214dce040", - "Architecture/0003-plugin-extension-boundary.md": "7933441e178e3b48b8fe9045c453a44ea831fab2d6664ce034c31a603f0b5197", - "Architecture/0004-workflow-storage-and-observability.md": "a1158960165de7438980410322ccf3910fc8fd829e518b9ea14123a107f9639a" - } - }, - "cacti-guide-de": { - "language": "de", - "sources": { - "resources/manuals/Guide-de.md": "c21a4671e883bd3a57e410ebe17fe05e3e22265a21e8109906eb4f9bdddf6a3a", - "README.md": "ab91ca51628fdc80b6d9b5d3c194dbfb335867ebbcf9339e6fffb0da967a20f5", - "Manual-Index.md": "4c12f6314c5bbf05d94176a85e3c6450cd0daa46b528af681985ccb02b68d3ff", - "Other-Manuals.md": "dbb5aa728e01d59acbd5d63bb9ea2a0eb81dd092c43e64269e2c71941ef28c50", - "Requirements.md": "c08df21877aa928095eaccb1d5866cf117312aff9be6606706baf5fc99c3ffcb", - "General-Installing-Instructions.md": "83be1191b4bb4cd8ee04604e47a21243ee3744d0dc022fd6e48474eb31a910d6", - "Install-Under-Enterprise-Linux-LAMP.md": "13be72575e89183147ac41e79b463d3bb0b41957d8a33bd9cafb7074013f1b38", - "Installing-Under-Ubuntu-Debian.md": "761ab637c614cabaa6315172fc29d7eb9d25c04ab30a763bb733e9ff5ed7755e", - "Installing-Under-Windows.md": "37bc088d4de0e74b16d0c15f688a72a0059264628c3320fd48d59023eae97fe2", - "Upgrading-Cacti.md": "4d8a547eaf9d4d34d75b7bd6fb71864714121fbf339e2e2df42a93685123ee4d", - "Upgrading-Cacti-Under-Windows.md": "b79bb339c03470358823910c1e34953f119a7b56095f9a9125975cc896440696", - "Upgrading-Cacti-Under-FreeBSD.md": "f83f853b7c571b56460ceacb7a23c5362b694645db84a423c5cb8dd074c96f1c", - "Hardening-Cacti-Installation.md": "d9662eaf0a493fe7aa073e3cef775eafa1df9fe47f093d75dfd22f9992d9163c", - "Cacti-SSL-Configuration.md": "8e2f53cf9696f27f3650179f991c8dac07446a5c2d9cc01c629750db3d8d8a24", - "Version-Specific-Release-Notes.md": "91ed5e11a4428aede3a704c5e0e227c33b3a463226ab05d80ee906a902712e90", - "Navigating-The-User-Interface.md": "55283b484c8ed9a46de1570e49157cc10e8b5231a103e96db3a55fd6b8dea40a", - "Themes.md": "0c8eb8d1bf06150646ca15a5267356356b9778e797a6356acf2ba0a9ade2ad17", - "Principles-of-Operation.md": "a38949896e7110787ecc5487032f25817debd99f36c245d29a3ee00bc94bfbc0", - "How-to-Graph-Your-Network.md": "dd77c2c6acb89e975484ee59a952acbd6662cbff56c1767092d8c1628123dca6", - "Devices.md": "b998f231887865cd644865806b66d7a62ba1772918eb927a44ad5f8301927e50", - "Graph-Overview.md": "af6f170389a89f9cec1dc548b2e15f600e63a0c8d23350eb139022c1e4d8e2fb", - "Graphs.md": "7357603235540171119e31b3a46905b4562d6a910e350e8e03cc0653495767c3", - "Viewing-Graphs.md": "2ebc7aeee341763291fac969be5e6c68e60c6b93d3b0fc3504af62a69c1fefbd", - "Graph-a-Single-SNMP-OID.md": "d6c1d71c578c5dd958c06c64cb9aceee51e05f26380ad92b4f9a36876969fe7f", - "Sites.md": "182bf78af0eceef6685fdfd2437b6ac24a5b50a355730fb6e23a1d23ec093039", - "Trees.md": "eea5d9f3e3113c372b5abe96c9a123caa927271f609f94c9ce3a2f93ec1a05a2", - "Data-Sources.md": "400e49e11b6442064a75a20cb7d299b296e1257cd1876802a570f15dfc1e6b1a", - "Aggregates.md": "13a59d2e6c6db2e662905053338f756ea64e66243304010fbc8dc933b436c761", - "Automation-Networks.md": "8eaa4ebc5f12879cc1571c7bb60f06aa92e3f3197d1f238555c7000bda0b3784", - "Discovered-Devices.md": "de23c940754e7874dbfeb2dd6eb702ad78e50a5771ebcc48172469e660ac9be8", - "Device-Rules.md": "e831948f6e452e6a9e3919ff5152d493a081bcd946615470b0117b7b7b4f1059", - "Graph-Rules.md": "f69614d251d934d389134a07788e0c8924f77085abf3b755b077b086b3f59a1a", - "Tree-Rules.md": "9e542224bd0489d71a6fad203310ad6b1a6f85cb773e3736aa77079bd82605c5", - "SNMP-Options.md": "ea80a7f6510e45c4280a28ae6348ab85636df2a84f4debcd18b628394606fd30", - "User-Management.md": "1275bbe329f9e71537f539acc5bdaf730492c41a546b30eade5d851465a86861", - "User-Group-Management.md": "4394064241ebf65003534ee1caf14fd07e13e5a21cd72c392055b937a7183865", - "Login-Providers.md": "bd0e094a5ce86cf2b4b91f04620a24912574ddae0e1d1462b62a82fa17dc3052", - "User-Domains.md": "57a9048f19ddf79039a7deae3cf33c5ebf8dd7dcf8e4a9ac1283ddcced1b9e71", - "Reports-Admin.md": "669631aedfd93b6565786662ea497e57f12235999bb16ab7cc127c5cb38a1d36", - "Reports-User.md": "92231cc5965a7ac41f9d0ca241819dc5d6f8080714d25d78ad233df9fb7de310", - "Reports-Items.md": "669187afa8fecdc8e241040770172b287d009da1889907c63b21807f481b9727", - "Reports-Preview.md": "cb7e1e6b7d74d2296aafa159b09c439d1119b695d4d5501fbd3615a5013da865", - "Reports-Events.md": "0e32cd09e1acc10f6e853b51f83b565cefa454f6453fc00fd4f561153a6be0a3", - "Reports-Other-Options.md": "6e89261231b645675a0ccfff9ed1fcfb15f86125810f940819d6b8d78774d2f4", - "System-Utilities.md": "8ba7a0ce99a457cd7f7f8a0ea394eaea7d3b9143599f1c5587659a4d4e10389d", - "Data-Collectors.md": "6c58c72e37bafdb2ff428b7f202cbe9bcf48b5d2b884693a7a1d5f07a0d1de3d", - "Spine.md": "84e4ca696d8eea1662facceeba987f55fc75d2f7c3b950df781b944301c26afd", - "Settings-Poller.md": "1100c33b4bb5d06f16aeefb3b89b4c103a5a30dc34e91bea40a72d487a5b9ee0", - "PHP-Script-Server.md": "3bc1ddfca59267c100fc7387b841c59b916abd67e87e760b93846f0b9b93e0b2", - "Boost.md": "2659f7eef28ee890b613c2e8f69a56091b6d4b27814d3b9218104eed2ae4a46c", - "RRDproxy.md": "343231bf0cbe89ccc8d2895f47c54889924723af392aeed8730d8d00d0473175", - "How-To-Setup-Remote-Pollers.md": "9597533d76658e2f727a53767423384064612aeb0724bc0ff8d329c94c2ab76a", - "How-To-Poller-5-to-1-min.md": "a743a57c618eed4d0c5a53c4c1c4b0ebb6ca995bcf3a8f275949ee0d49423bb3", - "How-To-SSH-Tunnels.md": "4a3c952f529cdf765527b60106e65c97c9e42c3bb5526ef5d8c17be6def5963c", - "How-To-SNMP-Custom-Script.md": "fdc16fc24c9c3b08b71ab9601d1b21dee3eb2baccfa219e3adae59eb3c0a74d8", - "Templates.md": "2b4e1b0102780f5b8cb73b0378166725f6c7df0163b181eca03ce6051892135a", - "How-To-Work-With-Templates.md": "912904ecf1fc983d29185cea11b8a162ab576143fbe98ac641717f5d5d9c3790", - "Device-Templates.md": "6970088d584488cfbd995a3459b91067527ae1b7139cfb76b1ba37af20342815", - "Graph-Templates.md": "19b1635529912bd8ec68285b44f83ed01c1b4c259600112e1f29d5795afb032d", - "Data-Source-Templates.md": "9cfebb40d09531734540d8abc90db7dcfd5de72b53202bef3770b02e1a6c37c5", - "Aggregate-Templates.md": "d1a153357f890d1f8f9b71829748b5ed931950ee9e03c468069bdc9ad327312d", - "Color-Templates.md": "37a731e1914c82e8e4efd692f1e865aede9c884c3c5373ab9d7ca8fa8922b3f8", - "Data-Input-Methods.md": "18e2a8ea1b1194d6db50654507c7c0b5e5d4a531b025192e2c838bfe87a45048", - "How-To-Create-Data-Input-Method.md": "27d6e1a8ed0f36fecef131fe57b21c4f2299ff82ad21fb9cb3cce29662723c0d", - "Data-Queries.md": "5a80c9a6b002087ea0431f087f4a9856d142077d4d0b22525190d9db56aa1dde", - "How-To-Data-Queries.md": "f2a48e39f0f0285a3a051631f66d40e8498c7fa9f48f672706297c99ccce14df", - "How-To-Existing-SNMP-Data-Queries.md": "9cdb4501e6fcf98b74701ac3a51ae7205a8c5d3e4c88716804e02945616379c1", - "How-To-New-SNMP-Data-Queries.md": "598061ef92928f9fd632852e78905f0817df95ee21be971df7207237b99fb767", - "How-To-Script-Data-Queries.md": "29b253e528c2c3a0deb07995ba43b769856c00e0752b7c7efbac366e18ef7635", - "How-To-Determine-Template-Version.md": "a1ff321240472ba51d28e4d73451660587d603b2de3e2807cdd59b31ee19bdfb", - "Import-Packages.md": "a3550a31ed8f3232b66e49e9c676fe2187aed74f0f77ab32d5af4c4ca4ffeef4", - "Import-Template.md": "33d0c15b7252788fe01d3ba00f70f659b083c9d9813227e0e1d2a8b0b0d19473", - "Export-Template.md": "5c3fcd2792117dbd6ee7f75d5860f218b32ca156600ced1278bcc208158f6bd8", - "Create-Packages.md": "c63f3173503fe8bac2d8d77faef3342271333ca7024ea017400204e04b287bf8", - "Package-Repositories.md": "aaaa3670007f167a8f8a2fa98a7dae16d2866190c10e0d70c8de96288c798922", - "Public-Keys.md": "d0ff80dd9a95edb465a93ec74b3479fe4c8cf0021e9e2752529f23eeb1706996", - "template_apache_config.md": "825e79c0a58b1117004ec6037634c6b39fcf398b51349e3d25d8ac8351c31532", - "template_esxi_config.md": "4f2e3bf61c0ab75404892f1c616852e2adc412ea5d00f673f4acc67c2d1b0db4", - "device-template-specific-proxmox.md": "eea7171dcca476837c85764275389b74839fabb6eb6ff3837176c9752027dd6c", - "Plugins.md": "b52fbd587e3bdc17609a0adf9cf84aa5935154fe93affb7d929d22d337fe0adc", - "supported-plugins.md": "fe00cd02194f36970cf35b0da8340abaadec63e8cdc9ddb26628e4f6094b66bd", - "Plugin-Syslog.md": "09394305cdc89df9769777432ceaa0f7b8f27aa06c54982da348e6c8d6ce16a9", - "Plugin-Mactrack.md": "5d252f41edd11b0775b56814aefd8c3434eda5c419d6dc1d4d8104a8f1429adb", - "Plugin-Development.md": "69b936a151b5f9239efbcf462604bc6084ba9c931c4c35cc6159ad2ec383908e", - "Plugin-Guidelines.md": "6ce7e64cf29bdf0760b8d5ce6bce65259c46b61c4c677df1cd959e5e44cb46ad", - "Plugin-Creating-Plugins.md": "b8ed2d4f2d263b8899d652cc6e4c1fa5b1298ab1eba71b296e9b0e91831bbeae", - "Plugin-Reference.md": "17c9c8583487e31b3bef13d6e7f67196fadda356a9980f32d32c94abd106e3bb", - "Plugin-Hook-API-Ref.md": "dc5d1de6b1d7cf394c0aa88274c683e834396ad59af0dd90f76422019b0aee9f", - "Data-Debug.md": "da6c390e0da7d1ac7fd41402f771ac88ace9ce84762d3e33e1c95688426e5cf9", - "Cacti-Log.md": "6b610eea19de9eb9cbcda3dd0134c71e0dcf413c6b4c071a89bbb01bf4a55506", - "Debugging.md": "a9711b8fe9123f916f9e11cd86276067017d05b42041403abfb323e5a299fb9a", - "Frequently-Asked-Questions.md": "83a1b2f47fb41b0fdd8c6ca249249373d1e75352e3e24a7ea06122c32a152a13", - "Known-Issues.md": "675aa579aca96122f4902d16c19915e862a0b71577bbca9fb18ca9500aaddf56", - "Spikekill.md": "2e3cb9db1e9ea31572a31bce7192ca2d3d004e755af439bc28de4443ee5136d9", - "Settings.md": "1d03ead82e83f3ef46e8b226cc8839e9fdf768997409df5a32412de9c8ff6fa5", - "Settings-General.md": "62340dfa42c966727677476130260d2ff8bcb09e1d3bc30142f61db8fb28b6dc", - "Settings-Paths.md": "b5253f2326842e42a8a0e17761c4df7832da3d369e855e1dd9362c6cc65b5155", - "Settings-Device-Defaults.md": "6a452a88458a771f9f93b23a0096ba3b129ad02b497f80b1d25b0abbd8511a1f", - "Settings-Data.md": "1952adfbf76a472e8f7b0baee51da6ae3391ffb3d523d70fff862404c49bb336", - "Settings-Visual.md": "307d7b6e486e1fd1a0828db83d07e8437c0fa506b0626c72d8ef6c1af7e893ce", - "Settings-Performance.md": "ddbe52d8e42317f7bdeb803d7458b3849d30a002d5af3dc4a497372dbc889c6f", - "Settings-Spikes.md": "cc70fb948725d84b7cd5d5e64dfbcf9e955a05c6c6f876be9f3d1c4b54b7cbbb", - "Settings-Mail-Reporting-DNS.md": "14237b8d81df084e8415273488f10c4f6afbab099f892fcebb783b49de29ec13", - "Settings-Auth.md": "a5b0e12bd897a9923f467a3574302dc0c4ed34fd2233426a6864296a1c8bd338", - "Settings-Auth-Local.md": "fb00ffb5344aff835ce5c91a8d46bd051e436de96f8c494b3a89cf988013aec7", - "Settings-Auth-LDAP.md": "41bdd3d9eb77678f76fdc86c8fc3cf5fd983dd9f8786d5f31914a621339d74f5", - "Settings-Auth-Basic.md": "1a31d818b402c8c279cc88d23faff8e5cdb9d391815b34500048ecec163dffa0", - "Settings-Domains.md": "d7d2ba7169e967644f479aeff45968482cab7756755c7d27c56fd51d07d4256e", - "Settings-Users-Groups-Domains.md": "51d953fa6206a69eaf9f23eabf93b359419f0d49e46100f09b752ab15afbd48c", - "Data-Profiles.md": "f0497f4d4aa12c40a7242d2514476625e9d29087527c31c52a2b5ff8da967a91", - "CDEFs.md": "96ea3b4792512be51ed81dc5a0128f37ca7b6ce53d921174af082de365fc27e9", - "VDEFs.md": "e53d1faa106a9c751b918d1c1c6a34a57575a2390f77e4f0bbd3ab1decae0563", - "Colors.md": "5bef1607cd4c73aee0f29d964cc8ee932f5fb933a6dae34ec4e9f831dec3608c", - "GPRINTs.md": "3fb809c23c1d8bd670e3835b7bd9276f29b6b65cbf763e448dbe87bfcb4cc2e8", - "Variables.md": "d61c6502a7d4f208ecba25ebfc0e3bf6a45fb38b32b327a946ef3cb57193faeb", - "RRDtool-Specific-Features.md": "a8dc18fff893b7b28809ccc48eb05c8587dfe66e835b71283e59d4110626ffce", - "Command-Line-Scripts.md": "fcb25a345128914e28110dcf26a6b49711f23a0a93b15201fe897b0af5919470", - "Contributing.md": "25c89a7ccae8ebac99d1d3fef31fe4f6c81869054e80f97712e505bf28d4a5c3", - "Development-and-Testing.md": "61a49da30c145e32cceb16b53c6ded2a576a6e68c37272b59eb8333be9d5e973", - "Contributing-Translations.md": "f2b33c3a2958a7302eed055d0ed6718490dade8f0aaf9eae09e73d681ebebd36", - "Standards-Documentation.md": "2704222edadd0224c8dffeeae7a7f53876dfcdfe9c881c4a1111dd81955bdc59", - "Standards-Code-Formatting.md": "9083a666b2e2e5d8d53f70b0bc91c7be1f95d537235f6abf065334f62832b637", - "Standards-PHP-Spec-Constructs.md": "2db90a19ff240908208d9a94c1750c0d9e99aa61a31b5d28657d173cf274b8a8", - "Standards-FileSystem-Layout.md": "7cd0c18b903f36fc1c62c91820145885cf7169f224057d68cd575d9bc79ec242", - "Standards-Patch-Creation.md": "1a384736263fea3d6db2acff68fffc309e8fd7178f99077009b35d42eb5de980", - "Standards-SQL.md": "ae18dd2175177964ac705a464651e49b5635622f967f178f77c984df3126e92a", - "Standards-Security.md": "61bfff0e348a43cfda49a67de5d054370ff3d8c1514af8c980d3f185ca943219", - "Architecture-Decisions.md": "e93ad44046c40e0ba1af2d8a1a9a951cec27e38787b9246e0dcae5fd3e488741", - "Architecture/0001-bounded-contexts.md": "8f9e713040116a2adeb906e733d9c6c1162d3d1656f8aaceb3731cec2b9aba7c", - "Architecture/0002-durable-install-runs.md": "e2addd65b378ac89f065031d06074daa8c3aea3aa58fa78a460f0e8b067218d3", - "Downloads.md": "3a8068ba48e268b642ce895b47c3828c5ce46c2b56a5858f77270f5fccf7e6a2", - "Project-Information.md": "761c26946281c8e624f4fcd115f259d5fb110fef654ee06458c2a3fff6b08734", - "External-Links.md": "bf09ffa4f194f5cbb5e9f0ef1641195d1516a6ef015bb39d4c148c0ad6e76b33", - "Install-Under-CentOS_LAMP.md": "ea8fbd8fe17a17dcf7fd64f4007bf292975aa1ba3e8acbfc798df232c7934051", - "Install-Under-CentOS_LEMP.md": "dd32dd8b763b1d92066d1025611cd38b7e47dd63a9458c7b901271aa35a5e4f0", - "Install-Under-Enterprise-Linux-LEMP.md": "ac3cd7c44e42451390a5f9b5ddfb8a203e9bcab9911043aac010b1f9bb38048c", - "Installing-Under-Ubuntu-LEMP.md": "8ea69673bb5b0d28616488bc7a79aefcea01994b1e367e962997b392a58b752e", - "convert-from-package-to-source-debian-ubuntu.md": "f9454bf43285f5989cf40859d52cee695994b610e5426cccf4f8a00214dce040", - "Architecture/0003-plugin-extension-boundary.md": "7933441e178e3b48b8fe9045c453a44ea831fab2d6664ce034c31a603f0b5197", - "Architecture/0004-workflow-storage-and-observability.md": "a1158960165de7438980410322ccf3910fc8fd829e518b9ea14123a107f9639a" - } - }, - "cacti-guide-tr": { - "language": "tr", - "sources": { - "resources/manuals/Guide-tr.md": "1329df08e7aa973733bde281ca87beed5b4df945cd0f21e234ee97affc8203f3", - "README.md": "ab91ca51628fdc80b6d9b5d3c194dbfb335867ebbcf9339e6fffb0da967a20f5", - "Manual-Index.md": "4c12f6314c5bbf05d94176a85e3c6450cd0daa46b528af681985ccb02b68d3ff", - "Other-Manuals.md": "dbb5aa728e01d59acbd5d63bb9ea2a0eb81dd092c43e64269e2c71941ef28c50", - "Requirements.md": "c08df21877aa928095eaccb1d5866cf117312aff9be6606706baf5fc99c3ffcb", - "General-Installing-Instructions.md": "83be1191b4bb4cd8ee04604e47a21243ee3744d0dc022fd6e48474eb31a910d6", - "Install-Under-Enterprise-Linux-LAMP.md": "13be72575e89183147ac41e79b463d3bb0b41957d8a33bd9cafb7074013f1b38", - "Installing-Under-Ubuntu-Debian.md": "761ab637c614cabaa6315172fc29d7eb9d25c04ab30a763bb733e9ff5ed7755e", - "Installing-Under-Windows.md": "37bc088d4de0e74b16d0c15f688a72a0059264628c3320fd48d59023eae97fe2", - "Upgrading-Cacti.md": "4d8a547eaf9d4d34d75b7bd6fb71864714121fbf339e2e2df42a93685123ee4d", - "Upgrading-Cacti-Under-Windows.md": "b79bb339c03470358823910c1e34953f119a7b56095f9a9125975cc896440696", - "Upgrading-Cacti-Under-FreeBSD.md": "f83f853b7c571b56460ceacb7a23c5362b694645db84a423c5cb8dd074c96f1c", - "Hardening-Cacti-Installation.md": "d9662eaf0a493fe7aa073e3cef775eafa1df9fe47f093d75dfd22f9992d9163c", - "Cacti-SSL-Configuration.md": "8e2f53cf9696f27f3650179f991c8dac07446a5c2d9cc01c629750db3d8d8a24", - "Version-Specific-Release-Notes.md": "91ed5e11a4428aede3a704c5e0e227c33b3a463226ab05d80ee906a902712e90", - "Navigating-The-User-Interface.md": "55283b484c8ed9a46de1570e49157cc10e8b5231a103e96db3a55fd6b8dea40a", - "Themes.md": "0c8eb8d1bf06150646ca15a5267356356b9778e797a6356acf2ba0a9ade2ad17", - "Principles-of-Operation.md": "a38949896e7110787ecc5487032f25817debd99f36c245d29a3ee00bc94bfbc0", - "How-to-Graph-Your-Network.md": "dd77c2c6acb89e975484ee59a952acbd6662cbff56c1767092d8c1628123dca6", - "Devices.md": "b998f231887865cd644865806b66d7a62ba1772918eb927a44ad5f8301927e50", - "Graph-Overview.md": "af6f170389a89f9cec1dc548b2e15f600e63a0c8d23350eb139022c1e4d8e2fb", - "Graphs.md": "7357603235540171119e31b3a46905b4562d6a910e350e8e03cc0653495767c3", - "Viewing-Graphs.md": "2ebc7aeee341763291fac969be5e6c68e60c6b93d3b0fc3504af62a69c1fefbd", - "Graph-a-Single-SNMP-OID.md": "d6c1d71c578c5dd958c06c64cb9aceee51e05f26380ad92b4f9a36876969fe7f", - "Sites.md": "182bf78af0eceef6685fdfd2437b6ac24a5b50a355730fb6e23a1d23ec093039", - "Trees.md": "eea5d9f3e3113c372b5abe96c9a123caa927271f609f94c9ce3a2f93ec1a05a2", - "Data-Sources.md": "400e49e11b6442064a75a20cb7d299b296e1257cd1876802a570f15dfc1e6b1a", - "Aggregates.md": "13a59d2e6c6db2e662905053338f756ea64e66243304010fbc8dc933b436c761", - "Automation-Networks.md": "8eaa4ebc5f12879cc1571c7bb60f06aa92e3f3197d1f238555c7000bda0b3784", - "Discovered-Devices.md": "de23c940754e7874dbfeb2dd6eb702ad78e50a5771ebcc48172469e660ac9be8", - "Device-Rules.md": "e831948f6e452e6a9e3919ff5152d493a081bcd946615470b0117b7b7b4f1059", - "Graph-Rules.md": "f69614d251d934d389134a07788e0c8924f77085abf3b755b077b086b3f59a1a", - "Tree-Rules.md": "9e542224bd0489d71a6fad203310ad6b1a6f85cb773e3736aa77079bd82605c5", - "SNMP-Options.md": "ea80a7f6510e45c4280a28ae6348ab85636df2a84f4debcd18b628394606fd30", - "User-Management.md": "1275bbe329f9e71537f539acc5bdaf730492c41a546b30eade5d851465a86861", - "User-Group-Management.md": "4394064241ebf65003534ee1caf14fd07e13e5a21cd72c392055b937a7183865", - "Login-Providers.md": "bd0e094a5ce86cf2b4b91f04620a24912574ddae0e1d1462b62a82fa17dc3052", - "User-Domains.md": "57a9048f19ddf79039a7deae3cf33c5ebf8dd7dcf8e4a9ac1283ddcced1b9e71", - "Reports-Admin.md": "669631aedfd93b6565786662ea497e57f12235999bb16ab7cc127c5cb38a1d36", - "Reports-User.md": "92231cc5965a7ac41f9d0ca241819dc5d6f8080714d25d78ad233df9fb7de310", - "Reports-Items.md": "669187afa8fecdc8e241040770172b287d009da1889907c63b21807f481b9727", - "Reports-Preview.md": "cb7e1e6b7d74d2296aafa159b09c439d1119b695d4d5501fbd3615a5013da865", - "Reports-Events.md": "0e32cd09e1acc10f6e853b51f83b565cefa454f6453fc00fd4f561153a6be0a3", - "Reports-Other-Options.md": "6e89261231b645675a0ccfff9ed1fcfb15f86125810f940819d6b8d78774d2f4", - "System-Utilities.md": "8ba7a0ce99a457cd7f7f8a0ea394eaea7d3b9143599f1c5587659a4d4e10389d", - "Data-Collectors.md": "6c58c72e37bafdb2ff428b7f202cbe9bcf48b5d2b884693a7a1d5f07a0d1de3d", - "Spine.md": "84e4ca696d8eea1662facceeba987f55fc75d2f7c3b950df781b944301c26afd", - "Settings-Poller.md": "1100c33b4bb5d06f16aeefb3b89b4c103a5a30dc34e91bea40a72d487a5b9ee0", - "PHP-Script-Server.md": "3bc1ddfca59267c100fc7387b841c59b916abd67e87e760b93846f0b9b93e0b2", - "Boost.md": "2659f7eef28ee890b613c2e8f69a56091b6d4b27814d3b9218104eed2ae4a46c", - "RRDproxy.md": "343231bf0cbe89ccc8d2895f47c54889924723af392aeed8730d8d00d0473175", - "How-To-Setup-Remote-Pollers.md": "9597533d76658e2f727a53767423384064612aeb0724bc0ff8d329c94c2ab76a", - "How-To-Poller-5-to-1-min.md": "a743a57c618eed4d0c5a53c4c1c4b0ebb6ca995bcf3a8f275949ee0d49423bb3", - "How-To-SSH-Tunnels.md": "4a3c952f529cdf765527b60106e65c97c9e42c3bb5526ef5d8c17be6def5963c", - "How-To-SNMP-Custom-Script.md": "fdc16fc24c9c3b08b71ab9601d1b21dee3eb2baccfa219e3adae59eb3c0a74d8", - "Templates.md": "2b4e1b0102780f5b8cb73b0378166725f6c7df0163b181eca03ce6051892135a", - "How-To-Work-With-Templates.md": "912904ecf1fc983d29185cea11b8a162ab576143fbe98ac641717f5d5d9c3790", - "Device-Templates.md": "6970088d584488cfbd995a3459b91067527ae1b7139cfb76b1ba37af20342815", - "Graph-Templates.md": "19b1635529912bd8ec68285b44f83ed01c1b4c259600112e1f29d5795afb032d", - "Data-Source-Templates.md": "9cfebb40d09531734540d8abc90db7dcfd5de72b53202bef3770b02e1a6c37c5", - "Aggregate-Templates.md": "d1a153357f890d1f8f9b71829748b5ed931950ee9e03c468069bdc9ad327312d", - "Color-Templates.md": "37a731e1914c82e8e4efd692f1e865aede9c884c3c5373ab9d7ca8fa8922b3f8", - "Data-Input-Methods.md": "18e2a8ea1b1194d6db50654507c7c0b5e5d4a531b025192e2c838bfe87a45048", - "How-To-Create-Data-Input-Method.md": "27d6e1a8ed0f36fecef131fe57b21c4f2299ff82ad21fb9cb3cce29662723c0d", - "Data-Queries.md": "5a80c9a6b002087ea0431f087f4a9856d142077d4d0b22525190d9db56aa1dde", - "How-To-Data-Queries.md": "f2a48e39f0f0285a3a051631f66d40e8498c7fa9f48f672706297c99ccce14df", - "How-To-Existing-SNMP-Data-Queries.md": "9cdb4501e6fcf98b74701ac3a51ae7205a8c5d3e4c88716804e02945616379c1", - "How-To-New-SNMP-Data-Queries.md": "598061ef92928f9fd632852e78905f0817df95ee21be971df7207237b99fb767", - "How-To-Script-Data-Queries.md": "29b253e528c2c3a0deb07995ba43b769856c00e0752b7c7efbac366e18ef7635", - "How-To-Determine-Template-Version.md": "a1ff321240472ba51d28e4d73451660587d603b2de3e2807cdd59b31ee19bdfb", - "Import-Packages.md": "a3550a31ed8f3232b66e49e9c676fe2187aed74f0f77ab32d5af4c4ca4ffeef4", - "Import-Template.md": "33d0c15b7252788fe01d3ba00f70f659b083c9d9813227e0e1d2a8b0b0d19473", - "Export-Template.md": "5c3fcd2792117dbd6ee7f75d5860f218b32ca156600ced1278bcc208158f6bd8", - "Create-Packages.md": "c63f3173503fe8bac2d8d77faef3342271333ca7024ea017400204e04b287bf8", - "Package-Repositories.md": "aaaa3670007f167a8f8a2fa98a7dae16d2866190c10e0d70c8de96288c798922", - "Public-Keys.md": "d0ff80dd9a95edb465a93ec74b3479fe4c8cf0021e9e2752529f23eeb1706996", - "template_apache_config.md": "825e79c0a58b1117004ec6037634c6b39fcf398b51349e3d25d8ac8351c31532", - "template_esxi_config.md": "4f2e3bf61c0ab75404892f1c616852e2adc412ea5d00f673f4acc67c2d1b0db4", - "device-template-specific-proxmox.md": "eea7171dcca476837c85764275389b74839fabb6eb6ff3837176c9752027dd6c", - "Plugins.md": "b52fbd587e3bdc17609a0adf9cf84aa5935154fe93affb7d929d22d337fe0adc", - "supported-plugins.md": "fe00cd02194f36970cf35b0da8340abaadec63e8cdc9ddb26628e4f6094b66bd", - "Plugin-Syslog.md": "09394305cdc89df9769777432ceaa0f7b8f27aa06c54982da348e6c8d6ce16a9", - "Plugin-Mactrack.md": "5d252f41edd11b0775b56814aefd8c3434eda5c419d6dc1d4d8104a8f1429adb", - "Plugin-Development.md": "69b936a151b5f9239efbcf462604bc6084ba9c931c4c35cc6159ad2ec383908e", - "Plugin-Guidelines.md": "6ce7e64cf29bdf0760b8d5ce6bce65259c46b61c4c677df1cd959e5e44cb46ad", - "Plugin-Creating-Plugins.md": "b8ed2d4f2d263b8899d652cc6e4c1fa5b1298ab1eba71b296e9b0e91831bbeae", - "Plugin-Reference.md": "17c9c8583487e31b3bef13d6e7f67196fadda356a9980f32d32c94abd106e3bb", - "Plugin-Hook-API-Ref.md": "dc5d1de6b1d7cf394c0aa88274c683e834396ad59af0dd90f76422019b0aee9f", - "Data-Debug.md": "da6c390e0da7d1ac7fd41402f771ac88ace9ce84762d3e33e1c95688426e5cf9", - "Cacti-Log.md": "6b610eea19de9eb9cbcda3dd0134c71e0dcf413c6b4c071a89bbb01bf4a55506", - "Debugging.md": "a9711b8fe9123f916f9e11cd86276067017d05b42041403abfb323e5a299fb9a", - "Frequently-Asked-Questions.md": "83a1b2f47fb41b0fdd8c6ca249249373d1e75352e3e24a7ea06122c32a152a13", - "Known-Issues.md": "675aa579aca96122f4902d16c19915e862a0b71577bbca9fb18ca9500aaddf56", - "Spikekill.md": "2e3cb9db1e9ea31572a31bce7192ca2d3d004e755af439bc28de4443ee5136d9", - "Settings.md": "1d03ead82e83f3ef46e8b226cc8839e9fdf768997409df5a32412de9c8ff6fa5", - "Settings-General.md": "62340dfa42c966727677476130260d2ff8bcb09e1d3bc30142f61db8fb28b6dc", - "Settings-Paths.md": "b5253f2326842e42a8a0e17761c4df7832da3d369e855e1dd9362c6cc65b5155", - "Settings-Device-Defaults.md": "6a452a88458a771f9f93b23a0096ba3b129ad02b497f80b1d25b0abbd8511a1f", - "Settings-Data.md": "1952adfbf76a472e8f7b0baee51da6ae3391ffb3d523d70fff862404c49bb336", - "Settings-Visual.md": "307d7b6e486e1fd1a0828db83d07e8437c0fa506b0626c72d8ef6c1af7e893ce", - "Settings-Performance.md": "ddbe52d8e42317f7bdeb803d7458b3849d30a002d5af3dc4a497372dbc889c6f", - "Settings-Spikes.md": "cc70fb948725d84b7cd5d5e64dfbcf9e955a05c6c6f876be9f3d1c4b54b7cbbb", - "Settings-Mail-Reporting-DNS.md": "14237b8d81df084e8415273488f10c4f6afbab099f892fcebb783b49de29ec13", - "Settings-Auth.md": "a5b0e12bd897a9923f467a3574302dc0c4ed34fd2233426a6864296a1c8bd338", - "Settings-Auth-Local.md": "fb00ffb5344aff835ce5c91a8d46bd051e436de96f8c494b3a89cf988013aec7", - "Settings-Auth-LDAP.md": "41bdd3d9eb77678f76fdc86c8fc3cf5fd983dd9f8786d5f31914a621339d74f5", - "Settings-Auth-Basic.md": "1a31d818b402c8c279cc88d23faff8e5cdb9d391815b34500048ecec163dffa0", - "Settings-Domains.md": "d7d2ba7169e967644f479aeff45968482cab7756755c7d27c56fd51d07d4256e", - "Settings-Users-Groups-Domains.md": "51d953fa6206a69eaf9f23eabf93b359419f0d49e46100f09b752ab15afbd48c", - "Data-Profiles.md": "f0497f4d4aa12c40a7242d2514476625e9d29087527c31c52a2b5ff8da967a91", - "CDEFs.md": "96ea3b4792512be51ed81dc5a0128f37ca7b6ce53d921174af082de365fc27e9", - "VDEFs.md": "e53d1faa106a9c751b918d1c1c6a34a57575a2390f77e4f0bbd3ab1decae0563", - "Colors.md": "5bef1607cd4c73aee0f29d964cc8ee932f5fb933a6dae34ec4e9f831dec3608c", - "GPRINTs.md": "3fb809c23c1d8bd670e3835b7bd9276f29b6b65cbf763e448dbe87bfcb4cc2e8", - "Variables.md": "d61c6502a7d4f208ecba25ebfc0e3bf6a45fb38b32b327a946ef3cb57193faeb", - "RRDtool-Specific-Features.md": "a8dc18fff893b7b28809ccc48eb05c8587dfe66e835b71283e59d4110626ffce", - "Command-Line-Scripts.md": "fcb25a345128914e28110dcf26a6b49711f23a0a93b15201fe897b0af5919470", - "Contributing.md": "25c89a7ccae8ebac99d1d3fef31fe4f6c81869054e80f97712e505bf28d4a5c3", - "Development-and-Testing.md": "61a49da30c145e32cceb16b53c6ded2a576a6e68c37272b59eb8333be9d5e973", - "Contributing-Translations.md": "f2b33c3a2958a7302eed055d0ed6718490dade8f0aaf9eae09e73d681ebebd36", - "Standards-Documentation.md": "2704222edadd0224c8dffeeae7a7f53876dfcdfe9c881c4a1111dd81955bdc59", - "Standards-Code-Formatting.md": "9083a666b2e2e5d8d53f70b0bc91c7be1f95d537235f6abf065334f62832b637", - "Standards-PHP-Spec-Constructs.md": "2db90a19ff240908208d9a94c1750c0d9e99aa61a31b5d28657d173cf274b8a8", - "Standards-FileSystem-Layout.md": "7cd0c18b903f36fc1c62c91820145885cf7169f224057d68cd575d9bc79ec242", - "Standards-Patch-Creation.md": "1a384736263fea3d6db2acff68fffc309e8fd7178f99077009b35d42eb5de980", - "Standards-SQL.md": "ae18dd2175177964ac705a464651e49b5635622f967f178f77c984df3126e92a", - "Standards-Security.md": "61bfff0e348a43cfda49a67de5d054370ff3d8c1514af8c980d3f185ca943219", - "Architecture-Decisions.md": "e93ad44046c40e0ba1af2d8a1a9a951cec27e38787b9246e0dcae5fd3e488741", - "Architecture/0001-bounded-contexts.md": "8f9e713040116a2adeb906e733d9c6c1162d3d1656f8aaceb3731cec2b9aba7c", - "Architecture/0002-durable-install-runs.md": "e2addd65b378ac89f065031d06074daa8c3aea3aa58fa78a460f0e8b067218d3", - "Downloads.md": "3a8068ba48e268b642ce895b47c3828c5ce46c2b56a5858f77270f5fccf7e6a2", - "Project-Information.md": "761c26946281c8e624f4fcd115f259d5fb110fef654ee06458c2a3fff6b08734", - "External-Links.md": "bf09ffa4f194f5cbb5e9f0ef1641195d1516a6ef015bb39d4c148c0ad6e76b33", - "Install-Under-CentOS_LAMP.md": "ea8fbd8fe17a17dcf7fd64f4007bf292975aa1ba3e8acbfc798df232c7934051", - "Install-Under-CentOS_LEMP.md": "dd32dd8b763b1d92066d1025611cd38b7e47dd63a9458c7b901271aa35a5e4f0", - "Install-Under-Enterprise-Linux-LEMP.md": "ac3cd7c44e42451390a5f9b5ddfb8a203e9bcab9911043aac010b1f9bb38048c", - "Installing-Under-Ubuntu-LEMP.md": "8ea69673bb5b0d28616488bc7a79aefcea01994b1e367e962997b392a58b752e", - "convert-from-package-to-source-debian-ubuntu.md": "f9454bf43285f5989cf40859d52cee695994b610e5426cccf4f8a00214dce040", - "Architecture/0003-plugin-extension-boundary.md": "7933441e178e3b48b8fe9045c453a44ea831fab2d6664ce034c31a603f0b5197", - "Architecture/0004-workflow-storage-and-observability.md": "a1158960165de7438980410322ccf3910fc8fd829e518b9ea14123a107f9639a" - } - }, - "install-linux": { - "language": "en", - "sources": { - "resources/manuals/Install-linux.md": "68c42a77bcfe176f43cdd5ace219698e5ef7f6da6087b09525e2bc556baf6c92", - "Requirements.md": "c08df21877aa928095eaccb1d5866cf117312aff9be6606706baf5fc99c3ffcb", - "General-Installing-Instructions.md": "83be1191b4bb4cd8ee04604e47a21243ee3744d0dc022fd6e48474eb31a910d6", - "How-to-Graph-Your-Network.md": "dd77c2c6acb89e975484ee59a952acbd6662cbff56c1767092d8c1628123dca6", - "Data-Debug.md": "da6c390e0da7d1ac7fd41402f771ac88ace9ce84762d3e33e1c95688426e5cf9", - "Debugging.md": "a9711b8fe9123f916f9e11cd86276067017d05b42041403abfb323e5a299fb9a", - "Hardening-Cacti-Installation.md": "d9662eaf0a493fe7aa073e3cef775eafa1df9fe47f093d75dfd22f9992d9163c", - "Spine.md": "84e4ca696d8eea1662facceeba987f55fc75d2f7c3b950df781b944301c26afd", - "Install-Under-Enterprise-Linux-LAMP.md": "13be72575e89183147ac41e79b463d3bb0b41957d8a33bd9cafb7074013f1b38", - "Install-Under-Enterprise-Linux-LEMP.md": "ac3cd7c44e42451390a5f9b5ddfb8a203e9bcab9911043aac010b1f9bb38048c", - "Installing-Under-Ubuntu-Debian.md": "761ab637c614cabaa6315172fc29d7eb9d25c04ab30a763bb733e9ff5ed7755e", - "Installing-Under-Ubuntu-LEMP.md": "8ea69673bb5b0d28616488bc7a79aefcea01994b1e367e962997b392a58b752e", - "Upgrading-Cacti.md": "4d8a547eaf9d4d34d75b7bd6fb71864714121fbf339e2e2df42a93685123ee4d" - } - }, - "install-ru-unix": { - "language": "ru", - "sources": { - "resources/manuals/Install-ru-unix.md": "fec5c83ab356375f7452c58f81d8e46e229385ad1b2393663a92eb896c22822d", - "Requirements.md": "c08df21877aa928095eaccb1d5866cf117312aff9be6606706baf5fc99c3ffcb", - "General-Installing-Instructions.md": "83be1191b4bb4cd8ee04604e47a21243ee3744d0dc022fd6e48474eb31a910d6", - "How-to-Graph-Your-Network.md": "dd77c2c6acb89e975484ee59a952acbd6662cbff56c1767092d8c1628123dca6", - "Data-Debug.md": "da6c390e0da7d1ac7fd41402f771ac88ace9ce84762d3e33e1c95688426e5cf9", - "Debugging.md": "a9711b8fe9123f916f9e11cd86276067017d05b42041403abfb323e5a299fb9a", - "Hardening-Cacti-Installation.md": "d9662eaf0a493fe7aa073e3cef775eafa1df9fe47f093d75dfd22f9992d9163c", - "Spine.md": "84e4ca696d8eea1662facceeba987f55fc75d2f7c3b950df781b944301c26afd", - "Install-Under-Enterprise-Linux-LAMP.md": "13be72575e89183147ac41e79b463d3bb0b41957d8a33bd9cafb7074013f1b38", - "Install-Under-Enterprise-Linux-LEMP.md": "ac3cd7c44e42451390a5f9b5ddfb8a203e9bcab9911043aac010b1f9bb38048c", - "Installing-Under-Ubuntu-Debian.md": "761ab637c614cabaa6315172fc29d7eb9d25c04ab30a763bb733e9ff5ed7755e", - "Installing-Under-Ubuntu-LEMP.md": "8ea69673bb5b0d28616488bc7a79aefcea01994b1e367e962997b392a58b752e", - "Upgrading-Cacti.md": "4d8a547eaf9d4d34d75b7bd6fb71864714121fbf339e2e2df42a93685123ee4d", - "Upgrading-Cacti-Under-FreeBSD.md": "f83f853b7c571b56460ceacb7a23c5362b694645db84a423c5cb8dd074c96f1c" - } - }, - "install-ru-windows": { - "language": "ru", - "sources": { - "resources/manuals/Install-ru-windows.md": "473719028300034aa5eb4b9d9f889f42416093e4dd3b690c2975cfc76572ba5d", - "Requirements.md": "c08df21877aa928095eaccb1d5866cf117312aff9be6606706baf5fc99c3ffcb", - "Installing-Under-Windows.md": "37bc088d4de0e74b16d0c15f688a72a0059264628c3320fd48d59023eae97fe2", - "How-to-Graph-Your-Network.md": "dd77c2c6acb89e975484ee59a952acbd6662cbff56c1767092d8c1628123dca6", - "Data-Debug.md": "da6c390e0da7d1ac7fd41402f771ac88ace9ce84762d3e33e1c95688426e5cf9", - "Upgrading-Cacti-Under-Windows.md": "b79bb339c03470358823910c1e34953f119a7b56095f9a9125975cc896440696", - "Hardening-Cacti-Installation.md": "d9662eaf0a493fe7aa073e3cef775eafa1df9fe47f093d75dfd22f9992d9163c" - } - }, - "install-windows": { - "language": "en", - "sources": { - "Requirements.md": "c08df21877aa928095eaccb1d5866cf117312aff9be6606706baf5fc99c3ffcb", - "Installing-Under-Windows.md": "37bc088d4de0e74b16d0c15f688a72a0059264628c3320fd48d59023eae97fe2", - "How-to-Graph-Your-Network.md": "dd77c2c6acb89e975484ee59a952acbd6662cbff56c1767092d8c1628123dca6", - "Data-Debug.md": "da6c390e0da7d1ac7fd41402f771ac88ace9ce84762d3e33e1c95688426e5cf9", - "Upgrading-Cacti-Under-Windows.md": "b79bb339c03470358823910c1e34953f119a7b56095f9a9125975cc896440696", - "Hardening-Cacti-Installation.md": "d9662eaf0a493fe7aa073e3cef775eafa1df9fe47f093d75dfd22f9992d9163c" - } - }, - "migrate-solaris": { - "language": "en", - "sources": { - "resources/manuals/Migrate-solaris.md": "0eff4f71bf58bf134c50d95ce246a2cc2563b67e692960916d754adb8a5038df", - "Requirements.md": "c08df21877aa928095eaccb1d5866cf117312aff9be6606706baf5fc99c3ffcb", - "General-Installing-Instructions.md": "83be1191b4bb4cd8ee04604e47a21243ee3744d0dc022fd6e48474eb31a910d6", - "How-to-Graph-Your-Network.md": "dd77c2c6acb89e975484ee59a952acbd6662cbff56c1767092d8c1628123dca6", - "Data-Debug.md": "da6c390e0da7d1ac7fd41402f771ac88ace9ce84762d3e33e1c95688426e5cf9", - "Debugging.md": "a9711b8fe9123f916f9e11cd86276067017d05b42041403abfb323e5a299fb9a", - "Hardening-Cacti-Installation.md": "d9662eaf0a493fe7aa073e3cef775eafa1df9fe47f093d75dfd22f9992d9163c", - "Spine.md": "84e4ca696d8eea1662facceeba987f55fc75d2f7c3b950df781b944301c26afd", - "Upgrading-Cacti.md": "4d8a547eaf9d4d34d75b7bd6fb71864714121fbf339e2e2df42a93685123ee4d", - "Upgrading-Cacti-Under-FreeBSD.md": "f83f853b7c571b56460ceacb7a23c5362b694645db84a423c5cb8dd074c96f1c" - } - }, - "schema-reference": { - "language": "en", - "sources": { - "resources/manuals/Schema-Reference.md": "877b0f9b76e6b1b44c58e0a40f46e1618c6a67953b533450cd0ba67ef049d27d" - } - } - }, - "files": { - "cacti-guide-de.pdf": "ae135b8a1b7289df9110eb5e625636299a8b91cd3b5dd6bc95612e3eaf6dbc97", - "cacti-guide-de.txt": "1a8341ec342906f6e76b049feed063c19f2f63f7a2e9f6eca81648946eb42d78", - "cacti-guide-tr.pdf": "1d466d01626218091856e9ec0c5adb5731233082e106fd0a843f13e9f3213cb8", - "cacti-guide-tr.txt": "c6ee90e2fb5f7e30ac7cb07bdccb5605f059f9c5ec37a50eaf77fdd3c61255f0", - "cacti-schema.sql": "1b89f72e9989d7e09e142183c4d1c0eb2eb1aa235672fca253489f49f49ac952", - "install-linux.pdf": "ed35c2b2cb3fa87566c360755f33b6f1acff75ad453599a948d4ac0d2f0a1b3b", - "install-linux.txt": "b5ad720c637b9e828739640c0e044b755b186798f05dc8d4ee1e349c3458b543", - "install-ru-unix.pdf": "55b03ed4476f8eddea63ab2e9f1cab50ffc22fdf3e963debd7c50fe1a28681b3", - "install-ru-unix.txt": "02f61f7cc5c20ea6d10bede530d6bf584d07ad3ef69607f5206d6686d7f40212", - "install-ru-windows.pdf": "eeef57cb1930495ab8ac386c75b6ea68a067f8a391f8d93c8662f8f8d237f3d5", - "install-ru-windows.txt": "7f1d08d46ac307868e1e88264e65825995fc7bee48a1a8e7dee82e6b9239e614", - "install-windows.pdf": "4c10eee60260e0bb7d717fc9d7e510f402414c8921248861412aff234e656983", - "install-windows.txt": "62c297b63f2aa768674b27502b60f7e84cee6675ea3839347e55d24ac1dadad9", - "manual.txt": "1e4fc1c3fde525293011de6edca4f3cf5ecdbb181f8041be0e6de299c7bbc422", - "migrate-solaris.pdf": "cc7460d62597b1845fd3e36cbf65f830a4d8ef4e5963bd5614cb15aba91659bf", - "migrate-solaris.txt": "dcb8ce1daeb27a31261f519fe60cf622dd1f609c5fd7a2cddecedd14b3a7f171", - "schema-reference.pdf": "36c9567710bd18c523013b4e0902ed032fb61ebce679c7513c5363d38d51f75b", - "schema-reference.txt": "8026b8ea354964467937288b6fab0c0c778ca6fd92cec84d7a109d19620987ae" - } -} diff --git a/resource/manuals/cacti-guide-de.pdf b/resource/manuals/cacti-guide-de.pdf deleted file mode 100644 index fcd9bc6c..00000000 Binary files a/resource/manuals/cacti-guide-de.pdf and /dev/null differ diff --git a/resource/manuals/cacti-guide-de.txt b/resource/manuals/cacti-guide-de.txt deleted file mode 100644 index 4583fdbb..00000000 --- a/resource/manuals/cacti-guide-de.txt +++ /dev/null @@ -1,34041 +0,0 @@ -Cacti installieren und betreiben -Unreleased Cacti 1.3 develop -Source: e80276e25ea4 -Built: 2026-11-18 - -Cacti installieren und betreiben - - -Diese Anleitung ersetzt den historischen deutschen Beitrag für neue -Installationen. Sie beschreibt Cacti 1.3 aus dem Entwicklungszweig develop, -keine veröffentlichte Version. Für Cacti 1.2 gilt das -Handbuch des Zweigs 1.2.x . Der deutsche Einstieg ist neu verfasst; -der vollständige Anhang enthält die aktuellen englischen Kapitel. Dies ist -keine vollständige deutsche Übersetzung des Handbuchs. - - -Version und Plattform auswählen - - -Prüfen Sie vor der Installation die Systemanforderungen . -Verwenden Sie ein unterstütztes, aktualisiertes Betriebssystem sowie eine -passende PHP-Version und Datenbank. Die Mindestversionen hängen vom gewählten -Cacti-Zweig ab. Die PHP-Konfiguration für die Kommandozeile und den Webserver -muss getrennt geprüft werden. - - -Für Linux wählen Sie die Anleitung für Ubuntu/Debian oder -Enterprise Linux . Verwenden Sie die Anleitung für Ihren Webserver; -Apache und nginx benötigen unterschiedliche Konfigurationen. Für FreeBSD -beachten Sie die Paket-, Pfad- und PHP-Flavor-Hinweise . Ein Paket -für Cacti 1.2 wird durch die Installation nicht zu Cacti 1.3. - - -Installation vorbereiten - - -Sichern Sie eine vorhandene Datenbank, Konfiguration und die RRD-Dateien. -Testen Sie die Wiederherstellung vor einem Versionswechsel. Installieren Sie -PHP, Datenbank, RRDtool und Net-SNMP nach der gewählten Plattformanleitung. -Verwenden Sie für einen Quellcode-Checkout die mitgelieferte -Composer-Lockdatei: - - -composer install --no-dev -composer check-platform-reqs --no-dev -php --ini -php -m - - - -Führen Sie Composer als Besitzer der Installation aus. Brechen Sie bei einem -fehlgeschlagenen Plattformtest ab. Importieren Sie cacti.sql ausschließlich -in eine neue Datenbank. Die Datenbank einer vorhandenen Installation wird -über den vorgesehenen Upgrade-Prozess aktualisiert. - - -Webzugriff und Datensammlung einrichten - - -Tragen Sie die tatsächlichen Datenbankparameter in include/config.php ein. -Schützen Sie diese Datei und den Anwendungscode vor Schreibzugriffen durch -den Webserver. Der Poller benötigt Schreibrechte auf seine -Laufzeitverzeichnisse, -aber keine Administratorrechte. Verwenden Sie HTTPS und beschränken Sie den -Zugriff während der Installation. Schließen Sie alle Prüfungen im Webinstaller -ab und ändern Sie die anfänglichen Zugangsdaten. - - -Richten Sie genau einen Zeitplan mit den absoluten Pfaden zu PHP und -poller.php ein. Benutzer, Intervall und Pfade müssen zur Installation passen. -Starten Sie keinen zweiten Poller parallel. Spine ist optional; -verwenden Sie nur eine zu Cacti passende Version. - - -Erstes Gerät und Diagramme - - -Fügen Sie unter Console > Devices ein Gerät mit der passenden Vorlage -hinzu. Konfigurieren Sie die tatsächlich am Gerät erlaubte SNMP-Version und -die Zugangsdaten. Begrenzen Sie den SNMP-Zugriff auf den Collector. Erstellen -Sie die gewünschten Diagramme und ordnen Sie sie einem Baum zu. Warten Sie -mehrere Polling-Intervalle, bevor Sie fehlende Messwerte beurteilen. - - -[Image: Beispieldiagramm mit historischen Messwerten] - - -Das Bild zeigt historische Beispieldaten und eine ältere Benutzeroberfläche. -Die aktuelle Schrittfolge steht in How to Graph Your Network . - - -Fehler untersuchen und aktualisieren - - -Prüfen Sie zuerst Uhrzeit, Dienststatus, PHP-Konfiguration, ausführbare Pfade, -Dateirechte und das Cacti-Protokoll. Verwenden Sie Data Source -Debugging -für eine einzelne Datenquelle. Aktivieren Sie ausführliche Protokollierung -nur gezielt und vorübergehend. Leere Diagramme rechtfertigen weder die -Neuinitialisierung der Datenbank noch das Löschen von RRD-Dateien. - - -Lesen Sie vor Updates die Versionshinweise und Upgrade-Anleitung . -Sichern Sie externe Datenpfade, Plugins und Cron-/Dienstkonfigurationen. -Verwenden Sie eine Testumgebung und führen Sie die Datenbankaktualisierung -nur einmal aus. Härtung gehört zur Inbetriebnahme. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Cacti (tm) Documentation - - -[Image: Cacti] - - -Cacti collects measurements from network devices, servers, and applications -and uses RRDtool to store time-series data and display graphs. Use this manual -to install Cacti, configure monitoring, and keep your installation running. - - -Version: This manual follows develop, the unreleased Cacti 1.3 series. -For released Cacti 1.2 installations, use the 1.2.x manual and -the requirements supplied with your installed version. - - -[Image: Cacti theme with synthetic device measurements] - - -Development Cacti theme with synthetic device measurements. See -themes and plugin appearance for settings and troubleshooting. - - -Getting Started - - -Follow this sequence for a new installation: - - -* Check requirements . - -* Install Cacti for your platform. - -* Add a device and create its graphs . - -* Verify data collection and check the -Cacti log . - -* Secure the installation before making -it available to other users. - - - -For the concepts behind these steps, read -Principles of Operation . To find your way around -Cacti, use Navigating the User Interface . - - -Current editions and contributed archives include PDF, -text, localized installation guides, and the development schema reference. - - -What Do You Want to Do - - -* Install or upgrade Cacti : -Check requirements, choose your platform, install, upgrade, and secure Cacti. - - -* Create your first graphs : -Add a device, configure SNMP, create graphs, and verify data collection. - - -* Manage your installation : -Organize devices and graphs, automate discovery, manage access, and report. - - -* Configure data collection : -Set up collectors, Spine, remote polling, scheduling, and performance. - - -* Create and reuse templates : -Work with templates, data queries, and package import and export. - - -* Choose a theme or check plugin appearance : -Find global and personal theme settings and report display problems. - - -* Troubleshoot a problem : -Investigate missing data, failed SNMP queries, and polling errors. - - - - -Troubleshoot a Problem - - -* Graphs have no data : Check polling and RRD updates. - - -* Find errors in the log : Inspect collection and system -logs. - - -* Investigate SNMP and graph failures : Follow the debugging -guide for polling and rendering problems. - - -* Common questions and polling problems : -Find answers about SNMP, scheduling, password recovery, and graph errors. - - -* Known issues : Check documented limitations and where -to report a problem. - - - - -Manual and Reference - - -Browse the complete manual index for every guide, -including procedures grouped with their related subjects. - - -For offline reading and runnable query examples, see -PDF manuals and example downloads . - - -Use the settings reference , -command-line scripts , and -graph and data reference when you -need a particular option, command, variable, or graph expression. Check -release notes for version-specific changes. - - -Extend and Contribute - - -* Use and develop plugins : Install extensions or -find plugin guidelines, hooks, and references. - - -* Contribute to Cacti : Report bugs, improve code or -documentation, and help translate Cacti . - - -* Development and testing : Find source -checkouts, automated checks, browser evidence, and contribution workflows. - - -* HTML manual content and publication : -Build all chapters and preserve links from the archived HTML manual. - - -* Development standards : Follow -the documentation, PHP, SQL, and security conventions for your target branch. - - -* Architecture decisions : Read proposals and -accepted decisions guiding development. - - -* Video tutorials : Watch tutorials on the official Cacti channel. -Check the demonstrated version against your installation. - - - - -Project Information - - -See project credits, acknowledgments, and licensing . -For downloads and news, visit the Cacti website . -For community support, use the Cacti Forums . - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Complete Manual Index - - -Return to the documentation front page . - - -This index follows develop, the unreleased Cacti 1.3 series. For released -Cacti 1.2 installations, use the 1.2.x manual . Menu visibility -also depends on permissions, enabled features, and plugins. Screenshots can -show an earlier release or a different theme. - - -Current editions and contributed archives include PDF, -text, localized installation guides, and the development schema reference. - - -Browse by task: start here , -monitor and operate , -customize and extend , -troubleshooting and reference , -contribute and develop , or -downloads and community . - - -Start Here - - -Install or Upgrade Cacti - - -Choose the guide for your operating system and installation method. -Earlier LAMP and LEMP guide URLs point to -the maintained Enterprise Linux instructions. - - -* Requirements - -* General Installing Instructions - -* Enterprise Linux with Apache (LAMP) - -* Rocky Linux 9 and 10 with Nginx (LEMP) - -* Ubuntu/Debian with Apache (LAMP) - -* Ubuntu Server 26.04 LTS and 26.10 with Nginx (LEMP) - -* Installing Under Windows - -* Upgrading Cacti Under UNIX Compatible Operating Systems - -* Upgrading Cacti Under Windows - -* Upgrading Cacti Under FreeBSD - -* Convert a Debian/Ubuntu package install to source - -* Hardening a Cacti Installation - -* Configuring SSL for Cacti - -* Version Specific Release Notes - - - -Create Your First Graphs - - -Start with the interface and concepts, then add a device and its graphs. - - -* Navigating the Cacti User Interface - -* Themes and Plugin Appearance - -* Principles of Operation - -* How to Graph Your Network - -* Device Management - -* Graph Overview - -* Graph Management - -* Viewing Graphs - -* Creating a Graph for a Single SNMP OID - - - -Monitor and Operate - - -Manage Your Installation - - -Organize monitoring, automate discovery, manage access, and create reports. - - -* Site Management - -* Cacti Trees - -* Data Source Management - -* Aggregate Graphs - -* Automation Networks - -* Automation Discovered Devices - -* Automation Device Rules - -* Automation Graph Rules - -* Automation Tree Rules - -* Automation SNMP Options - -* User Management - -* User Group Management - -* Login Providers - -* User Domains (1.2) - -* Reports Administration - -* Reports User - -* Report Items - -* Report Preview - -* Report Events - -* Other Report Management Options - -* System Utilities - - - -Configure Data Collection - - -Configure local and remote collection and diagnose performance constraints. - - -* Data Collectors - -* Spine - -* Poller Settings - -* PHP Script Server - -* Performance Boosting Settings - -* rrdproxy - -* Remote Poller Setup - -* Change the polling interval - -* SSH tunnels for remote Unix monitoring - -* How To Extend snmpd with custom script/data - - - -Customize and Extend - - -Create and Reuse Templates - - -Find template concepts, query procedures, packaging, and device-specific guides. - - -* Templates - -* How To Work with Templates - -* Device Templates - -* Graph Templates - -* Data Source Templates - -* Aggregate Templates - -* Color Templates - -* Data Input Methods - -* Create a data input method - -* Data Queries - -* How To Work with Data Queries - -* SNMP Data Queries - -* SNMP Data Query Walkthrough - -* Script Data Query Walkthrough - -* Determine a template version - -* Import Packages - -* Template Import - -* Template Exporting - -* Create Packages - -* Package Repositories - -* Package Public Keys - -* Apache Template Config - -* ESXi/VMware Template - -* Proxmox - external storage usage - - - -Plugins - - -Install and use plugins, or develop an extension. - - -* Plugin Management - -* Supported plugins - -* syslog - -* MacTrack - -* Plugin Development - -* Plugin Guidelines - -* Creating a plugin - -* Reference Plugins - -* Plugin Hook API Reference - -* ReportIt 3.0 development manual (PDF) - -* ReportIt plugin manual (historical PDF) - - - -Troubleshooting and Reference - - -Troubleshoot a Problem - - -Start with the symptom, polling output, and log messages. - - -* Data Source Debugging - -* The Cacti Log Interface - -* Debugging - -* Frequently Asked Questions - -* Known Issues - -* Spikekill - - - -Settings Reference - - -Use the settings for your branch. Development and 1.2 authentication differ. - - -* Settings - -* General Settings - -* Path Settings - -* Device Default Settings - -* Data Settings - -* Visual Settings - -* Performance Settings (Boost) - -* Spike Kill - -* Mail/Reporting/DNS Settings/Proxy - -* Authentication - -* Local Authentication - -* LDAP Authentication - -* Basic Authentication - -* Multiple LDAP/AD Domains (1.2) - -* Users, groups, and login providers - - - -Graph and Data Reference - - -Look up data profiles, expressions, formatting, and command-line tools. - - -* Data Source Profiles - -* CDEFs - -* VDEFs - -* Colors - -* GPRINT Presets - -* Variables - -* RRDtool Specific Features - -* Command Line Scripts (CLI) - - - -Contribute and Develop - - -Contributing - - -Contribute code, documentation, translations, and support. - - -* Contributing - -* Development and Testing - -* Creating Translations - - - -Development Standards - - -Follow the target branch's contributor instructions and checks. - - -* Documentation Standards - -* Formatting Guidelines - -* PHP Specific Constructs - -* File System Layout - -* Patch Creation - -* SQL Standards - -* Security - - - -Architecture Decisions - - -Read the decision index for the status of each proposal. - - -* Architecture Decision Records - -* ADR-0001: Bounded contexts - -* ADR-0002: Durable install runs - -* ADR-0003: Plugin extension boundary - -* ADR-0004: Workflow storage and observability - - - -Downloads and Community - - -Project and Community - - -Find project credits, licensing, support, and additional resources. - - -* Manual and Example Downloads - -* Project Credits and Licensing - -* External Links - -* Official video tutorials - -* Cacti Forums - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Current Manuals and Contributed Archives - - -These replacements follow develop, the unreleased Cacti 1.3 series. Use -the 1.2.x manual for released Cacti 1.2. The version guidance follows -the website's distinction between released and development documentation. -The manuals reuse the maintained chapter content and existing documentation -styles. They do not import the website's visual design. - - -Complete maintained manuals - - -* PDF manual , with all current main chapters, -bookmarks, screenshots, and links between chapters. - -* UTF-8 text manual , with the same main chapters, -command examples, image descriptions, and full link destinations. - -* HTML manual publication , including all -chapters and legacy chapter URLs. - -* Historical ReportIt manual . The newer -plugin manual is maintained separately from these Cacti editions. - - - -Current replacements for contributed guides - - -The new guides are separate Cacti documentation, not revisions attributed to -the original contributors. German, Turkish, and Russian editions contain a -new localized introduction and complete relevant English chapters in their -PDF and text appendices. They are not full translations. Language review is -welcome; platform checks and runtime limitations still apply. - - - - - - Guide - Read online - PDF - Text - - - - - - - German installation and operation - Deutsch - PDF - Text - - - - - Turkish installation and operation - Türkçe - PDF - Text - - - - - Linux installation - English - PDF - Text - - - - - Russian UNIX installation - Русский - PDF - Text - - - - - Russian Windows installation - Русский - PDF - Text - - - - - Windows installation - English - PDF - Text - - - - - Migration from Solaris - English - PDF - Text - - - - - Development database schema - Reference - PDF - Text - - - - - -The German and Turkish appendices include every current main manual chapter. -Installation editions include the complete platform, first-graph, -troubleshooting, security, and upgrade chapters selected in -editions.json . Solaris has a migration -guide rather than an unverified new-install procedure. The Windows guides -explain the current development dependency restriction before any install -instructions. - - -The schema SQL contains only the pinned -upstream CREATE TABLE statements. It is a reference, not an installer or -upgrade script. It has no seed data and does not describe plugin tables. -Use the schema supplied with your exact Cacti release for installation. - - -[Image: Example graph with populated historical data] - - -This screenshot shows historical sample measurements and an earlier interface. -It is included in the operating guides, not evidence of a deployment on every -listed platform. - - -Historical contributions - - -These originals remain archives at their existing URLs, with their original -credits and rights notices. Their obsolete dependencies and commands do not -apply to current installations. Do not overwrite them with the new guides or -present the new guides as work by the original contributors. - - - - - - Original - Credit from the original - Status - - - - - - - German documentation - Sebastian Larisch, August 2006 - Archive - - - - - Turkish handbook - Özgür Karataş, February 2006 - Archive - - - - - Linux how-to - Lee Carter, 2004 - Archive - - - - - Russian UNIX installation - Translation by Александр Цапкин, December 2006 - Archive - - - - - Russian Windows installation - Translation by Александр Цапкин, December 2006 - Archive - - - - - Solaris installation - Original credit and notice remain in the archive - Archive - - - - - Windows installation - Original credit and notice remain in the archive - Archive - - - - - Previous PDF manual - Original Cacti manual credits - Archive - - - - - Previous text manual - Original Cacti manual credits - Archive - - - - - Database schema PDF - Original notice remains in the archive - Archive - - - - - phpMyAdmin SQL - Original notice remains in the archive - Archive - - - - - -The archive inventory records each -original URL, byte count, and SHA-256 captured on 26 October 2026. Original -documents are not copied or translated into the new guides. - - -Build and publish - - -Follow manual publication to rebuild and -validate every edition. The edition manifest -records exact sources and checksums. The PDF builder also records its locked -toolchain in the PDF manifest . - - -CI publishes review artifacts; it does not deploy the public file host. -Maintainers should publish the new editions under distinct versioned names, -link this index from the download page, and retain the original archive URLs. -Publish the main manual separately from the historic manual.pdf and -manual.txt names so an existing archive citation keeps its meaning. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Requirements - - -This manual follows the unreleased Cacti 1.3 develop branch. Use the -1.2.x manual for released Cacti 1.2 installations. Verify the -requirements of the exact revision or release you deploy; development -requirements can change. - - -Supported operating systems - - -Platform guidance checked on 26 October 2026. Use the current security-updated -point release in a vendor-supported stable branch. The examples below target -these maintained operating systems; vendor OS support does not certify every -Cacti, PHP, database, or third-party binary combination. - - - - - - Operating system - Versions used for installation guidance - Lifecycle source - - - - - - - RHEL - Current supported minor release of 9 or 10 - Red Hat lifecycle - - - - - Rocky Linux - Current minor release of 9 or 10 - Rocky releases - - - - - AlmaLinux - Current minor release of 9 or 10 - AlmaLinux releases - - - - - Ubuntu Server - 24.04 LTS, 26.04 LTS, or 26.10 - Ubuntu lifecycle - - - - - Debian - 13 stable; 12 only with applicable Debian LTS coverage - Debian lifecycle - - - - - FreeBSD - 14.5-RELEASE or 15.1-RELEASE, with current patches - FreeBSD security support - - - - - Windows Server - 2022 or 2025, with current updates - Server 2022 , Server 2025 - - - - - -Check the linked lifecycle information before deployment. LTS coverage can -exclude architectures or packages. Use a maintained PHP and database version -that also meets this Cacti branch's requirements. A supported OS with an -incompatible default PHP version is not ready for installation. Do not use a -beta OS or an expired point release for these procedures. - - -Software Requirements - - - - - - Component - Development requirement or recommendation - - - - - - - Web server - PHP-capable Apache, nginx, or IIS FastCGI - - - - - PHP - PHP 8.3 or later in the PHP 8 series (^8.3 in Composer) - - - - - Database - MySQL 8.4+ or MariaDB 10.11+ recommended by the installer - - - - - RRDtool - Version 1.5 or later - - - - - SNMP - Net-SNMP command-line tools for operations using external binaries - - - - - Spine - Optional; use a version compatible with Cacti and its runtime libraries - - - - - -The PHP requirement comes from the dependency manifest and -runtime minimum . The database values are the branch's -installer recommendations , rather than a certification of every -vendor release. Check the actual server and extensions before installation. - - -PHP extensions - - -Cacti checks the CLI and web PHP environments separately. Install the -extensions required by the selected revision's Composer manifest and lock file, -and satisfy the installer checks. The combined requirements include: - - -* ctype, curl, date, dom, filter, gd, gmp, hash, intl, -json, ldap, mbstring, mysqlnd, openssl, pcre, PDO, -pdo_mysql, Phar, session, simplexml, sockets, spl, sqlite3, -standard, xml, and zlib. - -* posix and CLI pcntl on Unix. - -* com_dotnet for the Windows installer checks. - - - -Some modules are built into PHP. Check php -v, php --ini, and php -m for -the CLI, then check web PHP through the installer. Enabling an extension in one -PHP configuration does not enable it in the other. - - -The PHP SNMP extension is optional. External Net-SNMP tools are still needed -for collection paths such as some SNMPv3 and bulk requests. Configure their -paths and verify execution under the actual web and collector accounts. - - -Composer and source deployments - - -A source checkout or GitHub source archive needs its locked PHP dependencies. -Run these commands from the Cacti source root as the deployment owner: - - -composer install --no-dev -composer check-platform-reqs --no-dev - - - -Use composer install, which reads composer.lock. Do not run composer update during installation or upgrade. A complete release bundle can already -contain include/vendor/autoload.php; verify its generated platform checks and -the release's instructions rather than assuming every archive contains vendor -files. - - -The current manifest requires ext-pcntl and ext-posix unconditionally. -Native Windows PHP cannot supply these modules. Source dependency installation -is therefore blocked on native Windows, even though the installer has -Windows-specific checks. A bundled artifact must also pass its runtime platform -check. See Installing Under Windows before choosing a build. Do not -bypass platform checks to force installation. - - -Hardware Sizing - - -Size from the polling interval, number of data sources, retention profiles, -concurrent graph requests, collector settings, and measured storage latency. -Device count alone is not a reliable sizing rule. Test representative polling -and graphing load before increasing the deployment. - - -Use storage that can sustain RRD updates and database writes within the polling -window. Measure CPU, memory, I/O latency, database connections, and poll -completion time. Remote collectors can distribute collection work; they also -require connectivity, synchronization, and operational monitoring. Spine -process and thread counts should be tuned against those measurements. - - -Database configuration - - -Enable timezone support and grant the application account SELECT access to -mysql.time_zone_name. The grant does not populate that table. Import the -vendor's timezone data using the procedure for your operating system. - - -Use utf8mb4 and the utf8mb4_unicode_ci collation consistently for the Cacti -database. Changing server defaults does not convert existing tables; back up -and plan any conversion of an installed database separately. - - -Start with the database vendor's defaults and review the installer's checks for -the installed engine and version. Do not copy a fixed my.cnf block from -another server. Size global buffers and per-connection buffers together with -PHP and operating-system memory. Estimate Spine's connection demand as: - - -total_connections = total_processes * (total_threads + script_servers + 1) - - - -Allow additional connections for web requests, plugins, and maintenance. -Inspect actual storage engines before applying memory-table sizing guidance. - - -Keep InnoDB doublewrite protection enabled. Disabling it removes protection -against incomplete page writes; an SSD alone does not establish atomic page -writes. Review the durability consequences before changing commit flushing or -other crash-recovery settings. - - -Database variables differ by engine and release. Removed settings can prevent -startup. For example, MySQL 8 no longer accepts innodb_file_format, -innodb_large_prefix, or innodb_additional_mem_pool_size, and MariaDB 10.6 -removed innodb_buffer_pool_instances. Validate settings against the installed -server's documentation and Cacti's version-aware checks before restarting. See -the MySQL reference or MariaDB reference . - - -Accounts and platform controls - - -Keep application code owned by the administrator or deployment account. Give -web and collector identities the read, execute, and runtime-directory write -access they need. Grant temporary installation or import access only to the -required paths, and remove it afterward. Keep database credentials, CSRF -secrets, private caches, RRD files, and backups inaccessible over HTTP. - - -Configure SELinux, AppArmor, container permissions, or IIS request filtering -for the required operations. Do not remove confinement globally to make -installation checks pass. Follow the platform installation guide and -Hardening a Cacti Installation . - - - - -Copyright (c) 2004-2026 The Cacti Group - - -General Installing Instructions - - -Use only the supported operating systems and maintained -dependencies compatible with this Cacti branch. - - -Install the packages required by the selected operating system and verify that -the configured web server, PHP handler, and database start at boot. - - -Containers - - -Use an unprivileged container with its normal security profile where possible. -Diagnose the specific ICMP, socket, or filesystem permission that fails and -adjust only the required capability or policy. Do not remove AppArmor -confinement or make the entire container privileged as a general prerequisite. - - -Required Packages for Most Operating Systems - - -Depending on your operating system and PHP version, certain packages are -required for Cacti. The largest variable in these requirements come with regard -to PHP and MySQL/MariaDB. - - -Installation requirements include the packages below. The installation of these -packages will vary by operating system. - - -Base OS - - -* apache, IIS, or nginx - - -* net-snmp, net-snmp-utils - - -* rrdtool - - -* help2man (for spine) - - -* dos2unix (for spine) - - -* development packages (gcc, automake, autoconf, libtool, either mysql-devel or -mariadb-devel, net-snmp-devel, help2man) - - -(for spine) - - - - -Database - - -Use the database versions and configuration described in -Requirements . The development branch recommends MySQL 8.4+ -or MariaDB 10.11+. Check the installed server with the Cacti installer. - - -* mysql - - -* mysql-server - - -* libmysqlclient - - - - -or - - -* mariadb - - -* mariadb-server - - -* libmariadbclient - - - - -PHP Modules - - -Use PHP 8.3 or later in the PHP 8 series and the extensions listed in -Requirements . Verify the CLI with php -v and php -m and -check web PHP separately in the installer. Source deployments also need -Composer and all extensions required by the selected revision's lock file. -Run composer install --no-dev as the deployment owner, then -composer check-platform-reqs --no-dev. Use the lock file rather than updating -dependencies during installation. - - -Systems using PHP-FPM - - -After changing PHP configuration, test and restart the actual FPM service. -Service names can be versioned, for example on Debian and Ubuntu. Check the -installed unit rather than assuming that php-fpm is the service name. Confirm -its socket path and permissions match the web-server handler. - - -FreeBSD - - -Use a patched release listed in supported operating systems . -Choose binary packages or the Ports Collection using the -FreeBSD Handbook . Run package and service administration -commands as root. Use the dedicated poller account for collection. - - -Choose the Cacti version and PHP flavor - - -The FreeBSD net-mgmt/cacti port currently packages Cacti 1.2.31, not the -unreleased Cacti 1.3 development branch covered by this manual. For a packaged -release, follow its installed instructions and the 1.2.x manual . -For development source, meet Requirements and follow the -source-install steps below using FreeBSD paths and service configuration. -Do not overlay a source checkout onto files owned by pkg. - - -Cacti packages have PHP flavors. Discover the names available in your -configured repository before selecting one: - - -pkg update -pkg search -S name -x '^cacti(-php[0-9]+)?$' - - - -For example, if the repository offers cacti-php84 and the installation uses -PHP 8.4, review and install that flavor: - - -pkg install -n cacti-php84 -pkg install cacti-php84 -pkg info -D cacti-php84 -pkg info -l cacti-php84 - - - -Replace the example name with the selected flavor. Read the transaction before -accepting it, particularly changes to PHP extensions and database clients. -Dependencies do not configure a web server or create a database server. Set up -a compatible local MariaDB/MySQL service, or an existing remote database, -and configure Apache or nginx with the matching PHP handler separately. -Use FreeBSD service and sysrc for installed rc.d services; Linux -systemctl examples do not apply. - - -Build from ports when custom options are required - - -Use a maintained ports tree and read /usr/ports/UPDATING. Clone a tree only -if /usr/ports does not already contain one: - - -pkg install git -# New tree only: -git clone --depth 1 https://git.FreeBSD.org/ports.git /usr/ports -# Existing Git tree instead: -git -C /usr/ports pull --ff-only - - - -Build the chosen flavor, for example: - - -cd /usr/ports/net-mgmt/cacti -make FLAVOR=php84 config -make FLAVOR=php84 install clean - - - -The supported flavors and dependencies come from that ports revision. Follow -the handbook's dependency-management guidance before mixing custom ports with -binary packages. Rebuilding a port does not turn the packaged release into -Cacti development source. - - -Check installed paths and services - - -The Cacti port uses these default locations. Custom ports -options and existing Cacti settings can change them; inspect the installed -files and application configuration before copying commands. - - - - - - Item - Default location or account - - - - - - - Application and bundled schema - /usr/local/share/cacti - - - - - Database configuration - /usr/local/share/cacti/include/config.php - - - - - PHP configuration - /usr/local/etc/php.ini - - - - - RRD data - /var/db/cacti/rra - - - - - Log directory - /var/log/cacti - - - - - PHP CLI - /usr/local/bin/php - - - - - Packaged poller account - cacti - - - - - Web-server account - Commonly www; verify the service configuration - - - - - -The port supplies include/config.php.sample; preserve an existing -include/config.php and use the sample when creating a new one. Set the -intended timezone in both CLI and web PHP. Initialize a new database from the -bundled cacti.sql, grant the application account access to its database and -mysql.time_zone_name, and verify database timezone data is loaded. Never -import cacti.sql over an existing installation. - - -Check package-specific patches as well as upstream instructions. For example, -the current port sets $php_snmp_support = false for new configurations; -verify the installed setting and Net-SNMP paths when troubleshooting polling. - - -Configure write access only for the runtime directories needed by the actual -poller and web processes. Keep application code and database credentials -protected. Preserve Cacti's web-server restrictions on configuration, CLI, -resource, and data directories. - - -Create one Cacti schedule. For a five-minute launcher, an example entry in the -cacti user's crontab is: - - -*/5 * * * * /usr/local/bin/php -q /usr/local/share/cacti/poller.php - - - -Match this cadence to Cron/Daemon Interval in Cacti. A system crontab needs -the account field as well. Check for an existing cron entry or daemon first; -do not run both. Use Data Source Debugging and the Cacti log -to verify collection after completing the web installer. - - -Optional Spine poller - - -The Spine port is net-mgmt/cacti-spine; its package is -spine. Install it only when its version matches the Cacti release you use: - - -pkg install -n spine -pkg install spine - - - -Its default binary is /usr/local/bin/spine, with -/usr/local/etc/spine.conf.sample as the configuration example. Supply the -correct database connection in spine.conf and select the binary in Cacti. -Verify the poller account can run it. Grant ICMP privileges only when the -selected polling method requires them; do not apply a blanket setuid command. - - -For an existing installation, follow -Upgrading Under FreeBSD . - - -Configure PHP - - -Verify that the modules are installed and configured correctly. There are -several ways to do so - consult -PHP configuration instructions -for a complete description. - - -It is imperative that you set the date.timezone in your /etc/php.ini, or -/etc/phpX/apache/php.ini and /etc/phpX/cli/php.ini files. Failure to do so -will result in errors after the install is complete. - - -Most other PHP configuration is done automatically by the base OS, so there is -no need to discuss that here. - - -Configure the Webserver (Apache) - - -Use the distribution's Apache/PHP integration, selecting either its PHP-FPM -handler or a compatible Apache PHP module. Do not configure both handlers for -the same files. The Enterprise Linux LAMP guide and -Ubuntu/Debian guide provide examples. - - -Verify Apache's configuration before reloading. Restrict access during setup, -use HTTPS, and ensure that PHP requests execute rather than expose source. Keep -Cacti's shipped .htaccess restrictions active, or reproduce them in the -server configuration if overrides are disabled. nginx and IIS need their own -restrictions; they do not interpret Apache .htaccess files. - - -Configure MySQL/MariaDB - - -Initialize and secure the database using the procedure for the installed MySQL -or MariaDB package. Use the administrator authentication method configured by -that package; some Unix packages use local socket authentication. Store -credentials securely and do not put passwords directly on shell command lines. - - -You must also load timezone information into the database. This is required for -various plugin use. Later, you will be required to grant access to the -time_zone_name table during the final installation steps. - - -mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root -p mysql - - - -Since Cacti 1.x is supporting internationalization (i18n), it is important that -the default character set for MySQL/MariaDB be i18n compatible. The Cacti -installer will make specific recommendations on MySQL/MariaDB settings. Follow -those as applicable for your OS. - - -Galera clustering: There are several tables which are set to use the MEMORY -storage engine which do not get replicated among nodes which can cause -problems. If you configure Cacti to only connect to one node of your cluster -and are not load balancing this does not apply to you. - - -If you are running multiple nodes in a load-balanced environment where you -connect to a VIP you should remove all but one node from rotation during Cacti -installation or update. After the installation/update login to your MySQL -server and execute the following commands to update those tables to use the -InnoDB engine: - - -MariaDB [(none)]> use cacti; -MariaDB [cacti]> ALTER TABLE `automation_ips` ENGINE=InnoDB; -MariaDB [cacti]> ALTER TABLE `automation_processes` ENGINE=InnoDB; -MariaDB [cacti]> ALTER TABLE `data_source_stats_hourly_cache` ENGINE=InnoDB; -MariaDB [cacti]> ALTER TABLE `data_source_stats_hourly_last` ENGINE=InnoDB; -MariaDB [cacti]> ALTER TABLE `poller_output` ENGINE=InnoDB; -MariaDB [cacti]> ALTER TABLE `poller_output_boost_local_data_ids` ENGINE=InnoDB; -MariaDB [cacti]> ALTER TABLE `poller_output_boost_processes` ENGINE=InnoDB; -MariaDB [cacti]> ALTER TABLE `processes` ENGINE=InnoDB; - - - -Before restoring database load balancing, verify the table-engine changes, -replication state and successful polling on the configured topology. A fixed -number of polling cycles is not proof that the cluster is ready. - - -Install and Configure Cacti - - -These are fresh source-install examples for Cacti development (1.3). -Package-managed installations should use the maintainer's procedure instead. -For an existing installation, follow Upgrading Cacti . The -examples use /var/www/html/cacti; adjust that path and the service accounts -for your OS. Use administrator privileges for software installation and -permission changes. - - -Extract the source and create the database - - -Obtain the intended source revision in a new installation directory. Do not run -these commands over an existing deployment: - - -git clone --branch develop --depth 1 https://github.com/Cacti/cacti.git cacti -mv cacti /var/www/html/cacti -cd /var/www/html/cacti -composer install --no-dev -composer check-platform-reqs --no-dev - - - -The installation root should now contain cacti.sql, poller.php and -include/config.php.dist, rather than another nested release directory. - - -Connect with a database administrator account: - - -mysql --user=root --password - - - -Create the database and a dedicated application account. Replace the password -placeholder before running this SQL, and use the same secret in the Cacti -configuration. The database account is separate from the operating-system -account that runs the poller. - - -CREATE DATABASE cacti CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; -CREATE USER 'cactiuser'@'localhost' - IDENTIFIED BY 'REPLACE_WITH_UNIQUE_DATABASE_PASSWORD'; -GRANT ALL PRIVILEGES ON cacti.* TO 'cactiuser'@'localhost'; -GRANT SELECT ON mysql.time_zone_name TO 'cactiuser'@'localhost'; -EXIT; - - - -Use an authorized database administrator to grant access. Do not edit -mysql.tables_priv as a substitute for an authorized GRANT operation. Ensure -the server's timezone tables are populated using the procedure for the -installed MySQL or MariaDB server; granting access does not populate them. - - -Import the schema into the new database using the appropriate client: - - -mysql --user=root --password --default-character-set=utf8mb4 cacti \ - < /var/www/html/cacti/cacti.sql - - - -The --password option prompts for the password. Use mariadb in place of -mysql where appropriate for the installed server. - - -Configure access and complete installation - - -Copy the supplied configuration example: - - -cp /var/www/html/cacti/include/config.php.dist \ - /var/www/html/cacti/include/config.php - - - -Edit the copied file to match the account created above: - - -$database_type = 'mysql'; -$database_default = 'cacti'; -$database_hostname = 'localhost'; -$database_username = 'cactiuser'; -$database_password = 'REPLACE_WITH_UNIQUE_DATABASE_PASSWORD'; -$database_port = 3306; -$url_path = '/cacti/'; - - - -Identify the actual web and poller service accounts. Give them the required -read/execute access to application files and external tools, and write access -to the runtime paths they use, including RRD, log and cache paths. They need -not be the same account. Do not assume a database username is also a local OS -account or make the whole application tree writable. - - -During installation and package imports, grant the performing identity the -additional access required by the installer, including query/script resources -and the location used to initialize the CSRF secret. Remove temporary setup -permissions afterward. Preserve read access to the generated secret; do not -create an empty secret file. See the platform-specific installation guides for -their account and permission examples. - - -Restrict installer access to the administrator and use HTTPS or a protected -local connection before entering credentials. A freshly imported development -schema uses application username admin and initial password admin. Open the -configured Cacti URL, sign in and choose a unique administrator password when -prompted. These are separate from the database credentials. Complete the -installer's dependency, database, path and permission checks before allowing -general access. - - -Schedule collection after installation - - -Use either cron or cactid.service, not both. The following examples assume an -existing local user and group named cacti with the required polling -permissions; replace them with the actual service identity for your system. Do -not start polling before completing the web installer. - - -For a system cron file such as /etc/cron.d/cacti, use an absolute PHP CLI -path and include the OS username: - - -*/5 * * * * cacti /usr/bin/php /var/www/html/cacti/poller.php >/dev/null 2>&1 - - - -The five-minute launch interval must match Cron/Daemon Interval under the -poller settings. This is separate from individual data-source polling -intervals. The redirection above works with /bin/sh; &> is Bash-specific. - - -The supplied systemd unit uses Type=forking. Confirm that the selected PHP -CLI provides pcntl_fork before using it; otherwise use cron or install the -appropriate PCNTL support. For the example CLI path, this should report -bool(true): - - -/usr/bin/php -r 'var_dump(function_exists("pcntl_fork"));' - - - -For systemd, copy the supplied unit and edit the installed copy: - - -cp /var/www/html/cacti/service/cactid.service \ - /etc/systemd/system/cactid.service - - - -Replace the unit's existing User, Group, ExecStart and EnvironmentFile -settings with values for the actual deployment, retaining its other settings. -For example: - - -User=cacti -Group=cacti -ExecStart=/usr/bin/php /var/www/html/cacti/cactid.php -EnvironmentFile=-/etc/default/cactid - - - -The - allows the optional environment file to be absent. Disable the -Cacti-specific cron entry before enabling the daemon, then load the edited -unit: - - -systemctl daemon-reload -systemctl enable cactid.service -systemctl start cactid.service -systemctl status cactid.service - - - -The unit manages the local daemon; it does not establish high availability. -Verify scheduler execution, collector status, logs and recent graph data under -the configured account. - - -(Optional) Install and Configure Spine - - -Spine is a very fast data collection engine, written in C. It is an optional -replacement for cmd.php. If you decide to use it, you will have to install it -explicitly. It does not come with cacti itself. - - -The easiest way is to install Spine using rpm or ports. You will find packages -for Spine at the main cacti site or from your distribution. - - -To compile Spine, download it to any location of your liking. Then, issue from -the downloaded directory following commands - - -./bootstrap - - - -After bootstrap succeeds, follow the release's build instructions to -configure, compile and install Spine. - - -Assuming, you've managed to install spine correctly, you will have to configure -it. Use the installed spine.conf.dist as the example, and configure the -actual Spine configuration path in Cacti. Use the same database account and -secret as the Cacti configuration, and restrict file access to the poller -account and administrators. - - -DB_Host localhost -DB_Database cacti -DB_User cactiuser -DB_Pass REPLACE_WITH_UNIQUE_DATABASE_PASSWORD -DB_Port 3306 - - - -Considerations when using Proxies in front of Cacti (Cacti 1.2.23+) - - -A header allowlist does not authenticate a proxy. Trust forwarded client-IP -headers only when a trusted proxy replaces those headers and untrusted clients -cannot bypass it to reach Cacti directly. Leave forwarding disabled otherwise. -In include/config.php, select only the headers your proxy sets. For a -deployment using X-Forwarded-For, the setting is: - - -$proxy_headers = ['X-Forwarded-For']; - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Installing on Enterprise Linux with Apache - - -Use only the supported operating systems and maintained -dependencies compatible with this Cacti branch. - - -This source-install example covers the unreleased Cacti 1.3 development branch -on RHEL, Rocky Linux, or AlmaLinux. Read Requirements -first. Run administrative commands as root and adapt paths and accounts to -your deployment. For an existing installation, use -Upgrading Cacti . For package-managed Cacti, follow the -package maintainer's procedure instead of overlaying source files. - - -Choose repositories and PHP - - -For a new, fully updated RHEL 9 installation with the stream available, -PHP 8.3 is an example meeting the development minimum: - - -dnf module list php -dnf module install php:8.3 - - - -This is a fresh-install example, not a stream-switching procedure for an -existing server. Check the streams supplied by your distribution. EL 9 and EL -10 do not share identical repositories or module availability. If the required -PHP version is unavailable, choose a maintained distribution or repository that -provides it before continuing. - - -Install the web and database packages - - -This example uses MariaDB. MySQL installations should use the package and -service names for their selected MySQL repository. Review the database version -against Cacti's requirements before installation. - - -dnf install -y httpd php-fpm php-cli php-mysqlnd php-gd php-gmp \ - php-intl php-ldap php-mbstring php-xml php-process php-snmp \ - mariadb-server rrdtool net-snmp-utils cronie -php -v -php -m - - - -Additional packages can be required by the chosen source revision. Check -Requirements , including Composer dependencies where -applicable. Do not mix extensions from different PHP versions or repositories. - - -Configure date.timezone in the PHP configuration used by both CLI and FPM. -Check php --ini for CLI and the installer for web PHP. Review the FPM pool at -/etc/php-fpm.d/www.conf; its account needs access to Cacti's runtime paths. -Keep code owned by the deployment administrator. - - -Start the database: - - -systemctl enable --now mariadb - - - -Follow the installed database vendor's initialization and account-security -procedure. Do not set a root password on the shell command line. Configure only -variables accepted by that database version; use Cacti's installer -recommendations rather than a fixed tuning block. Keep InnoDB doublewrite -protection enabled. - - -Configure Apache - - -Use the distribution's Apache/PHP-FPM integration. Check that PHP requests are -executed by FPM rather than served as text. This example exposes only -/cacti/; replace the hostname and certificate paths before use. Save it in -/etc/httpd/conf.d/cacti.conf: - - - - ServerName cacti.example.com - SSLEngine On - SSLCertificateFile /etc/pki/tls/certs/cacti.crt - SSLCertificateKeyFile /etc/pki/tls/private/cacti.key - Alias /cacti /var/www/html/cacti - - - Options -Indexes - AllowOverride All - Require all granted - DirectoryIndex index.php - - - - - -Install mod_ssl if not already present. AllowOverride All lets Cacti's -shipped .htaccess restrictions protect private paths; if your policy disables -overrides, reproduce those restrictions in the server configuration. Do not -grant general access to private directories as a troubleshooting step. - - -dnf install -y mod_ssl -httpd -t -systemctl enable --now php-fpm httpd - - - -Use your certificate-management procedure and review any packaged default TLS -virtual host for conflicts. Restrict access to administrators during setup. - - -Install and configure Cacti - - -Use General Installing Instructions to obtain the intended source, -create a new database and dedicated application account, load timezone data, -import cacti.sql, and configure include/config.php. The examples there use -/var/www/html/cacti; use that same path here. - - -Complete the dependency and filesystem-permission checks before opening the -installer. The database account and operating-system service accounts are -separate identities. Grant runtime write access to the actual FPM and poller -accounts, not automatically to the nginx master process or the database user. -Keep executable code and credentials protected during normal operation. - - -Open https://cacti.example.com/cacti/ and complete the installer. Configure -one scheduler after installation: either a Cacti-specific cron entry or the -supplied cactid systemd service, using the procedure in the general guide. Do -not run both for the same collector. The five-minute cron example is: - - -*/5 * * * * apache /usr/bin/php /PATH/TO/cacti/poller.php >/dev/null 2>&1 - - - -Replace /PATH/TO/cacti and apache with the installed path and chosen poller -account. Enable crond if using cron. Verify a manual poll under that account, -then check scheduled runs, logs, collector status, and fresh graph samples. - - -SELinux and containers - - -Keep SELinux enforcing. For a custom installation path, use persistent file -contexts and allow writes only on Cacti's runtime paths. Review audit denials -and authorize the specific network and executable access needed by FPM, -RRDtool, SNMP tools, and the collector. Do not use setenforce 0 as the -installation procedure. See the RHEL SELinux guide . - - -For LXC or Proxmox, retain an unprivileged container and its confinement where -possible. Diagnose the specific ICMP/socket permission or mapped-file access -failure. Adjust only the required capability or policy; do not make the entire -container privileged or set an unconfined AppArmor profile merely to run Cacti. - - -Optional Spine and proxies - - -Follow Spine for the optional compiled collector. Select a -compatible source or package and the development headers for your OS. -Repository names differ: do not apply Rocky/AlmaLinux crb commands to RHEL -without checking its repository configuration. Configure the Spine database -connection with the same application credentials and restrict access to its -configuration file. - - -When using a reverse proxy, see the proxy configuration in the general -guide . A header allowlist alone does not authenticate a proxy; prevent -clients from bypassing the trusted proxy and require it to replace forwarded -client-IP headers. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Installing Cacti Development on Ubuntu or Debian with Apache - - -For nginx with PHP-FPM on Ubuntu Server 26.04 LTS or 26.10, use the -Ubuntu LEMP guide . - - -Use only the supported operating systems and maintained -dependencies compatible with this Cacti branch. - - -This is a source-install example for Cacti development (1.3), not a tested -distribution -matrix. Use a maintained distribution and check its PHP version against -Requirements before -installing packages. Run the administrative commands below as root. The -example uses /var/www/html/cacti and the default Debian/Ubuntu web account, -www-data; adjust both if your web-server setup differs. - - -Install the required packages - - -The unversioned PHP package names select the distribution's configured PHP -version. Confirm that it is PHP 8.3 or later in the PHP 8 series before -continuing. Use a distribution or configured repository that supplies the -required version; do not mix extensions from different PHP versions. - - -apt-get update -apt-get install -y apache2 libapache2-mod-php mariadb-server rrdtool snmp git cron \ - composer php-cli php-curl php-sqlite3 php-mysql php-snmp php-xml php-mbstring php-gd php-gmp php-zip php-ldap php-intl -systemctl enable --now apache2 mariadb cron - - - -If using PHP-FPM instead of the Apache PHP module, configure Apache's FPM -integration and use the installed FPM pool's account. FPM service names are -versioned on Debian/Ubuntu; inspect them with systemctl list-unit-files 'php*-fpm.service' and restart the actual unit after configuration changes. Do -not assume a service named php-fpm exists. - - -Download the Cacti source - - -This example checks out the unreleased develop branch. Record the commit you -deploy; do not treat a moving development branch as a stable release. - - -git clone --branch develop --depth 1 https://github.com/Cacti/cacti.git cacti -mv cacti /var/www/html/cacti -cd /var/www/html/cacti -composer install --no-dev -composer check-platform-reqs --no-dev - - - -Do not overwrite an existing installation with these fresh-install commands. - - -Create the database - - -Choose a unique database password and replace the example placeholder in both -the SQL and include/config.php. Connect using your database administrator's -authentication method; the example below prompts for a password. - - -mysql -u root -p - - - -CREATE DATABASE cacti CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; -CREATE USER 'cactiuser'@'localhost' IDENTIFIED BY 'replace-with-a-unique-password'; -GRANT ALL PRIVILEGES ON cacti.* TO 'cactiuser'@'localhost'; -GRANT SELECT ON mysql.time_zone_name TO 'cactiuser'@'localhost'; -EXIT; - - - -Load the system timezone data and the schema into this new database. A MariaDB -installation may provide mariadb-tzinfo-to-sql as the timezone utility's -name. - - -mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root -p mysql -mysql -u root -p cacti < /var/www/html/cacti/cacti.sql - - - -Configure Cacti and filesystem permissions - - -Copy the distributed configuration example; do not rename or delete it. - - -cp /var/www/html/cacti/include/config.php.dist /var/www/html/cacti/include/config.php - - - -Edit the database fields to match the account and database created above: - - -$database_type = 'mysql'; -$database_default = 'cacti'; -$database_hostname = 'localhost'; -$database_username = 'cactiuser'; -$database_password = 'replace-with-a-unique-password'; -$database_port = '3306'; - - - -Keep application code owned by the administrator. The web and poller accounts -must be able to read the configuration and write the runtime directories: - - -chown root:www-data /var/www/html/cacti/include/config.php -chmod 640 /var/www/html/cacti/include/config.php -chown -R www-data:www-data /var/www/html/cacti/rra /var/www/html/cacti/log /var/www/html/cacti/cache -chmod -R u+rwX,go-rwx /var/www/html/cacti/rra /var/www/html/cacti/log /var/www/html/cacti/cache - - - -During installation or package import, the installer also checks write access -to resource/snmp_queries, resource/script_server, resource/script_queries -and scripts, and the location used to create the CSRF secret. Grant only the -additional access requested by the installer and remove that temporary access -afterwards. Do not make the entire application tree world-writable. - - -Restrict installer access to the administrator. Configure HTTPS or use a -protected local connection before entering credentials, then browse to -/cacti/. For a freshly imported development schema, sign in with application -username admin and initial password admin, then choose a unique -administrator password when prompted. These are separate from the database -credentials. Complete the web installer before starting scheduled polling or -allowing general access. - - -Schedule polling - - -Choose either cron or cactid.service, not both. Complete the web installer -before starting the selected scheduler. The example cron interval is five -minutes; match the Cron/Daemon Interval in Settings > Poller. This is -separate from the data-source polling interval, which can be shorter. - - -Cron - - -Create /etc/cron.d/cacti as root, with mode 644, and include this line: - - -*/5 * * * * www-data /usr/bin/php /var/www/html/cacti/poller.php >/dev/null 2>&1 - - - -This is a system cron file, so the username field is required. Use an absolute -PHP CLI path and POSIX shell redirection; Debian cron uses /bin/sh by -default. See Debian crontab format . - - -systemd - - -The supplied unit uses Type=forking, so the selected PHP CLI must provide -pcntl_fork. Check /usr/bin/php -r 'var_dump(function_exists("pcntl_fork"));' for bool(true) before using this -example. If fork support is unavailable, use cron or install the appropriate -PCNTL support for that PHP CLI. - - -Copy the supplied service and edit the installed copy: - - -cp /var/www/html/cacti/service/cactid.service /etc/systemd/system/cactid.service - - - -Replace its existing User, Group, EnvironmentFile and ExecStart entries -with the following, retaining the other service settings: - - -User=www-data -Group=www-data -EnvironmentFile=-/etc/default/cactid -ExecStart=/usr/bin/php /var/www/html/cacti/cactid.php - - - -The leading - makes the optional environment file unnecessary if you do not -use one. After completing the installer, load and start the service: - - -systemctl daemon-reload -systemctl enable cactid.service -systemctl start cactid.service -systemctl status cactid.service - - - -The service manages the local polling daemon; it does not by itself provide -high availability. Verify the poller log and newly created graphs after -starting the selected scheduler. - - -Considerations when using Proxies in front of Cacti (Cacti 1.2.23+) - - -A header allowlist does not authenticate a proxy. Trust forwarded client-IP -headers only when a trusted proxy replaces those headers and untrusted clients -cannot bypass it to reach Cacti directly. Leave forwarding disabled otherwise. -In include/config.php, select only the headers your proxy sets. For a -deployment using X-Forwarded-For, the setting is: - - -$proxy_headers = ['X-Forwarded-For']; - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Installing Under Windows - - -Use only the supported operating systems and maintained -dependencies compatible with this Cacti branch. - - -These instructions describe a manual installation of Cacti development (1.3) on -Windows. Use the requirements for your Cacti release and -supported Windows builds of PHP, your database server and RRDtool. Community -Windows installers are also discussed in the Cacti -forums ; check their included versions and -maintenance status before using them. - - -The examples use C:\inetpub\wwwroot\cacti for Cacti, C:\php for PHP, -C:\rrdtool for RRDtool and C:\spine for optional Spine. Substitute your -actual paths throughout. Use a dedicated Windows account for the poller and a -separate web-server identity. Install software and configure services as an -administrator; the poller does not normally need administrator privileges. - - -Development packaging prerequisite - - -The current development dependency manifest requires PHP ^8.3, including -ext-pcntl and ext-posix unconditionally. Native Windows PHP cannot supply -those two extensions. A source checkout therefore cannot currently install its -Composer dependencies on native Windows. A bundled artifact must also pass its -generated runtime platform check. Stop if it rejects Windows and use a -compatible release or a Unix installation. Do not bypass platform checks or -edit generated vendor files to force an incompatible installation. - - -The remaining instructions apply only to an artifact that passes its platform -checks. Read the PHP PCNTL platform restriction and the selected -revision's dependency manifest before choosing an artifact. - - -Install the software - - -* Choose IIS or Apache and install only the web server you intend to use on -the selected address and port. - - -* Extract the Cacti ZIP distribution into the chosen web directory. - - -* Install PHP and its required runtime libraries using the -PHP Windows installation instructions . Match the architecture -and build type to your web-server integration. Use a Non-Thread-Safe build -for IIS FastCGI; an Apache module requires a compatible Thread-Safe build. -A path without spaces, such as C:\php, simplifies tool configuration. - - -* Install a Windows build of RRDtool and -verify its runtime dependencies. If using Spine, install a compatible -Spine release and the dependencies supplied or required by that -build. The PHP poller can be used without Spine. - - -* Install MySQL or MariaDB. Use the server's supported Windows configuration -and service-management instructions. Start with its documented defaults, -then review the Cacti installer's checks for your actual server and -workload. - - -Do not copy a tuning block from a different database version or operating -system. MySQL 8 removed NO_AUTO_CREATE_USER, innodb_file_format and -innodb_large_prefix; these settings can prevent startup. Do not disable -InnoDB doublewrite protection or reduce commit durability as an installation -shortcut. Size global and per-connection buffers for the available memory -and expected concurrency. - - -* Install Net-SNMP command-line tools if your collection configuration needs -them, for example into C:\usr. Cacti uses these tools for SNMPv3 -requests from the web interface and PHP poller; PHP's SNMP extension alone -does not provide that collection path. Verify the installed executable paths -instead of assuming a particular short filename or installation directory. - - - - -Configure PHP - - -Copy php.ini-production from the PHP distribution to C:\php\php.ini. Set -the timezone for your installation and enable the required extensions. For -current PHP Windows builds, an example configuration is: - - -extension_dir = "C:\php\ext" -extension=curl -extension=pdo_mysql -extension=sqlite3 -extension=gd -extension=gmp -extension=intl -extension=ldap -extension=mbstring -extension=openssl -extension=sockets -extension=com_dotnet -; Enable if using PHP's SNMP extension: -extension=snmp - -date.timezone = America/Detroit -file_uploads = On - - - -Use only extensions supplied for the selected PHP build and install their -required DLL dependencies according to PHP's instructions. Some modules are -built in. The Cacti installer checks additional modules, including SimpleXML, -XML and zlib, in both the web and command-line environments. pdo_mysql is the -database driver Cacti uses; the removed php_mysql.dll is not a substitute. -Set memory and execution limits using the installer recommendations for your -installation rather than copying values sized for another server. - - -Check the command-line configuration before configuring the web server: - - -C:\php\php.exe --ini -C:\php\php.exe -m - - - -Set PHPRC to C:\php for the web-server and poller environments if needed to -select this configuration. An absolute path to php.exe avoids depending on -PATH for scheduled tasks. Ensure required DLLs are discoverable by both -identities; do not copy PHP DLLs into Windows system directories. - - -If loading external MIBs, set MIBDIRS to their actual directory and allow the -collecting account to update the Net-SNMP index/cache there if needed. This is -separate from permission to modify executable files. - - -After changing PHP configuration, recycle the application pool or restart the -selected web-server service. Confirm the Cacti installer reports the expected -configuration and modules for both web PHP and CLI PHP. - - -Configure the web server - - -IIS with FastCGI - - -Follow the PHP IIS instructions and Microsoft's -FastCGI configuration reference . - - -* Enable the IIS CGI role service, which supplies FastCGI support. - - -* Create the Cacti site/application and a dedicated application pool. Match -the pool architecture to PHP. In Handler Mappings, map *.php through -FastCgiModule to C:\php\php-cgi.exe, not php.exe. Use the -corresponding -FastCGI application entry and allow script execution for the application. -PHP 8 does not provide php8isapi.dll; do not configure an ISAPI filter. - - -* Add index.php to the site's Default Document list. Apply the PHP CGI -settings required by the PHP IIS guide, including cgi.force_redirect=0 -for IIS. Configure authentication/impersonation deliberately so the account -accessing Cacti files is known. - - -* Configure an HTTPS binding and restrict access during installation. Recycle -the affected application pool after configuration changes. - - - - -Apache - - -Follow the PHP Apache instructions for a matching Apache/PHP -build. For Apache 2.4 with a compatible PHP 8 Thread-Safe module, the relevant -configuration is: - - -LoadModule php_module "C:/php/php8apache2_4.dll" - - SetHandler application/x-httpd-php - -DirectoryIndex index.php index.html -PHPIniDir "C:/php" - - - -Check Apache's configuration before restarting its service. If using FastCGI -instead of the Apache module, follow that integration's PHP instructions and -use the appropriate PHP build. - - -File permissions - - -Identify the effective web identity and the scheduled-task account before -setting ACLs. For IIS, this may be IIS AppPool\Cacti for a pool named -Cacti, or another account selected by authentication and FastCGI -impersonation. See Microsoft's application-pool identity -guidance . Do not assume the account is always IUSR. - - -Give the web and poller identities read access to Cacti's code and -configuration, and read/execute access to PHP, RRDtool, SNMP and optional Spine -programs and their dependencies. If PHP requires cmd.exe to launch a command, -allow only the necessary read/execute access. Do not grant either identity -write access to Windows system executables or to tool installation directories. - - -The poller needs Modify permission on rra and log and on the cache -subdirectories it uses. The web identity also needs Modify permission on log, -its configured temporary/session directories and the Cacti cache subdirectories -used by features such as real-time graphs. Use the installer's permission -checks to identify the required paths, including cache/boost, -cache/mibcache, cache/realtime and cache/spikekill. Grant access only to -the identities and paths that need it, accounting for inherited ACLs. - - -During installation or signed-package imports, Cacti also needs to write -queries and scripts under resource/snmp_queries, resource/script_server, -resource/script_queries and scripts. Grant temporary Modify access to the -identity performing that operation, then remove it when finished. The installer -also needs to initialize a nonempty CSRF secret, by default -include/vendor/csrf/csrf-secret.php. Allow creation in its containing -directory during setup, then retain read access to the generated secret and -remove the temporary directory write permission. Do not create an empty -placeholder secret. - - -Edit include/config.php as an administrator. Keep it readable by the web and -poller identities but not writable by them for ordinary operation. If a -specific installation operation needs to update it, grant temporary write -access for that operation and remove it afterward. - - -Create the database - - -The following commands are for Command Prompt, not PowerShell. Use the -actual path to mysql.exe or the equivalent MariaDB client if it is not on -PATH. The --password option prompts for the database administrator's -password; do not put that password on the command line. - - -mysql --user=root --password - - - -Create an empty database and a dedicated application account. Replace -REPLACE_WITH_UNIQUE_DATABASE_PASSWORD with a unique secret before executing -this SQL. The example account and connection use TCP loopback consistently. - - -CREATE DATABASE cacti CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; -CREATE USER 'cacti_user'@'127.0.0.1' - IDENTIFIED BY 'REPLACE_WITH_UNIQUE_DATABASE_PASSWORD'; -GRANT ALL PRIVILEGES ON cacti.* TO 'cacti_user'@'127.0.0.1'; -GRANT SELECT ON mysql.time_zone_name TO 'cacti_user'@'127.0.0.1'; - - - -Exit the SQL client and import the schema from the same Cacti release you -extracted: - - -mysql --user=root --password --default-character-set=utf8mb4 cacti < "C:\inetpub\wwwroot\cacti\cacti.sql" - - - -Ensure the server's time-zone tables are populated using its documented Windows -procedure. Granting access to an empty mysql.time_zone_name table does not -populate it. Resolve the database and time-zone checks reported by the Cacti -installer before completing installation. - - -Optional Cygwin and Spine configuration - - -If your Spine or RRDtool build depends on Cygwin, install the runtime packages -required by that build using the official -Cygwin installer . -For a source build, follow the release's build instructions and select its -current compiler/development dependencies. Do not replace or delete DLLs -shipped with a binary distribution without checking that distribution's -requirements. Avoid mixing incompatible Cygwin runtimes. - - -For Spine, copy spine.conf.dist to spine.conf and set the connection -details to match Cacti. Replace the password placeholder with the same -application secret used above, not a sample password: - - -DB_Host 127.0.0.1 -DB_Database cacti -DB_User cacti_user -DB_Pass REPLACE_WITH_UNIQUE_DATABASE_PASSWORD -DB_Port 3306 - - - -Restrict access to spine.conf to administrators and the poller account. -Verify Spine from that account before selecting it as the poller in Cacti. - - -Finish the Cacti installation - - -* Copy include/config.php.dist to include/config.php and set its database -connection. Replace the password placeholder with your application secret: - - -$database_default = 'cacti'; -$database_hostname = '127.0.0.1'; -$database_username = 'cacti_user'; -$database_password = 'REPLACE_WITH_UNIQUE_DATABASE_PASSWORD'; -$database_port = '3306'; -$url_path = '/cacti/'; - - - -Adjust $url_path if Cacti is served at another URL path. - - -* Open the Cacti URL through HTTPS. For a freshly imported development schema, -sign in with application username admin and initial password admin, -then choose a unique administrator password when prompted. These are -separate from the database credentials. Complete the installer and resolve -its dependency, database, path and permission checks before allowing -general access. - - -* In Console > Configuration > Settings > Paths, verify the executable -paths against your installation. For the example layout: - - - - - - Setting - Example - - - - - - - PHP binary - C:/php/php.exe - - - - - RRDtool - C:/rrdtool/rrdtool.exe - - - - - SNMP tools, if used - C:/usr/bin/snmpget.exe, snmpwalk.exe, snmpbulkwalk.exe, snmpgetnext.exe - - - - - Cacti log - C:/inetpub/wwwroot/cacti/log/cacti.log - - - - - Spine, if used - C:/spine/spine.exe - - - - - -Use the CLI PHP executable here, not the IIS FastCGI executable. Verify the -separate Spine configuration path if selecting Spine. - - -* Create devices and graphs deliberately, or configure discovery and -automation -rules for the intended network. Installing Cacti does not establish that -every discovered device exposes all measurements in its selected template. - - - - -Schedule and verify the poller - - -Log on as the intended poller account and test the same executable and paths -that the task will use: - - -C:\php\php.exe -q C:\inetpub\wwwroot\cacti\poller.php - - - -Check log/cacti.log, data-source polling and graph updates. RRD files are -created for configured data sources; an installation without graphs need not -create them. Resolve permission and configuration errors before scheduling. - - -Open Task Scheduler and choose Create Task: - - -* Select the dedicated poller account and Run whether user is logged on or -not, with the account rights needed for batch logon. Do not enable -Run with highest privileges unless a documented local requirement needs -it. - - -* Add a daily trigger that repeats every 5 minutes indefinitely for the -default five-minute scheduler configuration. If changing Cacti's scheduler -interval, adjust this trigger to match it; the scheduler interval and data -source polling intervals are separate settings. - - -* Add a Start a program action with these separate fields: - - -* Program/script: C:\php\php.exe - -* Add arguments: -q "C:\inetpub\wwwroot\cacti\poller.php" - -* Start in: C:\inetpub\wwwroot\cacti - - - -* Under Settings, choose Do not start a new instance if the task is -already running. Review any task execution limit against the configured -polling cycle; do not terminate a healthy poller prematurely. - - - - -Run the task manually, then verify subsequent scheduled runs, Task Scheduler's -result/history, Cacti's poller statistics and graph freshness. Recheck these -under the task account after changing PHP, paths, credentials or ACLs. - - -References - - -* Cacti development (1.3) PHP dependency checks - -* Cacti development (1.3) installation permission checks - -* PHP Windows installation , IIS and -Apache - -* Microsoft FastCGI configuration and -application-pool identities - -* MySQL 8 removed features - -* Microsoft Task Scheduler - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Upgrading Cacti Under UNIX Compatible Operating Systems - - -Use only the supported operating systems and maintained -dependencies compatible with this Cacti branch. - - -This procedure covers a source installation upgrading to Cacti development -(1.3). For a -package-managed installation, use the package maintainer's upgrade procedure -and configuration-file handling. See the separate guides for -Windows and -FreeBSD . - - -Review the release notes and requirements first. -Schedule time to back up and restore the installation. Test the upgrade on an -isolated copy of the database and files before changing production. Keep -dependency upgrades separate unless a prerequisite requires them. - - -Stop writers before backing up - - -Turn off Data Collection Enabled under the poller settings. Also suspend -the actual scheduler on each affected collector: disable only the Cacti cron -entry, or stop its installed cactid service. Preserve the scheduler settings -so they can be restored later. Do not disable all system cron jobs. - - -Wait for existing poller, Spine, script-server, Boost and other background jobs -to finish. Prevent web requests and plugin jobs from changing the installation -during the backup and upgrade. The application polling switch alone does not -stop every running process or administrative writer. - - -If collectors use rrdcached, drain its pending writes using the procedure for -that deployment before taking the RRD snapshot. Keep writers stopped until the -database and file backups are both complete. Coordinate this on remote -collectors as well as the main server. - - -Back up the database and complete installation - - -Record the installed Cacti, Spine, PHP and database versions, installation -paths, service accounts, scheduler entries and remote-collector configuration. -Store backups outside the web root with access restricted to administrators. - - -Back up the Cacti database with a client compatible with the database server. -For example, with the application stopped and a backup account with the -required privileges: - - -umask 077 -BACKUP_DIR=/srv/backups/cacti-before-1.3-dev -mkdir "$BACKUP_DIR" -mysqldump --user=backup_user --password --lock-tables --quick \ - --routines --events --triggers cacti \ - > "$BACKUP_DIR/cacti.sql" - - - -Adjust the database name, account and paths before running these examples. Use -mariadb-dump instead of mysqldump where appropriate. Enter the password at -the prompt. Stop if a command fails; an output file alone does not prove a -successful dump. The account needs the privileges required by the installed -dump client, including table locks for the example above. - - ---single-transaction provides a consistent snapshot for transactional -tables; it does not make nontransactional tables consistent. Inspect the -actual storage engines and choose the backup method accordingly. Keep all -application writers stopped for the corresponding file snapshot. See the -database backup documentation for the option and privilege details. - - -Back up the complete installation, including the RRD files. For an example -installation at /var/www/html/cacti: - - -tar -czpf "$BACKUP_DIR/cacti-files.tar.gz" -C /var/www/html cacti -tar -tzf "$BACKUP_DIR/cacti-files.tar.gz" - - - -Preserve include/config.php, plugins, custom scripts, query resources and -other local configuration. Include CSRF secret material, including an alternate -$path_csrf_secret from the configuration. Back up separately any RRD, -configuration or resource paths outside the installation tree. A tar archive -normally preserves a symlink rather than including its external target. Retain -the permissions and ownership needed for restoration. - - -Save the database user/grant definitions and any connection certificates needed -to recreate access. These are not included in a dump of the Cacti database -alone. Include site or plugin SQL routines and events, as in the example, and -account for their additional backup privileges. - - -Back up remote-collector databases and local files where they hold state. -Verify dump completion and archive contents, then rehearse restoration on an -isolated system. Excluding *.rrd would leave monitoring history outside the -recovery set. - - -Check development dependencies - - -Development source requires PHP 8.3 or later in the PHP 8 series, with the -extensions declared by the selected revision. Install locked dependencies in -the staging directory with composer install --no-dev, then run composer check-platform-reqs --no-dev. Preserve this complete dependency tree when -deploying the staged application. Do not run composer update against a live -installation. A complete release bundle can already include dependencies; -verify its platform checks instead of assuming that every archive is complete. - - -Install the staged files - - -Obtain the intended development revision and stage it outside the live -installation. Record its commit and verify its provenance. If using a release -archive instead, follow that release's requirements and verification steps. -Keep the existing installation and its backup until the upgrade has been -checked. - - -Copy the contents of the prepared staging directory into the existing -installation, not the directory itself. For example: - - -STAGING_DIR=/var/tmp/cacti-1.3-dev -CACTI_DIR=/var/www/html/cacti -cp -a "$STAGING_DIR"/. "$CACTI_DIR"/ - - - -Confirm that the new files are directly under the installation root, such as -$CACTI_DIR/poller.php, rather than a nested cacti-1.3-dev directory. -Preserve the existing include/config.php and review new options in -include/config.php.dist. Reconcile local code changes and plugin -compatibility with the new files; copying the release is not a substitute for -reviewing those changes. - - -Check permissions using the accounts that actually run the web server, poller -and maintenance jobs. Those accounts need not be identical. Give the poller the -required access to RRD and log paths, and check configured cache, resource and -script paths. Preserve access needed by installation and package imports. Do -not make the entire application tree writable as a permissions workaround. - - -Run and verify the upgrade - - -Allow an administrator to open the Cacti URL and follow the database-upgrade -workflow. Review errors before proceeding. The release also provides -cli/upgrade_database.php; consult its --help output if using the CLI -workflow. Do not manually advance the database version or force a starting -version merely to bypass an upgrade check. - - -Confirm the installed version, database-upgrade result, credentials, paths, -plugin state and collector configuration. Check remote collectors individually -and follow the applicable synchronization procedure; do not assume that two -polling cycles prove their files and databases have upgraded successfully. - - -Restore web access and the saved scheduler configuration only after the upgrade -checks succeed, then re-enable collection. Use either the configured cron path -or the daemon for a collector, not both. Verify logs, data freshness and -representative RRD updates after normal polling resumes. - - -Recovery - - -If the upgrade fails, keep writers stopped while deciding whether to retry or -restore. Replacing PHP files alone does not undo a database migration. Restore -the matching pre-upgrade database, application files, RRD data and external -configuration or secret material, including affected remote-collector state. -Verify the restored installation before re-enabling its schedulers. Restoring -an earlier backup discards changes collected after that backup. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Upgrading Cacti under Windows - - -Use only the supported operating systems and maintained -dependencies compatible with this Cacti branch. - - -These instructions cover upgrading a source/archive installation to Cacti -1.3-dev. For a managed Windows installation, also follow its package or -installer upgrade procedure; do not overwrite package-managed files with an -unrelated archive. Review the release -notes and requirements -for the target Cacti version first. An upgrade of Cacti does not automatically -require upgrading Windows, PHP or the database. - - -The current source manifest requires ext-pcntl and ext-posix, which native -Windows PHP cannot provide. Read the Windows installation -prerequisite -before scheduling downtime. Stop if the selected artifact rejects Windows. - - -Check development dependencies - - -Development source requires PHP 8.3 or later in the PHP 8 series, with the -extensions declared by the selected revision. Install locked dependencies in -the staging directory with composer install --no-dev, then run composer check-platform-reqs --no-dev. Preserve this complete dependency tree when -deploying the staged application. Do not run composer update against a live -installation. A complete release bundle can already include dependencies; -verify its platform checks instead of assuming that every archive is complete. - - -Pause collection and take a recoverable backup - - -* In Console > Configuration > Settings > Poller, clear Data Collection -Enabled and save. Disable the actual Windows Scheduled Task that launches -poller.php, or stop the service that manages your poller. Record the task -or service settings so you can restore them. Use Task Scheduler to -disable future starts; this alone does not finish an already running poll. - - -* Wait for running pollers, Spine processes, script servers and background -writers to finish. Include remote collectors and plugin jobs. Restrict web -access to the upgrade administrator so configuration changes cannot race the -backup. Flush pending RRD-cache writes before copying RRD files and confirm -that writers have stopped. Do not start a manual poll during this -maintenance window. - - -* Create a protected backup directory outside the web root. From Command -Prompt, use the dump utility matching your database server. Replace the -executable path, account, database name and output path in this example. Use -the actual database host, port and TLS options for your installation. The -account needs the backup privileges required by the installed server; ---password prompts rather than putting a password in the command. - - -"C:\path\to\mysqldump.exe" --user=YOUR_BACKUP_USER --password ^ - --lock-tables --quick --routines --events --triggers ^ - --databases cacti --result-file="D:\CactiBackup\cacti-YYYYMMDD.sql" - - - -With all Cacti writers paused, this dump example uses table locks to -cover transactional and nontransactional tables in the Cacti database. A -transaction-only dump does not protect nontransactional tables. Use a new -output filename and verify successful completion: a failed dump may leave a -partial file. Do not proceed until the backup can be restored in a separate -test environment. - - -* Back up the existing Cacti tree, including hidden files, using a separate -destination outside the web root. For example, Robocopy can -preserve file permissions as well as contents when run with the required -privileges: - - -robocopy "C:\inetpub\wwwroot\cacti" "D:\CactiBackup\cacti-YYYYMMDD" /E /COPYALL /SL /XJ /R:2 /W:2 - - - -Inspect its report; exit codes of 8 or greater indicate copy failures. -Confirm that the backup includes include/config.php, RRDs, custom scripts, -query resources, plugins and secret files, including any alternate -path_csrf_secret. Also save configured paths outside this tree, the Spine -configuration, scheduler settings, web-server configuration, database grants -and required certificates/keys. Record symbolic links and junctions and back -up their external targets separately; the example copies symbolic links and -excludes junctions. Preserve permissions and record the installed versions. -Keep this file backup and database dump together as one recovery set. - - - - -Install and verify the upgrade - - -* Extract the target Cacti release into a staging directory. Keep -the existing tree and verified backup available. Deploy the release files -using your existing installation layout, preserving the working -include/config.php and local resources. Compare the new -include/config.php.dist for changes; do not replace existing credentials, -collector IDs, paths or secrets with example defaults. Check plugin and -custom-script compatibility before restoring or enabling them. - - -* Verify file permissions for the web server and poller accounts. Open the -existing Cacti URL as an administrator and complete the database upgrade. -Review installer checks and logs. Use version-appropriate database settings -from Requirements , rather than applying fixed global SQL -tuning commands. - - -* For remote collectors, keep their schedulers paused while updating their -local application files and configuration and completing the applicable -upgrade and synchronization. Verify each collector's reported version, -connectivity and logs; completion is not guaranteed after two poll cycles. -Check the matching Spine version where it is used. - - -* Re-enable Data Collection Enabled and restore the recorded scheduler or -service only after the upgrade succeeds. Check a complete poll cycle, -collector status, new RRD samples and representative graphs. If recovery is -necessary, stop writers again and restore the matching application files, -database, RRDs and configuration together; copying old PHP files over an -upgraded database is not a rollback. - - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Upgrading Cacti Under FreeBSD - - -Use only the supported operating systems and maintained -dependencies compatible with this Cacti branch. - - -These instructions cover the FreeBSD upgrade procedure. This manual describes -Cacti development (1.3), while the FreeBSD port currently supplies Cacti 1.2.31. -Use the 1.2.x manual for release-specific requirements when -upgrading the packaged release. Determine whether Cacti is maintained by -pkg, by ports or from a source archive. Keep that installation -method for the upgrade; do not overlay an archive onto package-managed files. -Review the target Cacti release notes , -requirements and package or port notes before proceeding. Do -not make an unrelated operating-system, PHP or database major-version upgrade -part of this procedure without a separate compatibility plan. - - -Pause collection and back up - - -* Clear Data Collection Enabled under `Console > Configuration > Settings - - - - - -Poller`. Disable the Cacti-specific cron entry or stop its configured -poller service on every collector. Record what you change; do not stop the -system-wide cron service merely to pause Cacti. Wait for pollers, Spine, -script servers and other background writers to finish. Restrict web access -to the upgrade administrator and pause plugin jobs that write to Cacti. -Flush pending RRD-cache writes and confirm that the database and RRD files -remain unchanged before taking the backup. - - - -* Use the dump client appropriate to the installed MySQL or MariaDB server. -The following example requires an existing, protected backup directory and a -database account with the server's required backup privileges. Replace the -account, database name and filename for your installation. Use its actual -database host, port and TLS options. - - -mysqldump --user=YOUR_BACKUP_USER --password \ - --lock-tables --quick --routines --events --triggers \ - --databases cacti --result-file=/protected/backup/cacti-YYYYMMDD.sql - - - -The password is prompted. With all Cacti writers paused, this dump -method uses table locks for the Cacti database, including -nontransactional tables. A transaction-only dump does not cover those -tables. Verify the command succeeded and test restoring the dump separately; -a nonempty file alone is not proof of a complete backup. Use a new filename -rather than overwriting a known good backup. - - -* Back up the Cacti application files, RRDs and local configuration together -with the database dump. Preserve ownership, permissions and hidden files. -Include include/config.php, custom scripts, query resources, plugins, -secret files, including any alternate path_csrf_secret, and configured -paths outside the application tree. Record symbolic links and back up their -targets separately. Also record the Spine configuration, cron/service -settings, web-server settings, database grants, certificates/keys and -installed versions. Package layouts may keep configuration and data outside -/usr/local/share/cacti; inspect the installed paths rather than backing up -that directory alone. Include /var/db/cacti/rra and /var/log/cacti -when those are the configured package paths, and protect the backup directory -from other users because the configuration contains credentials. - - - - -Upgrade using the existing installation method - - -For a binary package installation, review the proposed package transaction -before applying it. The FreeBSD Handbook describes package -upgrades. Run the following with appropriate administrator privileges: - - -Discover the installed flavor first: - - -pkg info -o -x '^cacti' -pkg update - - - -For an installed cacti-php84 package, for example: - - -pkg upgrade -n cacti-php84 -pkg upgrade cacti-php84 -pkg info -D cacti-php84 - - - -Replace cacti-php84 with the installed package name. Keep the PHP flavor -unless a separate migration is intended. If Spine is installed, review its -upgrade and verify its version remains compatible with Cacti. See the -FreeBSD installation section for package paths and the -net-mgmt/cacti-spine port. - - -Check the proposed version and dependency changes before accepting the actual -upgrade. A package repository normally supplies a release rather than -development source. Stop if that is not your approved target and select an -appropriate repository or installation method. Do not delete Cacti first or -assume that upgrading one package cannot affect its dependencies. - - -For a ports-managed installation, follow the handbook's ports upgrade -procedure and applicable /usr/ports/UPDATING entries. Use the -existing ports management method; do not switch between ports and binary -packages without reviewing their options and dependencies. A source -installation instead follows Upgrading Cacti . - - -Preserve the working configuration and merge required changes from the new -configuration example. Keep existing database credentials, collector IDs, paths -and secrets. Review package-generated configuration changes and restore local -resources only after checking compatibility. Recreate cache or data directories -only where the installed configuration requires them, with access for the -actual service account; do not assume a universal account or apply recursive -ownership changes to the whole installation. - - -Check development dependencies - - -Development source requires PHP 8.3 or later in the PHP 8 series, with the -extensions declared by the selected revision. Install locked dependencies in -the staging directory with composer install --no-dev, then run composer check-platform-reqs --no-dev. Preserve this complete dependency tree when -deploying the staged application. Do not run composer update against a live -installation. A complete release bundle can already include dependencies; -verify its platform checks instead of assuming that every archive is complete. - - -Complete the application upgrade - - -Open the existing Cacti URL as an administrator and complete its database -upgrade. Review the installer and logs before resuming collection. Upgrade -remote collectors' local files and configuration through their installation -method, complete the applicable upgrade/synchronization, and verify their -versions, connectivity and logs. Do not rely on a fixed number of poll cycles -for completion. Check the matching Spine version on collectors using Spine. - - -After successful checks, re-enable Data Collection Enabled and restore the -recorded Cacti cron entry or service. Verify a complete poll cycle, recent RRD -samples and representative graphs on every collector. If recovery is needed, -stop all writers again and restore the matching files, database, RRDs and -configuration as one set; restoring old application files alone does not undo a -database upgrade. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Hardening a Cacti Installation - - -This page covers OS-level hardening controls for a production Cacti host. -The goal is defense in depth: even if a vulnerability in Cacti's PHP code -is exploited, the attacker's reach should be limited. - - -Why These Controls Matter - - -A recurring class of vulnerability in Cacti involves writing an arbitrary -file into the resource/ or scripts/ tree and then reaching that file -over the web. The package-import advisory (GHSA-7cmj-g5qc-pj88, CVE-2024-25641) is a -concrete example: a crafted package archive could write resource/test.php -and execute it as a web request. The controls below close or limit that -path at the OS and web-server layers, independent of the PHP fix. - - - - -1. File Permissions - - -Cacti writes to three paths at runtime. Everything else should be owned -by root (or a non-web user) and not writable by the web process. - - - - - - Path - Purpose - Recommended mode - - - - - - - rra/ - RRDtool data files - www-data:www-data 750 - - - - - log/ - Cacti log files - www-data:www-data 750 - - - - - cache/ - Boost / poller cache - www-data:www-data 750 - - - - - resource/ - XML templates - root:root 755 (read-only for web) - - - - - scripts/ - Data-source scripts - root:root 755 (read-only for web) - - - - - lib/, include/ - PHP libraries - root:root 755 - - - - - -Apply once after installation: - - -# Writable paths (web user only) -chown -R www-data:www-data /var/www/html/cacti/rra \ - /var/www/html/cacti/log \ - /var/www/html/cacti/cache -chmod -R 750 /var/www/html/cacti/rra \ - /var/www/html/cacti/log \ - /var/www/html/cacti/cache - -# Everything else read-only for the web user -chown -R root:root /var/www/html/cacti -chmod -R 755 /var/www/html/cacti -# Re-apply writable exceptions after the recursive chmod -chown -R www-data:www-data /var/www/html/cacti/rra \ - /var/www/html/cacti/log \ - /var/www/html/cacti/cache - -# Protect the database credentials in config.php. The recursive 755 above -# leaves it world-readable; restrict it to root and the web user. -chown root:www-data /var/www/html/cacti/include/config.php -chmod 640 /var/www/html/cacti/include/config.php - - - - - - -Note: The scripts/ and resource/ paths may be written during -template import or package import by a privileged CLI process running -as root, not by the web process. If your workflow requires the web -process to write there, use a strict code-review policy for any import -and consider the compat profile instead. - - - - - -2. Web Server — Block Direct Access to Scripts and Resources - - -PHP files inside scripts/ and resource/ must not be reachable via HTTP. -These directories hold data-source scripts and XML templates; a web request -to a .php file written there is the direct exploitation path. - - -Apache - - - is only valid in server config or context, -not .htaccess. Add this inside your Cacti : - - -# Deny direct HTTP access to the script and resource trees. -# A PHP file written here via import cannot be reached over the web. - - - Require all denied - - - - - -If you only have access to .htaccess (e.g. shared hosting), use a -FilesMatch block inside each directory instead: - - -# scripts/.htaccess and resource/.htaccess - - Require all denied - - - - -Or, more broadly, deny all non-XML/non-script files from direct access: - - - - Require all denied - - - - - Require all denied - - - - - -Nginx - - -Add inside your server {} block: - - -# Block PHP execution in scripts/ and resource/ -location ~ ^/cacti/(scripts|resource)/.*\.php$ { - return 403; -} - - - - - -3. PHP-FPM Pool Hardening - - -PHP itself warns that php-fpm pools are not a true security boundary, but -they provide useful knobs. Create a dedicated pool for Cacti -(/etc/php/8.x/fpm/pool.d/cacti.conf): - - -[cacti] -user = www-data -group = www-data - -listen = /run/php/php-cacti.sock -listen.owner = www-data -listen.group = www-data - -; Drop all inherited environment variables — pass only what Cacti needs. -clear_env = yes - -; Only execute .php files — blocks .phtml, .php3, .phar, etc. -security.limit_extensions = .php - -; Disable dangerous functions at the pool level (not overridable by ini_set). -; Cacti's web process shells out to RRDtool, fping and helper binaries via -; exec, shell_exec, system, popen and proc_open (see lib/rrd.php, lib/ping.php, -; lib/spikekill.php), so disabling those breaks graph rendering and diagnostics. -; Only passthru and pcntl_exec are unused by the web tier and safe to disable. -; For tighter control, constrain the process with open_basedir and a hardened -; PATH rather than removing the shell-exec family Cacti depends on. -php_admin_value[disable_functions] = passthru,pcntl_exec - -; Restrict file operations to the Cacti tree. -; NOTE: open_basedir disables the PHP realpath cache. Measure the -; performance impact before enabling in production. It is an extra -; safety net, not a full security boundary (PHP documentation). -; php_admin_value[open_basedir] = /var/www/html/cacti:/tmp - -; Suppress PHP version disclosure. -php_admin_flag[expose_php] = Off - - - -Reload php-fpm after changes: - - -systemctl reload php8.x-fpm # Debian/Ubuntu -systemctl reload php-fpm # RHEL/Rocky/Alma - - - - - -4. SELinux (RHEL / AlmaLinux / Rocky Linux) - - -SELinux ships enforcing on RHEL-family systems. These commands apply -the correct file contexts so Apache can serve Cacti while limiting what -the web process can write. - - -File Contexts - - -CACTI=/var/www/html/cacti - -# Read-only web content (Apache can read, not write) -semanage fcontext -a -t httpd_sys_content_t "${CACTI}(/.*)?" -semanage fcontext -a -t httpd_sys_content_t "${CACTI}/scripts(/.*)?" -semanage fcontext -a -t httpd_sys_content_t "${CACTI}/resource(/.*)?" - -# Read-write content for runtime paths only -semanage fcontext -a -t httpd_sys_rw_content_t "${CACTI}/rra(/.*)?" -semanage fcontext -a -t httpd_sys_rw_content_t "${CACTI}/log(/.*)?" -semanage fcontext -a -t httpd_sys_rw_content_t "${CACTI}/cache(/.*)?" - -# Apply the contexts -restorecon -Rv "${CACTI}" - - - -Database Network Access - - -If your database server is reached over TCP (not a local Unix socket), -enable the SELinux boolean that permits it: - - -setsebool -P httpd_can_network_connect_db on - - - -Poller Systemd Drop-in - - -The Cacti spine poller runs as a separate daemon and may need to connect -outward for SNMP. Do not force it into the httpd_t domain: that confines -spine to Apache's policy rather than freeing it, and outbound access in -httpd_t is still gated by booleans. If SNMP polling is blocked by SELinux, -enable the relevant boolean instead and leave the daemon in its own domain: - - -setsebool -P httpd_can_network_connect on - - - -Run systemctl daemon-reload && systemctl restart cactid after changes. - - - - - -Verify: After applying contexts, confirm Apache can still serve pages -and the poller can poll. Use audit2why on any AVC denials in -/var/log/audit/audit.log. - - - - - -5. AppArmor (Debian / Ubuntu) - - -Ubuntu Server ships AppArmor enforcing by default. Create a profile for -the Cacti php-fpm pool at /etc/apparmor.d/cacti-fpm: - - -#include - -profile cacti-fpm /usr/sbin/php-fpm* { - #include - #include - #include - - # Cacti tree — read-only by default - /var/www/html/cacti/ r, - /var/www/html/cacti/** r, - - # Allow execution of Cacti PHP files - /var/www/html/cacti/*.php r, - /var/www/html/cacti/**/*.php r, - - # Runtime write paths - /var/www/html/cacti/rra/** rw, - /var/www/html/cacti/log/** rw, - /var/www/html/cacti/cache/** rw, - - # Helper binaries Cacti shells out to. AppArmor is default-deny once - # file rules are present, so these need explicit execute (ix) or graphs - # and polling break under enforce mode. - /usr/bin/rrdtool ix, - /usr/bin/fping ix, - /usr/bin/ping ix, - /usr/bin/snmpget ix, - /usr/bin/snmpbulkwalk ix, - /usr/bin/php ix, - - # Temp files - /tmp/** rw, - /var/tmp/** rw, - - # Deny write to scripts/ and resource/ - deny /var/www/html/cacti/scripts/** w, - deny /var/www/html/cacti/resource/** w, -} - - - -Load and enforce the profile: - - -apparmor_parser -r /etc/apparmor.d/cacti-fpm -aa-enforce /etc/apparmor.d/cacti-fpm - - - -Attach the Profile to the php-fpm Service - - -Add a drop-in at /etc/systemd/system/php8.x-fpm.service.d/apparmor.conf: - - -[Service] -AppArmorProfile=cacti-fpm - - - -Reload and restart: - - -systemctl daemon-reload -systemctl restart php8.x-fpm - - - -Use complain mode (aa-complain) first to test without blocking, then -switch to enforce once logs show no legitimate denials: - - -# Test mode -aa-complain /etc/apparmor.d/cacti-fpm - -# Enforce when ready -aa-enforce /etc/apparmor.d/cacti-fpm - - - - - -6. Verification Checklist - - -After applying all controls, confirm: - - -* [ ] curl -s http://localhost/cacti/scripts/ss_webseer.php returns 403 - -* [ ] curl -s http://localhost/cacti/resource/ returns 403 for any .php inside - -* [ ] The Cacti web UI loads and graphs render (rra/ is writable) - -* [ ] The poller runs without errors (tail -f /var/www/html/cacti/log/cacti.log) - -* [ ] On RHEL: no AVC denials in ausearch -m avc -ts recent - -* [ ] On Debian/Ubuntu: no AppArmor denials in journalctl -k | grep apparmor - - - - - -See Also - - -* Installing Under Ubuntu/Debian - -* Installing Under Enterprise Linux (LAMP) - -* Standards Security - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Configuring SSL for Cacti - - -Enabling HTTPS for Cacti is done at the web server level. This page covers -self-signed certificates for internal use and Let's Encrypt for public-facing -servers. - - - - - -Note: If using multiple Data Collectors, all must have HTTPS enabled for -the remote polling feature to work correctly. - - - -Self-Signed Certificate (Internal Use) - - -Self-signed certificates are suitable for internal networks where you control -the clients. Use ECDSA (secp384r1) for best performance, or RSA 4096 if your -environment requires RSA. - - -ECDSA (recommended) - - -# RHEL/Rocky/AlmaLinux -dnf install -y mod_ssl - -# Generate a 384-bit EC private key and self-signed certificate (valid 3 years) -openssl req -x509 -nodes -newkey ec -pkeyopt ec_paramgen_curve:P-384 \ - -keyout /etc/pki/tls/private/cacti.key \ - -out /etc/pki/tls/certs/cacti.crt \ - -days 1095 \ - -subj "/CN=cacti.example.com" \ - -addext "subjectAltName=DNS:cacti.example.com" - -chmod 600 /etc/pki/tls/private/cacti.key - - - -RSA (alternative) - - -# 4096-bit RSA — use when EC is not supported by your TLS client pool -openssl req -x509 -nodes -newkey rsa:4096 \ - -keyout /etc/pki/tls/private/cacti.key \ - -out /etc/pki/tls/certs/cacti.crt \ - -days 1095 \ - -subj "/CN=cacti.example.com" \ - -addext "subjectAltName=DNS:cacti.example.com" - -chmod 600 /etc/pki/tls/private/cacti.key - - - - - - -Debian/Ubuntu paths: the commands above use the RHEL layout -(/etc/pki/tls/...). On Debian/Ubuntu, write the key and certificate to -/etc/ssl/private/cacti.key and /etc/ssl/certs/cacti.crt instead, to match -the Apache SSLCertificateKeyFile/SSLCertificateFile paths shown below. - - - - - - -Key size: RSA 2048-bit is below NIST SP 800-131A Rev 2 guidance for -long-term use. Use 4096-bit RSA or an ECDSA key. - - - -Apache Configuration - - -Update /etc/httpd/conf.d/ssl.conf (RHEL/Rocky/AlmaLinux) or -/etc/apache2/sites-available/cacti-ssl.conf (Debian/Ubuntu): - - - - ServerName cacti.example.com - DocumentRoot /var/www/html/cacti - - SSLEngine on - # RHEL/Rocky/AlmaLinux cert paths: - # SSLCertificateFile /etc/pki/tls/certs/cacti.crt - # SSLCertificateKeyFile /etc/pki/tls/private/cacti.key - # Debian/Ubuntu cert paths: - SSLCertificateFile /etc/ssl/certs/cacti.crt - SSLCertificateKeyFile /etc/ssl/private/cacti.key - - # Require TLS 1.2 or 1.3; TLS 1.0 and 1.1 are prohibited (RFC 8996) - SSLProtocol -all +TLSv1.2 +TLSv1.3 - - # TLS 1.2 cipher suites -- no RC4, 3DES, or export ciphers - SSLCipherSuite ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:\ -ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:\ -ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305 - SSLHonorCipherOrder on - - # TLS 1.3 cipher suites (SSLCipherSuite does not apply to TLS 1.3) - SSLOpenSSLConfCmd Ciphersuites TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256 - - -# Optional: redirect HTTP to HTTPS (uncomment to enable) -# -# ServerName cacti.example.com -# Redirect permanent / https://cacti.example.com/ -# - - - -Restart Apache after editing: - - -apachectl configtest -systemctl restart httpd # RHEL/Rocky/AlmaLinux -systemctl restart apache2 # Debian/Ubuntu - - - -Let's Encrypt (Public-Facing Servers) - - -For servers reachable from the internet, use Let's Encrypt for a -browser-trusted certificate at no cost. - - -RHEL/Rocky/AlmaLinux - - -# certbot ships in EPEL on RHEL/Rocky/AlmaLinux, not in BaseOS/AppStream -dnf install -y epel-release -dnf install -y certbot python3-certbot-apache -certbot --apache -d cacti.example.com - - - -Debian/Ubuntu - - -apt-get install -y certbot python3-certbot-apache -certbot --apache -d cacti.example.com - - - -Certbot configures Apache and sets up automatic renewal. Verify auto-renewal -works: - - -certbot renew --dry-run - - - -Verifying the Configuration - - -After restarting Apache, confirm TLS is working and that weak protocols are -disabled: - - -# Check the certificate and protocol support -openssl s_client -connect cacti.example.com:443 -tls1_2 < /dev/null -openssl s_client -connect cacti.example.com:443 -tls1 < /dev/null # should fail - - - -For a comprehensive scan, use SSL Labs on -public servers or testssl.sh on internal hosts: - - -# testssl.sh (download from https://testssl.sh/) -./testssl.sh cacti.example.com - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Version Specific Release Notes - - -Summary - - -Below you will find the release note for all versions of Cacti 1.0.0 and above. -Release notes for earlier Cacti versions have been excluded due to the large -list of changes that have occurred over the years, and since Cacti 0.8.x is no -longer supported, it's a good time to for the purposes of this document, move -them aside. - - -Before that list, let's talks about Cacti 1.0.0 first. - - -Cacti 1.0.0 - - -This was the initial release of Cacti 1.x. With the release of Cacti 1.0.0 many -improvements and enhancements have been made. As part of ongoing efforts to -improve Cacti almost 20 plugins were merged into the core of Cacti eliminating -the need for the plugins. A major refresh of the interface has been started and -will continue to occur as development on Cacti continues. - - -Plugins integrated into Cacti Core - - -The following plugins have been merged into the core Cacti code as of version -1.0.0: - - - - - - Plugin - Description - - - - - - - snmpagent - An SNMP Agent extension, trap and notification generator - - - - - clog - Log viewers for administrators - - - - - settings - Core plugin providing email and DNS services - - - - - boost - Large system performance boost plugin - - - - - dsstats - Cacti data source statistics - - - - - watermark - Watermark graphs - - - - - ssl - Force https connection - - - - - ugroup - User groups support - - - - - domains - Multiple authentication domains - - - - - jqueryskin - User interface skinning - - - - - secpass - C3 level password and site security - - - - - logrotate - Log management - - - - - realtime - Realtime graphing - - - - - rrdclean - RRDfile maintenance - - - - - nectar - Email based graph reporting - - - - - aggregate - Templating, creation and management of aggregate graphs - - - - - autom8 - Graph and Tree creation automation - - - - - discovery - Network Discovery and Device automation - - - - - spikekill - Removes spikes from Graphs - - - - - superlinks - Allows administrators to links to additional sites - - - - - -ChangeLog for All Cacti 1.x Releases - - -The following shows the naming convention used for issues and features listed in the CHANGELOG for both cacti and it's plugins - - - - - - Category - Description - - - - - - - issue[issue#] - Normal issues either experienced by a Developer or logged in GitHub and fixed - - - - - feature[issue#] - Features either implemented or logged in GitHub and addressed - - - - - security[issue#] - Security vulnerability either fixed or logged in GitHub and addressed - - - - - bug[bug#] - Feature of Bug reported in the old Cacti Mantis system that was addressed. - - - - - -Below are a few examples of the version, type and description that can be found in the CHANGELOG - - - - - - Version - Feature/Bug - Description - - - - - - - 1.2.17 - issue#3981 - PHP ERROR: Call to undefined function api_data_source_cache_crc_update() - - - - - 1.2.17 - feature#4013 - Remote Poller - reset avg/max polling time - - - - - 1.2.16 - issue#3704 - When generating a report, the Cascade to Branches function does not as expected - - - - - 1.2.16 - issue#3859 - When viewing graphs, automatic refresh so not always work as expected - - - - - 1.2.16 - feature - Update Chart.js to version 2.9.4 - - - - - 1.2.16 - feature#3923 - Add ability to hide the Graph Drilldown icons by datatecuk - - - - - 1.2.16 - feature#3943 - Add hooks for plugins to show custom Graph Source and custom Template URL (List View) - - - - - 1.2.13 - security#3628 - Lack of escaping on template import can lead to XSS exposure - - - - - 1.2.13 - issue#3517 - When generating reports, function looping can occur resulting in 100% cpu usage - - - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Navigating the Cacti User Interface - - -Menu names and available tabs depend on your Cacti version, permissions, -theme, and installed plugins. The screenshots illustrate navigation and may -show an earlier theme or release. - - -The Cacti User Interface is visually broken into multiple panels. Each major -panel is designed to hold content. Depending on the Cacti Theme you use -some of these panel may not be visible at the Theme Developers discretion. The -common panels are: - - -* Top Tabs - Where you perform major navigation separate content - -* Navigation Area - If the content in navigated to by the Top Tab has a -menu, -it will be found here. - -* Breadcrumb Bar - This is where you can see where in the Cacti interface -you -are currently pointed to - -* Content Area - This is where you present tables, charts, forms, etc. It -is -where your main Content resides - -* Footer - This section is left for Theme Developers to insert content -that belongs at the bottom of the screen. - - - -You can see the default Cacti layout with its various panels in the image below. -You will note, in this Modern Theme, the Theme Author has decided to dispense -with the Footer. - - -[Image: Cacti Layout] - - -In Cacti, when you click on the Top Tab, you will by default enter a -completely different section of Cacti. Cacti's Top Tabs are designed -to mimic browser tabs, this helps with users orienting themselves to the -various sections of Cacti. When you have many Plugins installed as -in the example above, you can see clearly the benefit of these -navigation aids. - - -Inside each of these panels, a page can be broken into sub-panels. Two -panels customarily broken into sub-panels include the Navigation Area -and the Content Area. - - -In the example below, we show the Device page in Cacti calling out the -various sub-panels. - - -[Image: Cacti Layout Subpanels] - - -Most of Cacti's pages are laid out in this fashion. However, what goes into -the Cacti Content Area is completely under the Plugin authors -control. - - -At the Theme developers discretion, all pages should include both the Top -Tab -and Breadcrumb Bar. Inside of the Breadcrumb Bar or Top Tab panels -you should always see the User Profile and Menu on the right. - - -To use Cacti properly, you should first understand these sections. We will -start by describing the Cacti Console. - - -Cacti Core Panels and Sub-Panels - - -* Top Tabs - - -Cacti Top Tabs provide Cacti with multiple Navigation Areas. By -default, Cacti includes four Top Tabs. They are Console, Graphs, -Log and Reports. - - -* Breadcrumbs - - -Breadcrumbs appear directly below the Top Tabs. Note that some Cacti -Themes disable the Breadcrumbs. You can click on a Breadcrumb area -to navigate to that area if desired. - - -* Cacti Content Area - - -This is where the main page content will be displayed. It is directly below -the Breadcrumbs or the Top Tabs with some Cacti Themes. They can -include any HTML that the Plugin Author or Cacti Administrator desires in -the case of External Links. - - -* Navigation Menu - - -If you click on the Cacti Console, you will see an example Navigation -Menu. These menus can appear on any Plugin based Top Tab page in -addition to the Cacti Console. - - -* Cacti Tables - - -These tables are where table based data is rendered in Cacti. Cacti -Tables are presented using an arcane, though easy to use API. - - -* Table Filters - - -Any Cacti Table can include a Table Filters. These filters can be -used to limit the data returned to a Cacti Table. - - -* Actions Dropdown - - -Any page that includes a Cacti Table will generally include an Actions -Dropdown. These Actions Dropdown menus allow you to take action on a -table row or rows. - - -* User Profile and Menu - - -This is where a Cacti User can edit their profile, change their password, -logout, or find links to other Cacti information and support. - - - - -Non-Administrative users, such as the Cacti Guest account should not have -access to the Cacti Console. The Cacti Guest account should additionally -not have access to their User Profile as that account is shared with -many users. - - -The Cacti Graphs Top Tab - - -The Cacti Graphs Top Tab is where most Cacti Graphs are viewed. By -default, the Cacti Graphs Top Tab includes three distinct views. They -include: - - -* Tree View - - -Allows Cacti Users to view Graphs in the form of hierarchical Trees. -These Trees are generally constructed by the Cacti Administrator and are -controlled either at the User or User Group level. - - -* Preview View - - -The Preview View provides a view of all Graphs that a Cacti User has -access to. Table Filters are provided to constrain the list of Graphs -returned to the page. - - -* List View - - -The List View allows the Cacti user to Create their own Preview Page -by allowing them to select graphs from various pages, and then finally view -those pages from the Preview View. - - - - -In the example Tree View page below, you can see the Tree Navigation -Area to the left, and in the Cacti Content Area, you can see the -Graphs and a Table Filter area for constraining the list of Graphs -returned. You can Search the Tree View from the Search area above the -Tree Navigation Area. - - -[Image: Cacti Tree View Page] - - -The Cacti Console - - -In the image below, you can see a basic Cacti Console menu area. It is divided -into separate sub-menus. We will describe the purpose of each next. - - -[Image: Cacti Console] - - -* Main Console - This sub-menu pick is fairly benign. It provides -an open area. This screen feels like it needs more content if it's -the Main Console. Fortunately, Plugin developers have solved -this problem. The intropage plugin for example can fulfill that need. - -* Create - This sub-menu allows you to create both Devices and -Graphs. They are essentially shortcuts to other sub-menu picks. - -* Management - This is where all core Cacti Site, Graph, -Device, Tree, Data Source, and Aggregate non-templated -objects reside. When you install Cacti Plugins, you will find -they extend this sub-menu. - -* Data Collection - This is where you define rules for Data Collection -Examples include: Data Collectors, Data Input Methods and -Data Queries - -* Templates - This is where you find all of Cacti's various Templates -outside of Automation. By default, You will find Templates for -Graphs, Data Sources, Devices, Aggregates, and Colors. - -* Automation - This sub-menu is where you find rules for automating -Device Discovery, and Rules for creating Devices, Graphs, -and Trees. - -* Presets - This area contains meta objects that cross Template -boundaries and are Global in nature. They include; Data Source Profiles, -CDEFs, VDEFs, GPrint Presets, and Colors - -* Import Export - This is how you can import and export various Cacti -Template objects. - -* Configuration - This is where you manage Users, User Groups, -Login Providers, Global Settings, and Plugins on the development -branch. Cacti 1.2 has User Domains instead. - -* Utilities - This is where Cacti includes common utilities that can be use -in the Web Portal without having to goto the Command line. - -* Troubleshooting - There are some handy utilities here that help -diagnose common problems with Cacti. - - - -All of these objects types will be explained in subsequent sections of the -Cacti documentation. For now, it's important just to know that these pages -exist. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Themes and Plugin Appearance - - -Cacti themes control the appearance of navigation, tables, forms, and dialogs. -Installed plugins can add their own styles, so check both the theme and the -plugin when investigating a display problem. - - -[Image: Cacti inventory with synthetic monitoring data] - - -This development browser fixture contains synthetic device measurements. -It illustrates the Cacti theme; it does not show a live monitoring system. - - -Choose a Theme - - -Administrators choose the default Theme in -Visual Settings . -Users can choose Theme in their personal settings when those settings -are available. A personal selection takes precedence over the global default. -Theme names and available options depend on the installed Cacti version. - - -The development theme set includes Cacti, Carrot, Dark, Deepness, Hollyberry, -Midwinter, Modern, Paper Plane, Paw, Raspberry, and Sunrise. Midwinter has light -and dark palettes. Additional themes installed by an RTM distribution belong -to that distribution and can have different compatibility requirements. - - -Check Plugin Appearance - - -Confirm that the plugin supports your Cacti version before -comparing appearances. Some plugins provide a stylesheet for each theme; -others use shared Cacti styles or their own color palette. A theme change can -therefore affect a plugin's titlebars, links, row selection, or status labels. - - -[Image: Synthetic Syslog interface alerts] - - -The Syslog example uses the development Carrot theme and synthetic alerts. -Plugin versions and fixture revisions are recorded with the development tests. -See Development and Testing -for validation scope and browser evidence. - - -Report a Display Problem - - -Include the following in a bug report : - - -* Cacti version, theme, and palette. - -* Plugin name and version, if the problem appears in a plugin. - -* Browser version and window size, including whether the issue is on mobile. - -* The affected page and steps that reproduce the problem. - -* A populated screenshot with sensitive device names and addresses removed, -or a synthetic example that reproduces the issue. - - - -Check resting, hovered, focused, and selected states where applicable. -Distinguish a missing value from text whose color blends into its background. -Use data source debugging when the underlying monitoring -measurements are missing. Check Known Issues for reports. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Principles of Operation - - -Cacti collects measurements, stores them in Round Robin Database (RRD) files, -and uses RRDtool to render graphs. A MySQL or MariaDB database holds device -configuration, templates, permissions, polling state, and intermediate results. -RRD files hold the time-series measurements. - - -Devices and sites - - -A Device represents something Cacti monitors, such as a server, -switch, sensor, or service. Its configuration identifies the responsible data -collector, address, availability checks, and SNMP settings where needed. -Site assignments organize devices by location; they do not create -separate database or security boundaries. - - -Device Templates associate graph templates and data -queries with a device. Automation can discover devices -and apply rules for creating devices, graphs, and tree entries. - - -Data collectors and scheduling - - -The main Data Collector runs on the central Cacti system. -Remote collectors poll devices closer to their location and exchange -configuration and results with the main system. During a loss of connectivity, -a configured remote collector can retain results locally for later delivery. -This does not replace backups or provide automatic failover of the main server. - - -An operating-system scheduler or the Cacti daemon starts poller.php. -It coordinates collection and launches the configured engine: the PHP -cmd.php poller or the C-based Spine poller. The scheduler -interval, -poller interval, and data-source profiles must agree; changing cron alone does -not change an existing RRD file's sampling interval. - - -Data retrieval - - -Cacti uses SNMP, external scripts, and resident PHP script-server functions. -The available SNMP algorithms depend on the device, Net-SNMP, PHP, and Spine -builds. Scripts execute with the poller's operating-system permissions, not -with an interactive administrator's environment. - - -Data Input Methods describe commands and their input -and output fields. Data Queries enumerate indexed objects, -such as network interfaces or disk partitions. Query input fields describe -those objects; output fields provide measurements to collect. - - -[Image: Data Input Methods and Queries] - - -Collection and storage - - -Data Sources connect collection definitions to RRD files and -the series stored in them. The poller writes results to database output tables. -Cacti's update processing writes those measurements to RRD files, either during -normal polling or through Boost when on-demand updating is enabled. -Spine does not directly render graphs or replace the RRD update process. - - -[Image: Principles of Operation] - - -Data Source Profiles define sampling, heartbeat, -consolidation functions, and retention when files are created. RRD archives -have bounded storage for their configured layout. Older measurements are -consolidated or expire according to that layout; changing a graph's timespan -does not recover detail already consolidated away. - - -An RRD file can contain multiple named series. Database data-source counts, -poller item counts, graph counts, and RRD file counts therefore need not match. - - -Graphing - - -Graph Templates define presentation settings and graph -items. A graph item can draw a series, calculate a value, or add legend text. -Several graphs can reuse an existing data source without collecting it again. -CDEFs , VDEFs , and GPRINT presets control -calculations and formatting at graph-rendering time. - - -Users view permitted graphs through the tree, list, and preview views described -in Viewing Graphs . Permissions and tree publication control -which graphs a user can reach; adding a graph to a tree does not start polling. - - -Extensions - - -Plugins add features through Cacti's plugin API. Check each plugin's release -compatibility, installation instructions, and permissions before enabling it. -Template import and export share definitions; they do not transfer historical -RRD measurements. See Plugin Management and -Template Import . - - - - -Copyright (c) 2004-2026 The Cacti Group - - -How to Graph Your Network - - -Create a device, select its measurements, and verify collection before adding -its graphs to a tree. The manual workflow below is useful for a first device. -Automation can perform these tasks for larger sets of -devices once its discovery and graph rules are configured. - - -Creating a Device - - -Open Console > Management > Devices and click Add. Enter a description -and address, choose the responsible data collector, and select a suitable -Device Template . The template supplies associated graph -templates and data queries; it does not restrict you to those defaults. - - -[Image: Adding a New Device] - - -Device Field Definitions - - -* Description identifies the device in lists and default graph titles. - -* Hostname is the device's address or resolvable DNS name. - -* Device Template associates collection and graph definitions. - -* Poller Association determines which collector reaches the device. - -* Site groups devices by location. - -* Notes records local information about the device. - -* Disable Device stops collection while retaining its configuration. - - - -Availability/Reachability Options - - -Choose a downed-device detection method appropriate to the device. Cacti can -use SNMP, ping, both, either, or no availability test. A failed availability -check can prevent measurements from being collected even when another -protocol is reachable. - - -For ping checks, select the method, port where applicable, timeout, and retry -count. ICMP permissions depend on the poller engine and operating system. -Test connectivity from the collector assigned to the device. - - -SNMP Options - - -Configure the SNMP version and credentials accepted by the device: - - -* SNMPv3 supports authentication and privacy. Prefer authPriv with -mutually supported SHA and AES protocols where the device supports them. - -* SNMPv2c supports 64-bit counters, but its community is not encrypted. -Restrict access to trusted collectors and networks. - -* SNMPv1 is for legacy devices and does not support 64-bit counters. - - - -Set the SNMP port, timeout, retries, and maximum OIDs per request. Start with -values the device supports; increase request sizes only after verifying that -responses are complete and collection remains reliable. - - -Security Options for SNMP V3 - - -Choose the security level, username, authentication protocol and passphrase, -privacy protocol and passphrase, and context or engine ID when required. -The protocols offered depend on Cacti settings and the installed SNMP builds. -The development defaults use SHA authentication and AES privacy. MD5 and DES -are legacy algorithms and can be hidden by policy or unavailable in the build. - - -SNMP Retrieval Types - - -Cacti's PHP paths can use PHP's SNMP extension or external Net-SNMP tools. -The extension supports SNMPv1, v2c, and v3; Cacti can select external tools for -protocol combinations unavailable in the extension. Spine uses Net-SNMP -through its C library. Verify the actual PHP, Net-SNMP, and Spine builds rather -than assuming all offered algorithms are available on every platform. - - -Verify device discovery - - -Save the device and check the SNMP information and any error shown on the edit -page. Review Associated Data Queries and Associated Graph Templates. -If a query has no rows, run its verbose query to check connectivity, OIDs, -indexes, and credentials before creating graphs. - - -For interface traffic, prefer the 64-bit counter graph type when the device -and selected SNMP version support it. See Data Queries for -query-to-template mappings and Device Management for other -availability and collection settings. - - -Creating the Graphs - - -Open Console > Create > New Graphs or use Create Graphs for this Device -from the device page. Select the device, then choose the graph templates or -query rows to graph. For indexed queries, choose the appropriate graph type -before clicking Create. - - -[Image: Creating New Graphs] - - -Fill in any per-graph values requested by the templates and complete creation. -Creating a graph defines collection; it does not immediately provide historical -measurements. Allow scheduled polling to produce enough valid samples for the -selected data-source type. - - -Verify and publish - - -* Check the device's status and the Cacti log after polling. - -* Open the graph under Console > Management > Graphs. For blank graphs, -inspect Data Source Debugging and the RRD last update. - -* Add the graph or device to a Tree , publish the tree, and grant -the intended users access. - -* Confirm the result in Viewing Graphs with an account -that has the intended permissions. - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Device Management - - -This section will describe Device management in Cacti. - - -Adding a Device to Cacti can be done in a few different ways, either via -the Web GUI, Cacti's Automation, or the Command Line Interface (CLI). - - -Web GUI Option - - -To add a device via the Web GUI first click on Console > Management > Devices -and -you will see the below device console window which will show existing devices -if any - - -[Image: Device Console] - - -You will now select the + on the top right hand corner - - -[Image: Add Device Button] - - -Once you select the + otherwise known as the add device button you will see the -below screen which will ask you for device specific information - - -Some of the most important information about the device will be required in this -window which includes - - -* Description - The name that will appear on Graphs by default - -* IP/Hostname - The DNS or IP address of the actual Device. IPv6 -address insert into brackets (example: [2001:db8::1]) - -* Poller Association - Defines which Data Collector is responsible for -pulling information about the Device - -* Device Template - Cisco, Net-SNMP, Linux, etc - The Cacti object that -holds all the Graph Templates and Data Queries to be graphed - -* Site, Location - Very important to performing Meta queries, or for -Site level Graph organization on Cacti Graph Trees - -* Availability/Reachability - Settings that describe Device -timeouts and availability methods. - -* SNMP information - SNMP Credentials for connecting to the Device - -* Device Notes - Arbitrary unstructured information about the Device - - - -[Image: Add Device Info Screen] - - -Cacti requires this basic information to be able to monitor the device and once -entered, click save on the bottom right corner. With the device created you will -need to add graphs for the device by clicking Create graphs for this device -on the top right hand corner. - - -Availability/Reachability Settings - - -Cacti prefers to use the Simple Network Management Protocol (SNMP) to -communicate -with Devices. Therefore, when creating a Device, you need to provide -SNMP -credentials to obtain information about the Device in order to collect data -from -it. Before Cacti will query the Device for data, it first verifies that the -Device is up and responding. When doing so, you have several options. -They include: - - -* None - Always assume the device is up. This is generally reserved for -Device -objects that do not have a state. - -* SNMP Uptime - Query the SNMP Uptime Instance OID - -* Ping and SNMP Uptime - Ping the device but also check the SNMP Uptime -Instance OID - -* Ping - Either ICMP, TCP at a port, or UDP as a port. Newer version has an -additional method TCP Ping Closed. -The device is considered UP even if the TCP ping returns closed - -* Ping or SNMP Uptime - Only one needs to be working for Cacti to collect -data - -* SNMP Desc - Query the SNMP sysDescription in cases where the SNMP Uptime -OID -is not available - -* SNMP GetNext - Query the first available OID in the OID tree for the -Device -Used for certain devices that have limited SNMP support. - - - -SNMP Credentials - - -When providing the SNMP credentials, Cacti currently supports the following -versions: - - -* Version 1 - Rarely used any more. Reserved for very old hardware - -* Version 2c - Supports 64-bit counters; community strings are not encrypted - -* Version 3 - Fully supported, including advanced settings such as SHA224+ -or AES192+ with SNMPv3. Cacti automatically leverages the Net-SNMP binaries -where needed, so there is no need to uninstall the php-snmp module. - - - -When providing the SNMP Credentials, Cacti will warn you if you have provided -incomplete information depending on the SNMP Version and SNMP Security Level -you have specified. - - -Additional Important Options - - -There are some additional options to be aware of before starting to use Cacti. -They include the following: - - -* Device Threads - If your device is far away, and can tolerate multiple -threads -querying information, you can increase this number to reduce the time it takes -to collect all information. - -* Maximum OIDs Per Get Request - Otherwise known as MaxOID's, this SNMP -option -will allow the SNMP client to gather more metrics per get request. Please -keep -in mind that the higher you make this number, the longer a SNMP respond may -take. -So, you have to be sensitive about the SNMP timeout as the number gets larger. -Since, by default SNMP is generally collected over UDP, you will also be -limited -in the number of responses depending on how many routers or VPN's you traverse -to reach a device. When traversing VPN connections, many VPN's limit the MTU -to around 500 bytes, which will significantly limit how large the Max OID's -can -be. In some cases, it may be better to deploy a Remote Data Collector -when -your device is either far way from a latency perspective, or that you must -traverse VPN's to communicate with. - -* External ID - This field is normally used for Asset Tracking information -for -the Device, but it use is entirely up to the System Administrator. - - - -Plugin Behavior - - -Many Cacti Plugins can and do add additional columns to the Device table in -Cacti. -Depending on the Plugin you have installed, you will find other information that -you can provide about the device including things like: - - -* Notification Settings - Who to notify when the Device changes state - -* Criticality - How important is the device - -* Failure and Recovery Counts - How long till a device is treated as truly -down. - -* Ping Thresholds - What RTL is considered bad when reaching a device - - - -Creating devices via CLI script - - -Run the CLI tool from the Cacti application root using the poller account and -PHP runtime configured for that installation: - - -php cli/add_device.php --help -php cli/add_device.php --list-host-templates - - - -Specify the device template, collector, availability method, and SNMP options -that match the device. Omitted options can inherit the installation's defaults; -there is no universal template or SNMP version implied by a minimal command. - - -For example, create an initially disabled device without SNMP, then complete -its settings in the web interface: - - -php cli/add_device.php --description="Example device" --ip=192.0.2.15 \ - --template=0 --version=0 --avail=none --disable - - - -Confirm the collector assignment, configure the required credentials and -availability checks, create graphs, and enable the device when ready. Do not -include real credentials in shared command output or shell history. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Graph Overview - - -Almost everything in Cacti is somehow related to a Graph. At any time, you can -list all available Graph by clicking on Console > Management > Graphs menu -pick. While it is possible to manually create graphs through this interface, -new users should follow the instructions provided in the next chapter for -creating New Graphs in Cacti. - - -For users who are familiar with RRDtool , you will -immediately recognize that a Graph in Cacti is closely modeled after RRDtool's -graphs. This makes sense since Cacti provides a user friendly interface to -RRDtool without requiring users to understand how RRDtool works. With this in -mind, every Graph in Cacti has certain settings and at least one Graph Item -associated with it. While graph settings define the overall properties of a -Graph, the Graph Items define the data that is to be represented on the Graph. -So the Graph Items define which data to display and how it should displayed, -and also define what should be displayed on the legend. - - -Each Graph and Graph Item has a set of parameters which control various aspects -of the Graph. Fortunately through the use of Graph Templates, it is not -necessary to understand the function of each field to create Graphs for your -network. When you are ready to take on the task of creating your own Graph -Templates, extensive field descriptions for both Graphs and -Graph Items are provided in that section of the manual. - - -Below, you can see a simple version of the Graph Management interface found -by going to Console > Management > Graphs - - -The screenshots below contain example devices and historical data from an -earlier interface. Check menu labels against your installed version. - - -[Image: Graph Management] - - -From this interface, you can see the Name, and ID of the Graph, -the Source Graph Template, and it's size. At the bottom of the page, there -is a list of Action that can be taken on Graphs. These actions are fairly -extensive, and are also extended as you add Plugins to Cacti. - - -When you click on the Name of the Graph, you will be taken to a Graph Edit -page as shown below. - - -[Image: Graph Management Edit] - - -In most cases, where the Graph is owned by a Graph Template, there is -not much your can do on this page. However, in the case that a Graph -is not managed by a template as in the image below, there are many more -options you will have when working with the Graph. The downside of -not leveraging a Graph Template for your Graphs is that you have -to duplicate the work for each Graph created. - - -[Image: Graph Management Edit] - - -When viewing a Non-Templated Graph, you have complete control of the -Graphs Canvas and all the Graph Items as you would in a Graph Template, -and the Graph Configuration as shown below. - - -[Image: Graph Management Edit] - - -The settings in both the Canvas and Configuration components of the Graph -will be covered in the Graph Template section of the manual and not -covered here. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Graph Management - - -This section will describe Graph management in Cacti. - - -Cacti features a way to view the graphs per device via the console. This allows -the administrator to view the graphs that are attached to a specific device. You -can also search by type of graph. Below we search for graphs that are -associated with the local linux server - - -[Image: graph management] - - -Graphs per page and PHP input limits - - -The Graphs list includes predefined page sizes through 5,000. Cacti removes -any size greater than PHP's effective max_input_vars value minus 20. The -20-variable reserve leaves room for the filter and action controls submitted -with the graph selections. - - -With PHP's default max_input_vars = 1000, the largest predefined value that -fits below the resulting 980-variable limit is 750. This protects bulk graph -actions: PHP emits a warning and truncates later request variables when a form -submits more values than the configured limit. - - -To make the 1,000 through 5,000 choices available, increase max_input_vars in -the configuration used by the web PHP SAPI. For example, the following value -exposes the 5,000 option while retaining Cacti's reserve: - - -max_input_vars = 5100 - - - -The CLI and web server can load different php.ini files. Change the -configuration used by PHP-FPM or the Apache PHP module, then restart that -service. The setting cannot be changed at runtime with ini_set() because PHP -classifies it as INI_PERDIR. Increase it only as far as the installation -requires because it also bounds how many GET, POST, and cookie variables PHP -accepts. See PHP's max_input_vars documentation . - - -Clicking on one of the graphs in the list shows the below menu. From this menu -you can enable debugging on the specific graph you can also change the template -of the graph amongst other things - - -[Image: Graph management click] - - -Modifying the graph template - - -An individual graph inherits managed settings from its graph template. Editing -that graph does not update the template or other graphs. Fields marked -Use Per-Graph Value in the template can be set independently on each graph. - - -To change shared settings, edit the Graph Template under -Console > Templates > Graphs. Review the affected graphs first: template -changes propagate to attached graphs for fields managed by that template. - - -[Image: Graph template options] - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Viewing Graphs - - -Background - - -Cacti, when it was first invented in 2001 by Ian Berry, his vision was to make it -the fastest and easiest way to view and render Network Monitoring Graphs for -people in the Network, Site, and Data Center Operations Space. As such, it's focus -from the very beginning was on render just one thing, Graphs. So, as such, -the second Top Tab on a Cacti system is the Graphs tab. - - -The Graphs Top Tab - - -The Graphs Top Tab has a few personalities. They include: - - -* Tree View - - -Allows Cacti Users to view Graphs in the form of hierarchical Trees. -These Trees are generally constructed by the Cacti Administrator and are -controlled either at the User or User Group level. - - -* Preview View - - -The Preview View provides a view of all Graphs that a Cacti User has -access to. Table Filters are provided to constrain the list of Graphs -returned to the page. - - -* List View - - -The List View allows the Cacti user to Create their own Preview Page -by allowing them to select graphs from various pages, and then finally view -those pages from the Preview View. - - - - -The way these various personalities appear in Cacti is somewhat different -depending on your Theme. Review the two images below, for how you navigate to -the various Graph View modes. - - -In this first image, we see the way the Graph View options are displayed to -the end user. This is the layout of the Classic, Modern and Dark themes. - - -[Image: Graph View Classic] - - -In this second image, you can see the way the Graph View page will appear for -users of the Paw, Paper-Plane, and Sunrise themes. - - -[Image: Graph View Alternate] - - -Graph Manipulation and Options - - -Once you can view the Graphs, there will be a Filter Panel that will provide -you multiple options to limit your view of them. Below, you can see an image of -that Filter Panel. - - -[Image: Graph View Filter Sub-Panel] - - -From this sub-panel, you can do the following: - - -* Search by regular expression - -* Select one to many, or all Graph Templates to view - -* Specify the number of Graphs per Page - -* Specify the number of columns to Display - -* View either Legendless Thumbnails or full Graphs with their legends - -* Set various Preset Time-spans, or select a Time Range - -* Shift the Time either forward or backward by the Shift Time-span - - - -Once you have the Filter where you like it from a Columns, Thumbnails, and Graphs -per Page setting, you can press the Save button, if you have the correct -permissions and save those defaults for your next login. - - -Depending again on permissions, to the right of the Graphs, you will find a -number of action icons that allow you to operate on the Graphs - - -The image below shows what that might look like if you have the Thold and -QuickTree Plugins installed. - - -[Image: Graph View Action Icons] - - -From top to bottom, the Graph Action Icons do the following. - - - - - - Name - Description - - - - - - - Graph Details - Allow you to perform precision zooming, view RRDtool debug information and perform CSV exports of your Graph Data. - - - - - CSV Export - Allows you to directly CSV Export your Graph Data - - - - - Realtime View - Allows you to view your Graphs at down to a 1 second granularity either in place, or in a pop-up Window - - - - - Spike Kill - Allow you to clear up Spikes and Gaps in your Graph - - - - - Create Threshold - Create a Threshold for the Graph - - - - - Add to QuickTree - Allow you to select Graphs to add to Trees by simply tooling around the Graphs page. - - - - - -Graph Zooming - - -Cacti also has a powerful Graph Zoom interface built in. You can discover -what it allows you to do by simply right clicking in the Graph area. When -zooming, you will zoom all the Graphs on a page. It's quite powerful. - - -[Image: Graph Zoom Context Menu] - - -There are many options for the Zoom menu. Instead of explaining them here -try them out for yourself. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Creating a Graph for a Single SNMP OID - - -When dealing with SNMP-enabled Devices, there are often times when you want -to graph the value of a single OID. This tutorial explains how to do this in -Cacti. It also assumes that you have the "SNMP - Generic OID Template" Graph -Template which is available in the Generic SNMP Device Package. If you do -not see this Graph Template listed under Graph Templates, install the -Generic SNMP Device Package using the import_package.php command line -script located in Cacti's cli directory. - - -To start the process of creating a new graph for your OID, click go to -Console > Create > New Graphs, and from there find the Device you would -like to add the Graph to. - - -From the image below, you can see the New Graphs interface. - - -[Image: Graphs New] - - -In this image, only the Graph Template based Graph Templates are -displayed. Had the Graph Types been switched to any of the Data Query -based Graph Types the interface would look a bit different. - - -From that Interface, to create a Generic SNMP OID based Graph, you need to -first select it from the Select a graph type to create drop-down. Once you -have selected it, you may press the Create button, at which point in time, you -will see the image below. - - -[Image: Graphs New] - - -From this interface, you must define various attributes for your resulting -Graph as shown in the table below. - - -Table 10-1. Field Description: SNMP - Generic OID Template - - - - - - Name - Description - - - - - - - (Graph) Title - The title that is to be used for the new graph. It is generally a good idea to keep host_description in the title, as to make the graph easier to identify later. - - - - - (Graph) Vertical Label - The text that will be printed along the y-axis of the graph. It is generally used to describe units, such as 'bytes' or 'percent'. - - - - - (Graph Items) Legend Color - The color that will be used to represent the data on the graph. - - - - - (Graph Items) Opacity/Alpha Channel - This optionally provides an opacity (not available with RRDtool-1.0.x) for a colored item. - - - - - (Graph Items) Legend Text - The text that will be used to describe the data on the graph legend. - - - - - (Data Source) Name - The title that is to be used for the new data source. It is generally a good idea to keep host_description in the title, as to make the data source easier to identify later. - - - - - (Data Source) Maximum Value [snmp_oid] - The maximum value that will be accepted from the OID. Make sure you choose a value that is reasonable for the data you are trying to graph because anything larger than the maximum will be ignored. If you are graphing a percentage, you should use '100' as the value should never exceed this. - - - - - (Data Source) Data Source Type [snmp_oid] - How the data from the OID should be stored by RRDtool and interpreted on the graph. If the value of the OID represents the actual data, you should use GAUGE for this field. If the OID value is a constantly incremented number, you should use COUNTER for this field. The two remaining field values, DERIVE and ABSOLUTE can be ignored in most situations. - - - - - (Custom Data) OID - The actual SNMP OID to graph. It is typically a good idea to enter the number OID here as opposed to using MIB names. For instance, to get the number of open files on a Netware server, you would use ".1.3.6.1.4.1.23.2.28.2.7.0" as the OID. - - - - - -So, based upon your specific OID that you are graphing, You will need to fill -out these fields before the new graph can be created properly. - - -When finished filling in values for these fields, click the Create button. Your -new Graph can now be accessed through the Console > Management > Graphs -menu pick. - - - - - -NOTE: When comparing the Table above, to the image, you will see that the -Opacity/Alpha Channel pick is missing from the interface. To add it, you -simply need > to edit the Generic SNMP OID > Graph Template, add a new -Graph Item Input override to the Alpha/Opacity on the Graph Template as -shown below. That topic will be covered in the Graph Template section of -the manual though. - - - -[Image: Graphs New] - - - - - -Important Note: - - -When graphing single OID's with Cacti, to ensure Spine and cmd.php will -process single OID's correctly, they should be written using numeric format -separated by dots, such as 1.3.6.1.4.1.9.9.97. - - -At this time, ASN's (named OID's) such as enterprise.9.9.97 (Cisco Switch) -or enterprises.cisco.ciscoMgnt.ciscoSwitchEngineMIB are not supported. - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Site Management - - -This section will describe Site management in Cacti. - - -Sites in Cacti can be used to separate different parts of your company -with the respective location devices. For example, you can have a site -called 123 main street in which you can associate all of the devices -that are in the physical location to the Cacti site. This could also -be a customer site or data center location - - -[Image: Cacti Sites page] . - - -Below is an example of some of the attribute data you can enter for the -site/location - - -Enter the appropriate information for the site and click Create in the -lower right corner: - - -[Image: cacti add sites] - - -Once a site has been created, you can associate devices with it when adding -or editing a device: - - -[Image: cacti add device site] - - -You can also associate the discovered devices via automation to a -particular site. - - -[Image: cacti sites automation] . - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Cacti Trees - - -Trees - - -A Tree can be thought of as a hierarchical way of organizing your graphs. -Each Tree consists of zero or more branches that contain -leaf nodes such as Graphs, Devices and Sites. It's a very powerful -way of organizing your Graphs. - - -Below we can see the current Trees we have setup on our Cacti -server. To get to this screen click Console > Management > Trees. - - -From this page you can add or remove Trees as required. - - -[Image: Tree Management Page] - - -Below is how a Tree is displayed in Graph View. We can see the Device -that is being monitored - clicking on this Device will result in seeing all -of the Graph data generated for the Device. - - -[Image: Tree View] - - -Creating a Tree - - -To create a new tree simply click the Add button (+) on the top right hand -corner and enter a name for your Tree. After the tree has been created you will -see the below page where you are able to add Devices to the Tree. - - -[Image: Tree Options] - - -To add devices to the new tree simply drag an available device to the -tree and it will be added to the tree. Cacti currently supports four -Sort Types, which can be either inherited, of left to the author to define -inheritance and at what level. See the image below for a visual representation -of how Tree Sorting is accomplished. - - -[Image: Tree Sorting] - - -Table 8-1. Tree Sorting Type Definitions - - - - - - Field - Value - Description - - - - - - - Name - Name of the tree entry. - The sort order of all trees themselves is always alphabetical - - - - - Sorting Type - Manual Ordering (No Sorting) - You may change the sequence at your will - - - - - Alphabetical Ordering - 1, Ab, ab - All sub-trees are ordered alphabetically, unless specified otherwise (you may change sort options at sub-tree label) - - - - - Natural Ordering - ab1, ab2, ab7, ab10, ab20 - N/A - - - - - Numeric Ordering - 01, 02, 4, 04 - Leading zeroes are not taken into account when ordering numerically - - - - - -End users will not be able to view the Tree or it's Graphs until you -publish it. To edit a Tree, you will be required to lock it for your use. -The locking is designed to prevent multiple users from editing a Tree -simultaneously. - - -When a Tree is locked, you can drag & drop the Sites, Devices and -Graphs over to the Tree menu. To add a 'Root Branch', simply press the -button to do so, once you have Root Branches, you may right click on the to -create sub-branches on the Tree. - - -When you single click on a Site, the Devices, and Graphs associated with -that Site should appear in their respective sections. You can also type into -the Search fields above the various sections to drill into them. You can also shift-click -and control-click on the objects within a section to drag & drop multiple objects -at one time. - - -Don't forget to unlock your Tree before finishing your editing session. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Data Source Management - - -A Cacti data source connects a collection definition to an RRD file. Each file -can contain more than one named RRDtool series, such as traffic_in and -traffic_out. Graphs refer to those series; they do not each require a separate -collection definition. - - -Counts and reuse - - -A switch with traffic graphs for 24 ports can have 24 Cacti data sources and -24 RRD files, each with inbound and outbound series. Additional graphs can -reuse those sources. Reuse depends on the template and creation settings; -creating another graph does not guarantee reuse in every case. - - -Poller statistics count collection items and processed RRD files separately. -Do not treat DataSources in the poller log as a universal count of RRD files, -graphs, or the rows shown on the Data Sources management page. - - -Check device-level counts under Console > Management > Devices: - - -[Image: Device data sources] - - -Storage and sampling - - -Storage depends on the number of series, sampling interval, archive rows, -consolidation functions, and retention defined by the -Data Source Profile . Use the profile's estimate and inspect -representative files with rrdtool info; there is no single file size for all -one-minute or five-minute data sources. - - -Changing a profile or template does not automatically convert an existing RRD -file's layout. Plan and back up any migration of existing data separately from -changes to future source definitions. - - -View data sources by device - - -Open Console > Management > Data Sources and filter by device or template. -Inspect the data source's collection method, path, active state, and associated -graphs before changing it. - - -[Image: Data sources per device] - - -The Orphaned filter identifies data sources without graph references. -Review whether a plugin or external process still needs a source before -removing it. RRD cleanup is controlled separately by the installation's -Paths settings . - - -For missing values, use Data Source Debugging and the -Cacti log . Check device reachability, poller ownership, file -permissions, and the last update time before changing a template. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Aggregate Graphs - - -An Aggregate Graph combines series from existing graphs into one graph. -Member graphs must have a compatible graph template so that corresponding items -can be combined consistently. An aggregate uses their data sources; creating it -does not start a separate collection cycle for those measurements. - - -Create an aggregate from a template - - -* Create an Aggregate Template for the common graph -template and choose its layout, totals and per-item color templates. - -* Under Console > Management > Graphs, select the compatible member -graphs. - -* Choose Create Aggregate from Template in the Actions menu, select the -aggregate template, and review the name and included members before saving. - -* Open the resulting graph and check units, stacking, member order and totals. -It can be placed on a tree and viewed like other Cacti graphs. - - - -Maintain members and propagation - - -Manage the aggregate through Console > Management > Aggregates. Review its -member graphs when adding or removing measurements; membership determines the -series contributing to the display and totals. - - -Propagation Enabled keeps the aggregate attached to its template's managed -settings. Template saves update attached aggregates with propagation enabled. -Disabling propagation allows independent settings and detaches template -management; subsequent template edits no longer update that aggregate. Review -this setting when an aggregate does not follow a template change. - - -Color Templates rotate colors across member graphs for -the items to which they are assigned. A legend entry is not an additional -member and does not advance that rotation. - - -Before a broad synchronization, back up the relevant definitions and verify one -aggregate. Keep source graphs and data-source ownership distinct from aggregate -membership when planning deletion or cleanup. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Automation Networks - - -This section will describe Automation Networks in Cacti. - - -Adding a network to scan with built-in automation is easy. On the main console -click Automation. Once on the below page click the + on the top right of the -page. - - -[Image: Automation Networks] - - -You will now see the below page. If you want to scan 192.168.1.0/24, you would -enter that in the subnet range textbox then enter the subnet in CIDR format. - - -Other important options are - - - - - - Option - Description - - - - - - - Schedule type - How often you want to scan this subnet for devices - - - - - Discovery threads - How many processes to spawn during the scan - - - - - Max Runtime - to prevent the scan from running indefinitely - - - - - Automatically add to Cacti - If a device is SNMP reachable and matches a rule from this subnet the device will be added - - - - - Netbios - Attempt to resolve the hostname by netbios - - - - - -After you are done adding your network details, ensure you enable the rule and -save. - - -[Image: Automation Networks Edit General] - - -Ensure that if you have a SNMP rule for this part of the network to select the -SNMP option set this will tie the network to the SNMP rules - - -[Image: Automation Networks Edit General] - - -To begin the scanner click on the bottom right drop down and select "Discover -Now" this will start the discovery - - -[Image: Automation Networks] - - -Here is the flow of the automation scan - - -[Image: Automation Flow] - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Automation Discovered Devices - - -After you initiate a scan from automation Cacti will compare devices -found to the device rules and SNMP options you set. - - -If Cacti is unable to match the device to a device template or unable to -find a proper SNMP credential. - - -Also if you have the automatically add to Cacti set to off the devices will -also be put in this section. - - -The Discovered Devices section can be found by navigating to the -following area. - - -[Image: Discovered Devices] - - -Below you can see devices that have been found during the scan that did -not meet a match criteria. - - -You will see the IP that was scanned as well if available the resolved -hostname either via DNS or netbios. - - -[Image: Discovered Devices] - - -You can then select the device you are interested in adding click the -checkbox next to the device - - -on the dropdown you select add device this will bring up the below menu. -From this Menu you will be able to fill out the details of the new device. - - -[Image: Discovered Devices] - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Automation Device Rules - - -This section will describe Device Rules in Cacti. - - -Cacti Automation relies on create device Rules these rules help the automation -process figure out what type of device is being scanned. Based on the device -rule REGEX the automation engine can apply the appropriate template to the -device i.e if there is a REGEX for IOS. The automation engine may pick the -Cisco router template for the device. - - -[Image: Automation Device Rules] - - -Below you will be able to choose a REGEX that will help identify the device -the REGEX can be in any Perl supported format. You can select either to -match sysDescr, the device's system description, or sysName, its -administratively assigned name. - - -An example regex for Cisco would be (Cisco Internetwork Operating System -Software|IOS) Use that pattern against sysDescr, where IOS software -identifies itself. - - -Using this info automation would apply the appropriate device template you -choose. If you see below we match for a system that matches Linux once a -device is found with that system name it is assigned the Net-SNMP device -template. - - -[Image: Automation Device Rules Edit] - - -If the System/Device you are matching has a unique OID you can also match based -on that. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Automation Graph Rules - - -This section will describe Graph Rules in Cacti. - - -Graph rules are used by the Cacti automation process after a device has been -identified and a template has been applied the next step is graph creation. -Graph rules are processed from top to bottom. - - -The graph rule matches the graph template by looking at the data fields -chosen that are available in the data query for example below we are creating -graphs for interface traffic the data query has several fields available to -match on. - - -You can see how these rules would take place by clicking the show matching -objects link. - - -[Image: Automation Graph Rules] - - -For example, filter interface query rows using ifOperStatus to select -operationally up interfaces. Check the actual cached value and use Show -Matching Objects to verify the rule. If both administrative and operational -state must be up, also filter ifAdminStatus; ifOperStatus alone does not -test both states. - - -A device selection Criteria is also important Cacti needs a way to find which -device it needs to match. In the below example we are matching any device -that has an interface that is up and is not a Windows server. - - -You can preview which devices this will apply to by clicking the Show matching -devices link. - - -[Image: Automation Graph Rules Edit] - - -[Image: Automation Graph Rules Device -Criteria] - - -[Image: Automation Graph Rules Graph -Criteria] - - -This output shows us which devices match our devices rules this can help with -tweaking rules as needed. - - -[Image: Automation Graph Rules Matching -Devices] - - -This output shows which interfaces,drives,sensors etc will be graphed based -on the graph rules. - - -[Image: Automation Graph Rules Matching -Objects] - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Automation Tree Rules - - -This section will describe Tree Rules in Cacti. - - -Tree rules allow Automation to bunch up devices based on matches -on rules we come up with you can say bunch all Cisco devices on to a Cisco tree. -Or if you have a site where all of the hostnames start with siteb you can -have a site b tree etc see below for some examples. - - -To get started you will need to create a Tree rule on the top right click the + -to start a new rule you are also able to duplicate rules to make it easier as well. - - -[Image: Tree Rules] - - -[Image: Tree Rules Edit] - - -[Image: Tree Rules Item Edit] - - -We need a way to tell automation what device we are looking for -in the example above we are looking for a device with the hostname Linux -this is done via a REGEX any perl based REGEX can be used. - - -To test this REGEX on existing devices you can click the show eligible Objects -this will check the Devices currently in cacti for a match. - - -[Image: Tree Rules Preview] - - -Once a device is a match it will be placed on the default tree. -To change which tree the device will be placed on simply select the tree name -from the dropdown list. - - -[Image: Tree Rules Item Edit] - - -We also have the option to auto create a tree based on our rule in this case -a new tree Named Linux will be created if it does not already exist. - - -Video Walkthrough - - -[Image: Video Tutorial] - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Automation SNMP Options - - -This section will describe SNMP Options in Cacti. - - -The SNMP Options page holds the SNMP strings and credentials that automation -uses when it scans a network. Cacti supports SNMP v1, v2c and v3, so enter the -details that match the devices you intend to poll. - - -[Image: SNMP Options] . - - -[Image: SNMP Options Edit] . - - -[Image: SNMP Options Item Edit SNMPv1/2] . - - -[Image: SNMP Options Item Edit SNMPv3] . - - -Important: When performing a network scan ensure that you select the SNMP -options that contain the SNMP strings you want to use - - - - -Copyright (c) 2004-2026 The Cacti Group - - -User Management - - -In addition to giving you the tools to create sophisticated Graphs, Cacti -enables you to manage User and User Group access to those Graphs as -well as various other areas of Cacti. Each User has a variety of settings -and permissions. Some of these settings can be controlled by the individual -User via editing their Profile, or controlled by the Cacti Administrator. A -Users Cacti permissions are only modifiable by authorized Cacti -Administrators. - - -Note: for a users to see new settings, they will have to log off and back in -again to view. - - -[Image: User Management] - - -Out of the box, there are two users that come with every Cacti installation. The -"admin" user - the main user that by default has access to see and change -everything in Cacti. This is the user that you first login with in Cacti, and it -is probably a good idea to keep around unless you know otherwise. The second -user is the "guest" user, which controls which areas/graphs are allowed for -unauthenticated users. - - -By default, this user only has rights to view, but not change graphs. This -enables any unauthenticated user to visit 'graph_view.php' and view your graphs. -This behavior can be changed by either changing the realm permissions for the -"guest" user, or disabling the guest user altogether under Cacti Settings. By -default in 0.8.7 and later, the "guest" user is not enabled, effectively -disabling "guest" (Unauthenticated) access to Cacti. - - -Editing an existing User - - -To edit an existing user, open Console > Configuration > Users. Once at the -user management screen, click username of -the user you wish to edit. You will see a screen that looks similar to the image -below. - - -[Image: Editing a User] - - -At minimum, you must specify a User Name and a Password for each user. Each user -field is described in more detail below. In addition to these fields, each user -can have their own realm permissions", graph permissions, and graph settings. -Each of these items are described in this section of the manual. - - -User Management Options - - -* User Name - - -This field contains the login name for the user. Use the account name -expected by the selected login realm. The development -editor permits up to 255 characters; external providers can impose their -own identity requirements. - - -* Full Name - - -(Optional) You can use this field as a more descriptive identifier for the -user. It is currently only used for display on the user management page. - - -* Password - - -Enter the password for the user twice, once in each text box. Keep in mind -that passwords are case sensitive and the password will remain unchanged if -the boxes are both left empty. - - -* Account Options - - -There are two account related options that can be set for each user. - - -* User Must Change Password at Next Login - - -Force a password change immediately after the user logs in. - - -* Allow this User to Keep Custom Graph Settings - - -Allows user to maintain their own custom graph viewing settings. - - - - -* Graph Options - - - -Enables certain defined graph viewing options. - - -* User Has Rights to Tree View - - -* User Has Rights to List View - - -* User Has Rights to Preview View - - - - -* Login Options - - -These options set what occurs after the user logs in. - - -* Show the page that user pointed their browser to - - -Will point the user to whatever page they were heading to before being -interrupted by the login page. - - -* Show the default console screen - - -This option will always point the user to 'index.php' after a successful -login. - - -* Show the default graph screen - - -This option will point the user to default graph view after login. - - - - -* Authentication Realm - - -This setting allows you to specify a user for use with Local, Web Basic -or -LDAP Authentication. - - -Note: Template users must be Local. - - - - -User Interface Permissions - - -Realm permissions control which areas of Cacti a user can access. You can edit a -user's realm permissions by selecting User Management and choosing the user you -want to edit the permissions for. The Realm Permissions box will be displayed in -the lower part of the screen. Each "realm" is a grouping that represents common -tasks in Cacti, making it easier to fine tune each user's access. - - -If you want to create a user that can only view graphs, you should select the -View Graphs realm and leave everything else unchecked. See the Graph Permissions -section for more information about how to fine tune this even more on a -per-graph basis. Conversely, if the user needs to access the console, they will -need Console Access and any additional realms that you see fit. - - -[Image: User Realm Management] - - -Graph Permissions - - -Graph Permissions control which graphs a user is allowed to view. However, -in general, these permissions do not apply to editing graphs. You can edit a -Users Graph Permissions either by assigning that User to one to many -User Groups, or by modifying their Graph Permissions directly. - - -[Image: User Realm Management] - - -Cacti supports four Graph Permission models on the development branch. There is -the Permissive Graph -permission which states that if a user has access either to the Graph, the -Device or Graph Template, the user will have access to all the Graphs that match -that class. For example, in the Permissive model, if you have access to the -Device, you have access to all it's Graphs. If you have access to a -Graph Template, you have access to every Device Graph that matches that -Graph Template. - - -The second Graph Permission model is Restrictive. In the Restrictive Graph -permission model, you must have access either to the Graph directly, or both -the Device and Graph Template. Using this permission model requires the -Users and User Groups have much more specific access if they want to -gain access to various device Graphs. - - -The development branch also offers Device Based and Graph Template Based -methods. These use the corresponding device or graph-template policy, while -retaining direct graph permissions. Check the selected method when diagnosing -access that differs from the device or template checkbox alone. - - -In addition to the Permissive and Restrictive models, which can be set from -Console > Configuration > Settings > General, a User or User Group -is either Allowed or Denied all Graphs, Devices and Graph -Templates through a setting called the Default Policy in each of the -Permission Tabs. The Graph Permissions tab includes an Effective Policy, -which combines all the Users various User Group and User permissions -to provide an effective permission. If the Graph is ultimately permitted for -the User to view, you will see for what reason from this Permission tab. - - -Note: even if a User is denied access to a Device or Graph Template, -but has access to at least one Graph from that Device or Graph -Template, they will see that Device or Graph Template name in areas of -Cacti that display it. - - -Default Permission Policies - - -[Image: Default Policies Example 1] - - -[Image: Default Policies Example 2] - - -Device Permissions - - -Device Permissions allow you to Grant or Revoke access to specific -Devices. If you wish to Grant or Revoke access to a Device, you can -select it, and then choose the specified action from the drop down, and press -the Go button to make that permission change. As mentioned above, revoking -Device access does not necessarily block a User from seeing that -Device from the User Interface. - - -[Image: User Realm Management] - - -Template Permissions - - -Template Permissions allow you to Grant or Revoke access to specific -Graph Templates. If you wish to Grant or Revoke access to a Graph -Template, you can select it, and then choose the specified action from the -drop down, and press the Go button to make that permission change. As -mentioned above, revoking Graph Template access does not necessarily block a -User from seeing that Graph Template from the User Interface. - - -[Image: User Realm Management] - - -Tree Permissions - - -Cacti allows the Administrator to Grant and Revoke Tree permissions from -this tab. The Cacti Tree permissions are a single level security object. -However, when you browse a Tree to it's various branches, a user will only -be allowed access to the Graphs and Devices that they have access to. Managing -permissions to Trees is identical to Graphs, Devices and Graph -Templates otherwise. Additionally, Cacti has will hide branches from a -User when they have no access to any Devices or Graphs within it. - - -User Specific Settings - - -Cacti optionally allows Users to control certain User Settings such as -their Email Address and Full Name. However, the Cacti Administrator also has -the ability to view a Users settings and modify them for the User from -the User Settings tab. This feature allows the Cacti Administrator to better -support their Users. However, you can disable a Users ability to modify -defaults from the General User Management tab. This is important for the -guest account for example. - - -[Image: User Realm Management] - - -[Image: User Realm Management] - - -[Image: User Realm Management] - - -Caching of Permissions - - -Cacti caches permission results to reduce repeated work. After changing user or -group access, test the effective permissions with the affected account in a new -session. Include both allowed and denied objects in that check; do not infer -access solely from a management-page checkbox or a previously loaded page. - - -Creating a New User - - -To create a new user, open Console > Configuration > Users. Once at the -user management screen, click the plus -(+) glyph. - - -[Image: Adding a User] - - -At minimum, you must specify a User Name, Password and Login Realm for -each user. Each User field is self documented either below the field, or in -the help bubble to the right of it. In addition to the fields on the General -tab, settings can be controlled from the various sub-tabs when editing a user. -Those sub tabs include: - - -General - - -From this sub-tab, you can modify general User attributes including Full -Name, Email Address, Lockout status, Account Options, Graph Options, etc. - - -Permissions - - -From this sub-tab, you control what areas of Cacti a User has access to. -Cacti has broken those access areas into various Roles to make the setting of -permissions easier to understand. Note that Plugin permissions are still -grouped by Plugin in the current version of Cacti. This will change over the -next few releases to be more in line with the various Cacti Roles. - - -[Image: Permissions] - - -Group Membership - - -From this sub-tab, you can assign or remove users from various User Groups. - - -Graph Perms - - -From this sub-tab, you can view a users Effective Graph permissions and also -Grant or Revoke access to Graphs for an individual User. - - -[Image: Graph Permissions] - - -Device Perms - - -From this sub-tab, you can view and edit a users Device permissions. Note -that removing a users permission to a Device can be overridden if they have -access to either a Graph or, depending on the permission model you have -chosen, a Devices Graph Template. - - -[Image: Graph Permissions] - - -Template Perms - - -From this sub-tab, you can Grant or Revoke a Users access to various -Cacti Graph Templates. - - -[Image: Graph Permissions] - - -Tree Perms - - -From this sub-tab, you can Grant or Revoke a Users access to the various -Cacti Trees. - - -User Settings - - -From this sub-tab, you can modify a Users settings to assist the User -with their use of Cacti, or to set defaults for that User. - - -[Image: User Settings] - - -Copying a user - - -[Image: Copy a User Part 1] - - -To copy a User to a new one, go to Console > Configuration > Users. Once -at the Users interface, highlight the User you would like to copy from -and select Copy from the Choose an action drop down selection box, click -Go to continue. If you select multiple users, only the first selected User -will be used as the source User. - - -[Image: Copy a User Part 2] - - -Specify the New Username, New Full Name and New Realm of the new user. Click -Continue to copy the selected template user to the designated new user. An -error will be returned if you attempt to copy over an existing user. If you -would like to copy over an existing user, use Batch Copy. - - -Enable/Disable Users - - -[Image: Enable/Disable Users Part 1] - - -To enable or disable a set of or a single user, open **Console > Configuration - - - - - -Users**. Once at the Users interface, -highlight the User you would like to Enable or Disable and select either -Enable or Disable from the Choose an action drop down selection box, click -Go to continue. - - - -[Image: Enable/Disable Users Part 2] - - -Confirm that you want to disable or enable the listed users. Click Continue to -perform the action. Disabling your own account is not permitted. - - -Batch Copy Users - - -Batch Copy is a helpful utility that helps Cacti Administrators maintain users. -It copies a template account's settings to selected users. For ongoing shared -permissions, use User Groups . - - -[Image: Batch Copy Users Part 1] - - -To Batch Copy a set of or a single user, select the Users interface under -Console > Configuration. Once at the Users interface, highlight the -Users you would like to batch copy information to and select Batch Copy -from the Choose and action drop down selection box, click Go to continue. - - -[Image: Batch Copy Users Part 2] - - -Select the Template User and confirm that you want to Batch Copy the listed -Users. Click Continue to perform the action. - - -It is important to note that when using Batch Copy the original Users -Full Name, Password, Login Realm and Enable status will be retained, all -other fields will be overwritten with values from the selected Template User. - - -Delete Users - - -[Image: Delete Users Part 1] - - -To delete users, select their rows under Console > Configuration > Users, -choose Delete from the actions menu, and click Go. - - -[Image: Delete Users Part 2] - - -Confirm that you want to delete the listed users. Click Continue to perform -the action. Deleting your own account is not permitted. - - -Guest (Anonymous) Access - - -By default, Guest or Anonymous access is disabled in Cacti. Enabling "Guest" -access is easy. But, you must understand that you should only allow the -designated "Guest" user access to what you authorized. It is not suggested that -you give the designated "Guest" user more than just access to graphs. To enable -guest access, first, need a designated "Guest" user. Cacti by default comes with -one already created that has access to only graphs. - - -It is important to note that the default guest user has access to all graphs on -the system. Once you have created the "Guest" user, you need to tell Cacti what -the "Guest" user is. This is done by updating the Authentication Settings and -selecting the "Guest" user you have designated. The "Guest" user must be enabled -and be set as the guest user for anonymous access to work. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -User Group Management - - -Cacti supports User Groups for shared permissions. On the development branch, -Login Providers can also assign membership at login when -automatic assignment rules are configured. -User Groups closely mimic the normal user. You see things like Graph -permissions, Roles and Realms, Default pages, and settings, it's all there. - - -The way that a Cacti User Group works is that it's combined with the Users -permission, and then the resulting permission is the most permissive. -So, if a User does not have a permission, but the User Group that they -belong to does, the user then gains the permission. - - -There are other types of settings that the User Group can own the -permission as well. There are only a few of these permissions however. - - -In the next series of images, we will walk through the User Group interface. -In this first images, we can see the main User Group interface. -From here, you can see all of the Groups defined on the system and -the number of Users in the Group, if the User Group is enabled or -disabled. Lastly, in the Action drop-down, you can see the actions -that you can take with a User Group. - - -[Image: User Groups] - - -In this next image, you can see the User Group Edit page. The -Edit page has multiple Sub-tabs. They include: - - -* General - General settings about the User Group - -* Members - A list of User Group members - -* Permissions - Roles and Realms that provide group member access to Cacti -components - -* Graph Perms - Effective Graph Permissions, rolling up Device and Template -permissions - -* Device Perms - User Group Device Permissions - -* Template Perms - Graph Template Permissions - -* Tree Perms - Tree Permissions - -* User Settings - Settings for the User of the Group if they can not manage -settings on their own - - - -The first form elements are pretty self explanatory. The Tree, -Graph List, and Preview rights speak to Cacti three Graph Viewing modes -which are explained in the Viewing Graphs section of the Document. - - -Lastly Login options, are how the user should be re-directed after logging. -This is again, pretty self explanatory. - - -[Image: User Groups General] - - -The next image shows the Member list. This one is pretty self explanatory. -You can see all the users defined on the system and whether or not they -below to the User Group, and the ability to add or remove them enmass. - - -[Image: User Groups Members] - - -The next image shows Cacti's Roles and Realms within those Roles. Cacti -organizes it's Authorization Realms into Pre-defined Roles. Plugin -Developers can create their own Roles as well. So, when you Extend -Cacti using Plugins, you may find additional Roles. - - -[Image: User Groups Realm Permissions] - - -In this last image on the page, you can see every Graph in the Cacti -system and whether or not the User Group has permission to view it. This -permission can granted by giving the Group permission to a Device -or the Graph Template in the Permissive permission mode, -or in the Restrictive permission mode, they have to have both Device -and Graph Template permissions to gain access to the Graph. Finally, -the Cacti Administrator can grant access to Graphs one at a time if they -choose. - - -[Image: User Groups Graph Permissions] - - -You can find the Permission and Restrictive permission setting on Cactis -configuration page at Console > Configuration > Settings > General. We have -not covered the Device, Template, Tree or Settings sub-tabs -here. If you would like more information on them, see the User documentation. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Login Providers - - -Login Providers are part of the unreleased Cacti 1.3 development series. -They replace the older User Domains management interface and support LDAP, -Active Directory, SAML2, and OpenID Connect. For Cacti 1.2, see -User Domains and Multiple LDAP/AD -Domains . - - -Create a provider - - -* Keep a working local administrator account and an authenticated session -available while testing. - -* Open Console > Configuration > Login Providers and add a provider. - -* Enter a name and choose the Provider Type. Select a User Template -with the permissions intended for newly created accounts. - -* Fill in the connection or identity-provider settings for that type. - -* Enable the provider and save it. - -* Under Console > Configuration > Settings > Authentication, select -Login Providers as the authentication method and save. - -* Test a permitted account and a denied account in a new private browser -session. Confirm the resulting Cacti permissions before wider use. - - - -LDAP and Active Directory providers use credentials entered on the login page. -SAML2 and OpenID Connect providers use redirect-based login buttons. The -Login Button Label customizes the button text for those redirect providers. -Local accounts remain available through the local login realm. - - -LDAP and Active Directory - - -Configure the server, ports, protocol version, encryption, and search or bind -settings. Use the LDAP guide for the meaning of DN, -search modes, and group membership checks. On the development branch, configure -these values on the provider rather than in the older User Domains screen. - - -Use TLS with a trusted server certificate. If access should be restricted to -a directory group, configure and test that membership requirement; merely -naming a provider after an administrative group does not restrict access. - - -For one-time-password authentication, follow the server field's guidance: a -space-delimited list can retry a consumed code against another server. Use a -single resilient endpoint where directory failover happens below Cacti. - - -SAML2 - - -Configure the service-provider entity ID and the identity provider's entity -ID, single sign-on URL, and signing certificate. Configure signing options and -service-provider certificate and private key as required by your identity -provider. Exchange the Cacti service-provider metadata with the identity -provider and register its assertion-consumer endpoint. - - -Map the username, full-name, and email attributes to those actually sent by -the identity provider. Configure the group attribute and required group when -restricting membership. Treat certificates, private keys, and identity claims -as configuration that must be verified with the identity-provider administrator. - - -OpenID Connect - - -Register Cacti as a client with the identity provider. Enter its client ID, -client secret, HTTPS discovery URL, and scopes. The implementation uses the -authorization-code flow with PKCE. Discovery and the returned authentication -endpoints must use HTTPS. - - -Set Cacti's Server Base URL to its externally reachable URL, including its -installation path. The redirect URI is that base URL followed by -/login_sso.php?action=callback&realm=REALM, where REALM is 1000 plus the -saved provider ID. Register that exact URI with the identity provider. - - -Map the username, full-name, and email claims. Configure the group claim and -required group if access must be limited to particular users. - - -Permissions, cookies, and troubleshooting - - -A successful identity-provider login does not grant unrestricted Cacti access. -Review the template user, Cacti user groups, and resulting object permissions. -Where automatic group assignment is configured, test both membership and -removal cases. SAML2 and OpenID Connect assignment requires the corresponding -group attribute or claim. - - -Persistent login requires HTTPS, the global Support Authentication Cookies -setting, and the provider's Allow "Remember Me" Cookies option. Disable the -provider option where every new session must return to the identity provider. - - -Use provider debug logging temporarily while diagnosing failures, then disable -it. Check the Cacti log , callback URL, clock synchronization, -certificate trust, claim mappings, and group restrictions. Remove sensitive -information before sharing logs. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -User Domain Management - - -This page describes User Domains in Cacti 1.2. The unreleased Cacti 1.3 -development branch replaces this screen with -Login Providers . User Domains are a core Cacti feature -in 1.2, not a separate plugin. - - -User Domains in Cacti are a way of providing Custom Login -experiences to differing groups of users and using LDAP -or Active Directory Group Permissions to limit who -can login using those customer permissions. - - -Once a user login in for the first time, their permissions -will enherit the Template accounts permission settings -including User Group's and their permissions. - - -So, as the name implies, you can have from one to many -LDAP and Active Directory entries in the User Domains interface. - - -A use example would be for example 3 levels of customers -who will have access to the system. For example lets -say those three groups are: - - -* Administrators - -* Managers - -* Client Team - - - -Each of these users groups are controlled by Active Directory -there are AD User Groups that map one-to-one with these -Groups. When you have these three Domains setup and enabled, -when you goto the Cacti Login screen there will be a drop-down -settings with the three Domains listed in the drop-down. - - -If a normal user tries logging as an Administrator, their -login will be blocked and so on. - - -The first image shows the list of domains, which domain is -primary, and the actions you can take on a Domain. - - -[Image: User Domains] - - -In this second screen, you can see the User Domain login screen -where you can pick AD or LDAP, the credentials, importantly the -Template User Account (That which holds base permissions), -and the require group membership, which when you check it, -you can then specify the AD and LDAP User Group paths. - - -[Image: User Domains Edit] - - -In the last images, you can see the Group Settings information, and -if you have the users Full Name and Email stored in LDAP or -AD, you can pull that information and make it a part of the -Cacti wrapper account when it's first created. - - -[Image: User Domains Edit] - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Reports Administration - - -This section will describe Reports Administration in Cacti. - - -The Reports Administration tab allows Cacti Administrators to administer all -Reports in Cacti. The Administrator can change the ownership of or take -ownership away from any user on the system, and can edit all Reports. The -primary difference between the Reports Administration and the Reports User -interfaces breaks down to simply what can be done and seen by the user. - - -The Web Interface - - -The administration of any Report begins on the main Reports tab in Cacti. -A screen shot of the Reports tab is shown below. - - -[Image: Reports Admin Tab] - - -When viewing any Reports from this interface, you will see the following -columns: - - -* Report Name - The name of the Report. - -* Owner - The Cacti account that has ownership of the Report. - -* Frequency - How often the Report is to be sent to the distribution. - -* Last Run - The last time that the Report was sent to the distribution. - -* Next Run - The approximate next time that the report is to be sent. -this is not an exact number. It does depend on the poller first running. So, -depending on how long your poller runs for, this time could be off by a -few minutes. - -* From - The From Name portion of the From Email address - -* To - The list of Emails that the reports is to be sent to. - -* Type - The Image format and the type of embedding done in the Email. - -* Enabled - Is the Report able to be sent on the Schedule. - - - -The actions that you can take on an existing Report as an Administrator include: - - -* Send Now - Force send one or more Reports now - -* Duplicate - Duplicate one or more Reports - -* Enable - Enable one or more Reports - -* Disable - Disable one or more Reports - -* Delete - Delete one or more Reports - -* Take Ownership - Take over ownership of one or more Reports - - - -Report Editing - - -When you click the Add button on the right side of the Reports page, or Click -the Report Name of an existing Report, you will be presented with the interface below. - - -[Image: Reports Admin Edit] - - -This section includes: - - -* Report Name - The Name of the Report - -* Enable Report - Is the Report Enabled - -* Use Custom Format HTML - This is an indication that you wish to use a -custom html/css document that you can use to customize the layout of your -reports and add corporate branding for example. - -* Format File to Use - The specific html/css file to use. - -* Graphs Linked - Provide the recipient of the report a ling back to the actual -graph in Cacti. - -* Graph Columns - The number of Graph columns to use per row. - -* Graph Width - The width of each Graph - -* Graph Height - The height of each Graph - -* Thumbnails - Should the Graphs be rendered in Thumbnail mode - -* Next Timestamp of Sending Mail Report - The approximate next time to send the report - -* Report Interval - The frequency to send the report. Options are every X Minute, -Hours, Days, Weeks, Months on a Day of the Month, Months on the Day of the Week, -and Years. - -* Interval Frequency - How often to send, for example if you select Days, -and the Interval is one, it means every day, if you select 2, -it means every other day. - - - -The Email Frequency section does not use the same layout as does our -Automation Networks. Correcting that is a future project for the team. - - -The last section of the Report Details is the Email Sender/Receiver -section as shown below. - - -[Image: Reports Admin Edit] - - -From here you can set the following columns. - - -* Subject - The Email subject. - -* From Name - The From Name on the Email. For example Cacti Administrator - -* From Email Address - The From Email address. For example noreply@mydomain.com - -* To Email Address(es) - A comma delimited list of Email addresses that should -receive the Report. - -* BCC Address(es) - An anonymized list of Email recipients - -* Image attach type - This defines how the Cacti Graph images get attached -to the Email. Maybe are for legacy purposes. Most users will use -Inline PNG or Inline JPG. - - - -Once you save a new Report additional Tabs will show up. Those tabs are: - - -* Items - The Graph's, Tree's, Text, Horizontal Rules, -and Device's to place on the Report. - -* Preview - See a Preview of your Report - -* Events - Approximate Future Event Days for your Report to be sent. - -This helps interpret the idiosyncrasies of the scheduler design. - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Reports User - - -This section will describe the user view to Cacti's Reports feature. - - -The Reports User interface allows you to see and manage your own reports. -This is unlike the Reports Administration interface that allows you to -manage others reports in addition to your own. - - -The Web Interface - - -The user of any Report begins on the main Reports tab in Cacti. A screen -shot of the Reports tab is shown below. - - -[Image: Reports User Tab] - - -When viewing any Reports from this interface, you will see the following -columns: - - -* Report Name - The name of the Report. - -* Owner - The Cacti account that has ownership of the Report. - -* Frequency - How often the Report is to be sent to the distribution. - -* Last Run - The last time that the Report was sent to the distribution. - -* Next Run - The approximate next time that the report is to be sent. this -is not an exact number. It does depend on the poller first running. So, -depending on how long your poller runs for, this time could be off by a few -minutes. - -* From - The From Name portion of the From Email address - -* To - The list of Emails that the reports is to be sent to. - -* Type - The Image format and the type of embedding done in the Email. - -* Enabled - Is the Report able to be sent on the Schedule. - - - -The actions that you can take on an existing Report as an Administrator include: - - -* Send Now - Force send one or more Reports now - -* Duplicate - Duplicate one or more Reports - -* Enable - Enable one or more Reports - -* Disable - Disable one or more Reports - -* Delete - Delete one or more Reports - - - -Report Editing - - -When you click the Add button on the right side of the Reports page, or -Click on the Report Name of an existing Report, you will be presented with the -interface below. - - -[Image: Reports User Edit] - - -This section includes: - - -* Report Name - The Name of the Report - -* Enable Report - Is the Report Enabled - -* Use Custom Format HTML - This is an indication that you wish to use a -custom html/css document that you can use to customize the layout of your -reports and add corporate branding for example. - -* Format File to Use - The specific html/css file to use. - -* Graphs Linked - Provide the recipient of the report a ling back to the -actual graph in Cacti. - -* Graph Columns - The number of Graph columns to use per row. - -* Graph Width - The width of each Graph - -* Graph Height - The height of each Graph - -* Thumbnails - Should the Graphs be rendered in Thumbnail mode - -* Next Timestamp of Sending Mail Report - The approximate next time to send -out the Report. - -* Report Interval - The frequency to send the report. Options are every X -Minute, Hours, Days, Weeks, Months on a Day of the Month, Months on the Day of -the Week, and Years. - -* Interval Frequency - How often to send, for example if you select Days, -and the Interval is one, it means every day, if you select 2, it means every -other day. - - - -The Email Frequency section does not use the same layout as does our -Automation Networks. Correcting that is a future project for the team. - - -The last section of the Report Details is the Email Sender/Receiver -section as shown below. - - -[Image: Reports Admin Edit] - - -From here you can set the following columns. - - -* Subject - The Email subject. - -* From Name - The From Name on the Email. For example Cacti -Administrator - -* From Email Address - The From Email address. For example -noreply@mydomain.com - -* To Email Address(es) - A comma delimited list of Email addresses that -should receive the Report. - -* BCC Address(es) - An anonymized list of Email recipients - -* Image attach type - This defines how the Cacti Graph images get attached -to the Email. Maybe are for legacy purposes. Most users will use Inline PNG or -Inline JPG. - - - -Once you save a new Report additional Tabs will show up. Those tabs are: - - -* Items - The Graph's, Tree's, Text, Horizontal Rules, and Device's to place -on the Report. - -* Preview - See a Preview of your Report - -* Events - Approximate Future Event Days for your Report to be sent. This -helps interpret the idiosyncrasies of the scheduler design. - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Report Items - - -This section will describe the Report Edit Items Sub-Tab. - - -From this Sub-Tab, you can add, remove, and if Drag and Drop is enabled, easily -reorder any Report Item. Report Items include: - - -* Trees - Including one or more Branches, which include Devices as a Branch Type. - - -* Graphs - One or more Graphs from a Device. - - -* Devices - One or more Cacti Devices with Graphs whose titles -may include a Regular Expression. - - -* Text - For example to sub-section a Report and add a Title - - -* Horizontal Rule - For separating sections of a Report. - - - - -An example Report Items interface can be seen below. - - -[Image: Report Item] - - -From this image, you can see a combination of Graphs, Devices, and a Device -showing only Graphs that include eth0, and SCSI in their titles indicating -something about Interface Graphs and Disk Utilization Graphs. - - -Item Edit Page - - -When you either add a new Item by pressing the Add button on the right, -Clicking on the Item # on the left, you will be presented a page -that is personalized depending on the Item Type. -When you add an item for the first time, you will see the image below. - - -[Image: Report Item New Item] - - -Again, the user interface will change layout depending on the Item Type -that you select which happens to be the first drop-down on that page. - - -The columns for a Graph Type Report Item include: - - -* Site - A filter that will show only Devices and Graphs from a specific site. - -* Device Template - A filter that will only show Devices and Graphs from a -specific Device Template - -* Device - A filter that will show only Graphs from a specific Device. - -* Graph Template - A filter that will show only Graphs -from a specific Graph Template. - - - -The options above are only Filter to reduce the Graph list when you -actually select the Graph Name, it will apply those filters -to narrow in on the Graphs to display in the drop-down. -All of the filters above are optional. - - -The last sections are for the specific Graph in question including: - - -* Graph Name - The name of the Graph to include. - -* Graph Timespan - The time range to show for the Graph. - -* Alignment - Should the Graph be Center, Left or Right Aligned on the page. - -* Sequence - The Graph Items Sequence number. This is a Read Only variable. - - - -When, you change the Report Item to Device the layout of the page will -change and you will see the form shown below. - - -[Image: Report Item Device Item] - - -In this case, the Site, and Device Template both remain Filters, the Device -represents the Device to include on the Report. -After that, the options below define what Graphs from the Device are to be included. - - -* Graph Template - Either Any Graph Template, or a Specific Graph Template. - -* Graph Name Regular Expression - A regular expression that limits the Graphs -to only those matching the Regular Expression. - -* Graph Timespan - The time range to show for the Graph. - -* Alignment - Should the Graph be Center, Left or Right Aligned on the page. - -* Sequence - The Graph Items Sequence number. This is a Read Only variable. - - - -The last Report Item that we will document here is the Tree type. -The Text and Horizontal Rule types are pretty much self explanatory. -The image below is the layout that will be shown -when you change the Report Item to Tree. - - -[Image: Report Item Tree Item] - - -In this case, there are no filter, just selections. They include: - - -* Graph Tree - The name of the Cacti Tree to include in the report. - - -* Graph Tree Branch - The specific Branch to include - - - - -if you are only wanting to include aportion of the Tree - - -* Cascade to Branches - Walk all the Graph Trees branches - - -* Graph Name Regular Expression - A MySQL/MariaDB compatible Regular - - - - -Expression of Graph Names to include in the Report. - - -* Graph Timespan - The time range to show for the Graph. - - -* Alignment - Should the Graph be Center, Left or Right Aligned on the page. - - -* Sequence - The Graph Items Sequence number. This is a Read Only variable. - - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Report Preview - - -This section will describe the Report Preview Sub-Tab. - - -From this Sub-Tab, you will be able to preview the Report leveraging the -Format File if you included one on the Details sub-tab. The rendering may actually -be different depending on the Email client your recipient uses. So, it's best -to send the reports to the recipients using the Send Report option in the upper -right corner of the image below. - - -[Image: Report Preview] - - -There is not too much more to speak about on this Sub-Tab. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Report Events - - -On this page, you can simply see on what dates and approximate times that the -Reports scheduler will send future report. You can see from the image below -this the report will be sent every day at approximately 09:18:30. The poller frequency -or Data Collector interval is 30 seconds on this system. - - -[Image: Report Events] - - -Currently Cacti does not record past events in a Database table or store the published -report in either PDF or other document format in a Database for historical reference. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Other Report Management Options - - -Not only can you add and remove Report Items from the Reports interface, -but you can also add Graphs, Devices, and Trees to a Report from -the Cacti Console under Graphs, Devices and Trees pages. - - -For each Management section, you will find a drop-down that looks similar to the -Drop down below. Note that from this interface, you will not be able to add any -object type more than once. If you need to add a Device more than once to -more precisely choose filtering attributes, you will have to perform that from -the Reports interface itself. - - -We have future plans to add an icon to the right of the Graph on the Graph Tree and -Preview pages. - - -[Image: Report Other Options Device Page] - - -Regardless of the page type, when you select this option, upon clicking the Go button you will be presented with the following page. - - -[Image: Report Other Options Add Menu] - - -From there, select your destination Report, Timespan, and Alignment. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -System Utilities - - -This section will describe System Utilities in Cacti. - - -The system utilities page in cacti contains tools used for administering -cacti from this page you can do the following - - -* Rebuild poller cache. - - -* View technical support information. - - -* Adjust log settings. - - -* View the user log for audits. - - - - -[Image: System Utilities] . - - -Some of the most important tools are listed below - - -Rebuild poller cache - - -The Poller Cache will be re-generated if you select this option. Use this -option only in the event of a database crash if you are experiencing issues -after the crash and have already run the database repair tools. Alternatively, -if you are having problems with a specific Device, simply re-save that Device -to rebuild its Poller Cache. There is also a command line interface equivalent -to this command that is recommended for large systems. NOTE: On large systems, -this command may take several minutes to hours to complete and therefore -should not be run from the Cacti UI. You can simply run -'php -q cli/rebuild_poller_cache.php --help' at the command line for more -information. - - -Technical support - - -Cacti technical support page. Used by developers and technical support -persons to assist with issues in Cacti. Includes checks for common -configuration issues. There is also built-in checks that help you tune -your Cacti installation. - - -For example in the technical support section under the summary, you will see a -calculation for how many MySQL connections. You should have (Cacti 1.2.16+) -you will also show poller information such as the last polling time process -count and more detailed info that can be used for a quick view of how the -system is configured. - - -[Image: System Utilities] . - - -You will also see all of the system variables such as allocated php memory -as well as mysql variables. - - -[Image: System Utilities] - - -Any Variable appearing in red indicates a subpar setting and should be looked. -the recommendations are dynamic in that they change when more system resources are -detected so if you upgrade your server hardware be sure to check back to this page -to get the most out of your new hardware. - - -RRD cleaner - - -Console > utilities > System Utilities > RRDfile Cleaner - - -When you delete Data Sources from Cacti, the corresponding RRDfiles are not -removed automatically. Use this utility to facilitate the removal of -these old files. - - -In system utilities you can manually start the RRD cleaning procedure -You can either archive the selected RRD's -to have them deleted in the next polling cycle - - -[Image: System Utilities] - - -RRDfiles can also be schedule to automatically be removed this option can -be configured in Console > Configuration > Settings > Paths by selecting -the RRDfile autoclean selection. - - -[Image: System Utilities] - - -RRDfile Checker - - -Console > utilities > System Utilities > RRDfile Checker - - -The RRDfile checker is a tool that scans all RRDfiles at a -scheduled time and tests the stored data: - - -* Stale values for 1 or 24 hours - -* Whether the file is updated regularly - -* Incorrect file read/write access - -* Whether the Database Data Source objects match the RRDfiles Data Sources - - - -For very large Cacti installs the RRDfile checker can take quite -a long time to complete. -You can set number of concurrent parallel processes in Console > Configuration > Settings > Data - - -Viewing Change log from system utilities - - -With Cacti 1.2.16+, you are now able to view the CHANGELOG information up to the -version your server is currently running. This is available via the system -utilities menu which is useful for seeing what fixes and occasional features are -included in your version. - - -[Image: System Utilities] - - -View user login history - - -Console > utilities > System Utilities > View user Log - - -In system utilities you are able to view a log of user logins -both successful and failures The Log will also show what Client IP address -the login originated from along with info -if the login was based on password or token based login - - -[Image: System Utilities] - - -View boost update status and stats - - -Console > Utilities > System Utilities > View Boost Status - - -In this view you can see statistics on how Boost is running you will be able to see -Information such as when the last time boost started, How long it ran for, -The average boost record size - - -[Image: System Utilities] - - -[Image: System Utilities] - - -Viewing the Data Source Query Cache - - -Console > Utilities > System Utilities > View Data Source Query Cache - - -The Data Query Cache stores information gathered from Data Query input types. -The values from these fields can be used in the text area of Graphs for Legends, -Vertical Labels, and GPRINTS as well as in CDEF's. - - -[Image: System Utilities] - - -Viewing the Poller Cache - - -Console > Utilities > System Utilities > View Poller Cache - - -This is the data that is being passed to the poller each time it runs. - - -[Image: System Utilities] - - -Viewing System log via System Utilities - - -You are able to view the system log via the System utilities -page this will show the RAW log -this slightly differs from the view log tab as the device names -will show the device ID rather than -the Device name this is the same view as you reading the log in the OS - - -[Image: System Utilities] - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Data Collectors - - -Data Collector Background - - -Cacti can support from one to many Data Collectors. There are two types -of Data Collectors they are: - - -* Main Data Collector - This is essentially your core Cacti server -and database. The Main Data Collector is also referred to as -the Primary Server. - -* Remote Data Collector - These Data Collectors are located in -distant locations, or where reaching devices is blocked due to -firewall or security policies. The Remote Data Collectors are -also referred to as Remote Pollers. - - - -Due to the design of the Cacti Remote Data Collector, someone at the -remote site, can actually login to that Data Collector and interact -with it as if their Data Collector was the Main Data Collector. -Additionally, if for some reason the Main Data Collector becomes -unavailable due to a WAN outage for example, the data for the Devices -it manages will be cached locally until such time as the -Main Data Collector is reachable again. - - -When connectivity returns, the remote collector forwards cached results to the -main collector. This provides continuity during some network outages; it is -not automatic failover of the main server, database, or RRD storage. Size local -storage for the expected outage and monitor the delivery backlog. - - -Remote collection uses Cacti's built-in Boost functionality. -Review its configuration before deploying additional collectors. - - -Main and remote systems exchange data over the configured web and database -connections. Permit only the required hosts and configured ports, use HTTPS, -and secure database connections according to the installation's policy. -Confirm connectivity in both directions where configuration replication and -remote-agent operations require it. Additional dependencies such as DNS, -SNMP, and device availability checks have their own network requirements. - - -Data Collector User Interface - - -The image below shows the current online collector (aka pollers). On this page, -we can see the current, average, and max data collection times, the -Data Collector processes and threads used, the number of Devices as well -as what those Devices are polling. The Actions drop-down allows your to -Enable, Disable, and Delete Remote Data Collectors. There is also a -Full Sync option there. The Full Sync option will replicate key Cacti -tables to the selected Remote Data Collectors for things like -authentication, -global settings, etc. - - -In the current Cacti design, you should not have to perform a Full Sync -very often. It would mainly be used to push the user database and global -settings to the remotes, after an outage if there were database changes -during that outage. - - -[Image: Data Collectors] - - -The Main Data Collector resides on the central Cacti server. It also -serves as the master Data Collector performing key maintenance operations -for the entire system. - - -In the edit page below, you can see what options are available when editing the -Main Data Collector. It is important that the hostname used is resolvable -by the Remote Data Collectors. - - -[Image: Data Collectors Edit Main] - - -When editing the Remote Data Collector in the images below, you can see that -it shares many of the settings of the Main Data Collector with the addition -of a TimeZone setting and MySQL/MariaDB credentials and a Test Connection -button. Generally, these setting are only use during the initial setup -of Cacti, and afterwards for diagnostics only. - - -[Image: Data Collectors Edit Remote] - - -[Image: Data Collectors Edit Remote Connection Test] - - -Setup Main Data Collector to accept connections Remotes - - -Use the same Cacti version on the main and remote systems. Follow -How To Setup Remote Pollers , and select -New Remote Poller when installing the remote system. - - -Create a database account restricted to the remote collector's address, using -the account name consistently for both grants. Run the following in an -interactive database administration session after replacing the address and -password placeholders: - - -CREATE USER 'cacti_remote'@'192.0.2.20' IDENTIFIED BY 'REPLACE_WITH_UNIQUE_PASSWORD'; -GRANT ALL PRIVILEGES ON cacti.* TO 'cacti_remote'@'192.0.2.20'; -GRANT SELECT ON mysql.time_zone_name TO 'cacti_remote'@'192.0.2.20'; - - - -Configure the database listener, firewall, TLS, and host restrictions for your -network. Do not expose database access publicly or grant global privileges. -Use separate accounts where collectors require different access policies. - - -On the remote system, include/config.php uses $database_* settings for its -local database and $rdatabase_* settings for the main database. Populate the -remote settings during installation using that release's config.php.dist. -Verify the main hostname, database name, credentials, port, and TLS settings; -do not copy the main database address into the remote's local database fields. -Protect the configuration file because it contains credentials. - - -[Image: Remote Data Collector Setup] - - -After installation, assign a test device to the collector, run a polling cycle, -and verify both local collection and delivery to the main system. Confirm -that graph timestamps advance before moving additional devices. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Spine - - -Use only the supported operating systems and maintained -dependencies compatible with this Cacti branch. - - -Spine is Cacti's C-based, multithreaded data collector. It replaces cmd.php -as the collection engine; poller.php remains the scheduling entry point. -Actual throughput depends on device latency, scripts, concurrency, database -capacity, and the collection interval. Measure your installation before tuning. - - -Spine Architecture and Operating Principles - - -Spine reads polling definitions from the Cacti database, collects measurements -using SNMP and scripts, and writes results to poller output tables. Cacti's -poller or Boost processing updates the RRD files. Spine does not directly -write historical RRD files or render graphs. - - -Spine can run several processes and multiple threads per process. It also -maintains PHP script-server processes for methods configured to use -script_server.php, avoiding a separate PHP startup for each such call. - - -Installing Spine - - -Use the Spine release corresponding to your Cacti release. For development -checkouts, use compatible branches; do not mix a development poller with a -maintenance installation without verifying compatibility. - - -Install a C compiler, make, Autoconf, Automake, Libtool, and the development -headers and libraries required by that Spine version, including Net-SNMP and -MySQL or MariaDB client libraries. Git checkouts also need the bootstrap tools. -Use the package names and build repository appropriate to your distribution. - - -Download source from Cacti Spine -releases -or use your distribution's compatible package. From the extracted source: - - -./bootstrap -./configure --prefix=/usr/local/spine -make -sudo make install - - - -Inspect ./configure --help for library locations and optional build features. -Package installations can use different paths and permission policies. - - -ICMP permissions - - -Run the poller as its dedicated service account. ICMP availability checks need -socket permissions appropriate to the operating system and Spine version. -Possible mechanisms include permitted ping sockets, a narrowly scoped raw -socket capability, or the release's documented setuid installation. - - -The development branch can use unprivileged ICMP where the operating system -permits it. When started setuid root, it opens the required sockets and drops -root permanently before reading configuration. Older release behavior differs. -Do not assume Spine ships setuid or repeatedly regains root while polling. - - -Follow the installed release's instructions and local security policy. Keep -the executable owned by an administrative account and unwritable by the poller -account. Test the chosen availability method as the actual poller user. -SNMP collection does not itself require running the entire poller as root. - - -Configuring spine.conf - - -Create the configuration file from the installed template if one is not already -provided by the package: - - -sudo cp /usr/local/spine/etc/spine.conf.dist /usr/local/spine/etc/spine.conf - - - -Set the database host, database name, user, password, and port to match the -collector's database. Use that release's spine.conf.dist as the reference. -For example: - - -DB_Host localhost -DB_Database cacti -DB_User cactiuser -DB_Pass REPLACE_WITH_DATABASE_PASSWORD -DB_Port 3306 - - - -Use the DB_UseSSL and DB_SSL_* options when configuring the local database -connection for TLS. Remote collectors also have RDB_* settings for the main -database. Do not confuse local DB_* with remote RDB_* settings. - - -Restrict the configuration file to the accounts that need to read it, because -it contains database credentials. One Linux example, with a poller in the -www-data group, is: - - -sudo chown root:www-data /usr/local/spine/etc/spine.conf -sudo chmod 0640 /usr/local/spine/etc/spine.conf - - - -Substitute the actual poller group. Do not change application code ownership to -make a credential file readable. - - -Testing Spine from the Command Line - - -Use the poller account to run a database read-only test. The -R option -suppresses database writes, but still polls devices and executes configured -scripts. It is not a guarantee that those scripts have no side effects. - - -/usr/local/spine/bin/spine -R -V 3 -S - - - -To restrict the test to one device, substitute its actual ID for DEVICE_ID: - - -/usr/local/spine/bin/spine -R -f DEVICE_ID -l DEVICE_ID -V 5 - - - -Confirm the configuration path, database connection, device availability, and -returned values. Verbose output can expose sensitive operational information; -redact it before sharing. Use the installed binary's --help for its options. - - -Activating Spine in Cacti - - -* Open Console > Configuration > Settings > Paths and set -Spine Binary File Location to the installed executable. - -* Set Spine Config File Path when using a non-default configuration path. - -* Open Settings > Poller, choose spine as the Poller Type, and -save. - -* Leave the existing poller.php scheduler in place. Check the next scheduled -cycle for errors and confirm that graph timestamps advance. - - - -[Image: Alternate Poller Path] - - -Tuning Spine for Optimal Performance - - -Change one setting at a time and compare elapsed polling time, missed samples, -CPU use, database connections, and errors. More concurrency can overload a -collector, database, or device. - - -* Settings > Poller contains global script-server counts and script -timeout settings. Allow expected script execution time within the overall -polling budget. - -* Data Collection > Data Collectors sets processes and threads for each -collector. Size them for that collector's workload and database capacity. - -* Management > Devices provides device threads and maximum OIDs per -request. Larger SNMP requests can reduce round trips, but can also exceed -agent limits or fragment across the network. - - - -There is no universal process-per-core ratio, maximum useful thread count, or -OIDs-per-request value. Start with the release defaults and measured results. - - -Database Connection Sizing - - -Budget database connections across all collectors, poller processes, threads, -script servers, web requests, and maintenance jobs. Remote collection can -require connections to both local and main databases. Use Cacti's technical -support information and observed peak connections to size max_connections. - - -A connection failure can indicate credentials, DNS, routing, TLS, account-host -restrictions, or exhausted capacity. Check the database error before increasing -limits, and account for the memory cost of additional connections. - - -Security Policies - - -SELinux or AppArmor can restrict execution, network connections, or -configuration -file access. Inspect policy denials and apply rules appropriate to the poller -account and executable. Do not disable enforcement to diagnose a path or -credential error. See Hardening . - - -Troubleshooting Spine - - -* Configuration unreadable: verify the configured path and read access as -the poller user. - -* ICMP failure: check the selected ping method, socket permissions, -operating-system policy, and firewall. Do not assume SNMP must also fail. - -* Database failure: verify the correct local or remote connection settings -and inspect the database's error and connection count. - -* Missing samples: inspect script output, timeouts, SNMP responses, and the -configured collection interval. - - - -A SYSTEM STATS log line containing Method:spine confirms the selected -engine, not successful collection of every item. Check errors and actual RRD -updates as well. See Data Source Debugging and -The Cacti Log . - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Poller Settings - - -The Poller sub-tab of the Cacti settings are where you go to control -many aspects of Data Collection in Cacti, you control various base -collection frequencies, communication timeouts, and other settings that -impact how Cacti's Data Collection works. - - -General Settings - - -The General Settings are a broad collection of settings into -multiple categories. The image below shows Cacti's General Settings -sub-section. - - -[Image: Settings Poller General] - - -Those settings include: - - -* Data Collection Enabled - This is a setting that essentially will -override and disable all Cacti Data Collection from all of Cacti's -Data Collectors. It's really intended to allow you to put Cacti -in maintenance mode with a single click. - - -* SNMP Agent Support Enabled - The SNMP Agent has a measurable amount -of overhead on larger systems. Therefore, if you are not using it, you -should disable it. However, the SNMP Agent is a marvelous addition to -any Cacti system that's participating in a multi-level Operations -Framework. - - -* Poller Type - This is where you define either Cacti's built in poller -cmd.php, or use the more robust poller spine. You will not see the -spine drop-down option unless it has first been installed, and the -spine binary path defined from -Console > Configuration > Settings > Paths settings sub-tab. - - -* Poller Sync Interval - When creating a Cacti Data Collector -this is the default Full Sync interval it will use. In the current -Cacti design, a Full Sync should only be required when attempting -to replicate local authentication or authorization data to -Remote Data Collectors, of if you have made changes that would -otherwise impact the behavior of a Remote Data Collector when it -was offline. - - -* Poller Interval - This setting must align with the highest frequency -Data Source Profile polling interval. - - - - - - - -Note: This only applies to the Data Source Profiles that are in -use. If you only plan on polling every minute and therefore only using -the 1 Minute Data Source Profile, then your Poller Interval -should be 1 Minute as well. - - - -* Cron/Daemon Interval - This is the frequency at which either the Cacti -daemon (cactid.php), or the systems crontab/task-manager should relaunch -every Data Collectors Poller process. - - -* Balance Process Load - This setting will sort the devices such that -each concurrent Cacti process is polling the same number of Data Sources. -Otherwise, Cacti will simply order the hosts by their device ids. - - -* Debug Output Width - This is a diagnostic settings that you would only -enable from time to time if you wish to check if the output from your -Data Collector scripts exceeded the output width in the various -Poller tables. Since checking this have a very negative impact on -polling performance, it's disabled by default. - - -* Disable Decreasing OID Check - This setting is for performing -Data Query Re-index activities for tables whose OID's are not -structured in an orderly way where the suffix for the OID increases -in a known way. Though, in most cases enabling this setting will -not be harmless. There may be some cases where it would slow the -Re-index process. - - -* Remote Agent Timeout - When Cacti either needs information from -a Data Collector, like ping latency from the collector to one -of the Devices it's monitoring, or when a Remote Data Collector -needs information from the main Cacti server, this is the timeout -for receiving a handshake from that server. It's use to keep the -Website from locking up in the case a Data Collector is not -responding due to being down. - - -* SNMP Bulkwalk Fetch Size - This controls how many OID's are -returned per UDP turn when obtaining snmpwalk data from an -SNMP enabled Device. - - - - - - - -Note: This only works with SNMP v2 and v3. It is not supported -on older SNMP v1 Devices. - - - -* SNMP Get OID Limit - The default maximum number of SNMP Get -OIDs to issue per snmpget request. For Devices, this setting -is controlled at the Device level. You should only use this -setting when using Cacti's SNMP API natively in your scripts -and Plugins. - - -* Disable Resource Cache Replication - By default Cacti will -continually replicate it's Website content with it's -Remote Data Collectors. So, essentially, they are self -upgradable. However there are some cases where customers wish -to upgrade the Central system before allowing the remotes -to self upgrade. In those cases, you would enable this feature. - - - - -Background Timeout Settings - - -The settings below limit how long Cacti background processes will be -allowed to run before timing out and being killed the system and -notifying the Cacti administrator. These background timeouts are -required to keep Cacti performing a peak performance by not allowing -certain tasks to re-spawn while they are still running causing -system overload. Below is the image of those settings. - - -[Image: Background Timeout Settings] - - -Those settings include: - - -* Report Generation Timeout - Some reports can take several minutes -to complete. Adjust accordingly based upon your system size and -the number of reports across all users. - - -* Data Source Statistics Timeout - Depending on the size of your -Cacti system, some Data Source Statistics tasks can take quite -a bit of time. This setting is for the periodic collection and -not the Daily process. - - -* Background Commands Timeout - Cacti will schedule some commands -to be run offline during normal operations. This timeout affects -those commands. Some activities include some aspects of re-indexing, -removing old RRDfiles, etc. - - -* Maintenance Background Generation Timeout - Cacti performs daily -maintenance at midnight every day. This maintenance can include: -rotating logs, purging old logs, calculating Data Source -statistics, etc. This setting controls it maximum allowed runtime. - - -* Spikekill Background Generation Timeout - If you are using Cacti's -prophylactic spike-killer process on your Data Queries, this will control -it's maximum allowed run-time. - - - - -Data Collector Defaults - - -Cacti's Data Collectors include both concurrent process and thread -settings. They are maintained at the Data Collector level due to the -fact that not all Data Collectors are created equally. You may have -one Data Collector that's collecting data from 1,000 hosts, and another -that is collecting from 10. Maybe one is a Raspberry Pi and the other -a two socket EPYC chip. You would not want the same settings for each. - - -These settings are only the defaults, when you fist create a -Data Collector, once you save them, the setting stays with the -individual Data Collector. Below, you can see an image of those -settings. - - -[Image: Data Collector Defaults] - - -Those settings include: - - -* Data Collector Processes - The default number of concurrent -processes the Data Collector will spawn every cron or daemon -cycle. - - -* Threads per Process - The default number of spine threads -per Concurrent Poller Process above. - - - - - - - -Note: The Thread setting only applies if you are using the -spine poller. It does not apply to the cmd.php poller. - - - -Additional Spine Parameters - - -These settings are Global Spine poller settings. They apply to all -Data Collectors. An image of these settings can be seen below: - - -[Image: Additional Spine Parameters] - - -Those settings include: - - -* Invalid Data Logging - By default spine will only log the number -of errors it experienced for a Device. If you wish more -granularity you can change this settings to either Summary -or Detailed logging. - - -* Number of PHP Script Servers - Another level of Spine parallelism -is it's ability to create a pool of memory resident PHP -interpreters for running PHP scripts, making spine very powerful. -Every concurrent process will have this many memory resident -PHP interpreters pooled for running scripts. - - -* Script and Script Server Timeout Value - This is the timeout -to stop run-on script from blocking poller performance. If a script -exceeds this timeout, it will generate a log message. - - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -PHP Script Server - - -The PHP Script Server is a memory resident PHP interpreter that is launched -by each Cacti Data Collector or poller each polling cycle. If using -cmd.php, there will be at most one PHP Script Server launched per poller -process. If using spine poller, then up to 10 PHP Script Servers will be -launched in a pool for the various spine threads to consume. - - -If you have a number of devices that must gather their data via a script, it's -very important to utilize the PHP Script Server. This feature allows for the -rapid execution of PHP based Scripts and Data Queries in Cacti thus -reducing Data Collector polling times. - - -The reason that the PHP Script Server is so fast is that the PHP interpreter -is started in memory one time, and for every Data Source polled, it's -controlling function is interpreted only once. The resulting much faster script -execution and reduced load average during the Data Collectors life cycle. -Using the PHP Script Server process over the traditional exec() process nets -roughly a 20+ fold speed improvement in Cacti's Data Collection process. - - -Since PHP is such a powerful language, this Cacti feature enables rapid -collection of virtually any Data Source metric. It's an excellent choice -for both SNMP and non-SNMP based data. - - -Using the Script Server - - -Cacti contains two sample PHP Script Server scripts for reference. They are -for the collection of HostMib CPU and Disk Partition information. These two -examples are based off the traditional POPEN version of the HostMib functions -found in earlier versions of Cacti. Upgrading from these very old Data Input -Methods to the PHP Script Server is not longer supported. - - -Migration of Existing Scripts and Data Queries to PHP Script Server - - -If you have Scripts or Data Queries that you wish to migrate, you must -follow the steps below to migrate those scripts to the PHP Script Server -format. - - -Script File Changes - - -First, if your script is written in another languages, say Perl, or Python, you -need to convert it to PHP. Then, each PHP Script file must be changed to the -new Script Server format. The changes are not dramatic, but required for the -proper operation of the PHP Script Server. Note that you should use PHP -internal functions for calling services rather than forking binaries within the -PHP script as this will defeat the purpose of the PHP Script Server. Follow -the steps below to complete the migration. - - -* Copy your existing script to a new name. The name must begin ss_ followed -by your script name. The ss_ identifies the script as being a script server -variety of the a PHP script and is named that way to easily identify them in -your install. For example, if you previously had a script called -get_mysql_stats.php, it's new name would be ss_get_mysql_stats.php. - - -* Edit the new PHP script and add the following required lines to the file, -where ss_myfunction is the same as your filename. - - - - - - -* What was originally just mainline code, must be replaced with a function -name. For example, if your program previously contained the following three -lines of code: - - - - - - -Would become: - - -function ss_myfunction() { - $a = 100; - $b = $a / 10; - print $b; -} - - - -* If you have any additional functions declared within your script file, you -must prefix them to make them unique among all functions. Our recommendation -would be to prefix all functions with the name of the main function. For -example if you have a function called "meme" you would rename it to -ss_myfunction_meme. This guarantee's correct PHP Script Server -functionality. - - -* The last step is to change the function call that could have traditionally -returned the value to the Cacti poller using the print function. You must -change that line or lines in your code to utilize the return function -instead. However, this does not apply to print statements that are not -called from the Poller. For a simple script, this results in - - -function ss_myfunction() { - $a = 100; - $b = $a / 10; - return $b; -} - - - -Be careful, when writing Script Server Data Queries. Use the return -function for returning results of the GET operation. But use print for -index and query operations, e.g. - - -if (($cmd == "index")) { - ... - print $some_index_data . PHP_EOL; -} elseif ($cmd == "query") { - ... - print $some_query_data . PHP_EOL; -} elseif ($cmd == "get") { - ... - return $some_get_data; -} - - - - - -XML File Changes - - -If your Data Sources are based upon a Data Query, then you must also -change your XML file contents and location. Please reference the XML files in -the /resource/script_server directory for the specifics related to -your required modifications. However, you may also follow the instructions -below: - - -* Modify the tag. Change it from: - - -|path_php_binary| -q |path_cacti|/scripts/myfucntion.php - - - -to simply the following: - - -|path_cacti|/scripts/ss_myfunction.php - - - -* Add the following two XML tags below the tag. Replace -ss_myfunction with your function name: - - -ss_myfunction -php - - - -* Save the XML file. - - - - -Data Query & Data Template Changes - - -Your Data Queries and Data Templates must be also modified. Although -somewhat self explanatory by now, you must make the following changes: - - -* If the Data Template is based upon a Script and not a Data Query, -change it's Data Input Method to Script Server. - - -* If the Data Template is based upon a Data Query, edit the Data -Query and change it's Data Input Method to Get Script Server Data (Indexed) and change the XML file path to point to the new XML file in the -/resources/script_server/ directory. - - -* Your final step is to go to the Console > System Utilities > Rebuild Poller -Cache to apply the new settings. - - - - -If your PHP Script Server script is operating correctly, you should now be -migrated to the PHP Script Server. - - -Testing Your Script in the Script Server - - -To test your script in the script server, simply follow the instructions below. -When you have finished you testing, simply type "quit" + at the PHP -Script Server command line to exit the script server. - - -* Start the script server - You can do this by typing the following command: - - -shell> php /script_server.php - - - - - - -NOTE: Due to a bug in Windows implementation of PHP, you must type the -full path name to the script_server.php file. - - - -* Type in your command - Using the example from above, you would type in the -following: - - -script server> /path_cacti/scripts/ss_myserver_file.php my_function argument1 argument2 ... - - - -In the Windows environment, your example could be the following: - - -script server> c:\www\root\cacti\script\ss_myserver_file.php ss_myfunction argument1 argument2 ... - - - -* If your script and function is operating properly, you should get a result. - - -script server> c:\www\root\cacti\script\ss_myserver_file.php ss_myfunction argument1 argument2 ... -nameA:valueA nameB:valueB ... - - - -* To quit the script server, simply type quit at the command line. - - - - - -Note: If there are errors in your script, you must restart the script -server before your retest your code. - - - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Performance Boosting Settings - - -Summary - - -Cacti Performance Settings, formerly known as boost are available to support -very large Cacti installations, and are required for supporting the multiple -Data Collector architecture that Cacti affords. - - -Designed years ago, Boost's intent was to reduce the main data collector's -cycle time by caching writes to disk, and those writes would be handled by an -out of band process currently known as poller_boost.php. - - -Since these Large Sites had potentially well over one million Data Sources, -there was previously no way to write all that data every 5 minutes. So, the -buffering helped with maintaining a consistent run-time, and minimizing the user -experience disruption from all that blocking Disk I/O. - - -In the modern Data Center, where we find an abundance of NVMe, Flash, and SSD's, -the impact of all that I/O has been reduced. However, Boost now serves as a way -to extend the life of your Flash media and therefore increase the availability -of your Cacti server over its lifetime. - - -The Boost function in Cacti has several features that can be enabled or disabled -on demand by the Cacti Administrator. They include: - - -* On Demand RRD Updates - Required in ALL multiple Data Collector -installs and control the mass update of RRDfiles through periodic dumping of -Cacti's Boost cache. - -* Image Caching - caches PNG and SVG representations of the Cacti Graphs -to reduce the overall CPU utilization of the Cacti server infrastructure. - - - -Prerequisites - - - - - -Recommendation: For most installations, especially those using the -multiprocessing update feature introduced in Cacti 1.2.17, or any -deployment with multiple Data Collectors, use InnoDB for all Boost tables. -The MEMORY engine can cause race conditions between concurrent processes -competing for memory table locks, which leads to polling backlogs and data -loss on busy systems. InnoDB with SSD or NVMe storage performs comparably and -avoids these failure modes. MEMORY tables are also incompatible with MariaDB -Galera and MySQL replication. - - - -In its initial design the Boost process leveraged MySQL Memory Tables to -increase overall performance, and to reduce writing data to disk. With -improvements in InnoDB performance over the years combined with Flash storage, -the need for MySQL Memory Tables has diminished. The sections below document -MEMORY table sizing for sites that have an explicit reason to use it, but InnoDB -is the recommended engine. The main boost data table (poller_output_boost) -already ships as InnoDB; the ALTER TABLE examples below convert tables to -MEMORY only if you have a specific reason to use that engine. - - -If you do wish to use Memory you have to pay close attention to the amount of -data that will be cached in your design. You should periodically check that you -have sufficient memory available to cache all the data in the Boost cache. The -MySQL/MariaDB setting that controls the maximum size of a memory table is the -max_heap_table_size setting in your /etc/my.cnf.d/server.cnf file. - - -To change the max_heap_table_size setting you require a restart of -MySQL/MariaDB. So you won't want to make these changes often, as some systems -have little time between mass updates to perform a restart. If you restart -MySQL/MariaDB when the cache is full, you will lose those updates upon restart -unless you first change the ENGINE of the Boost cache table to InnoDB or MyISAM -before restarting. - - -When using Memory Tables you have to be cognizant of the maximum output width of -the Cache table called poller_output_boost. By default, it's set to 512 bytes, -which allows for very wide output from your Data Collectors. MySQL Memory -Tables do not allow for variable sized columns in memory - which means if you -write one byte to it, it will take 512 bytes. So, tuning this width is very -important. That will be explained in more detail later on in this chapter. - - -Checking how your system is configured - - -To see how your system is configured, you can goto -Console > Utilities > System Utilities > View Boost Status option, when you go -there, you will see an image similar to that below. - - -[Image: Boost Status Screen] - - -From this image, we can tell a few things: - - -* Boost is Idle, or flushing the Cache - -* The system has 1,120 Data Sources in total - -* There are currently 58,710 Boost records cached in all tables - - - -Additionally, you can tell - - -* Our Current Database Engine is InnoDB - -* The size of the current table is 3.52 MBytes - -* The average 'Bytes/Record' is 62 - -* We have unlimited Records that can be stored there - - - -From that Data, we know if we were to use a Memory Table, at present it's width -could be say 100 Bytes and we could cut memory use by 80%. - - -We can also estimate from this interface, how large our max_heap_table_size -would ultimately have to be, keeping in mind that the Current Boost Table Size -is misleading since even though each record can be in excess of 512 bytes, it's -presently only using 62 bytes of total storage per record. - - -In the image below, you can see runtime statistics, update frequencies, and -Image Caching settings, which are currently disabled. - - -[Image: Boost Status Screen] - - -From this setup, you can see that mass RRDfile updates are only happening -roughly every 6 hours to minimize wear and tear on the SSD storage in use. - - -Enabling Boost - - -To find and Enable the Boost settings, you first go to -Console > Configuration > Settings > Performance. From this interface, in the -image below, you can setup Boost. - - -[Image: Boost Settings Screen] - - -As an exercise, lets look at a fictitious setup and determine what the -max_heap_table_size should be. Let's say, for example, that your Cacti systems -Poller Cache contains 200k rows, and the maximum length of any rows output -is 20 bytes, about the size of a 64bit counter value. - - -If you are running scripts, ones that return very long results, like the MySQL -statistics plugin, you should consider carefully the next step. - - -In this case, we will assume that even though the largest value returned is 20 -bytes, we will elect to maintain a maximum output column width of 50 bytes. - - -The important thing here is that memory tables store the full size of the -column, even though the column type is varchar(). By default it's -varchar(512). Therefore, if your system only needs 50 bytes, you will have 90% -waste in your poller_output_boost table. - - -The next step would be to modify the structure of your poller_output and -poller_output_boost tables. You would do this by doing the following: - - -ALTER TABLE poller_output - MODIFY COLUMN output varchar(50) NOT NULL DEFAULT '', - ENGINE=MEMORY; - -ALTER TABLE poller_output_boost - MODIFY COLUMN output varchar(50) NOT NULL DEFAULT '', - ENGINE=MEMORY; - - - -As previously mentioned, its also important that the poller_output table is -converted to memory, eliminate any disk I/O related to poller updates. - - -Now, you need to determine how many polling cycles will fit into your -poller_output_boost table. In this case, when sizing the poller_output_boost -table, you take the output column width and add 34 bytes per record. So, in this -case, each data source result to be stored in the poller_output_boost table -would take 84bytes. - - -Then, with the Maximum Heap Table size in hand, and let's say the default is -16MBytes for the largest table (the MySQL default), you can calculate the number -of poller intervals that you can store without running out of MySQL memory. So, -let's take our example: - - -200k Cache Entries x 84 Bytes Per Poller Cache Row = 1,680,000 Bytes per Poll - - - -This means that your poller_output_boost can handle 10 Cacti polling cycles, -or roughly 4/5 of an hour of poller data before it must be cleared by the -system. - - -As all things go, you should not want to take your system to the edge. So, it is -best to increase the max_heap_table_size of your system to ensure you have -buffer in cases where say for example, your disks become degraded over time and -the Boost cycle is extended as a result. - - -But let's look at the problem a different way. Let's say that you wish to -perform major updates every 4 hours. With a 50% memory reserve, we should plan -for 6 hours of updates. This way, we need to have size for 72 poller cycles in -your poller_output_boost table. This means that the max_heap_table_size must -be at least 131,040,000 Bytes. - - -So, let's call it a deal. Provided you have enough memory, and I expect that you -do, you would edit the /etc/my.cnf.d/server.cnf and add/modify the following -line: - - -max_heap_table_size=132M - - - -Then, save the file, and restart MySQL. Once this is done, you are ready to -"enable" Boost as described above. - - -Flushing the Boost Cache - - - - - -Warning: MEMORY tables are cleared on every MySQL/MariaDB restart. If you -are using MEMORY storage, always flush the Boost Cache before taking the -database offline. Failure to do so will result in loss of all buffered poller -data since the last flush. - - - -If you are planning on system maintenance and are using MEMORY storage in -MySQL or MariaDB, flush your Boost Cache before the system is taken offline. -Login to the Cacti system as root and run the following: - - -cd /var/www/html/cacti -php -q poller_boost.php --force - - - -This operation will take several minutes to complete, at which time there will -be additional records in the poller_output_boost table. So, it might be better -that after the poller_boost.php process is complete, to modify the -poller_output_boost table to InnoDB before reboot, and then convert it back to -memory after they system maintenance is complete. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -rrdproxy - - -Cacti RRD Proxy is a standalone proxy interface to Tobi Oetiker's great RRDtool. - - -The main focus of this project is to allow the relocation of RRDfiles, data -replication, support of Cacti Boost and, if needed, the RRDcached daemon. It -allows system administrators to split Cacti's access resources across machines -without the need for NFS. - - -Due the fact that updates to files may contain sensitive data and to prevent -undesired updates, RRDtool proxy utilizes high encrypted connections (RSA2048 -and AES192) with continuously changing keys. This ensures a secured connection -between the proxy and registered clients and/or other proxies. - - -A local service port is provided to allow administrators are able to access a -separate command line interface which provides easy access to configure and -debug the proxy. - - -Contribute - - -Get involved in development by participating in active development on -GitHub . - - -Requirements - - -RRDproxy runs on any Unix-based operating system that can meet the minimum -requirements, though it will perform better with the recommended (or higher). - - -Minimum Requirements - - -* PHP Version 7.1 or higher -Installation must include and enable the following modules: - - -* Sockets - - -* Posix - - -* PCntl - - -* GMP - - -* ZLIB - - - - -* RRDtool Version 1.5 or higher - - -* Cacti Version 1.2.7 or higher - - - - -Recommended Requirements - - -All minimum requirements must be met, though the following are more optional: - - -* PHP Version 7.3 or higher -Include all minimum recommendation modules - - -* RRDtool 1.7 or higher - - -* Cacti 1.2.7 - - - - -Usage - - -Before using the RRDproxy, you must install the system using the setup wizard -which can be run at any point using the -w parameter. - - - php rrdtool-proxy.php --help - - RRDtool Proxy v1.2.7 - Copyright (C) 2004-2026 The Cacti Group - usage: rrdtool-proxy.php [--wizard] [-w] [--version] [-v] - Optional: - -v --version - Display this help message - -w --wizard - Start Configuration Wizard - - - -When running through the wizard, the status of items will appear on the right -hand side of the screen. When an item is successfully completed, the status of -[OK] will be shown in green (when color is supported) as seen below: - - -Checking System Requirements... -[0.00001] test: operation system supported [OK] -[0.00007] test: php module 'sockets' [OK] -[0.00011] test: php module 'posix' [OK] - - - -Should any item have an issue, the status will be displayed as something other -than [OK] such as [FAILED]: - - -[0.40270] read: RRDproxy configuration file [FAILED] - - - -Status Color | Description -: --- | : --- -Green | Success and without issue -Yellow | Warnings and will be ignored, correct the problem if needed -Red | Errors and will not be ignored, may prevent continuation - - -When the wziard prompts for the various settings that are available, you can -accept the default value simply by pressing return to accept it. Below are a few -of these settings and the default values that can be accepted: - - -Setting | Default | Comment -: --- | : --- | : --- -CLI System Prompt | rrdp | Max 8 chars -IPv4 Listen Addr | 0.0.0.0 | Listen all addr -Client Proxy Port | 40301 | Connections from a client -Proxy port | 40302 | Connections from another proxy -Dedicated CLI port | 40303 | Connections to the RRDproxy cli - - -Command Line Interface - - -Use '?' to get a list of all commands being supported by the proxy or hints -about missing parameters. - - -telnet localhost 40303 -Trying 127.0.0.1... -Connected to localhost. -Escape character is '^]'. -rrdp>? - enable Turn on privileged commands - help Display help - show Show running system information - quit Close terminal session - -rrdp>ena -rrdp#sh version - -# ___ _ _ __ __ ___ ___ -# / __\__ _ ___| |_(_) /__\ /__\ / \ / _ \_ __ _____ ___ _ -# / / / _` |/ __| __| | / \// / \// / /\ / / /_)/ '__/ _ \ \/ / | | | -# / /__| (_| | (__| |_| | / _ \/ _ \/ /_// / ___/| | | (_) > <| |_| | -# \____/\__,_|\___|\__|_| \/ \_/\/ \_/___,' \/ |_| \___/_/\_\__, | -# |___/ - - RRDtool Proxy v1.2.7 - Copyright (C) 2004-2026 The Cacti Group - rrdp uptime is 14 days, 0 hours, 4 minutes, 14 seconds - Memory usage 0.18872917 % (2026464/1073741824 in bytes) - a8:29:6a:b7:5d:be:c3:8a:be:13:7a:61:ee:0c:8b:d3 - Process ID: 13996 - Session usage (1/399) - - Server IP [192.168.10.10] - Administration: [localhost :40303] - Replication: [192.168.10.10 :40302] - Clients: [192.168.10.10 :40301] - -rrdp# - - - -Missing features - - -* Data replication has been completed to 95%, but is still not ready - - -* NET-SNMP pass persistent daemon and MIB needs to written to make proxy stats -available through SNMP - - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Remote Poller Setup - - -Remote Pollers add complexity to your cacti setup while also massively extended -the scalability of it. Remote Pollers allow system admins to distribute -the load of polling between different servers as well as provide another source -of polling close to a device. - - -For example you may have a device in Toronto but if your pollers are in New York -the network latency may causes issues with your metrics having a remote poller -in Toronto in this case will help with that issue. - - -Setup Instructions - - -The process of remote poller installation is similar to cacti installation. -In the wizard, select the installation type for Remote poller. For the remote poller -you must use the same version of cacti as the main poller installation. - - -With this setup the following layout is assumed - - -* Main server IP is 192.168.1.5 - - -* Remote poller 1 server IP is 192.168.1.10 - - -* Remote poller 2 servers Ip is 192.168.1.20 - - - - -Database Configuration - - - - - -Security: The username cacti and password cacti shown in the examples -below are placeholders. Use a strong, randomly generated password in -production. Never use the literal string cacti as a database password on -any reachable system. - - - -Each server will have its own local database however the remote pollers will -need to talk back to the main poller so we must allow the remote servers user -account to connect back to the main pollers database via the network - - -Main server database config - - -CREATE USER 'cacti'@'192.168.1.10' IDENTIFIED BY 'strongpassword'; -GRANT ALL PRIVILEGES ON cacti.* TO 'cacti'@'192.168.1.10'; -CREATE USER 'cacti'@'192.168.1.20' IDENTIFIED BY 'strongpassword'; -GRANT ALL PRIVILEGES ON cacti.* TO 'cacti'@'192.168.1.20'; -FLUSH PRIVILEGES; - - - -Remote poller 1 database configuration - - -CREATE USER 'cacti'@'192.168.1.5' IDENTIFIED BY 'strongpassword'; -GRANT ALL PRIVILEGES ON cacti.* TO 'cacti'@'192.168.1.5'; -FLUSH PRIVILEGES; - - - -Remote poller 2 database configuration - - -CREATE USER 'cacti'@'192.168.1.5' IDENTIFIED BY 'strongpassword'; -GRANT ALL PRIVILEGES ON cacti.* TO 'cacti'@'192.168.1.5'; -FLUSH PRIVILEGES; - - - -We have also let the main poller talk to the remote pollers to keep in sync - - -Spine configuration - - -When you have setup multiple pollers while using spine you will need to also -configure the spine.conf file to connect to the remote database as well. - - -Be sure to remove the # next to the below entries - - -RDB_Host 192.168.1.5 -RDB_Database cacti -RDB_User cacti -RDB_Pass strongpassword -RDB_Port 3306 - - - -If the network between pollers and the main server is not fully trusted, -enable SSL for the remote database connection: - - -RDB_UseSSL 1 -RDB_SSL_Key /etc/cacti/ssl/client.key -RDB_SSL_Cert /etc/cacti/ssl/client.crt -RDB_SSL_CA /etc/cacti/ssl/ca.crt - - - -Spine poller and max connections - - -Since in a multi poller setup Spine is highly recommended you will need -to follow the following calculation when that calculation would be: - - -connections = spine-processes x ( 1 + threads-per-process + PHP servers ) - - - -Remote poller config.php setup - - -Now that we have set up the database connections we need to set up the cacti -config.php file on the remote pollers to give them the database info they need -to connect to the main poller we won’t have to edit the main servers config.php -file aside from the normal install procedure to give it access to its local -database. Below is the portion of the config.php that we need to edit to allow -the remote poller to talk to the main server be sure to remove the hash sign (#) - - -$rdatabase_type = 'mysql'; -$rdatabase_default = 'cacti'; -$rdatabase_hostname = '192.168.1.5'; -$rdatabase_username = 'cacti'; -$rdatabase_password = 'strongpassword'; -$rdatabase_port = '3306'; -$rdatabase_retries = 5; -$rdatabase_ssl = false; -$rdatabase_ssl_key = ''; -$rdatabase_ssl_cert = ''; -$rdatabase_ssl_ca = ''; - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Change poller interval from 5 minutes to 1 minute - - -This howto describes all necessary steps for convert your cacti to 1 minute poller interval. This cause one gap in graphs during the convert. Gap size depends on count of your rrd files. - - -Prerequisites and default values used in this howto - - -* Cacti installation directory is /usr/local/share/cacti/ - -* PHP binary is /usr/local/bin/php - -* RRD files are in /usr/local/share/cacti/rra - -* Poller is running by user cacti - -* Not structured RRDfile paths (Configuration->Settings-> Data -> Structured RRDfile Paths). With structured path you will have more works with splice rrd files. You need change splice script. - -* Crontab row looks like - - - -*/5 * * * * cacti /usr/local/bin/php /usr/local/share/cacti/poller.php 2>&1 - - - -Backup your Cacti - - -Before this operation, backup Cacti database and all data in rra folder - - -RRDCleaner (optional step) - - -You can run rrdcleaner and delete unused RRD files. It can decrease converting time. -System Utilities - - -Stop poller - - -Disable your poller in Crontab or via GUI Console -> Configuration -> Settings -> Poller tab -> Data Collection Enabled - - -Prepare directory structure for RRD file convert - - -mkdir -p /tmp/cacti/rrd_old -mkdir -p /tmp/cacti/rrd_new -mkdir -p /tmp/cacti/rrd_fin - - - -Make sure that you have enough space on temporary disk. You need more than twice of rra directory size. - - -Move rrd files - - -mv /usr/local/share/cacti/rra/* /tmp/cacti/rrd_old/ - - - -Check or create Presets -> Data profiles - - -Go to Console -> Presets -> Data Profiles. Here should be at least 5 Minute Collection profile (because you are using it until now) and 1 Minute Collection profile. -If the second is missing, create it. -[Image: Presets] - - -Remember Data profile ID - Edit your 1 minute collection again and in URL will be .../data_source_profiles.php?action=edit&id=3 - - -Switch to 1 min - - -Console -> Configuration -> Settings -> Poller tab - - -* Poller interval = Every minute - -* Cron/Daemon interval = Every minute - - - -Update database records - - -Run these SQL queries: - - -UPDATE data_template_data SET rrd_step=60 WHERE rrd_step=300; -UPDATE data_template_rrd SET rrd_heartbeat=600; - - - -Here replace X with ID from Step "Check or create Presets -> Data profiles": - - -UPDATE data_template_data SET data_source_profile_id=X; - - - -Rebuild poller cache - - -Console -> Utilities -> System utilities -> Rebuild Poller Cache - - -Set 1 min Data Profile as default - - -Console -> Presets -> Data Profiles - - -Edit profile 1 min Collection, checkbox default. - - -[Image: Presets] - - -Change profile for all Data templates - - -Console -> Templates -> Data Source - - -Select all -> Change Profile - - -[Image: Presets] - - -Run the poller once - - -New rrd files with correct 1 min profile will be created in /usr/local/share/cacti/rra directory. -Cacti log shouldn't contain errors. - - -Move new rrd files to temporary folder - - -mv /usr/local/share/cacti/rra/* /tmp/cacti/rrd_new/ - - - -Run splice - - -You need run splice command for each rrd file. This could be time consuming, depends on number of files. You can use some tool for parallel tasks. -The splice_rrd.php file is designed to allow two RRDfiles to be merged. This utility can effectively change the resolution/step of an RRDfile so long as the new RRDfile already has the correct step. - - -Basic script: - - -#!/bin/sh - -cd /tmp/cacti/rrd_old/ -for f in *.rrd -do - echo $f - /usr/local/bin/php /usr/local/share/cacti/cli/splice_rrd.php --oldrrd=/tmp/cacti/rrd_old/$f --newrrd=/tmp/cacti/rrd_new/$f --finrrd=/tmp/cacti/rrd_fin/$f -done - - - -Run script and wait. My experience - 5200 files took 100 minutes without parallelization. Script will be output sometning like: - - -fortigate_1_-_fg200e4q17911506_traffic_in_7317.rrd -NOTE: Using Native Arrays due to lack of SQLite. -NOTE: Using RRDtool Version 1.8.0 -NOTE: RRDfile will be written to '/tmp/cacti/rrd_fin/fortigate_1_-_fg200e4q17911506_traffic_in_7317.rrd' -NOTE: Re-Importing '/tmp/fortigate_1_-_fg200e4q17911506_traffic_in_7317.dump.27482713' to '/tmp/cacti/rrd_fin/fortigate_1_-_fg200e4q17911506_traffic_in_7317.rrd' -NOTE: Time:0.88, RUsage:18 MB - - - -Move spliced files back to cacti - - -mv /tmp/cacti/rrd_fin/* /usr/local/share/cacti/rra/ - - - -File owner should be cacti - - -chown cacti /usr/local/share/cacti/rra/* - - - -Enable poller in Cron again - - -Change your cron settings from 5 minutes to 1 minute and enable (uncomment). Old row: - - -#*/5 * * * * cacti /usr/local/bin/php /usr/local/share/cacti/poller.php 2>&1 - - - -New row - - -* * * * * cacti /usr/local/bin/php /usr/local/share/cacti/poller.php 2>&1 - - -How To Set Up SSH Tunnels to Graph a Remote Unix Server - - -Howto created by fmangeant at the -Cacti Forum - - -This guide explains how to use SSH tunnels to graph a Unix server that is not -directly reachable by your Cacti server. - - -[Image: Overview] - - -In this example, the Cacti server can reach the Gateway, which can reach the -target server. - - - - - -Important — TCP vs UDP: SSH port forwarding (-L) is TCP-only. Standard -SNMP uses UDP port 161 and cannot be tunneled this way. This guide works -only when the target's snmpd is explicitly configured to accept TCP -transport (as shown below). It is not suitable for most network devices -(routers, switches, etc.), which support UDP SNMP only. For UDP SNMP across -untrusted networks, use a VPN instead. - - - -Configuring the SSH tunnel - - -On the Gateway, create a cactiuser account: - - -# useradd -d /home/cactiuser -m cactiuser - - - -Generate an SSH key pair (no passphrase, so the tunnel can start -unattended). The modern recommendation is ed25519: - - -# su - cactiuser -$ ssh-keygen -t ed25519 -Generating public/private ed25519 key pair. -Enter file in which to save the key (/home/cactiuser/.ssh/id_ed25519): -Enter passphrase (empty for no passphrase): -Enter same passphrase again: -Your identification has been saved in /home/cactiuser/.ssh/id_ed25519. -Your public key has been saved in /home/cactiuser/.ssh/id_ed25519.pub. - - - -Authorize the public key for login: - - -$ cd $HOME/.ssh -$ cp -p id_ed25519.pub authorized_keys - - - -Create the SSH tunnel: - - -# su - cactiuser -c "ssh -f -N -g -L 192.168.0.2:10000:192.168.1.2:161 cactiuser@localhost" - - - -This forwards all TCP traffic sent to 192.168.0.2:10000 on the Gateway to -192.168.1.2:161 on the target server. - - -Option summary: - - --f Go to background before executing the command --N Do not execute a remote command --g Allow remote hosts to connect to locally forwarded ports --L Forward the given local port to the given host and port on the remote side - - - -Making the tunnel persistent (systemd) - - -On systemd-based hosts covered by the -supported operating systems , -/etc/rc.local is deprecated and disabled by default. Use a systemd service -instead. - - -Create /etc/systemd/system/cacti-ssh-tunnel.service: - - -[Unit] -Description=SSH tunnel for Cacti SNMP polling -After=network.target - -[Service] -User=cactiuser -ExecStart=/usr/bin/ssh -N -g -L 192.168.0.2:10000:192.168.1.2:161 cactiuser@localhost -Restart=always -RestartSec=10 - -[Install] -WantedBy=multi-user.target - - - -Enable and start it: - - -# systemctl daemon-reload -# systemctl enable cacti-ssh-tunnel -# systemctl start cacti-ssh-tunnel - - - -Configuring Net-SNMP on the target server - - -By default, the Net-SNMP agent listens on UDP port 161. For this SSH -tunnel approach you must configure it to listen on TCP port 161 instead. - - -In snmpd.conf on the target server: - - -agentaddress tcp:161 -rocommunity mycommunity - - - -For a more detailed snmpd.conf reference, see the -Net-SNMP snmpd.conf man page . - - -Testing SNMP connectivity - - -From the Gateway host: - - -$ snmpwalk -v 1 -c mycommunity tcp:192.168.1.2 sysname -SNMPv2-MIB::sysName.0 = STRING: target_server - - - -From the Cacti server: - - -$ snmpwalk -v 1 -c mycommunity tcp:192.168.0.2:10000 sysname -SNMPv2-MIB::sysName.0 = STRING: target_server - - - -If these succeed, the host is ready to be added to Cacti. If not, review -your firewall rules and verify snmpd is listening on TCP. - - -Adding the device to Cacti - - -In Cacti, create a new device as shown: - - -[Image: Add device] - - -Your target server is now graphed by Cacti. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -How To Extend snmpd with custom script/data - - -Some SNMP servers can be extended with custom scripts or programs. The output of the running script can then -be read using the OID and can therefore be easily used in Cacti. An example is the thermometer on the USB port. -In combination with Graph a Single SNMP OID , this is a very simple way to display such data. - - -We will show the procedure for the very extensive Net-SNMP and FreeBSD BSNMPD. - - -Linux Net-SNMP - - -Simply add a line to /etc/snmpd.conf and restart snmpd: - - -extend test /bin/echo hello - - - -The result will be here: - - -snmpwalk -v2c -c testing 127.0.0.1 nsExtendOutput1 -NET-SNMP-EXTEND-MIB::nsExtendOutput1Line."test" = STRING: hello -NET-SNMP-EXTEND-MIB::nsExtendOutputFull."test" = STRING: hello -NET-SNMP-EXTEND-MIB::nsExtendOutNumLines."test" = INTEGER: 1 -NET-SNMP-EXTEND-MIB::nsExtendResult."test" = INTEGER: 0 - - - -For Cacti you need a numeric OID. Use snmptranslate: - - -snmptranslate -On NET-SNMP-EXTEND-MIB::nsExtendOutput1Line."test" - - - -The result is an OID that we can use: - - -.1.3.6.1.4.1.8072.1.3.2.3.1.1.4.116.101.115.116 - - - -FreeBSD BSNMPD - - -Install bsnmp-ucd: - - -pkg install bsnmp-ucd - - - -Add these lines to /etc/snmpd.config and restart bsnmpd: - - -begemotSnmpdModulePath."ucd" = "/usr/local/lib/snmp_ucd.so" -%ucd -extNames.0 = "first command" -extCommand.0 = "/path/to/script.sh" -extNames.1 = "second command" -extCommand.1 = "/path/to/script.sh param1" - - - -The name and result of the first command share the same index: - - -snmpwalk -v2c -c testing 127.0.0.1 .1.3.6.1.4.1.2021.8.1.2.0 -.1.3.6.1.4.1.2021.8.1.2.0 = STRING: first command - -snmpwalk -v2c -c testing 127.0.0.1 .1.3.6.1.4.1.2021.8.1.101.0 -.1.3.6.1.4.1.2021.8.1.101.0 = STRING: 15 - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Templates - - -The real strength of Cacti is unleashed by using templates. There are five -different types of templates with the basic Cacti installation: - - -* Device Templates - Define a Collection of Graph Templates and Data -Queries that belong to a class of Devices - - -* Graph Templates - Define how to paint the Graph, it size, legend, left and -right Axis and it Canvas - - -* Data Templates - Define how data is to be stored in the RRDfile and how -often to collect that data - - -* Aggregate Templates - A special class of Graph Template that allows -you to combine elements from multiple Graph of a common Template into one -Graph - - -* Color Templates - A collection of color rotations to use for Aggregate -Graphs - - - - -While it is perfectly fine to define all Data Sources and Graphs without -using Templates at all, the burden of this approach is high. - - -In most installations, there are hundreds if not thousands of Devices of the -same kind. And there are many similar Graph Templates, that span multiple -Device Templates. For example: Network Traffic information is needed for -almost every Device. Therefore, the parameters needed to create a traffic -RRDfile are defined by the Data Template, in this case known as "Interface - -Traffic". These definitions are used by all Traffic-related RRDfiles. - - -The same approach is used for defining Graph Templates. This is done only -once. And all parameters defined within such a Graph Template are copied to -all Graphs that are created using this Template. - - -The last type of classic Templates are the Device Templates. The purpose of -Device Templates is to group all Graph Templates and Data Queries -for a given Device Type. Example Device Types that you might find a -Device Template for include: - - -* Cisco Router - -* Net-SNMP Device - -* F5 Load Balancer - -* Windows Device - -* Local Linux Device - -* ... - - - -So you will make up a Device Template e.g. for a specific type of router, -switch, host and the like. By assigning the correct Device Template to each -new Device, you'll never forget to create all needed Graphs. - - -There's no need to create all Templates on your own! Apart from the fact, that -many common templates are provided out-of-the-box, there's a very simple -mechanism to Import Templates and to Export Templates and more recently -to Import Packages. - - -More recent additions to the Cacti family of Templates are the Aggregate -Template and Color Template. The Aggregate Template allows you to -define a Graph Template that can aggregate data from many Graphs sharing -that Template. - - -The Color Template defines a list of colors that are used in a Round Robin -fashion to change the colors seen on the resulting Aggregate Graphs to -better assist the user in interpreting the resulting Graph. - - -In order to best follow the natural course of Template creation, the remainder -of this chapter will explain Templating starting with Data Templates, then -we will go from there to Graph Templates, and from there go to a -walk-through of creating both a Data Template and Graph Template. - - -From there, we will explain how to create a Graph using that newly created -set of Templates. - - -Data Templates - - -In Cacti, a Data Template provides a skeleton for an actual Data -Source. If you have many Data Sources that share most of their -characteristics, using a Data Template makes sense. Saving a template -propagates eligible fields into attached Cacti data-source definitions, subject -to their per-source settings. It does not automatically rewrite existing RRD -files. - - -Changes to physical RRD structure need a separate migration or repair. RRDtool -1.5 and later can add a data source with rrdtool tune DS:...; current Cacti -RRD comparison/repair code can generate those recommendations. Back up the RRD -and inspect the proposed changes before applying them. Changing a sampling step -or archive layout needs a migration suited to that change. See Data Source -Profiles . - - -Creating a Data Template - - -To create a new Data Template, select Data Source under -Console > Templates menu selection and then click Add, which in most cases -will be the plus sign in the upper right area of the page. - - -The first thing you must do is give the template a name. This name has nothing -to do with the Data Source name, but is what you will use to identify the -template throughout Cacti. - - -Second, you will notice a list of Data Source / Data Source Item field -names with Use Per-Data Source Value check-boxes next to each one. The nice -thing about Templates in Cacti is that you can choose whether to template each -field on a per-field basis. If you leave the check-box unchecked, every Data -Source attached to the Data Template will inherit its value from the -Template. If the check-box is checked, every Data Source attached to the -Data Template will contain its own value for that particular field. When -generating a real Data Source, you will be prompted to fill those -non-templated fields. - - - - - -NOTE: If you are using Cacti's Automation feature, there is presently -no way for you to override these values. So, plan accordingly when engineering -your Cacti deployment. - - - -Table 13-1. Data Templates: Field Description of the Data Source Section - - - - - - Name - Description - - - - - - - Name - The name of the Data Source that will be created by using this Template. You can use the keyword host_description enclosed by vertical bars in this field, which will be automatically substituted with the current host description of the Device. There are several replacement values available to you when using a Template. - - - - - Data Input Method - Here is where you tell Cacti how it is supposed to fetch data for this Data Source. There are several Data Input Methods that come with Cacti, and you can add your own by going to Console > Data Collection > Data Input Methods. If this RRDfile is being populated outside of Cacti, make sure to leave this field set to "None". - - - - - Data Source Profile - The Data Source Profile will define how often to collect data for the resulting Data Source, and how long to keep that data in the RRDfile. - - - - - Data Source Active - This is a quick and easy to tell Cacti to stop gathering data for this Data Template. The resulting Data Source can still be used on Graphs, but no data will be fed to it until it is made active again. - - - - - - - - -NOTE: For most Data Templates, you should not have to check -the Use Per-Data Source Value check-box for the name field. The Templating -should -handle this just fine. However, the Generic SNMP OID Data Template has -this value checked to allow you to create Graphs and Data Sources on a -piecemeal basis. - - - -When you are finished filling in values for the Data Template, click Create -and you will be presented with a screen similar to the image below. - - -[Image: Adding a Data Template] - - -Data Source Items - - -Just like a Graph, a Data Source can have more than one item. This is -useful in situations where a script returns more than piece of data at one time -and both need to appear on the same Graph. This also applies to Data -Queries, so you can have a single Data Template that contains both Inbound -and Outbound Traffic, rather than having to create a separate Data Template -for each. - - -Table 13-2. Data source item fields - - - - - - Name - Description - - - - - - - Internal Data Source Name - This is the name used by RRDtool to identify this particular data source within the RRDfile. The Cacti template editor accepts 1–19 letters, digits, or underscores. Some imported names can contain other RRDtool-valid characters, including hyphens, that this editor rejects. Use underscores for new templates; renaming an existing RRD data source requires a coordinated file and definition change. - - - - - Minimum Value - Here is where you specify the minimum value that is expected for this data source in the RRDfile. If a value lower than the minimum is given, it will be stored as Unknown (U). - - - - - Maximum Value - Here is where you specify the maximum value that is expected for this data source in the RRDfile. If a value higher than the maximum is given, it will be stored as Unknown (U). Note: It often makes sense to define a reasonable maximum value here to avoid spikes in case of a COUNTER wrap - - - - - Data Source Type - Choose a type supported by the collection method and installed RRDtool. See Data Source Templates for COUNTER, GAUGE, DERIVE, ABSOLUTE and version-dependent double-precision types, plus the current COMPUTE creation limitation. - - - - - Heartbeat - As defined by RRDtool: "The maximum amount of time that can pass before data is entered as "unknown". This field is usually '600' or 2 data gathering intervals". - - - - - -Custom Data - - -Assuming you selected a Data Input Method on the previous screen, you should -now be presented with a Custom Data form. It will show a single line for -every single parameter required for that very Data Input Method. This is how -the Data Source connects to the Data Input Method to provide all run -time parameters. - - -Each Custom Data field is per-field Templatable as all of the other Data -Source fields are. Even if you select the Use Per-Data Source Value check-box, -it might be useful to specify a value that will be used as an "initial value" -for any Data Source using the Data template. - - -Applying Data Templates to Data Sources - - - - - -NOTE: When changing parameters of a Data Template, existing RRDfiles -will not be changed automatically. If this is required, you will have to apply -rrdtool tune command to any related RRDfile manually. - - - -Applying a Data Template to a Data Source is a very simple process. The -first thing you must do is select the Data Source you want to apply the -template to under Data Sources. Under the Data Template Actions -drop-down, select the Data Template that you want to apply to the Data -Source and click Save. Though this should be very rare in modern Cacti -instances, it was fairly common before Cacti's Templating system matured. - - -Once a Template is applied to a Data Source, you will notice that you can only -change values for the fields that you checked Use Per-Data Source Value for. - - - - - -NOTE: Eligible template and item fields propagate to attached database -definitions unless configured per data source. This database propagation is -separate from changing an existing RRD file. Inspect the actual RRD structure -and use a backed-up repair or migration when its fields no longer match. - - - -How To: Working with Templates - - -If you goto the following article -How to Work with Templates . There you will find -a step by step guide on how to work with variout Cacti Templates in general. - - -Graph Templates - - -In Cacti, a Graph Template provides a skeleton for an actual Graph. If -you have many Graphs that share most of their characteristics, using a -Graph Template makes perfect sense. After a Graph is attached to a -particular Graph Template, all changes made to the Graph Template will -propagate out to all of its Graphs, unless Use Per-Graph Value has been -checked. - - -Creating a Graph Template - - -To create a new Graph Template, select Graph under Console > Templates -menu selection, then click Add normally the plus sign in the upper right corner -of the Graph Template interface. - - -The first thing you must do is give the Graph Template a name. This name has -nothing to do with the graph title, but is what you will use to identify the -Graph Template throughout Cacti. Second, you will notice a list of graph -field names with Use Per-Graph Value check-boxes next to each one. The nice -thing about Templates in Cacti is that you can choose whether to template each -field on a per-field basis. If you leave the check-box unchecked, every -Graph owned by the Graph Template will inherit its value from the -Template. If the check-box is checked, every Graph owned by Graph -Template will have its own value for that particular field. - - -Table 13-3. Field Description: Graph Templates - - - - - - Name - Description - - - - - - - Title - The title of the Graph within Cacti and the title that will be printed on the actual Graph itself. NOTE: You can use the keyword host_description enclosed by vertical bars in this field, which will be automatically substituted with the current host description. - - - - - Image Format - Choose whether you would prefer to output your graph images in PNG or SVG. - - - - - Height - The height of the Graph Canvas in pixels. This is not the height of the overall Graph, just the Graph Canvas. - - - - - Width - The width of the Graph Canvas in pixels - - - - - Base Value - Should be set to 1024 for memory values and 1000 for traffic measurements. - - - - - Slope Mode - RRDtool graphs are composed of stair case curves by default. This is in line with the way RRDtool calculates its data. Some people favor a more "organic" look for their graphs. - - - - - Auto Scale - Enable auto scale for the graph. This option must be check to use the next two options. Upper/Lower limit values are ignored when using auto-scale since these boundaries are determined automatically. - - - - - Auto Scale Options - Choose whether you would like to use --alt-autoscale (ignoring given limits), --alt-autoscale-max (accepting a lower limit), --alt-autoscale-min (accepting an upper limit. - - - - - Logarithmic Scaling - Choose if you want logarithmic y-axis scaling. - - - - - Scientific Units for Logarithmic Scaling - For linear graphs, scientific units (in magnitudes of k=kilo, M=mega, ...) is default. But for logarithmic graphs, exponential notation is default. Choose if you want logarithmic y-axis scaling and scientific units. - - - - - Rigid Boundaries Mode - From the RRDtool manual "Normally rrdgraph will automatically expand the lower and upper limit if the graph contains a value outside the valid range. With this option you can disable this behavior". - - - - - Auto Padding - If you have ever created RRDtool based graphs manually, you may have realized how annoying it can be to get text to line up properly. With this option Cacti will do its best to make the columns on your graph legend line up. This option works best when your graph legend has a consistent number of columns. - - - - - Allow Graph Export - If you choose to use Cacti's static HTML/image export, you can choose whether you want each individual graph to be exported. - - - - - Upper Limit - The maximum value that will be displayed on the y-axis. This value is ignored is auto-scaling is turned on. - - - - - Lower Limit - The minimum value that will be displayed on the y-axis. This value is ignored is auto-scaling is turned on. - - - - - Base Value - Whether you want to base the y-axis labels on 1000 or 1024. This field will typically be set to 1024 for memory and 1000 for traffic measurements. - - - - - Unit Grid Value - Sets the unit value for the y-axis (--y-grid). You should probably keep the unit short as to keep it readable. - - - - - Unit Exponent Value - Sets the 10^e scaling of the y-axis. Valid values for this field are between -18 and 18. For example, you could use 3 to display everything in 'k' (kilo) or -6 to display everything in 'u' (micro). - - - - - Vertical Label - The text to print on the left edge of the graph. Usually is the units the data on the graph is measured in. - - - - - -Auto-scaling Options Explained - - -Relative to Auto-scale Options, the RRDtool graph manual says: - - -* Limits [-u|--upper-limit value] [-l|--lower-limit value] [-r|--rigid] By -default the graph will be auto-scaling so that it will adjust the y-axis to -the range of the data. You can change this behavior by explicitly setting the -limits. The displayed y-axis will then range at least from lower-limit to -upper-limit. Auto-scaling will still permit those boundaries to be stretched -unless the rigid option is set. - - -* [-A|--alt-autoscale] Sometimes the default algorithm for selecting the -y-axis -scale is not satisfactory. Normally the scale is selected from a predefined -set of ranges and this fails miserably when you need to graph something like -"260 + 0.001 * sin(x)". This option calculates the minimum and maximum y-axis -from the actual minimum and maximum data values. Our example would display -slightly less than "260-0.001" to slightly more than "260+0.001". - - -* [-J|--alt-autoscale-min] Where "--alt-autoscale" will modify both the -absolute -maximum AND minimum values, this option will only affect the minimum value. -The maximum value, if not defined on the command line, will be 0. This option -can be useful when graphing router traffic when the WAN line uses compression, -and thus the throughput may be higher than the WAN line speed. - - -* [-M|--alt-autoscale-max] Where "--alt-autoscale" will modify both the -absolute -maximum AND minimum values, this option will only affect the maximum value. -The minimum value, if not defined on the command line, will be 0. This option -can be useful when graphing router traffic when the WAN line uses compression, -and thus the throughput may be higher than the WAN line speed. - - - - -When you are finished filling in values for the Graph Template, click Create -and you will be presented with a page similar to the image below. The example -below is from a completed Traffic Graph Template. - - -In this first image, you can see what elements will be painted on the Graph -Canvas. They are represented by LINEX, AREA and STACK elements. The -Graph Items listed as GPRINT and COMMENT appear in the Legend Area -of the Graph. - - -The Graph Input Items are the Cacti names for the Data Sources that appear -on the Graph as well as other items that can be substituted during Graph -Creation. - - -The Multiple Instances field is a parameter to let Cacti know that it should -allow you to create more than one Graph per Device using the Graph -Template. - - -[Image: Adding a Graph Template] - - -The Common Options are options that most every Graph Template included. -The Scaling Options are also very common, but related to Graph scaling -only. - - -[Image: Adding a Graph Template Options] - - -The Grid Options, Axis Options, and Legend Options are must less -common but are available in Cacti should you choose to use them. - - -[Image: Adding a Graph Template Options] - - -Graph Items - - -The first thing you should do is create Graph Items for a Graph -Template, just like for a stand alone Graph. One difference you will -notice is that the Data Sources drop-down will contain a list of Data -Template items rather than Data Source Items. It is important that Cacti -can make this association here, so that Cacti doesn't have to make unnecessary -assumptions later. - - -Table 13-4. Field Description: Graph Template Items - - - - - - Name - Description - - - - - - - Data Source - If this graph item is to represent some sort of data, you must select a your data source here. Keep in mind that not all graph items have a data source. Graph item types such as COMMENT, VRULE, and HRULE typically do not. - - - - - Color - Depending on the graph item type, you can select a color for the graph item. This field only applies to the graph item types AREA, STACK, LINE1, LINE2, and LINE3. - - - - - Opacity/Alpha Channel - For a colored graph item, you may optionally select an opacity (alpha channel). This option is not available with RRDtool-1.0.x. - - - - - Graph Item Type - This field is important because it defines what kind of graph item this is. Types such as AREA, STACK, LINE1, LINE2, and LINE3 are used to represent data on the graph, while COMMENT and GPRINT are used put on the legend. The LEGEND type is specific to Cacti only and can be used if you want to Cacti to automatically create a GPRINT-LAST/GPRINT-AVERAGE/GPRINT-MAXIMUM graph item for you. Note: You must always put an AREA item before using STACK or your graph will not render. - - - - - Consolidation Function - This tells RRDtool which consolidation function to use when representing this data on the graph. You will typically use AVERAGE for most things on the graph area, and LAST/MAXIMUM as well for GPRINT items. - - - - - CDEF Function - If you want to apply a CDEF function to the graph item, select one here. Check out the CDEF section of the manual for more information. - - - - - Value - This field is only used with the HRULE/VRULE graph item types. Type any valid integer to draw the line at for HRULE or the time of the day HH:MM for VRULE. - - - - - GPRINT Type - If this item is a GPRINT, you can choose how you want the number to be formatted. You can add your own in the GPRINT Presets section of Cacti. - - - - - Text Format - You can enter text to be displayed on the legend here. This field is applicable for all graph item types except for the virtual LEGEND type. - - - - - Hard Return - Check this box to force graph items onto the next line. - - - - - -Graph Item Inputs - - -After creating Graph Items for your Graph Template, you will need to -create some Graph Item Inputs. Graph Item Inputs are unique to Graph -Templates because of the large number of items they sometimes contain. Graph -Item Inputs enable you to take one Graph Item field, and associate it with -multiple Graph Items. Graph Item Input fields are generally created -automatically as you add Graph Items associated with a Data Source, like -a LINE or AREA or GPRINT. - - -To create a new Graph Item Input manually, click Add on the right of the -Graph Item Inputs form. There are various fields that must be filled in for -every graph item input: - - -Table 13-5. Field Description: Graph Template Items - - - - - - Name - Description - - - - - - - Name - This will be the name used to identify the Graph Item Input on both the Graph Template and Graph edit pages. - - - - - Description - (Optional) This description will be displayed on the Graph edit page of any Graph using this Graph Template if specified. - - - - - Field Type - You must choose the field that you are going to associate with one or more Graph Item. - - - - - Associated Graph Items - Choose one or more Graph Items to associate with the field selected for "Field Type". When the user specifies a value for the field, it will be applied to all of the items you select here. - - - - - -Applying Graph Templates to Graphs - - -Applying a Graph Template to an existing Graph is a very simple process, -though very uncommon in a modern Cacti install. The first thing you must do is -select the Graph you want to apply the template to under Graph -Management. Under the Graph Template Action drop-down, select the Graph -Template that you want to apply to the Graph and click Save. If this is a -new Graph or the Graph and Graph Template contain an equal number of -Graph Items, the Graph Template will be automatically applied. If number -of Graph Items varies from the Graph to the target Graph Template, -you will be prompted with a warning that your Graph will be changed, and not -always for the better. - - -Once the Graph Template is applied to the existing Graph, you will -notice that you can only change values for the fields that you checked Use -Per-Graph Value for. You will also notice a new box, called Graph Item -Inputs. This is where you can specify values for the Graph Item Inputs -that you defined in the Graph Template. The values specified here will be -applied to each Graph Item tied to the Graph Item Input. - - - - - -NOTE: Any time a change is made to the Graph Template, it will be -automatically propagated to the Graphs associated to it. - - - -Device Templates - - -Device Templates in Cacti, often times referred to as Host Templates serve -as a way to group a set of common Graph Templates and Data Queries to -Devices of a certain class, say a Cisco Router or Linux host using Net-SNMP. -It really accelerates the deployment of a Cacti system across and enterprise of -Devices. - - -Adding a Device Template - - -To create a new Device Template in Cacti, select the Device option under -the Console > Templates menu selection. Once on that page, click Add on the -right. Type a unique name for the Device Template and click the Create -button. You will be redirected back to the edit page with the -Associated Graph Templates and Associated Data Queries forms empty. These -two forms allow you to associate Graph Templates and/or Data Queries -with the Device Template. Simply select something from the drop-down menu -and click Add to associate it with your Device Template. - - -In the case below, we show the Net-SNMP Device Template. Note the variety of -Graph Templates and Data Queries available for this Class of Devices. - - -[Image: Adding a Host Template] - - -Import Templates - - -Assume, you're searching for a specific set of templates to monitor a special -type of device. Apart from designing templates from scratch, there's a good -chance to find a solution in the Scripts and Templates -Forum . The set of templates is usually -provided as a single XML file holding all required definitions for a data -template and a graph template. Depending on the goal of the original author, -he/she may have provided a Device Template as well as part of this XML -file. Note that after you Import Templates, you may also have to copy a -Resource XML file to the appropriate /resource directory, and -a script to the /scripts directory. However, also note that -in the current version of Cacti, Packages are now importable as well. -Signed Packages can include those files, subject to the import selection -and permissions. See Import Packages ; plain template XML -and signed .xml.gz packages use different import workflows. - - -[Image: Import Templates] - - -If the XML file was downloaded, simply select that file from the Downloads -location on your local system. Cacti no longer supports pasting the XML into the -browser window. - - -Please pay attention to the Data Source Profile field. By default, cacti will -attempt to use your default Data Source Profile. However, you can change -that at import time to use an alternate Data Source Profile or even the one -from the Template itself, if it includes one. - - -Review the automatically generated preview before importing. Use Remove -Orphaned Graph Items only when you intend to delete items absent from the -incoming template, including those on attached graphs. It can remove local -customizations; it is not a general requirement for every update. See Template -Import for selection and override details. - - -In the image below, you can see the output of a Preview of the Cisco WLC 5520 -Device Template. Preview shows proposed template changes. Import -compatibility repair can still update system data-input metadata during -preview; it is not a strictly read-only audit. - - -[Image: Import Template Preview] - - -As mentioned previously, for a single OID based template, Importing the -Template is all that will be required. However, for a script based template, -the author will provide the script that has to be downloaded to the Cacti -./scripts directory and for a Data Query based Template, a second XML -file holding the Data Query definitions will have to be downloaded to the -appropriate directory under the ./resource directory. - - -Cacti checks the XML object's hash compatibility code against the installed -version's mapping. Several releases can share a code, so it does not identify -an exact exporter release. Unknown or newer codes can be rejected. See -Determine a Template Version before -troubleshooting compatibility; do not change hash prefixes to force an import. - - -Export Templates - - -Now that you know how to import, you may want to know in which way to export as -well. Selecting the Export Templates gives - - -[Image: Export Templates] - - -You may select to export a graph template, a data template, a Device -Template or a Data Query. When selecting Include Dependencies, e.g. a -Device Template will include all referred templates (Graph Template, -Data Template, if defined, Data Query). Output may be written to the -browser or to a file for uploading. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -How To Work with Templates - - -We will follow the following process in this example: - - -* Create Data Template - Defines how we store the data in the RRDfile - -* Create Graph Template - Defines how we graph the data in the RRDfile - -* Device Template - Defines which Graphs to associate with a Device Type - - - -Data Template Creation - - -For this task, let's stick to SNMP stuff. For you to be able to reproduce this -example, I've chosen the UDP information of the IP MIB. - - -snmpwalk -c -v1 udp -UDP-MIB::udpInDatagrams.0 = Counter32: 7675 -UDP-MIB::udpNoPorts.0 = Counter32: 128 -UDP-MIB::udpInErrors.0 = Counter32: 0 -UDP-MIB::udpOutDatagrams.0 = Counter32: 8406 - - - -As cacti does not use the MIBs but pure ASN.1 OIDs, let's search the OID used as -udpInDatagrams: - - -snmpwalk -c -v1 -On udp -.1.3.6.1.2.1.7.1.0 = Counter32: 7778 -.1.3.6.1.2.1.7.2.0 = Counter32: 129 -.1.3.6.1.2.1.7.3.0 = Counter32: 0 -.1.3.6.1.2.1.7.4.0 = Counter32: 8514 - - - -The needed OID is .1.3.6.1.2.1.7.1.0. Now learn how to enter this into a new -Cacti Data Template: Please proceed to Data Templates and filter for SNMP. Check -the SNMP - Generic OID Template - - -[Image: Data Templates] - - -After clicking Go, you're prompted with a new page to enter udp/net - udp In Datagrams as the Title Format for the new Data Template: - - -The screenshots are from an older example; follow the names and OIDs in this -text for each copy. - - -[Image: Data Templates Duplicate] - - -Due to the filter defined above, you won't see the new Template at once, so -please enter udp In as a new filter to find: - - -[Image: Data Templates New] - - -Edit the copy for udpInDatagrams, using OID .1.3.6.1.2.1.7.1.0, a -recognizable internal name such as udp_in, and the COUNTER data-source -type. The historical screenshots show the field locations and mix older labels. -Use the name/OID pair above for the inbound copy, then udpOutDatagrams and -.1.3.6.1.2.1.7.4.0 for the second, outbound template: - - -[Image: Data Templates New 1] - - -[Image: Data Templates New 2] - - -[Image: Data Templates New 2] - - -Set Maximum Value to U for no upper limit, as shown in the screenshot. Do -not use 0: with the illustrated minimum of 0, Cacti rejects that range. Use -a finite upper limit only when it represents a valid bound for the metric. And -you saw the OID .1.3.6.1.2.1.7.1.0 from above, didn't you? Please copy -another one for OID .1.3.6.1.2.1.7.4.0, using the description -udpOutDatagrams - - -Graph Template Creation - - -Now let's generate the Graph Template for those already generated Data -Templates. Please go to Graph Templates and Add a new one: - - -[Image: Graph Template] - - -Now you have to fill in some global parameters: - - -[Image: Graph Template New] - - -and Create to see: - - -[Image: Graph Template New 3] - - -Now let's add some Graph Template Graph Items. They will specify, -which Data Sources defined by some Data Template should be displayed -on the Graph. Please click Add as shown on the last image: - - -[Image: Graph Template Items 1] - - -Now click Save to see the resulting image below. Not that both the -Graph Item and the Graph Item Input have been created. - - -[Image: Graph Template Items 1] - - -Next, we have to add a Legend in order for people viewing the Graph in the -future to obtain numeric data about the Graph contents. We will create -a very simple one, though Graph Legends can be a very complex subject. - - -To add the Graph Legend, simply press the Add button again and fill out -the Graph Item as shown in the image below. You should note that -for this second Graph Item, it remembered the previous Data Source. - - -[Image: Graph Template Items] - - -Press Save to see three legend items created in one step! - - -[Image: Graph Template Items 2] - - -Now we could have continued to add the UDP Datagrams In by adding a second -RRDfile Data Source to our Data Template, but we will skip that for this -exercise and continue now that our Graph Template is reasonably completed. - - -At this point, since we only added Graph Items to the Graph Template -there is no need to resave it at this point. We can simply continue to the -next step. - - -Now, you may add this new Graph Template to any Devices that -responds to the udp OID we specified in the Data Template. But in this -case, please wait a moment. Let's first proceed to the Device Template -and use this new Graph Template for our first own Device Template. - - -Device Template Creation - - -The next task is to create a new Device Template. So, select Device -under Console > Templates and press the Add button as in previous -examples. When you do that, you will be presented with an page that -resembles the one below. - - -[Image: Add Host Template] - - -and fill in the name of this new Template: - - -[Image: Add Host Template New] - - -Now you'll find two sections added. First, let's deal with -Associated Graph Templates. The Add Graph template select drop-down -contains all existing Graph Templates. In the images, you will see that -we are creating a Device Template for a NetApp Filer and adding some -common Graph Templates and Data Queries from the Cacti built-in collection. - - -[Image: Host Template Associate Graph Template] - - -and Add it: - - -[Image: Host Template Associate Graph Template 2] - - -Next, let's add the Data Query already selected above: - - -[Image: Host Template - Data Query] - - -Keep in mind, this is one of the more simple Template examples. Topics such -as Data Queries, Data Input Methods, and Script Server add a few -steps to the Template creation process. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Device Templates - - -Device Templates are Cacti objects that allow you to define classes of -Devices that include one or more Graph Templates, Data Queries and -other Plugin related object types. - - -The purpose of Device Templates is to simplify the Automation process by -pre-defining the Graphs that should be created for every Device that is -added to Cacti. They work in conjunction with Automation Templates so that -when Cacti discovers a Network it knows what Graphs to create for each -Device. - - -The Device Templates main screen looks like the image below: - - -[Image: Device Templates Page] - - -From this page, you can see the title of each Device Template, and its ID, -which is important for the Cacti CLI scripts. You can see if the Device -Template can be removed, and the number of Devices using the Device -Template. -Templates that are used by Devices can not be removed and therefore if you -attempt to remove one of these Templates, you will receive an error message. - - -From the drop down there are the following options: - - - - - - Option - Description - - - - - - - Delete - Remove the Device Template if it's Deletable - - - - - Duplicate - Make an exact copy of the Device Template. - - - - - Sync Devices - Update all Devices using this Device Template with the latest definition, adding, but not removing Graph Templates, and Data Queries. - - - - - Archive - Store a copy of the current Device Template definition with an optional Archive Note. Archives are listed on the Archives tab of the same page. - - - - - Download - Download the Device Template as a Cacti Package. - - - - - -Archive and Download were added in Cacti 1.3; Cacti 1.2.x offers only the -first three options. They appear only once the package signing keys exist, -which cli/genkey.php creates. - - -When editing a Device Template, you will see the page as displayed below. -From this page, you can add and remove Graph Templates, Data Queries, -and other Plugin objects. In the image below, you can see that the Cisco -Router has one Graph Template, Cisco - CPU Usage, and one Data Query, -SNMP - Interface Statistics. There are no Threshold -Templates defined on the system, so there is no way to select one. - - -[Image: Device Template Edit Page] - - -To add a Graph Template or Data Query to the Device Template, simply -select it from the drop down, and press the Add button. There is no need to -Save afterwards. To remove one of these items, simply press the x glyph to -the right of the desired Graph Template or Data Query. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Graph Templates - - -Graph Templates are Cacti objects that allows you to define how RRDtool is -to render a Cacti Graph. Most RRDtool options are supported including -CDEF's and VDEF's, Left and Right Axis, Ticks and Dashes, multiple Auto Scaling, -Grid, and Legend Options. - - -The purpose of Graph Templates is to simplify the Automation process by -pre-defining the layout of Graphs for various metrics that are to be -monitored in Cacti. When used in Conjunction with Cacti's Graph Rules, you -can automatically create just about any Data Query based Graph during -Cacti's Network Discovery process. - - -The Graph Templates main screen looks like the image below: - - -[Image: Device Templates Page] - - -The list shows template IDs, the number of attached graphs, default size, image -format and vertical label. IDs are useful for CLI operations. Deletability is -based on referencing graph instances, not simply on a device-template -association. A template with attached graphs is shown as non-deletable. - - -The Actions menu contains: - - -Table 1. Graph template actions - - - - - - Action - Effect - - - - - - - Delete - Remove a deletable template. - - - - - Duplicate - Create a separate copy of the template. - - - - - Change Settings - Apply selected common settings, such as graph dimensions. Review the confirmation form before applying them. - - - - - Full Sync Graphs - Reconcile attached graphs with the selected template's full definition. Use when quick synchronization is insufficient. - - - - - Quick Sync Graphs - Repair graph-item differences with less work than a full synchronization. Try this first for item mismatches. - - - - - -Synchronization changes existing graph definitions. Back up relevant database -objects and review local graph inputs before applying a fleet-wide change. - - -The editor groups its fields into these sections: - - -Table 2. Graph template sections - - - - - - Section - Purpose - - - - - - - Graph Template Items - Ordered drawing and legend items. - - - - - Graph Item Inputs - Fields applied to one or more items; data-source inputs are normally created automatically. - - - - - Graph Template - Name, multiple-instance policy and data-source testing. - - - - - Common Options - Title, vertical label, image format, dimensions, base and slope mode. - - - - - Scaling Options - Automatic scaling and optional upper/lower bounds. - - - - - Grid Options - Canvas grid rendering. - - - - - Axis Options - Right-axis conversion and formatting. - - - - - Legend Options - Legend placement and formatting. - - - - - -Each of these sections are displayed below for reference. For more information -on how to use these options, please visit the RRDtool -Website . - - -The Graph Items make up what is draw within the canvas of the Graph. There -are several Graph Item types including: - - -Table 3. Common graph item types - - - - - - Type - Purpose - - - - - - - AREA - Fill a plotted area. - - - - - AREA:STACK - Stack an area on a preceding plotted item. - - - - - COMMENT - Print legend text, including supported replacement variables. - - - - - GPRINT - Print a value with a GPRINT preset and applicable CDEF or VDEF. - - - - - GPRINT:AVERAGE / LAST / MAX / MIN - Print a value using the selected consolidation function. - - - - - HRULE - Draw a horizontal rule using the configured value. - - - - - LEGEND - Create Current, Average and Maximum GPRINT items. - - - - - LEGEND_CAMM - Create Current, Average, Minimum and Maximum GPRINT items. - - - - - LINE1 / LINE2 / LINE3 - Draw a line of the selected width. - - - - - LINE:STACK - Stack a line on a preceding plotted item. - - - - - TEXTALIGN - Set alignment for subsequent text. - - - - - VRULE - Draw a vertical rule at a time position. - - - - - -The canvas is painted from the first Graph Item till the last with each -successive Graph Item rendered on top of the previous. Please keep this in -mind when creating a Graph Template. - - -[Image: Graph Items and Item Inputs] - - -Graph Template - General and Common Options - - -* Name - Identifies the template in Cacti; it is separate from the graph's -title pattern. A prefix such as Net-SNMP can help organize related -templates. - - -* Class - Categorizes the template using the available graph-template -classes. - - -* Version - The author's template version. This is separate from the Cacti -XML hash compatibility code. - - -* Multiple Instances - Allow more than one graph of this template on a -device through the New Graphs interface. - - -* Test Data Sources - Require a valid data-source response before creating -a graph. This helps a generic device template select applicable measurements. -Long-running scripts can increase graph-creation time when testing is -enabled. - - - - -Common options set the title pattern, vertical label, dimensions and image -format. Use base 1000 for decimal scaling, such as traffic, and 1024 for -binary scaling, such as memory. Decimal MB and binary MiB are different unit -conventions; MiB means mebibytes. The base controls display scaling, not a -conversion of stored measurements. Slope Mode smooths the rendered lines. - - -[Image: Graph Name and Common Options] - - -Graph Template - Scaling Options - - -The Scaling Options allow the Administrator to apply either Rigid or Auto -Scaling settings to the resulting Graph. These options are fairly self -explanatory. However, you can always view the RRDtool Documentation online for -more information. - - -[Image: Scaling Options] - - -Graph Template - Grid Options - - -The Grid Options are rarely necessary unless you have specific requirements to -render the resulting Graphs with some exotic unit. - - -[Image: Grid Options] - - -Graph Template - Axis Options - - -The Axis Options allow you to define a Right Axis and optional Formatters. - - -[Image: Axis Options] - - -Graph Template - Legend Options - - -The Legend options allow you to specify how the Legend should be placed on -the resulting Graph modern RRDtool has several options that were not -available in Cacti prior to Cacti 1.0. - - -[Image: Legend Options] - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Data Source Templates - - -Data sources serve an important role in Cacti data sources are data points -collected from the devices you monitor in Cacti. - - -Data sources take the data that has been collected by the poller. - - -The Data source then holds the value to be presented to the graph. - - -The Data source template is then associated with a graph template. - - -These data sources can be for example incoming traffic on an interface. Cacti -allows you to create data source templates to associate to data queries the -template allows you to describe what type of data Cacti should expect. - - -To create a Data source you will need to select the proper data input there are -several options but the most popular ones would be GET SNMP data or GET SNMP -data (indexed.) - - -You would use Get SNMP data (indexed) for interfaces for example as Cacti would -need to query the device to find the interface index. You would use Get SNMP -data and put in a single OID for an OID that won't change for example CPU usage -generally does not have an index and the OID won't change - - -You will also need to tell the template what the data source type is. The most -common ones being Gauge and Counter. These data types come from the RRDtool its -self. Below are the supported data types and their uses. For more information -see -RRD Tool Create Function - - -GAUGE - - -GAUGE is for things like temperatures or number of people in a room or the value -of a RedHat share. - - -COUNTER - - -COUNTER is for continuous incrementing counters like the ifInOctets counter in a -router. The COUNTER data source assumes that the counter never decreases, except -when a counter overflows. The update function takes the overflow into account. - - -The counter is stored as a per-second rate. When the counter overflows, RRDtool -checks if the overflow happened at the 32bit or 64bit border and acts -accordingly by adding an appropriate value to the result. - - -DCOUNTER - - -Available when the configured RRDtool version is 1.5 or later. - - -DCOUNTER the same as COUNTER, but for quantities expressed as double-precision -floating point number. It could be used to track quantities that increment by -non-integer numbers, i.e. number of seconds that some routine has taken to run, -total weight processed by some technology equipment etc. - - -The only substantial difference is that DCOUNTER can either be upward counting -or downward counting, but not both at the same time. The current direction is -detected automatically on the second non-undefined counter update and any -further change in the direction is considered a reset. The new direction is -determined and locked in by the second update after reset and its difference to -the value at reset. - - -DERIVE - - -DERIVE will store the derivative of the line going from the last to the current -value of the data source. This can be useful for gauges, for example, to measure -the rate of people entering or leaving a room. Internally, derive works exactly -like COUNTER but without overflow checks. So if your counter does not reset at -32 or 64 bit you might want to use DERIVE and combine it with a MIN value of 0. - - -DDERIVE - - -Available when the configured RRDtool version is 1.5 or later. - - -DDERIVE the same as DERIVE, but for quantities expressed as double-precision -floating point number. - - - - - -NOTE: on COUNTER vs DERIVE - - -by Don Baarda don.baarda@baesystems.com - - -If you cannot tolerate ever mistaking the occasional counter reset for a -legitimate counter wrap, and would prefer "Unknowns" for all legitimate -counter wraps and resets, always use DERIVE with min=0. Otherwise, using -COUNTER with a suitable max will return correct values for all legitimate -counter wraps, mark some counter resets as "Unknown", but can mistake some -counter resets for a legitimate counter wrap. - - -For a 5 minute step and 32-bit counter, the probability of mistaking a counter -resetfor a legitimate wrap is arguably about 0.8% per 1Mbps of maximum -bandwidth. Note that this equates to 80% for 100Mbps interfaces, so for high -bandwidth interfaces and a 32bit counter, DERIVE with min=0 is probably -preferable. If you are using a 64bit counter, just about any max setting will -eliminate the possibility of mistaking a reset for a counter wrap. - - - -ABSOLUTE - - -ABSOLUTE is for counters which get reset upon reading. This is used for fast -counters which tend to overflow. So instead of reading them normally you reset -them after every read to make sure you have a maximum time available before the -next overflow. Another usage is for things you count like number of messages -since the last update. - - -COMPUTE - - -RRDtool supports computed data sources using an RPN expression derived from -other data sources in the same file. That is distinct from a graph-time CDEF. - - -The current Cacti type list includes COMPUTE, but the ordinary data-template -editor has no expression field and the normal RRD creation path emits the -heartbeat/minimum/maximum form used by collected data sources. That form is not -a valid COMPUTE definition. Do not select it for a new data source through this -workflow. Use a CDEF for graph-time calculations, or an explicitly -managed external RRD workflow when persistent computed data is required. -Advanced RRD/XML helpers do not supply the missing template editor and creation -support. - - -[Image: Data-Source-Templates] - - -You are also able to use Variables to set the name for the data source. The -available Variables can be seen on the -Variables -documentation page. - - -[Image: Data-Source-Templates] - - -What is also an important setting is the internal data source name. This will -be used to associate the data source with the graph template. The template -editor accepts 1–19 letters, digits, or underscores. Use a recognizable name, -such as traffic_in. Do not rename an existing item without also planning the -matching RRD file change; a metadata edit alone does not rename the stored -series. - - -[Image: Data-Source-Templates] - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Aggregate Templates - - -Aggregate Overview - - -Aggregate Templates are a special form of a Graph Template. They allow -you to easily create Graphs that combine data from multiple common -Graphs from multiple Devices, and allow you to easily manage the -resulting Aggregate Graphs to add and remove elements from other common -Graphs. - - -To create Aggregate Graphs that are managed through a Template, you first -must create the Aggregate Template. Then from the Cacti Graphs page, you -can select the Graphs that you want used as part of the Aggregate. You -then select Create Aggregate from Template from the Cacti Actions drop-down. - - -Once you have created your Aggregate Graphs, they behave like any other -Cacti Graph. They can be a part of a Tree, zoomed, etc. They have an added -bonus - you can add and remove Graphs from aggregate in a very controlled -way, reducing the effort to maintain them during their life-cycle. - - -If you wish to change settings for Graphs managed by the Aggregate -Template, simply make the changes in the Aggregate Template, and they -will cascade to attached Aggregate Graphs with Propagation Enabled. An -aggregate whose propagation has been disabled no longer follows these template -settings. See Aggregate Graphs for membership and propagation. - - -Aggregate Template Interface - - -The images below shows an Aggregate Template for Traffic. - - -[Image: Aggregate Templates] - - -When you edit the Aggregate Template, you are presented with an interface -that allows you to define the Graph Canvas as well as it's formatting. You -should experiment until you find the mechanism that works best to suite your -needs. - - -The Aggregate Template Prefix setting allows you to provide a pattern to be -applied to the Aggregate Graph legend items. Any host, query or input -references can be used in the Prefix section in order to uniquely identify the -Graph Item. - - -There are several Graph Types transformations that deal with how AREA, -LINEX and STACK items are handled in the resulting Aggregate Graph, -they include: - - -* Keep Graph Types - No transformation will occur. All AREA, LINE, and -STACKS will be unchanged. - -* Keep Type and Stack - Which means the types will be preserved, but all -data will be stacked instead of simply LINEX it will be transformed to -LINEX:STACK - -* Convert to Area/STACK Graph - All LINEX will be converted to AREA and -stacked. - -* Convert to LINE1 - All Graph Items will be converted to LINE1 - -* Convert to LINE2 - All Graph Items will be converted to LINE2 - -* Convert to LINE3 - All Graph Items will be converted to LINE3 - -* Convert to LINE1/Stack - All Graph Items will be converted to LINE1 -and stacked. - -* Convert to LINE2/Stack - All Graph Items will be converted to LINE2 -and stacked. - -* Convert to LINE3/Stack - All Graph Items will be converted to LINE3 -and stacked. - - - -The Totaling setting has multiple values. They include: - - -* No Totals - There will be no Summation of Data in the Legend - -* Print All Legend Items - Means that all Legend Items selected will be -included with a Total - -* Print Totaling Legend Items Only - This option means that the Legend will -total all the Legend items into a single Legend. - - - -The Total Type - Will create groupings of common elements on the Graph, -and reset stacking rules when a change in the common element occurs. The options -include: - - -* Total Similar Data Sources - Means that you will Total legend items and -Data Sources through similar Data Source names, for example -traffic_out and traffic_in. - -* Total All Data Sources - It means that you will sum the values for all -Data Sources regardless of their Data Source name. - - - -When using Total Type, you are provided an option to additionally prefix your -legends using the Prefix for GPRINT Totals with a text value. The default -works in most cases. - - -The Reorder Type will re-order the Data Sources within their respective -grouping on the Graph so that they are ordered in a common way, in alphabetic -order. The options include: - - -* No Reordering - Don't make any changes in ordering. - -* Data Source, Graph - Order by Data Source name and then by Graph -name - -* Graph, Data Source - Order by Graph name and then by Data Source -name - -* Base Graph Order - Focus on the Graph name only - - - -[Image: Aggregate template general options] - - -The Graph Template Items section allows you to either Skip or Total (aka -include) the Graph Items in the resulting Aggregate Graphs. When you -think about how a resulting Aggregate graph will look, there are some -elements that simply will not result in a good looking Graph. In those cases -you will want to remove them from the resulting Aggregate Graphs. - - -The Color Template option allows you to use differing Color rotations when -displaying elements on the resulting Aggregate Graphs. Color Templates -can be added and removed from the Color Templates menu pick under -Console > Templates. - - -[Image: Aggregate Templates Edit Canvas Options] - - -The several sections allow you to override any of the common Graph Template -elements from the resulting Aggregate Graph. We will not explain those -options here, only let you know that you can override them in your resulting -Aggregate Graph. - - -[Image: Aggregate Templates Edit Common Options] - - -[Image: Aggregate template scaling options] - - -[Image: Aggregate Templates Edit Grid Options] - - -[Image: Aggregate Templates Edit Axis Options] - - -[Image: Aggregate Templates Edit Legend Options] - - -Summary - - -There are several combinations of options that you can use when working with an -Aggregate Template. Some of these options will results in horrible and -unexpected outcomes, so you will have to experiment until you come up with a -desirable Aggregate Template. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Color Templates - - -Color Templates define a list of Colors to be used for Aggregate Graphs -in Cacti. As you add Graphs to an Aggregate Graph, you need to -distinguish one Graph from the next within the Aggregate Graph. These -Color Templates are a list of colors that will be looped through in Round -Robin fashion to render the Aggregate Graph. - - -Color selection rotates across member graphs for each item to which a color -template is assigned. It uses the member-graph index modulo the number of -colors; it does not advance once for every graph item or legend entry. - - -For example, assign an eight-color template to one plotted series shared by 16 -member graphs. Each color is selected twice for that series. Additional series -can have their own assigned color templates, while uncolored legend items do -not add steps to this rotation. - - -Below, you can see the four standard Color Templates. From the Actions -drop down you can Delete, Duplicate, or Sync Aggregates for the selected -Color Templates. As with other Cacti objects, you will not be allowed to -Delete a Color Template in use. - - -[Image: Color Templates] - - -In the image below, you can see the Color Template edit screen. This simple -screen allows you to add, remove and re-order colors in the list. - - -[Image: Color Templates Edit] - - -Shown in the image below, only Cacti Colors are allowed to be selected for -Aggregate Color Templates. The Color drop down can be typed into if you -wish to search through the list of approximately 340 legacy and Named Colors. - - -[Image: Color Templates Item Edit] - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Data Input Methods - - -Data Input Methods allow Cacti to retrieve data to insert into RRDfiles based -upon a mapping controlled by Data Templates and their corresponding Data -Sources. These resulting Data Templates and Data Sources can then be -used to create Graph Templates and Graphs. - - -Cacti includes a number of build in Data Input Methods for SNMP data and -for Script, Script Server and SNMP Data Queries. - - -Outside of the built in Data Input Methods, the Cacti Administrator can -create virtually any Data Input Method based upon a Script, or a PHP -Script Server script. The Script based Data Input Method allows -Cacti to virtually collect data from anywhere, though the built in SNMP and -Script Server methods provide the greatest scalability in Cacti. Both -Data Queries, and PHP Script Server topics will be covered in later -sections of the documentation. - - -Creating a Data Input Method - - -To create a new Data Input Method, from the Cacti Console, select Data -Collection > Data Input Methods. Once on that screen, click the plus (+) glyph -on the right which will allow you to add a new Data Input Method. You will -be presented with a few fields to populate on the following screen. - - -Table 11-1. Field Description: Data Input Methods - - - - - - Name - Description - - - - - - - Name - Give the data query a name that you will use to identify it - - - - - Input Type - Select the type of Data Input Method you are trying to create - - - - - Input String - This field is only used when the Input Type is set to Script/Command - - - - - -The Name specified will be used throughout Cacti to identify the human -readable name given to the Data Input Method. Careful consideration should -be made to help uniquely identify the Data Source. Having very similar -names can lead to confusion when utilizing them as your Cacti system grows. - - -Valid options for Input Type are Script/Command, and Script Server. -As mentioned previously, Cacti provides built in Data Input Methods for SNMP -data gathering and for SNMP, Script, and Script Server based Data -Queries. Though present in the Cacti database, they are hidden from user -view. - - -When the type is set to Script/Command, the Input String specifies the full -path to the script including any per Data Source input variables. Data -Source input variables must be enclosed in greater than and less than -characters. For instance, if you are passing an IP address to a script, your -input string might look something like: /path/to/script.pl When the user -creates a Data Source based on this Data Input Method, they will be -prompted for an IP address to pass onto the script. - - -When you are finished filling in all necessary fields, click the Create button -to continue. Upon saving the new Data Input Method, you will be presented -with two new sections to complete. Those sections will instruct Cacti what to -pass to the Script, known as Input Fields otherwise known as Input Parameters and how to handle the output data, which we refer to as Output Fields. - - -The Input Fields box is used to define any fields that require information -from the user or from various data within the Cacti Database such as the -hostname, ip address, host id, etc. Any input fields referenced to in the input -string must be defined here. - - -The Output Fields box is used to define each field that you expect back from -the script and will be eventually stored in both the database and RRDfiles. - - -All Data Input Methods must have at least one output field defined, but -may have more than one depending on the type. - - -Data Input Fields - - -To define a new field, click the plus sign (+) next to the input or output field -boxes. You will be presented with some or all of the fields below depending on -whether you are adding an input or output field. - - -Table 11-2. Field Description: Data Input Fields - - - - - - Name - Description - - - - - - - Field/Field Name - You will be presented a drop down list of the unused braced input fields from the command - - - - - Friendly Name - Enter a more descriptive name for this field - - - - - Regular Expression Match (Input Only) - Enter a valid regular expression as to how to modify the output - - - - - Allow Empty Input (Input Only) - Can the input value of this field blank or not - - - - - Special Type Code (Input Only) - Pull the input data from the Cacti database and don't prompt the user for this input value - - - - - Update RRDfile (Output Only) - Checked if you intend this output data to be stored in an RRDfile - - - - - -The Field Name must contain no spaces or other non-alphanumeric characters -(except '-' or '_'). - - -If you want to enforce a certain regular expression pattern when the user enters -a value into Regular Expression Match (Input Only) for this Data Input Field, -use a Perl-compatible regular expression (PCRE), as required by PHP's -preg_* functions. - - -If the Data Input Field needs to reference another field internally, you can -enter this into the Special Type Code. For instance, if your field requires an -IP address from the user, you can enter 'management_ip' here and Cacti will fill -this field in with the current IP address of the selected host. - - -Table 11-3. Special Type Codes - - - - - - Field Name - Description - - - - - - - hostname - The hostname - - - - - management_ip - The ip - - - - - snmp_community - The SNMP community - - - - - snmp_username - The SNMP username - - - - - snmp_password - The SNMPv3 authentication password - - - - - -If you enable the Update RRDfile, Cacti will insert the return value from this -field into the RRDfile. This box needs to be checked for at least one output -field per data input source, but can be left blank to have Cacti store the value -only in the database instead. - - -When you are finished filling in all necessary fields, click the Create button -to continue. You will be redirected back to the Data Input Method edit page. -From here you can continue to add additional fields, or click Save on this -screen when finished. - - -Making Your Scripts Work With Cacti - - -The simplest way to extend Cacti's data gathering functionality is through -external scripts. Cacti comes with a number of scripts out of the box which are -located in the scripts/ directory. These scripts are used by the Data Input -Methods that are present in a new installation of Cacti. - - -To have Cacti call an external script to gather data you must create a new -Data Input Method, making sure to specify Script/Command for the Input Type -field. See the previous section, Creating a Data Input -Method for more -information about how to create a -Data Input Method. To gather data using your Data Input Method, Cacti -simply executes the shell command specified in the Input String field. Because -of this, you can have Cacti run any shell command or call any script which can -be written in almost any language. - - -What Cacti is concerned with is the output of the script. When you define your -Data Input Method, you are required to define one or more output fields. The -number of output fields that you define here is important to your script's -output. For a Data Input Method with only one output field, your script -should output its value in the following format: - - - - - - -So if I wrote a script that outputs the number of running processes, its output -might look like the following: - - -67 - - - -Data Input Methods with more than one output field are handled a bit differently -when writing scripts. Scripts that output more than one value should be -formatted like the following: - - -: : ... : - - - -If you wrote a script that outputs the 1, 5, and 15 minute load average of a -Unix machine and in Cacti named the output fields '1min', '5min', and '15min', -the output of the script should look like the following: - - -1min:0.40 5min:0.32 15min:0.01 - - -One last thing to keep in mind when writing scripts for Cacti is that they will -be executed as the user the data gatherer runs as. Sometimes a script may work -correctly when executed as root, but fails due to permissions problems when -executed as a less privileged user. - - -Walkthrough - - -You can find a detailed example of how to create a complete Graph from -simple command output in the following example -How To Create a Data Input Method . - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Data Input Methods - From Script Output to Complete Graph - - -In this How-To we will take you through the process of creating a script and -then from the scripts output generate a complete Graph Template that you can -apply to your Cacti system. You should be able to reproduce this process -regardless of the script type in question. - - -Data Input Method returning a single value - - -Lets start with a simple script that takes a hostname or IP address as input -parameter returning a single value. - - -/scripts/ping.pl: - - -#!/usr/bin/perl - -# take care for tcp:hostname or TCP:ip@ -$host = $ARGV[0]; -$host =~ s/tcp:/$1/gis; - -# old Linux version use "icmp_seq" -# newer use "icmp_req" instead -open(PROCESS, "ping -c 1 $host | grep 'icmp_[s|r]eq' | grep time |"); -$ping = ; -close(PROCESS); -$ping =~ m/(.*time=)(.*) (ms|usec)/; - -if ($2 == "") { - print "U"; # avoid cacti errors, but do not fake RRDtool stats -}elsif ($3 eq "usec") { - print $2/1000; # re-calculate in units of "ms" -}else{ - print $2; -} - - - -To define this script as a Data Input Method to Cacti go to Data Input -Methods and click Add. You should see: - - -[Image: Data Input Methods New] - - -Please fill in Name, select Script/Command as Input Type and provide the -command that should be used to retrieve the data. You may use as -a symbolical name for the path_to_your_Cacti_installation. Those commands will -be executed from crontab; so pay attention to providing full path to binaries if -required (e.g. /usr/bin/perl instead of perl). Enter all Input -Parameters in <> brackets. Click create to see: - - -[Image: Data Input Methods edit] - - -Now lets define the Input Fields. Click Add as given above to see: - - -[Image: Input Fields] - - -The drop down Field [Input] contains one single value only. This is taken -from the Input String above. Fill Friendly Name to serve your -needs. The Special Type Code allows you to provide parameters from the -current Device to be queried. In this case, the hostname will be taken from -the current device. Click create to see: - - -[Image: Output Fields] - - -At least, define the Output Fields. Again, click Add as described above: - - -[Image: Output Fields 2] - - -Provide a short Field [Output] name and a more meaningful Friendly Name. -As you will want to save those data, select Update RRDfile. Create to see: - - -[Image: Output Fields 3] - - -Click Save and you're done. - - -Creating the Data Template - - -Now you want to tell Cacti, how to store the data retrieved from this script. -Please go to Data Templates and click Add. You should see: - - -[Image: Data Templates New] - - -Fill in the Data Templates Name with a reasonable text. This name will be -used to find this Template among others. Then fill in the Data Source Name. -This is the name given to the host-specific Data Source. The variable -|host_description| is taken from the actual Device. This is to -distinguish Data Sources for different devices. The Data Input Method is -a drop down containing all known scripts and the like. Select the Data Input -Method you just created. The Associated RRA's is filled by default. At the -moment there's no need to change this. The lower part of the screen looks like: - - -[Image: Data Source Item] - - -The Internal Data Source Name may be defined at your wish. There's no need -to use the same name as the Output Field of the Data Input Method, but it -may look nicer. Click create to see: - - -[Image: Data Source Item] - - -Notice the new drop down Output Field. As there is only one Output Field -defined by our Data Input Method, you'll see only this. Here's how to -connect the Data Source Name (used in the RRDfile) to the Output Field of -the Script. Click Save and you're done. - - -Creating the Graph Template - - -Now you want to tell Cacti, how to present the data retrieved from this script. -Please go to Graph Templates and click Add. You should see: - - -[Image: Graph Template New] - - -Fill in Name and Title. The variable |host_description| will again be -filled from the Device's definition when generating the Graph. Keep the rest -as is and Create. See: - - -[Image: Graph Template Items] - - -Now click the plus (+) glyph to Add the first item to be shown on the -Graphs: - - -[Image: Graph Template Items 2] - - -Select the correct Data Source from the drop down, fill in a color of your -liking and select AREA as a Graph Item Type. You want to fill in a Text -Format that will be shown underneath the Graph as a legend. Again, -Create: - - -[Image: Graph Template Items 3] - - -Notice, that not only an entry was made under Graph Template Items, but -under Graph Item Inputs as well. Don't bother with that now. Lets fill some -more nice legends, see: - - -[Image: Graph Template Items 4] - - -Notice, that the Data Source is filled in automagically. Select LEGEND as -Graph Item Type (it is not really a Graph Item Type in RRDtool-speak, -but a nice time-saver), and click Create to see: - - -[Image: Graph Template Items 5] - - -Wow! Three items filled with one action! - - -Apply the Graph Template to a Device - - -Now go to the Devices and select the one of your choice. See the -Associated Graph Templates in the middle of this page: - - -[Image: Associate Graph Template] - - -Select your newly created Graph Template from the Add Graph Template -drop down. Click the plus (+) glyph to see: - - -[Image: Associate Data Queries] - - -By default, the Graph Template is added and shown as Is Being Graphed. -The reason for this is that Cacti now automatically creates Graphs -automatically, unless disabled. If the Graph Template shows Not Being -Graphed, you can create the Graph by pressing the Create Graphs at the -top of the Devices page. Click this link to see: - - -[Image: Create New Graph] - - -Check the box that belongs to the new template and Create. See the results: - - -[Image: Newly create Graph] - - -This will automatically - - -* Create the needed Graph Description from the Graph Template. As you -may notice from the success message, this Graph takes the hosts name in -it: router - Test ping (router is the hosts name of this example). - - -* Create the needed Data Source Description from the Data Template. -Again, you will find the Hosts name replaced for |host_description| - - -* Create the needed RRDfile with definitions from the Data Template. The -name of this file is derived from the Host and the Data Template in -conjunction with an auto-incrementing number. - - -* Create an entry to the poller_item to instruct Cacti to gather data on each -polling cycle. - - - - -You'll have to wait at least two polling cycles to find data in the Graph. -Find your Graph by going to Graph Management, filtering for your host -and selecting the appropriate Graph (there are other methods as well). This -may look like: - - -[Image: Newly Graph after a few polling cycles] - - -Walkthrough: Script with more Output Parameters - - -The script below will be implemented in perl. Please note that any supported -language is supported using Cacti from direct command execution to scripts -written in perl, python, php, bash, etc. - - -#!/usr/bin/perl -w - -# -------------------------------------------------- -# ARGV[0] = <hostname> required -# ARGV[1] = <snmp port> required -# ARGV[2] = <community> required -# ARGV[3] = <version> required -# -------------------------------------------------- -use Net::SNMP; - -# verify input parameters -my $in_hostname = $ARGV[0] if defined $ARGV[0]; -my $in_port = $ARGV[1] if defined $ARGV[1]; -my $in_community = $ARGV[2] if defined $ARGV[2]; -my $in_version = $ARGV[3] if defined $ARGV[3]; - -# usage notes -if ( - ( ! defined $in_hostname ) || - ( ! defined $in_port ) || - ( ! defined $in_community ) || - ( ! defined $in_version ) -) { - print "usage:\n\n - $0 <host> <port> <community> <version>\n\n"; - exit; -} - -# list all OIDs to be queried -my $udpInDatagrams = ".1.3.6.1.2.1.7.1.0"; -my $udpOutDatagrams = ".1.3.6.1.2.1.7.4.0"; - -# get information via SNMP -# create session object -my ($session, $error) = Net::SNMP->session( - -hostname => $in_hostname, - -port => $in_port, - -version => $in_version, - -community => $in_community, - # add more parameters if there's a need for them: - # [-localaddr => $localaddr,] - # [-localport => $localport,] - # [-nonblocking => $boolean,] - # [-domain => $domain,] - # [-timeout => $seconds,] - # [-retries => $count,] - # [-maxmsgsize => $octets,] - # [-translate => $translate,] - # [-debug => $bitmask,] - # [-username => $username,] # v3 - # [-authkey => $authkey,] # v3 - # [-authpassword => $authpasswd,] # v3 - # [-authprotocol => $authproto,] # v3 - # [-privkey => $privkey,] # v3 - # [-privpassword => $privpasswd,] # v3 - # [-privprotocol => $privproto,] # v3 -); - -# on error: exit -if (!defined($session)) { - printf("ERROR: %s.\n", $error); - exit 1; -} - -# perform get requests for all wanted OIDs -my $result = $session->get_request( - -varbindlist => [$udpInDatagrams, $udpOutDatagrams] -); - -# on error: exit -if (!defined($result)) { - printf("ERROR: %s.\n", $session->error); - $session->close; - exit 1; -} - -# print results -printf("udpInDatagrams:%s udpOutDatagrams:%s", # <<< cacti requires this format! - $result->{$udpInDatagrams}, - $result->{$udpOutDatagrams}, -); - -$session->close; - - - -It should produce following output, when executed from command line: - - -[prompt]> perl udp_packets.pl localhost 161 public 1 -udpInDatagrams:10121 udpOutDatagrams:11102 - - - -Where “public” would be replaced by your community string. Those input -parameters again are controlled by the Input Fields in Cacti and the output -from the script will be mapped to Output Fields. If you wish to return -multiple output values, they must be space delimited name value pairs in the -form of nameA:valueA nameB:valueB ... - - -The Data Input Method - - -To define this script as a Data Input Method to Cacti go to Data Input -Methods and click the plus (+) glyph. - - -[Image: More Scripts dim 1] - - -You should see: - - -[Image: More Scripts dim 2] - - -Enter the name of the new Data Input Method, select Script/Command and -type in the command to call the script. Please use the full path to the -command interpreter. Instead of entering the specific parameters, type - for each parameter the script needs. Save: - - -[Image: More Scripts dim 3] - - -Now add each of the input parameters in the Input Fields section, one after -the other. All of them are listed in sequence, starting with : - - -[Image: More Scripts dim 4] - - - - - -[Image: More Scripts dim 5] - - - - - -[Image: More Scripts dim 6] - - - - - -[Image: More Scripts dim 7] - - -We've used some of Cacti builtin parameters. When applied to a host, those -variables will be replaced by the hosts actual settings. Then, this command will -be stored in the poller_command table. Now Save your work to see - - -[Image: More Scripts dim 8] - - -After having entered all Input Fields, let's now turn to the Output -Fields, respectively. Add the first one, udpInDatagrams: - - -[Image: More Scripts dim 9] - - -Now udpOutDatagrams: - - -[Image: More Scripts dim 10] - - -Be careful to avoid typos. The strings entered here must exactly match those -spitted out by the script. Double check Output Fields! Now, results should -be like - - -[Image: More Scripts dim 11] - - -Finally Save and be proud! - - -[Image: More Scripts dim 12] - - -The Data Template - - -The previous step explained how to call the script that retrieves the data. Now -it's time to tell Cacti, how to store them in RRDfiles. You will need a single -Data Template only, even if two different output fields will be stored. RRD -files are able to store more than one output fields; RRDtool's name for those is -Data Source. So we will create - - -* One single Data Template representing one RRDfile - - -* Two output fields/data sources - - - - -The first step is quite the same as Create the Data Template for a simple -Data Input Method. For sure, we provide a different name, Example - UDP -Packets. Now, let's enter the first Data Source. Again, its like above. -But we now provide the name of udpInPackets, enter a Maximum value of -100,000 and select the Data Source Type of COUNTER. - - -[Image: Data Template - Two DS, Step1] - - -Then save and find with the exception that the Output Field will be set to -None Selected. Therefore, before adding the second Data Source Item, make -sure you select the Output Field of udpInDatagrams and press the Save button -to create the association. - - -[Image: Data Template - Two DS, Step2] - - -Then, add the second Data Source by pressing the plus (+) glyph and -providing data for udpOutPackets. Pay attention to select the correct Output -Field defined by the Data Input Method as we did with the udpInDatagrams. - - -[Image: Data Template - Two DS, Step3] - - -To deactivate maximum checking, enter 'U', else the desired number. Do not -forget to select the correct Data Source Type and the Output Field as -before. - - -The Graph Template - - -Most of this task of creating a Graph Template has already been covered in -our example. You will basically create a new Graph Template, provide a -Line or an Area Fill followed by a Legend for both the udpInDatagrams -and udpOutDatagrams. The result of those actions will be the image below: - - -[Image: Graph Template - Two DS, Step4] - - -After you have created your Graph Template you can proceed to Add the -Graph Template to your Device, and either allow the automation to create -the Graph for you, or to manually add it from the New Graphs menu pick. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Data Queries - - -Overview - - -Cacti Data Queries are not a replacement for Data Input Methods in -Cacti. Instead they provide an easy way to extend Data Input methods to -interpret multidimensional objects, or list data based upon an index, making the -data easier to graph. The most common use of a **Data Query within Cacti is to -retrieve a list of network interfaces via SNMP. - - -If you want to graph the traffic of a network interface, first Cacti must -retrieve a list of interfaces on the host. Second, Cacti can use that -information to create the necessary Graphs and Data Sources. Data -Queries are only concerned with the first step of the process, that is -obtaining a list of network interfaces and not creating the graphs/data sources -for them. While listing network interfaces is a common use for Data -Queries, they also have other uses such as listing partitions, processors, -or even cards in a router. - - -One requirement for any Data Query in Cacti, is that it has some unique -value that defines each row in the list. This concept follows that of a 'primary -key' in SQL, and makes sure that each row in the list can be uniquely -referenced. Examples of these index values are 'ifIndex' for SNMP network -interfaces or the device name for partitions. - - -There are three types of Data queries that you will see referred to -throughout Cacti. They are script queries, script server queries, and SNMP -queries. Script, Script Server and SNMP queries are virtually identical in their -functionality and only differ in how they obtain their information. Script and -Script Server queries will call an external command or script and an SNMP query -will make an SNMP call to retrieve a list of data. - - -User Interface - - -Below, you can see Cacti's default Data Queries interface. From the -interface, you can see the Name, ID, Data Input Method, and other information -about the Data Query. - - -[Image: Data Query Interface] - - -When you edit an existing Data Query, you will see an interface like the one -below. In that interface, you will note that there is an XML file path included. -The XML file is a key component of a Cacti Data Query. For Script based -Data Queries, there will also be a script that must be called to gather -information about the Data Query, the script name is included in the XML -file. - - -[Image: Data Query Edit Interface] - - -In this Interface, you can see the Name, Description, XML Path, and Data Input -Method. In the section below that, you have the Associated Graph Templates -section which includes all the various Graph Templates that can be used for -the Data Query. - - -Once a Data Query Graph Template is in use, it can not longer be removed -from Cacti. This feature is there to prevent Graphs from becoming -unrenderable if someone accidentally were to remove the Graph Template -association. - - -When you click on any of the Associated Graph Template name, you will be taken -to the interface below. - - -[Image: Data Query Associated Graph Template Edit Interface] - - -From here, you map the various matching Data Template RRDfile Data Source -names to Data Source names that exist in the XML file. There can be many Data -Source names in the XML file, but a Graph Template may only require a few of -them, which explains the reason for having the Associated Data Templates -section of the Data Query. To associate the XML field with the Data -Templates RRDfile Data Source, you simply select the correct one, and then -toggle on the checkbox to the right of the XML field Data Source name. - - -Below the Associated Data Templates, you will find two sections which are -referred to as Suggested Values for both the Data Source and the Graph -names. When creating Graphs and their associated Data Sources Cacti will -use the first name in the Suggested Values pattern that fully replaces all the -tags that are identified by opening and closing vertical bars. So, in the -example above, when creating an Interface Graph, if that Interface does not have -an ifAlias, Cacti will likely use the second Suggested Value, unless the -interface does not have an IP Address, in which case it will use the third -Suggested Value. - - -Cacti also allows Suggested Values, to replace both Graph and Data -Source values, as in the case above, the "rrd_maximum" column is replaced by -the Network Interfaces maximum speed, otherwise known as the "ifSpeed" from an -SNMP perspective. - - -All data queries have two parts, the XML file and the definition within Cacti. -An XML file must be created for each query, that defines where each piece of -information is and how to retrieve it. This could be thought of as the actual -query. The second part is a definition within Cacti, which tells Cacti where to -find the XML file and associates the data query with one or more graph -templates. - - -Creating a Data Query - - -Once you have created the XML file that defines your data query, you must add -the data query within Cacti. Open Console > Data Collection > Data Queries -and select Add. You will be prompted for some basic -information about the data query, described in more detail below. - - -Table 12-1. Field Description: Data Queries - - - - - - Name - Description - - - - - - - Name - Give the Data Query a name that you will use to identify it. This name will be used throughout Cacti when presented with a list of Data Queries. - - - - - Description (Optional) - Enter a more detailed description of the data query including the information it queries or additional requirements. - - - - - XML Path - Fill in the full path to the XML file that defines this query. You can optionally use the path_cacti variable that will be substituted with the full path to Cacti. On the next screen, Cacti will check to make sure that it can find the XML file. - - - - - Data Input Method - This is how you tell Cacti to handle the data it receives from the data query. Typically, you will select Get SNMP Data (Indexed) for an SNMP query and Get Script Data (Indexed) for a script query. - - - - - -When you are finished filling in all necessary fields, click the Create button -to continue. You will be redirected back to the same page, but this time with -some additional information to fill in. If you receive a red warning that says -'XML File Does Not Exist', correct the value specified in the 'XML Path' field. - - -Associated Graph Templates - - -Every data query must have at least one graph template associated with it, and -possibly more depending on the number of output fields specified in the XML -file. This is where you get to choose what kind of graphs to generate from this -query. For instance, the interface data query has multiple graph template -associations, used to graph traffic, errors, or packets. To add a new graph -template association, simply click Add at the right of the Associated Graph -Templates box. You will be presented with a few fields to fill in: - - -Table 12-2. Field Description: Associated Graph Templates - - - - - - Name - Description - - - - - - - Name - Give a name describing what kind of data you are trying to represent or graph. When the user creates a graph using this data query, they will see a list of graph template associations that they will have to choose from. - - - - - Graph Template - Choose the actual graph template that you want to make the association with. - - - - - -When you are finished filling in these fields, click the Create button. You will -be redirected back to the same page with some additional information to fill in. -Cacti will make a list of each Data Template referenced to in your selected -Graph Template and display them under the Associated Data Templates box. -As previously mentioned, for each Data Source item listed, you must selected -the Data Query output field that corresponds with it. Do not forget to -check the checkbox to the right of each selection, or your settings will not be -saved. - - -The Suggested Values form provides you a way to control field values of Data -Sources and Graphs created using the Data Query. If you specify -multiple Suggested Values for the same field, Cacti will evaluate them in -order which you can control using the up or down arrow icons. For more -information about valid field names and variables, read the section on -Suggested Values. - - -When you are finished filling in all necessary fields on this form, click the -Save button to return to the data queries edit screen. Repeat the steps under -this heading as many times as necessary to represent all data in your XML file. -When you are finished with this, you should be ready to start adding your data -query to hosts. - - -SNMP Query XML Syntax - - - - Get SNMP Interfaces - Queries a host for a list of monitorable interfaces - .1.3.x.x.x - .1.3.6.1.2.1.2.2.1.1 - OID/REGEXP:.*.([0-9]{1,3}.[0-9]{1,3})$ - .1.3.6.1.2.1.2.1.0 - ifDescr:ifName:ifIndex - numeric - |chosen_order_field| - - - - Index - walk - value - input - .1.3.6.1.2.1.2.2.1.1 - - - - - - -Table 12-3. SNMP Query XML Settings Reference - - - - - - Field - Description - - - - - - - name - (Optional) You can enter a "friendly name" for the SNMP Query here. It will not be used by Cacti, and is for identification only. - - - - - description - (Optional) You can enter a description for the SNMP Query here. It will not be used by Cacti, and is for identification only. - - - - - oid_uptime - If you have another OID that contains ticks (time), say for example a Java VM. Then, you can create a data query that specifies an alternate uptime OID. To implement this for a data query, simply add the oid_uptime XML parameter to your XML file. Then, if you select your re-index method to be Uptime Goes Backward, Cacti will use that OID to detect whether it is time to re-index the host instead of the standard SNMP OID for uptime. - - - - - oid_index - Every SNMP Query must have an OID that represents the index values for the query when walked. As described above, any data query in Cacti must contain a field that uniquely identifies each row returned by the query. In the example above, the oid_index points to the OID of ifIndex in the interface MIB. Note: Cacti is able to parse unique indexes from the OID itself. While the regular expression used for parsing the value from the OID is defined below, you must still specify an OID that can be walked by Cacti in order to obtain the list of OID's. Any OID defined for one of your input fields should work in this case. The values returned from the snmpwalk walk will be completely disregarded. - - - - - non_unique - If set to true, Cacti will allow the Data Query index to be non-unique, and it will not attempt to change the index_order if for some reason, the chosen index field is not unique. - - - - - oid_index_parse - This field should only be used if you are trying to parse the unique index from the OID itself. If this field is defined, to obtain a list of indexes, Cacti walks the OID provided in the oid_index field above. It then applies the regular expression provided in this field to the list of OID's that are returned. The matched substrings that remain become the list of indexes for this SNMP Query. - - - - - value_index_parse - This field uses regular expressions to restrict the list of data returned from the get or walk method. For example: .1.3.6.1.2.1.2.2.1.8 OID/REGEXP:1 will only show the list of up-state interfaces. Tip - When using this field it is also worth using oid_index_parse, example: OID/REGEXP:.\*\.([0-9]+)$ - - - - - oid_num_indexes - An OID that can be queried to determine the total number of available indexes. If specified, this will be used to determine when to automatically re-cache this SNMP Query when it is attached to a device. - - - - - index_order - Cacti will attempt to find the best field to index off of based on whether each row in the query is unique and non-null. If specified, Cacti will perform this check on the fields listed here in the order specified. Only input fields can be specified and multiple fields should be delimited with a colon. - - - - - index_transient - If set to 'true', this field instructs Cacti not to stop attempting to Graph an index if it disappears from the host cache as a result of a re-index. This setting is for indexes that come and go, for example PPPoE statistics or user statistics which appear when a user log's in, but disappear a few hours after the connection is terminated. - - - - - index_order_type - For sorting purposes, specify whether the index is numeric or alphanumeric. numeric: The indexes in this SNMP Query are to be sorted numerically (ie. 1,2,3,10,20,31) alphabetic: The indexes in this SNMP Query are to be sorted alphabetically (1,10,2,20,3,31). - - - - - index_title_format - Specify the title format to use when representing an index to the user. Any input field name can be used as a variable if enclosed in pipes (|). The variable |chosen_order_field| will be substituted with the field chosen by Cacti to index off of (see index_order above). - - - - - -Table 12-4. SNMP Query XML Field Settings Reference - - -Each field contained within the SNMP Query must be defined under the field tag -as show in the example above. In addition, each defined field in the SNMP Query -must have a unique name given to it. Do not use spaces or any non-alphanumeric -characters, this name must be identifiable within Cacti. - - - - - - Field - Description - - - - - - - name - Here you can specify a "friendly name" for the field. This name will be used by Cacti to help the user identify this field. - - - - - method - Tell Cacti how you want it to gather SNMP information for this field. get: The get method performs an snmpget for the OID specified for this field appended by the index values derived from /. walk: The walk method does a walk of the OID specified for this field. If all OIDs belong to the same SNMP table, both methods will return the same values, even though the 'walk' method is typically more efficient. - - - - - source - When Cacti obtains a list for this field, you need to tell it how to derive its value for each row. value: The 'value' option simply returns the result of the snmpget for each row. OID/REGEXP (regexp_match): The OID/REGEXP modifier can be used when you need to use a Perl-compatible regular expression to derive the value from the OID. The most common example of this is to retrieve the IP address of an interface, and can be seen in the 'interface.xml' file. VALUE/REGEXP (regexp_match): The VALUE/REGEXP modifier can be used to parse the value based on a regular expression, returning the first match. index: Simply use the value of the index for this row as the value. If the index is being parsed from the OID using the oid_index_parse field, you must specify index here. Omit the ... field, then. OID2HEX/REGEXP (regexp_match): The OID2HEX/REGEXP modifier can be used to parse the OID to extract IPv6 addresses. This is useful for input type fields. It also supports the 'oid_index_parse' expression as well. - - - - - direction - input: Input values are the "known" values that you will use to derive the output values, this is where the "query" part of SNMP query comes in. When you create a graph based on an SNMP query, Cacti will prompt you to choose the input value to base the graph on. output: Output values are "unknown" values that are returned from the script. An SNMP query may return multiple statistics for a single index. For instance, a single interface could return bytes/sec in, errors, packets/sec, etc. A rule of thumb is that input fields contain semi-static data that is not graphable, while the output fields contain the data that will be graphed. - - - - - oid - You must specify the actual OID that corresponds with the field. Each value for this field can be obtained by doing an snmpget on oid.(each)snmpindex. - - - - - oid_rewrite_pattern - You can specify and OID/REGEXP string which will be replaced by the oid_rewrite_replacement string if found. - - - - - oid_rewrite_replacement - You must specify the actual OID that corresponds with the field. Each value for this field can be obtained by doing an snmpget on oid.(each)snmpindex. - - - - - oid_suffix - The suffix, if specified will be appended to the each oid from the walk or get response, prior to the oid_rewrite_pattern to oid_rewrite_replace regular expression replace. If the method is get, Cacti will issue an snmpget to obtain the resulting data. - - - - - rewrite_index - Modifies the snmp values using the rewrite_index expression. - - - - - output_format - Determines the output format of the column values. Options are 'ascii', 'hex'. If not specified, Cacti will allow SNMP to 'guess' the output format. - - - - - -Script Query XML Syntax - - - - Get Unix Mounted Partitions - Queries a list of mounted partitions on a unix-based host with the 'df' command. - perl |path_cacti|/scripts/query_unix_partitions.pl - index - query - get - num_indexes - : - dskDevice:dskMount - alphabetic - |chosen_order_field| - - - - Device Name - input - device - - - - - - -Table 12-5. Script Query XML Settings - - - - - - Field - Description - - - - - - - name - (Optional) You can enter a "friendly name" for the script query here. It will not be used by Cacti, and is for identification only. - - - - - description - (Optional) You can enter a description for the script query here. It will not be used by Cacti, and is for identification only. - - - - - script_path - Enter the complete path to the script or executable that is going to handle your script query. When in doubt, specify the pull path to all binaries referenced in this path, the query may not execute otherwise. - - - - - arg_index - Enter the argument that is to be passed to the script to retrieve a list of indexes. - - - - - arg_query - Enter the argument that is to be passed to the script to retrieve a list of values given a field name. - - - - - arg_get - Enter the argument that is to be passed to the script to retrieve a single value given a field name and index value. - - - - - arg_num_indexes - Enter the argument that is to be passed to the script to determine the total number of available indexes. If specified, this will be used to determine when to automatically re-cache this script query when it is attached to a device. - - - - - output_delimeter - Enter the one character delimiter that will be used to separate output values. This is only used when you "query" the script in which case it outputs 'index(delimiter)value'. - - - - - index_order - Cacti will attempt to find the best field to index off of based on whether each row in the query is unique and non-null. If specified, Cacti will perform this check on the fields listed here in the order specified. Only input fields can be specified; separate multiple fields with a colon, as in ifDescr:ifName:ifIndex. - - - - - index_transient - If set to 'true', this field instructs Cacti not to stop attempting to Graph an index if it disappears from the host cache as a result of a re-index. This setting is for indexes that come and go, for example PPPoE statistics or user statistics which appear when a user log's in, but disappear a few hours after the connection is terminated. - - - - - index_order_type - For sorting purposes, specify whether the index is numeric or alphanumeric. numeric: The indexes in this script query are to be sorted numerically (ie. 1,2,3,10,20,31) alphabetic: The indexes in this script query are to be sorted alphabetically (1,10,2,20,3,31). - - - - - index_title_format - Specify the title format to use when representing an index to the user. Any input field name can be used as a variable if enclosed in pipes (|). The variable |chosen_order_field| will be substituted with the field chosen by Cacti to index off of (see index_order above). - - - - - -Table 12-6. Script Query XML Field Settings - - -Each field contained within the Script Query must be defined under the field tag -as show in the example above. In addition, each defined field in the Script -Query must have a unique name given to it. Do not use spaces or any -non-alphanumeric characters, this name must be identifiable within Cacti. - - - - - - Field - Description - - - - - - - name - Here you can specify a "friendly name" for the field. This name will be used by Cacti to help the user identify this field. - - - - - direction - input: Input values are the "known" values that you will use to derive the output values, this is where the "query" part of script query comes in. When you create a graph based on a script query, Cacti will prompt you to choose the input value to base the graph on. output: Output values are "unknown" values that are returned from the script. A script query may return multiple statistics for a single index. For instance, a single partition could return free disk space, total disk space, fragmentation percentage, etc. A rule of thumb is that input fields contain semi-static data that is not graphable, while the output fields contain the data that will be graphed. - - - - - query_name - Enter the name that Cacti must use when asking the script for information about this field. For instance, the following should return values: '(script_name) query (query_name)'. - - - - - -Script Server XML Syntax - - - - Get Host MIB CPUs - |path_cacti|/scripts/ss_host_cpu.php - ss_host_cpu - php - |host_hostname| |host_id| |host_snmp_version|:|host_snmp_port|:|host_snmp_timeout|:|host_ping_retries|:|host_max_oids|:|host_snmp_community|:|host_snmp_username|:|host_snmp_password|:|host_snmp_auth_protocol|:|host_snmp_priv_passphrase|:|host_snmp_priv_protocol|:|host_snmp_context| - index - query - get - num_indexes - ! - hrProcessorFrwID - numeric - CPU#|chosen_order_field| - - - - Processor Index Number - input - index - - - - Processor Usage - output - usage - - - - - - - -Table 12-7. Script Server XML Settings - - - - - - Field - Description - - - - - - - name - (Optional) You can enter a "friendly name" for the script query here. It will not be used by Cacti, and is for identification only. - - - - - description - (Optional) You can enter a description for the script query here. It will not be used by Cacti, and is for identification only. - - - - - script_path - Enter the complete path to the script or executable that is going to handle your script query. When in doubt, specify the pull path to all binaries referenced in this path, the query may not execute otherwise. - - - - - script_function - The function within the script in the case where the script can be used for multiple data collection functions. Most script server scripts are associated with only one Data Query, but it's possible to have one script perform the collection for multiple Data Queries. - - - - - arg_prepend - A list of device variables from the host to prepend after the script function when calling the script. This information can be used to identify the device that is being monitored or pass certain device information to the script. - - - - - arg_index - Enter the argument that is to be passed to the script to retrieve a list of indexes. - - - - - arg_query - Enter the argument that is to be passed to the script to retrieve a list of values given a field name. - - - - - arg_get - Enter the argument that is to be passed to the script to retrieve a single value given a field name and index value. - - - - - arg_num_indexes - Enter the argument that is to be passed to the script to determine the total number of available indexes. If specified, this will be used to determine when to automatically re-cache this script query when it is attached to a device. - - - - - output_delimeter - Enter the one character delimiter that will be used to separate output values. This is only used when you "query" the script in which case it outputs 'index(delimiter)value'. - - - - - index_order - Cacti will attempt to find the best field to index off of based on whether each row in the query is unique and non-null. If specified, Cacti will perform this check on the fields listed here in the order specified. Only input fields can be specified; separate multiple fields with a colon, as in ifDescr:ifName:ifIndex. - - - - - index_transient - If set to 'true', this field instructs Cacti not to stop attempting to Graph an index if it disappears from the host cache as a result of a re-index. This setting is for indexes that come and go, for example PPPoE statistics or user statistics which appear when a user log's in, but disappear a few hours after the connection is terminated. - - - - - index_order_type - For sorting purposes, specify whether the index is numeric or alphanumeric. numeric: The indexes in this script query are to be sorted numerically (ie. 1,2,3,10,20,31) alphabetic: The indexes in this script query are to be sorted alphabetically (1,10,2,20,3,31). - - - - - index_title_format - Specify the title format to use when representing an index to the user. Any input field name can be used as a variable if enclosed in pipes (|). The variable |chosen_order_field| will be substituted with the field chosen by Cacti to index off of (see index_order above). - - - - - -Table 12-6. Script Server XML Field Settings - - -Each field contained within the Script Query must be defined under the field tag -as show in the example above. In addition, each defined field in the Script -Query must have a unique name given to it. Do not use spaces or any -non-alphanumeric characters, this name must be identifiable within Cacti. - - - - - - Field - Description - - - - - - - name - Here you can specify a "friendly name" for the field. This name will be used by Cacti to help the user identify this field. - - - - - direction - input: Input values are the "known" values that you will use to derive the output values, this is where the "query" part of script query comes in. When you create a graph based on a script query, Cacti will prompt you to choose the input value to base the graph on. output: Output values are "unknown" values that are returned from the script. A script query may return multiple statistics for a single index. For instance, a single partition could return free disk space, total disk space, fragmentation percentage, etc. A rule of thumb is that input fields contain semi-static data that is not graphable, while the output fields contain the data that will be graphed. - - - - - query_name - Enter the name that Cacti must use when asking the script for information about this field. For instance, the following should return values: '(script_name) query (query_name)'. - - - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -How To Work with Data Queries - - -During the past few weeks as I've made various SNMP Data Query templates I've -ran into a few 'tricks' (which existing user scripts use) to make them work -with most devices. It'd probably be beneficial to publish these in some manner -on the documentation site so others don't have to stumble. - - -As you already know getting an index is the hardest thing users struggle with. -I've ran across three scenarios and their solutions: - - -SNMP index is present - - -Basically mimic the interface.xml template which comes with Cacti -(cacti/resource/snmp_queries/interface.xml). - - -SNMPWALK: - - -Raw OIDs: -.1.3.6.1.2.1.2.2.1.1.1 = INTEGER: 1 -.1.3.6.1.2.1.2.2.1.1.2 = INTEGER: 2 -.1.3.6.1.2.1.2.1.0 = INTEGER: 2 - - - -Textual MIB names: -IF-MIB::ifIndex.1 = INTEGER: 1 -IF-MIB::ifIndex.2 = INTEGER: 2 -IF-MIB::ifNumber.0 = INTEGER: 2 - - - -In the SNMP XML file, specify the and optional - fields. For example: - - - - Get SNMP Interfaces - Queries a host for a list of monitorable interfaces - .1.3.6.1.2.1.2.2.1.1 - .1.3.6.1.2.1.2.1.0 - - - - Index - walk - value - input - .1.3.6.1.2.1.2.2.1.1 - - - - - - -A verbose query from inside Cacti shows the following: - - -+ Running data query [1]. -+ Found type = '3' [snmp query]. -+ Found data query XML file at 'C:/Inetpub/wwwroot/cacti/resource/snmp_queries/interface.xml' -+ XML file parsed ok. -+ Executing SNMP walk for list of indexes @ '.1.3.6.1.2.1.2.2.1.1' -+ Index found at OID: 'iso.3.6.1.2.1.2.2.1.1.1' value: '1' -+ Index found at OID: 'iso.3.6.1.2.1.2.2.1.1.2' value: '2' -+ Located input field 'ifIndex' [walk] -+ Executing SNMP walk for data @ '.1.3.6.1.2.1.2.2.1.1' -+ Found item [ifIndex='1'] index: 1 [from value] -+ Found item [ifIndex='2'] index: 2 [from value] - - - -SNMP Index is a STRING - - -Some devices (like on a F5 BigIP) use a STRING to represent the Index due to -the fact it is user configurable. In this case we need Cacti to parse out the -variable length Index. - - -Sample of a STRING Index: - - -Raw OID: - - -.1.3.6.1.4.1.3375.2.2.10.2.3.1.1.5.76.88.87.69.66 = STRING: "LXWEB" -.1.3.6.1.4.1.3375.2.2.10.2.3.1.1.6.69.80.88.87.69.66 = STRING: "EPXWEB" - - - -Textual MIB names: - - -F5-BIGIP-LOCAL-MIB::ltmVirtualServStatName."LXWEB" = STRING: LXWEB -F5-BIGIP-LOCAL-MIB::ltmVirtualServStatName."EPXWEB" = STRING: EPXWEB - - - -Next we need to define a OID/REGEXP that will look for the start of the STRING -and create the Index. In this case the regexp "^.{32}" matches the first 32 -characters beginning at the start of the OID -- this is the length of the OID -from the leading dot up to the start of the index. Then the capturing parens -"(.*)" grab the remainder of the OID as a backreference. Use the following SNMP -XML script: - - - - Get F5 Big-IP Load Balancer Virtual Server Statistics - .1.3.6.1.4.1.3375.2.2.10.2.3.1.1 - OID/REGEXP:^.{32}(.*) - vsIndex - alphabetic - - - - Index - index - input - - - - - - -After creating the Data Query Data & Graph templates in Cacti a verbose query -will spit out the following: - - -+ Running data query [20]. -+ Found type = '3' [snmp query]. -+ Found data query XML file at 'C:/Inetpub/wwwroot/cacti/resource/snmp_queries/f5_bigip_vs.xml' -+ XML file parsed ok. -+ Executing SNMP walk for list of indexes @ '.1.3.6.1.4.1.3375.2.2.10.2.3.1.1' -+ Index found at OID: 'enterprises.3375.2.2.10.2.3.1.1.5.76.88.87.69.66' value: 'LXWEB' -+ Index found at OID: 'enterprises.3375.2.2.10.2.3.1.1.6.69.80.88.87.69.66' value: 'EPXWEB' -+ index_parse at OID: 'enterprises.3375.2.2.10.2.3.1.1.5.76.88.87.69.66' results: '5.76.88.87.69.66' -+ index_parse at OID: 'enterprises.3375.2.2.10.2.3.1.1.6.69.80.88.87.69.66' results: '6.69.80.88.87.69.66' -+ Inserting index data for field 'vsIndex' [value='5.76.88.87.69.66'] -+ Inserting index data for field 'vsIndex' [value='6.69.80.88.87.69.66'] - - - -SNMP Index does not exist - - -Some devices do not offer a traditional Index OID to query. Here we need to -create/fake the index for Cacti. This is accomplished once again with a simple -REGEX to split off the last OID (or middle, etc) to create the index for cacti. - - -SNMPWALK: - - -Raw OIDs: - - -.1.3.6.1.2.1.7.1.0 = Counter32: 69367 -.1.3.6.1.2.1.7.2.0 = Counter32: 11 -.1.3.6.1.2.1.7.3.0 = Counter32: 0 -.1.3.6.1.2.1.7.4.0 = Counter32: 64392 - - - -Textual MIB name: - - -UDP-MIB::udpInDatagrams.0 = Counter32: 69458 -UDP-MIB::udpNoPorts.0 = Counter32: 11 -UDP-MIB::udpInErrors.0 = Counter32: 0 -UDP-MIB::udpOutDatagrams.0 = Counter32: 64471 - - - -Consulting the MIB file for these OIDs, we know that the associated index will -always be "0" for each OID. We'll want to split this off with the -REGEX. - - -Create the following SNMP XML file: - - - - Get RFC1213 Stats - Management Information Base for Network Management of TCP/IP-based internets - .1.3.6.1.2.1.7.2 - OID/REGEXP:.*\.([0-9]{1,2})$ - Index - alphabetic - - - - Index - index - input - - - - - - -Once all of the required templates have been created, a verbose query from -Cacti results in the following: - - -+ Running data query [23]. -+ Found type = '3' [snmp query]. -+ Found data query XML file at 'C:/Inetpub/wwwroot/cacti/resource/snmp_queries/RFC1213.xml' -+ XML file parsed ok. -+ Executing SNMP walk for list of indexes @ '.1.3.6.1.2.1.7.2' -+ Index found at OID: 'iso.3.6.1.2.1.7.2.0' value: '11' -+ index_parse at OID: 'iso.3.6.1.2.1.7.2.0' results: '0' -+ Inserting index data for field 'Index' [value='0'] - - - -A note on Textual SNMP MIBS and SPINE - - -Please be aware the SPINE does not parse out textual Mibs. This means that if -you were to use an OID that contained a string reference rather than numerical -this will cause Graphs to fail as they will not be generated due to spine not -receiving a value at each poll - - -Example of a bad OID reference for spine: - - -interfaces.mib.1.1.1.1.1 - - - - - -Copyright (c) 2004-2026 The Cacti Group - - -SNMP Data Queries - - -Walkthrough: A New SNMP Data Query - - -For SNMP Queries, you won't need to create a data retrieval script. Cacti will -use SNMP to retrieve information. But cacti will need additional information on -how the indexed data is structured. Think about a table (a MIB table in this -case); you'll have to tell cacti about the table structure. This is done by -defining an XML file. Basically, you have to define the index to tell cacti -about the number of rows and about their unique index. This index is later used -to access each rows data. Furthermore, you may define columns, that serve as -descriptive fields to be shown in the selection table. The XML file knows -them as - - -input - - - -You will have to define those fields, that will be queried for the readings, -e.g. ifInOctets, ifOutOctets, ifInErrors, …The XML file knows them as - - -output - - - -Lets have an example: standard Interface MIB with the corresponding part of the -/resources/snmp_queries/interfaces.xml file are displayed using -the following table: - - -[Image: SNMP Table 1] - - -[Image: SNMP Table 2] - - -[Image: SNMP Table 3] - - -and see the corresponding table structure when defining New Graphs for that -Device (my laptop): - - -[Image: Creating graph for Data Query] - - -Now you can map - - -* Index: IF-MIB::ifIndex - - -* Status: IF-MIB::ifOperStatus - - -* Description: IF-MIB::ifDescr - - -* Type: IF-MIB::ifType - - -* Speed: IF-MIB::ifSpeed - - - - -All those are input Parameters. They serve as -descriptive information to each row to help you identify the proper interface to -use. Those parameters of output can be compared to -output parameters of a script (see ping.pl script above). These are the readings -from the device. By selecting the appropriate row (the one grayed out had been -selected by me), you tell cacti to retrieve data from the interface defined by -this index. But how does cacti know, what output parameters it shall retrieve? -See the Select a Graph type dropdown. It specifies a Graph Template defined -for this Data Query. The Graph Template in turn references a Data Template -which incorporates the needed output parameters as Data Sources. This works -quite the same way as defined for a Data Input Method. - - -To sum up: the SNMP XML file is somehow a replacement for the Data Input -Method described above to be used on indexed values. It tells cacti, what data -it should retrieve (direction: output). To help you identifying the relevant -indexes, the XML defines descriptive parameters (direction: input) to be -displayed in the selection table. - - -A walkthrough for this is given now. It is based on the already supplied -interfaces.xml file. - - -Create a Data Query to tell cacti how to retrieve data - - -Go to Data Queries and click the plus (+) glyph to see: - - -[Image: Add new Data Query] - - -Here, we are using the already existing interface.xml file. Select Get SNMP -Data (Indexed) as Data Input Method. Press Create to see: - - -[Image: Fill Data for Data Query] - - -See, that cacti found the XML file. Don't bother with the Associated Graph -Templates at the moment. The success message does not include checking of the -XML file's content. Not lets proceed to the next definitions. - - -Create a Data Template to tell Cacti how to store data - - -This is the exact copy of the definitions made above. So I do not repeat -everything here. Data Input Method must be selected as Get SNMP Data -(Indexed). As this data source is a COUNTER type, select this as the Data -Source Type. But after saving the new Data Source definition, you may want to -define a second Data Source to the same Data Template. To do so, select New -from the Data Source Item heading to see: - - -[Image: Enter new Data Source Item] - - -The name of the internal RRDtool Data Source (ifOutOctets) is not replaced in -the Tab until you save your work. By default, Maximum Value is set to 100. -This is way too low for an interface. All readings above this value will be -stored as NaN by RRDtool. To avoid this, set to 0 (no clipping) or to a -reasonable value (e.g. interface speed). Don't forget to specify COUNTER! You -will have noticed, that the name of the data source does not match the Name in -the interface.xml. Don't worry, the solution to this is given later on. Before -leaving, pay attention to the bottom of the page: - - -[Image: Check Indexes for Data Query Data Template] - - -This is specific to indexed Data Queries. You will have to check the last -three items to make indexing work. All other items should be left alone, there -values will be taken from the appropriate device definitions. Now click Save -and you're done with this step. - - - - - -Note that if you wish to hand Edit mappings of various indexed interfaces -manually for each Graph in the future, you should check the following -three fields Index Type, Index Value and Output Type ID as shown below. -Do this for each Data Template Data Source Items in the Data -Template. - - - -[Image: Force the Indexes to be Hand Editable] - - -Create a Graph Template to tell cacti how to present the data - - -Since creating a new Data Query based upon an existing Data Query called -SNMP - Interface Statistics we don't need to create any Graph Templates, -we can use the ones created for the other Data Query. - - -Add Graph Template to the Data Query - - -Now it's time to re-visit our Data Query. Remember the Associated Graph -Template we've left alone in the very first step? Now it will get a meaning. -Go to Data Queries and select our new one. Then press the plus (+) glyph, -and select Interface - Traffic (bits/second) from the drop down as shown -below. Press Create to initialize the association of this Graph -Template with out new Data Query. - - -[Image: Add new associated Graph Template] - - -Once we press the Create button, we should get an image like the one below. -From here, it's important that we associate the Data Sources to the XML file -columns that retrieve the data using SNMP. Press the Save button to -complete the mapping of Data Sources to the XML file Data Source Output -Values. - - -[Image: Creating new associated Graph Template] - - -In addition, we need to setup any Suggested Values as you can see from the -example below. Suggested Values are optional when the Data Query can have -a multitude of suggested names based upon the output from the Data Query. -For both the Suggested Values - Graphs and Suggested Values - Data Sources, -we must include the name of the column, and the Suggested Value which can -includes the special tag |query_xmlcolumn| as shown in the examples below. - - -[Image: Suggested Values for Associated Graph Template] - - -Once the Associated Graph Template mappings have been completed, you should -see the image below, where we have: - - -* Mapped the internal Data Template Data Sources to the XML file Input -Data Sources - - -* Added any Suggested Values for the Graph Title or other Graph fields - - -* Added any Suggested Values for the Data Source name or other Data -Source fields - - - - -[Image: Associated Graph Template Completed] - - -Once you have confirmed all the values, you can press Return to return to -the Data Query page for our Example Data Query as shown below. - - -[Image: Save Associated Graph Template] - - -Apply the Data Query to your Device - - -Now go to your Device to add the Associated Data Query: - - -[Image: Apply Data Query to your Device] - - -Click Add and then Create Graphs for this Host to see: - - -[Image: Create Graphs for Data Query] - - -Now select the wanted Interfaces and press Create to generate the Traffic -Graph. As long as there's only one Associated Graph Template for that Data -Query, there will be no Associated Graph Type drop down. Once you create -more than one Associated Graph Template for the Data Query, you will see -a drop down just above the Create button showing the available Graph -Templates for the Data Query in question, like the SNMP - Interface -Statistics as show below. - - -[Image: Additional Associated Graph Templates Example] - - -Pressing the Set Default button will set the selected Graph Type to be the -default for this Data Query. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -SNMP Data Query Walkthrough - - -This walkthrough will show you how to implement a new SNMP Data Query. Assuming, -you know the SNMP table, the next steps show how to proceed. - - -Building Raw XML File - - -The starting point will be snmptable for a well know table of the HOSTS MIB: - - -snmptable -c -v 1 HOST-RESOURCES-MIB::hrStorageTable -SNMP table: HOST-RESOURCES-MIB::hrStorageTable - - hrStorageIndex hrStorageType hrStorageDescr hrStorageAllocationUnits hrStorageSize hrStorageUsed hrStorageAllocationFailures - 1 HOST-RESOURCES-TYPES::hrStorageOther Memory Buffers 1024 Bytes 1035356 59532 ? - 2 HOST-RESOURCES-TYPES::hrStorageRam Real Memory 1024 Bytes 1035356 767448 ? - 3 HOST-RESOURCES-TYPES::hrStorageVirtualMemory Swap Space 1024 Bytes 1048568 0 ? - 4 HOST-RESOURCES-TYPES::hrStorageFixedDisk / 4096 Bytes 2209331 826154 ? - 5 HOST-RESOURCES-TYPES::hrStorageFixedDisk /sys 4096 Bytes 0 0 ? - 6 HOST-RESOURCES-TYPES::hrStorageFixedDisk /proc/bus/usb 4096 Bytes 0 0 ? - 7 HOST-RESOURCES-TYPES::hrStorageFixedDisk /boot 1024 Bytes 102454 9029 ? - 8 HOST-RESOURCES-TYPES::hrStorageFixedDisk /home 4096 Bytes 507988 446407 ? - 9 HOST-RESOURCES-TYPES::hrStorageFixedDisk /usr/local 4096 Bytes 507988 17133 ? - 10 HOST-RESOURCES-TYPES::hrStorageFixedDisk /var 4096 Bytes 507988 129429 ? - 11 HOST-RESOURCES-TYPES::hrStorageFixedDisk /var/lib/nfs/rpc_pipefs 4096 Bytes 0 0 ?** - - - -This given, the first step will be the definition of an XML file based on those -OIDs. So change to your /resource/snmp_queries directory and -create a file named hrStorageTable.xml. You may of course choose your own -name, but for me it seems appropriate to take the name of the SNMP Table itself. -Before doing so, it is necessary to identify the Index of that table. Without -looking at the MIB file, simply perform - - -snmpwalk -c -v 1 -On HOST-RESOURCES-MIB::hrStorageTable|more -.1.3.6.1.2.1.25.2.3.1.1.1 = INTEGER: 1 -.1.3.6.1.2.1.25.2.3.1.1.2 = INTEGER: 2 -.1.3.6.1.2.1.25.2.3.1.1.3 = INTEGER: 3 -.1.3.6.1.2.1.25.2.3.1.1.4 = INTEGER: 4 -.1.3.6.1.2.1.25.2.3.1.1.5 = INTEGER: 5 -.1.3.6.1.2.1.25.2.3.1.1.6 = INTEGER: 6 -.1.3.6.1.2.1.25.2.3.1.1.7 = INTEGER: 7 -.1.3.6.1.2.1.25.2.3.1.1.8 = INTEGER: 8 -.1.3.6.1.2.1.25.2.3.1.1.9 = INTEGER: 9 -.1.3.6.1.2.1.25.2.3.1.1.10 = INTEGER: 10 -.1.3.6.1.2.1.25.2.3.1.1.11 = INTEGER: 11 -.1.3.6.1.2.1.25.2.3.1.2.1 = OID: .1.3.6.1.2.1.25.2.1.1 -.1.3.6.1.2.1.25.2.3.1.2.2 = OID: .1.3.6.1.2.1.25.2.1.2 - - - -The first index is .1.3.6.1.2.1.25.2.3.1.1.1, but the Index Base is -.1.3.6.1.2.1.25.2.3.1.1. This OID is needed for the XML file: - - - - Get hrStorageTable Information - Get SNMP based Partition Information out of hrStorageTable - hrStorageDescr:hrStorageIndex - numeric - .1.3.6.1.2.1.25.2.3.1.1 - - - - Index - walk - value - input - .1.3.6.1.2.1.25.2.3.1.1 - - - - - - -Lets talk about the header elements - - - - - - Field - Description - - - - - - - Name - Short Name; choose your own one if you want - - - - - Description - Long Name - - - - - index_order - tells us, which field shall be selected to index on; evaluated from left to right - - - - - index_order_type - numeric instead of alphabetic sorting - - - - - oid_index - the index of the table - - - - - -There are more header elements, but for sake of simplification, we'll stick to -that for now. - - -Lets turn to the fields. They correspond to the columns of the snmptable. For -debugging purpose it is recommended to start with the Index field first. This -will keep the XML as tiny as possible. The section contains one or -more fields, each beginning with and ending with -. It is recommended but not necessary to take the textual -representation of the OID or an abbreviation of that. - - - - - - Field - Description - - - - - - - Name - Short Name - - - - - Method - Walk or get (representing snmpwalk or snmpget to fetch the values) - - - - - Source - Value = take the value of that OID as the requested value. Sounds ugly, but there are more options that we won't need for the purpose of this example - - - - - Direction - Input (for values that may be printed as COMMENTs or the like). Output (for values that shall be graphed, e.g. COUNTERs or GAUGEs). - - - - - OID - the real OID as numeric representation - - - - - -Now save this file and lets turn to cacti to implement this one. First, go to -Data Queries to see - - -[Image: SNMP Table 1 - Data Query] - - -and Add a new one: - - -[Image: SNMP Table 2 - Data Query] - - -Fill in Short and Long Names at your wish. Enter the file name of the XML file -and don't forget to choose Get SNMP Data (indexed). Create to see - - -[Image: SNMP Table 3 - Data Query] - - -It has now Successfully located XML file. But this does not mean that there -are no errors. So lets go on with that. Turn to the Device you want to query -and add the new Data Query as shown: - - -[Image: SNMP Table 1 - Device] - - -Index Count Changed was chosen on purpose to tell cacti to re-index not only -on reboot but each time the Index Count (e.g. number of partitions) changed. -When done, see the results as - - -[Image: SNMP Table 2 - Device] - - -You'll notice, that on my laptop there are 11 indices = 11 partitions. So the -XML worked up to now! To make this clear, select Verbose Query to see: - - -[Image: SNMP Table Preview - Device] - - -Insert all descriptive table columns - - -Now lets put all descriptive table columns into the SNMP Query XML file. This -refers to - - -* hrStorageType - - -* hrStorageDescr - - -* hrStorageAllocationUnits - - - - -I like to take the XML field names from the snmptable output, but this is not a -must. - - - - Get hrStorageTable Information - Get SNMP based Partition Information out of hrStorageTable - hrStorageDescr:hrStorageIndex - numeric - .1.3.6.1.2.1.25.2.3.1.1 - - - - Index - walk - value - input - .1.3.6.1.2.1.25.2.3.1.1 - - - Type - walk - value - input - .1.3.6.1.2.1.25.2.3.1.2 - - - - Description - walk - value - input - .1.3.6.1.2.1.25.2.3.1.3 - - - Allocation Units (Bytes) - walk - value - input - .1.3.6.1.2.1.25.2.3.1.4 - - - - - - -The information will later show up as a column heading. Don't -forget to provide the correct base OIDs. Remember, that the Index will -always be appended to those OIDs, e.g. the first Description will be fetched -from OID = .1.3.6.1.2.1.25.2.3.1.3.1 (that is base OID = -.1.3.6.1.2.1.25.2.3.1.3 together with the appended index .1 will form the -complete OID .1.3.6.1.2.1.25.2.3.1.3.1. - - -Please notice, that all fields that will yield descriptive columns only take -input - - -If you have completed your work, turn to the cacti web interface and select your -host from the Devices list to see: - - -[Image: SNMP Table 3 - Devices] - - -Select the little green circle next to our SNMP XML to update your last changes. -Then you'll see something like: - - -[Image: SNMP Table 4 - Devices] - - -When using Verbose Query, you'll now find - - -[Image: SNMP Table 5 - Devices] - - -And clicking Create Graphs for this host will result in - - -[Image: SNMP Table 6 - Devices] - - -You're not supposed to really create graphs at this moment, cause the XML is not -yet complete. And you'll notice, that the second column does not present very -useful information. So it may be omitted in later steps. - - -Getting the Output Values - - -Now lets modify the XML again. As said earlier, the second column is not very -meaningful, so lets drop it. To get the output values, I appended the last two -XML field descriptions, see: - - - - Get hrStorageTable Information - Get SNMP based Partition Information out of hrStorageTable - hrStorageDescr:hrStorageIndex - numeric - .1.3.6.1.2.1.25.2.3.1.1 - - - - Index - walk - value - input - .1.3.6.1.2.1.25.2.3.1.1 - - - Description - walk - value - input - .1.3.6.1.2.1.25.2.3.1.3 - - - Allocation Units (Bytes) - walk - value - input - .1.3.6.1.2.1.25.2.3.1.4 - - - Total Size (Units) - walk - value - output - .1.3.6.1.2.1.25.2.3.1.5 - - - Used Space (Units) - walk - value - output - .1.3.6.1.2.1.25.2.3.1.6 - - - - - - -This works very much the same way as above. - - -* Provide the fields hrStorageSize and hrStorageUsed - - -* Provide a useful name - - -* Don't forget to specify output - - -* Give the corresponding base OIDs - - - - -Now we may proceed as said above: Pressing the green circle runs that XML -definitions against the host and updates the rows/columns. You will notice the -“missing” second column only when Create Graphs for this Host is selected. - - - - -Note: Don't forget to set output for all -variables/fields, that should be stored in RRDfiles and be graphed!. This is the -mistake that occurs most often. - - -Defining the Data Template - - -The Data Template will define, how the data is retrieved by the XML Query is -saved. For more information about the principles of operation, please see Common -Tasks. Please go to Data Templates and Add: - - -[Image: SNMP Table 1 - Data Template] - - -Define the Name of the Data Template. When defining the Name of the Data -Source, do not forget to check the Use Per-Data Source Value (Ignore this -Value) checkbox. This will come in useful later. Data Input Method will read -Get SNMP Data (Indexed). Select the Data Source Profile as usual: - - -[Image: SNMP Table 2 - Data Template] - - -Now to the Data Source Items. I like giving them the names of the MIB OIDs, -see: - - -[Image: SNMP Table 3 - Data Template] - - -and New or the plus sign on the Data Source Item panel. Now enter the -second Data Source Item: - - -[Image: SNMP Table 4 - Data Template] - - -Please pay attention to setting the Maximum Value to 'U' (no limit). Else, -all values exceeding the pre-defined as NaN. Now scroll down to the bottom -of the page and check Index Type, Index Value and Output Type Id - - -[Image: SNMP Table 5 - Data Template] - - -Save and the Data Template is finished. - - -Defining the Graph Template - - -The Graph Template will define, how the data is presented. For more information -about the principles of operation, please see Principles of Operation . -Please go to Graph Templates and Add: - - -[Image: Defining Graph Template] - - -Fill in the header names and don't forget to check the Use Per-Graph Value -(Ignore this Value) for the Graph Template Title: - - -[Image: Graph Template Preview] - - -and Create. - - -[Image: Graph Template Preview after creation] - - -Now Add the first Graph Item as usual: - - -[Image: Graph Template Items 1] - - -Add the Legend and the second Graph Item: - - -[Image: Graph Template Items 2] - - -Again, add the Legend to end up with - - -[Image: Graph Template Items 3] - - -Revisiting The Data Query - - -We'll now have to revisit the Data Query - - -[Image: Data Query Review 1] - - -Create: - - -[Image: Data Query Review 2] - - -Select the correct Data Sources and check the boxes on the right. Save. -Now fill in some useful Suggested Values, at first for the Data -Template: - - -[Image: Data Query - Name Suggested Values] - - -Now apply suggested values for the Graph Template: - - -[Image: Data Query - Apply Suggested Values] - - -Now the Data Query is complete: - - -[Image: Data Query Complete] - - -Create Graphs for this Host - - -Now we're almost done. Everything's ready for use now. So go to your device and -select Create Graphs for this Host. Select some of the partitions you're -interested in: - - -[Image: Create Graphs for this host] - - -and Create to see: - - -[Image: Graphs created] - - -Lets visit the Data Sources: - - -[Image: Host Data Sources] - - -As you can see, the Suggested Values of the Data Query defined the Name of -the Data Template. So lets go to Graph Management: - - -[Image: Graph Management Preview] - - -to see the title defined by the Suggested Values. When turning to the -Graphs, you may see something like - - -[Image: Graph image] - - -This might be the end of the show. While it should be enough to define some -“easy” SNMP XML based Data Queries, there are some tricks and hints left to -explain. - - -As you may have noticed, the quantities defined by this example are counted in -Units, not Bytes. This is somewhat inconvenient but may be changed. Lets wait -for the next Section... - - -VALUE/REGEXP in Action - - -As said above, with the current XML size values are measured in Units. The -current Unit Size is given by hrStorageAllocationUnits, but the reading of -it is like 4096 Bytes. To use this in any calculations, we must get rid of -the string Bytes. This can be done by the VALUE/REGEXP Feature of -Cacti's XML definitions. So please change - - - - Allocation Units (Bytes) - walk - value - input - .1.3.6.1.2.1.25.2.3.1.4 - - - - -By - - - - Allocation Units (Bytes) - walk - VALUE/REGEXP:^([0-9]+)(?:[[:space:]]+Bytes)?$ - input - .1.3.6.1.2.1.25.2.3.1.4 - - - - -To prove this, go to your device and again Verbose Query our Data Query to -see: - - -[Image: Data Query Debug Info] - - -Now select Create Graphs for this Host and notice the change of the column -Allocation Units (Bytes). The string “Bytes” has gone: - - -[Image: Data Query Table] - - -To use these values, we define a CDEF: - - -[Image: CDEF Preview] - - -Notice, that with recent releases of cacti, it is possible to use |query_*| -values within CDEFs. Finally, go to Graph Templates and use this CDEF with -all Graph Items: - - -[Image: Graph Template - CDEF] - - -Change the Base Value to 1024 for Bytes → kBytes and the y-axis description -to Bytes: - - -[Image: Graph Template - Base and Vertical values] - - -Now the Graph looks like - - -[Image: Graph image] - - -Please find the example resources below. Save hrStorageTable.xml into -./resource/snmp_queries and import the Graph Template from -cacti_graph_template_host_mib_hrstoragetable.xml. - - -Cacti Graph Template Host MIB hrStorageTable - - -hrStorageTable download and store into -resource/snmp_queries. - - - - -Copyright (c) 2004-2026 The Cacti Group - - -Script Data Query Walkthrough - - -Goal of this HowTo will be to show the principles of writing a Script Query, -including script, xml and all needed templates. Why should you create such a -thing? Suppose, your target features some indexed readings, that are not -available via SNMP but by some other method (e.g. wget/cgi, ssh, NRPE, …). -Writing a Script Data Queries works very much the same way as SNMP Data Queries. -But nevertheless, I'll take you through all of the steps now. - - -The example uses PHP. Why PHP? First, it's easier to copy stuff from already -existing PHP scripts. Second, it would be possible to use cacti functions. It -should be possible to imagine, how this works with other programming languages. -Strictly speaking, I'm not that PHP expert. So be patient with me. - - -Please pay attention. This HowTo will not explain how to write a Script Server -Data Query (yes, there is such a thing!). It would not introduce that many -changes. But this will be left to some other HowTo. - - -Personally, my primary goal was to use an example, that all users should be able -to copy to execute each and every step on its own. Unfortunately, there seems to -be no example, that is common enough and interesting at the same time. So I'm -sorry to announce, that this HowTo will show “Interface Traffic Data Gathering”. -Yes, I know, this is not that new. And surely, it will not be as fast as pure -SNMP. So, to my shame, I suppose that this will never make it into any -production environment. But, again, this is not the primary goal. - - -Before starting the work, I feel encouraged to point out a drawback of this -approach. Cacti will start a PHP instance, each time it has to fetch a value -from the target device. This is not that fast, obviously. And it will not -prosper from the performance boost when switching over from cmd.php to Spine. Of -course, even Spine will need to start php! And that's exactly, where the thingy -called Script Server Data Query drops in. But let's leave this for the next -main chapter. - - -The code runs on Cacti 0.8.7 versions. - - -Basic Script - - -The starting point will be some very basic php script. Put it into -/scripts/query_interface_traffic.php. It will show interface -indices only for the given target host. The script takes two parameters as -input, the hostname of the target and the string index. You have to -implement the index method, as OO programmers would say. In this case, -there's an “if” clause to process index requests. Output is a list of indices, -each one on a separate line. - - - '.1.3.6.1.2.1.2.2.1.1', -); - -$xml_delimiter = '!'; - -# all required input params -$hostname = $_SERVER['argv'][1]; # hostname/IP@ -$cmd = $_SERVER['argv'][2]; # one of: index/query/get - -# put your own community string here -$snmp_community = 'public'; # community string -$snmp_version = 1; # snmp version -$snmp_port = 161; # snmp port -$snmp_timeout = 500; # snmp timeout -$snmp_retries = 3; # snmp retries -$max_oids = 1; # max oids for V2/V3 hosts -# required for SNMP V3 -$snmp_auth_username = ''; -$snmp_auth_password = ''; -$snmp_auth_protocol = ''; -$snmp_priv_passphrase = ''; -$snmp_priv_protocol = ''; -$snmp_context = ''; - -# ------------------------------------------------------------------------- -# main code starts here -# ------------------------------------------------------------------------- - -# ------------------------------------------------------------------------- -# script MUST respond to index queries -# the command for this is defined within the XML file as -# index -# you may replace the string 'index' both in the XML and here -# ------------------------------------------------------------------------- -# php -q