From 7c970d15218a3f1fb3ac4dd2e917a5e74dc2fc9b Mon Sep 17 00:00:00 2001 From: Jon Date: Mon, 26 Feb 2024 16:09:24 +0930 Subject: [PATCH] docs: fluffing with requirements and more details !15 --- docs/projects/ansible/collection/phpipam_scan_agent/index.md | 2 ++ .../projects/ansible/collection/phpipam_scan_agent/scanner.md | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/projects/ansible/collection/phpipam_scan_agent/index.md b/docs/projects/ansible/collection/phpipam_scan_agent/index.md index b083e92..860909b 100644 --- a/docs/projects/ansible/collection/phpipam_scan_agent/index.md +++ b/docs/projects/ansible/collection/phpipam_scan_agent/index.md @@ -25,6 +25,8 @@ A phpIPAM scan agent designed for both local and remote network scanning. This A This collection has been broken down into two components, a [server](server.md) and a [scanner](scanner.md). The scanner as the name implies will scan the networks assigned to it by phpIPAM and on completing a scan of a subnet, will post the results to the Server component which will process the results, and update the phpIPAM MySQL/MariaDB database directly. +This agent has been created to solve a few shortcomings of the official scan-agent. Ansible was chosen as the tool for the creation of the scan-agent. This was done as it lowers the bar of entry to modifying and development. This as well as that Ansible is a mature automation system that has many modules. The latter offers a wide range of integrating different systems. The scanner component is just an ansible playbook, whilst the server is an ansilbe rulebook which is based upon Event Driven Ansible (EDA). + ## Installation diff --git a/docs/projects/ansible/collection/phpipam_scan_agent/scanner.md b/docs/projects/ansible/collection/phpipam_scan_agent/scanner.md index a05911c..bb2e3cb 100644 --- a/docs/projects/ansible/collection/phpipam_scan_agent/scanner.md +++ b/docs/projects/ansible/collection/phpipam_scan_agent/scanner.md @@ -6,12 +6,12 @@ template: project.html about: https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent --- -The Scan Agent Scanner component is intended to scan networks that are assigned to it by the phpIPAM server. It can be installed and ran from any host that is capable of running python. +The Scan Agent Scanner component is intended to scan networks that are assigned to it by the phpIPAM server. It can be installed and ran from any host that is capable of running python. The scan agent only requires that there be `nmap` installed as this is the package that conducts the network scanning. ## Usage -After installing the collection and configuring. Running the agent is as simple as running the following command: +Ensure that the `namp` package is installed, install and configure the collection. Running the agent is as simple as running the following command: ``` bash