ansible-collections/phpipam_scan_agent
2
0
Fork 0
Code Issues 10 Pull Requests Actions Projects Releases 7 Wiki Activity

Merge branch 'development' into 'master'

Browse Source 
chore: release

See merge request nofusscomputing/projects/ansible/collections/phpipam_scan_agent!10
This commit is contained in:
Jon Lockwood
2024-02-23 08:30:53 +00:00
parent 067826f2e7 8b65ba0341
commit 37ec8a9265
24 changed files with 394 additions and 205 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.cz.yaml
View File

@ -4,5 +4,5 @@ commitizen:
prerelease_offset: 1 prerelease_offset: 1
tag_format: $version tag_format: $version
update_changelog_on_bump: false update_changelog_on_bump: false
version: 0.1.1 version: 0.2.0-a2
version_scheme: semver version_scheme: semver

93
.gitlab-ci.yml
View File

@ -21,6 +21,9 @@ variables:
include: include:
- local: .gitlab/unit-test.gitlab-ci.yml
- project: nofusscomputing/projects/gitlab-ci - project: nofusscomputing/projects/gitlab-ci
ref: development ref: development
file: file:
@ -29,6 +32,11 @@ include:
- template/mkdocs-documentation.gitlab-ci.yaml - template/mkdocs-documentation.gitlab-ci.yaml
# ToDo: update gitlabCI jobs for collections workflow # ToDo: update gitlabCI jobs for collections workflow
- git_push_mirror/.gitlab-ci.yml - git_push_mirror/.gitlab-ci.yml
- automation/.gitlab-ci-ansible.yaml
Update Git Submodules:
extends: .ansible_playbook_git_submodule
Github (Push --mirror): Github (Push --mirror):
@ -141,9 +149,9 @@ Github (Push --mirror):
docker buildx imagetools inspect $DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG; docker buildx imagetools inspect $DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG;
DOCKER_MULTI_ARCH_IMAGES=$(docker buildx imagetools inspect "$DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG" --format "{{ range .Manifest.Manifests }}$DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG@{{ println .Digest }} {{end}}") #DOCKER_MULTI_ARCH_IMAGES=$(docker buildx imagetools inspect "$DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG" --format "{{ range .Manifest.Manifests }}$DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG@{{ println .Digest }} {{end}}")
echo "[DEBUG] DOCKER_MULTI_ARCH_IMAGES=$DOCKER_MULTI_ARCH_IMAGES"; # echo "[DEBUG] DOCKER_MULTI_ARCH_IMAGES=$DOCKER_MULTI_ARCH_IMAGES";
# done; # done;
@ -151,35 +159,44 @@ Github (Push --mirror):
- docker login docker.io -u $NFC_DOCKERHUB_USERNAME -p $NFC_DOCKERHUB_TOKEN - docker login docker.io -u $NFC_DOCKERHUB_USERNAME -p $NFC_DOCKERHUB_TOKEN
- docker image ls - docker image ls
- | - |
DOCKER_HUB_TAG=dev # DOCKER_HUB_TAG=dev
echo "[DEBUG] default: DOCKER_HUB_TAG=$DOCKER_HUB_TAG"; # echo "[DEBUG] default: DOCKER_HUB_TAG=$DOCKER_HUB_TAG";
if [ "$CI_COMMIT_BRANCH" == "master" ]; then # if [ "$CI_COMMIT_BRANCH" == "master" ]; then
DOCKER_HUB_TAG=latest # DOCKER_HUB_TAG=latest
echo "[DEBUG] stable: DOCKER_HUB_TAG=$DOCKER_HUB_TAG"; # echo "[DEBUG] stable: DOCKER_HUB_TAG=$DOCKER_HUB_TAG";
elif [ "$CI_COMMIT_BRANCH" == "development" ]; then # fi;
DOCKER_HUB_TAG=dev # if [ "$CI_COMMIT_BRANCH" == "development" ]; then
echo "[DEBUG] dev: DOCKER_HUB_TAG=$DOCKER_HUB_TAG"; # DOCKER_HUB_TAG=dev
fi; # echo "[DEBUG] dev: DOCKER_HUB_TAG=$DOCKER_HUB_TAG";
echo "[DEBUG] DOCKER_IMAGE_PUBLISH_NAME=$DOCKER_IMAGE_PUBLISH_NAME"; # fi;
echo "[DEBUG] final: DOCKER_HUB_TAG=$DOCKER_HUB_TAG";
echo "[DEBUG] DOCKER_MULTI_ARCH_IMAGES=$DOCKER_MULTI_ARCH_IMAGES"; # echo "[DEBUG] DOCKER_IMAGE_PUBLISH_NAME=$DOCKER_IMAGE_PUBLISH_NAME";
# echo "[DEBUG] final: DOCKER_HUB_TAG=$DOCKER_HUB_TAG";
# echo "[DEBUG] DOCKER_MULTI_ARCH_IMAGES=$DOCKER_MULTI_ARCH_IMAGES";
docker buildx imagetools create $DOCKER_MULTI_ARCH_IMAGES --tag $DOCKER_IMAGE_PUBLISH_REGISTRY/$DOCKER_IMAGE_PUBLISH_NAME:$DOCKER_HUB_TAG;
if [ "${CI_COMMIT_TAG}" ]; then if [ "${CI_COMMIT_TAG}" ]; then
docker buildx imagetools create $DOCKER_MULTI_ARCH_IMAGES --tag $DOCKER_IMAGE_PUBLISH_REGISTRY/$DOCKER_IMAGE_PUBLISH_NAME:$CI_COMMIT_TAG; docker buildx imagetools create $DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG --tag $DOCKER_IMAGE_PUBLISH_REGISTRY/$DOCKER_IMAGE_PUBLISH_NAME:$CI_COMMIT_TAG;
docker buildx imagetools create $DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG --tag $DOCKER_IMAGE_PUBLISH_REGISTRY/$DOCKER_IMAGE_PUBLISH_NAME:latest;
else
docker buildx imagetools create $DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG --tag $DOCKER_IMAGE_PUBLISH_REGISTRY/$DOCKER_IMAGE_PUBLISH_NAME:dev;
fi; fi;
@ -225,10 +242,31 @@ Docker Container (dev):
- when: never - when: never
test:unit:docker:collection:installed:dev:
extends: .docker_collection_installed
needs:
- "Docker Container (dev)"
rules:
- if: $CI_COMMIT_TAG
when: never
- if: "$CI_COMMIT_AUTHOR =='nfc_bot <helpdesk@nofusscomputing.com>'"
when: never
- if:
$CI_COMMIT_BRANCH != "master"
&&
$CI_PIPELINE_SOURCE == "push"
when: always
- when: never
Docker Hub (dev): Docker Hub (dev):
extends: .publish-docker-hub extends: .publish-docker-hub
needs: needs:
- "Docker Container (dev)" - "Docker Container (dev)"
- "test:unit:docker:collection:installed:dev"
resource_group: docker-build resource_group: docker-build
rules: rules:
- if: $CI_COMMIT_TAG - if: $CI_COMMIT_TAG
@ -241,7 +279,7 @@ Docker Hub (dev):
$CI_COMMIT_BRANCH == "development" $CI_COMMIT_BRANCH == "development"
&& &&
$CI_PIPELINE_SOURCE == "push" $CI_PIPELINE_SOURCE == "push"
when: always when: on_success
- when: never - when: never
@ -267,10 +305,31 @@ Docker Container:
- when: never - when: never
test:unit:docker:collection:installed:
extends: .docker_collection_installed
needs:
- Docker Container
rules:
- if: $CI_COMMIT_TAG
when: on_success
- if: "$CI_COMMIT_AUTHOR =='nfc_bot <helpdesk@nofusscomputing.com>'"
when: never
# - if: # Occur on merge
# $CI_COMMIT_BRANCH == "development"
# &&
# $CI_PIPELINE_SOURCE == "push"
# when: always
- when: never
Docker Hub: Docker Hub:
extends: .publish-docker-hub extends: .publish-docker-hub
needs: needs:
- "Docker Container" - "Docker Container"
- "test:unit:docker:collection:installed"
- "Gitlab Release" - "Gitlab Release"
resource_group: docker-build resource_group: docker-build
rules: rules:

33
.gitlab/unit-test.gitlab-ci.yml Normal file
View File

@ -0,0 +1,33 @@
.docker_collection_installed:
stage: test
image:
name: nofusscomputing/docker-buildx-qemu:dev
pull_policy: always
services:
- name: docker:23-dind
entrypoint: ["env", "-u", "DOCKER_HOST"]
command: ["dockerd-entrypoint.sh"]
variables:
DOCKER_HOST: tcp://docker:2375/
DOCKER_DRIVER: overlay2
DOCKER_DOCKERFILE: dockerfile
# See https://github.com/docker-library/docker/pull/166
DOCKER_TLS_CERTDIR: ""
GIT_STRATEGY: none
before_script:
- | # Pull the image
docker pull $DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG;
- | # Show local images
docker images;
script:
- | # Confirm the package is installed within the docker container
docker run \
--rm \
$DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG \
ansible-galaxy collection list | grep nofusscomputing.phpipam_scan_agent;

41
CHANGELOG.md
View File

@ -1,4 +1,43 @@
## Unreleased ## 0.2.0-a2 (2024-02-23)
### Feat
- **server**: update subnet discovery date/time
- **server**: move config of variables to vars file
- **agent**: move config of variables to vars file
### Refactor
- **server**: don't process scan results in parallel
## 0.2.0-a1 (2024-02-22)
### Feat
- **server**: if hostname in scan report, update the database
- **agent**: if hostname present in nmap scan report, add to report for server
- **agent**: showsubnet address in logs when conducting subnet actions
- **server**: show ip address in logs when updating an ip address
- **api_call**: before returning check if cached file exists
### Fix
- **server**: use correct sql syntax to insert ipaddress
- **agent**: only attempt to scan subnet if subnets were returned
- **agent**: cater for api call that returns nothing
- **docker**: ensure correct variable used to install package
### Refactor
- **api_call**: use var name that makes more sense
## 0.1.2-a1 (2024-02-21)
### Fix
- **build**: ensure the correct tags and architectures are published
## 0.1.1 (2024-02-21)
### Fix ### Fix

20
README.md
View File

@ -1,9 +1,13 @@
<span align="center"> <span style="text-align: center;">
# No Fuss Computing - Ansible Collection PHPIPAM Scan Agent # No Fuss Computing - Ansible Collection PHPIPAM Scan Agent
![Project Status - Active](https://img.shields.io/badge/Project%20Status-Active-green?logo=gitlab&style=plastic) ![Project Status - Active](https://img.shields.io/badge/Project%20Status-Active-green?logo=gitlab&style=plastic)
[![Downloads](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgalaxy.ansible.com%2Fapi%2Fv3%2Fplugin%2Fansible%2Fcontent%2Fpublished%2Fcollections%2Findex%2Fnofusscomputing%2Fphpipam_scan_agent%2F&query=%24.download_count&style=plastic&logo=ansible&logoColor=white&label=Galaxy%20Downloads&labelColor=black&color=cyan)](https://galaxy.ansible.com/ui/repo/published/nofusscomputing/phpipam_scan_agent/)
[![Docker Pulls](https://img.shields.io/docker/pulls/nofusscomputing/phpipam-scan-agent?style=plastic&logo=docker&logoColor=0db7ed&color=0db7ed)](https://hub.docker.com/r/nofusscomputing/phpipam-scan-agent)
---- ----
<br> <br>
@ -28,20 +32,6 @@ This project is hosted on [gitlab](https://gitlab.com/nofusscomputing/projects/a
![Gitlab build status - development](https://img.shields.io/badge/dynamic/json?color=ff782e&label=Build&query=0.status&url=https%3A%2F%2Fgitlab.com%2Fapi%2Fv4%2Fprojects%2F55052132%2Fpipelines%3Fref%3Ddevelopment&logo=gitlab&style=plastic) ![branch release version](https://img.shields.io/badge/dynamic/yaml?color=ff782e&logo=gitlab&style=plastic&label=Release&query=%24.commitizen.version&url=https%3A//gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent%2F-%2Fraw%2Fdevelopment%2F.cz.yaml) ![Gitlab build status - development](https://img.shields.io/badge/dynamic/json?color=ff782e&label=Build&query=0.status&url=https%3A%2F%2Fgitlab.com%2Fapi%2Fv4%2Fprojects%2F55052132%2Fpipelines%3Fref%3Ddevelopment&logo=gitlab&style=plastic) ![branch release version](https://img.shields.io/badge/dynamic/yaml?color=ff782e&logo=gitlab&style=plastic&label=Release&query=%24.commitizen.version&url=https%3A//gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent%2F-%2Fraw%2Fdevelopment%2F.cz.yaml)
----
**Ansible Galaxy**
[![Latest Version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgalaxy.ansible.com%2Fapi%2Fv3%2Fplugin%2Fansible%2Fcontent%2Fpublished%2Fcollections%2Findex%2Fnofusscomputing%2Fphp_scan_agent%2F&query=%24.highest_version.version&style=plastic&logo=ansible&logoColor=white&label=Latest%20Release&labelColor=black&color=cyan)](https://galaxy.ansible.com/ui/repo/published/nofusscomputing/ci_test_collection/)
![Downloads](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgalaxy.ansible.com%2Fapi%2Fv3%2Fplugin%2Fansible%2Fcontent%2Fpublished%2Fcollections%2Findex%2Fnofusscomputing%2Fphp_scan_agent%2F&query=%24.download_count&style=plastic&logo=ansible&logoColor=white&label=Downloads&labelColor=black&color=cyan)
----
**Docker Hub**
[![Docker Image Version](https://img.shields.io/docker/v/nofusscomputing/phpipam-scan-agent?sort=semver&style=plastic&logo=docker&logoColor=0db7ed&color=0db7ed&label=Latest%20Release)](https://hub.docker.com/r/nofusscomputing/phpipam-scan-agent)
[![Docker Pulls](https://img.shields.io/docker/pulls/nofusscomputing/phpipam-scan-agent?style=plastic&logo=docker&logoColor=0db7ed&color=0db7ed)](https://hub.docker.com/r/nofusscomputing/phpipam-scan-agent)
</span> </span>
---- ----

6
dockerfile
View File

@ -94,7 +94,7 @@ RUN mkdir -p /tmp/collection; \
if [ "$COLLECTION_PACKAGE" != "dev" ]; then \ if [ "$COLLECTION_PACKAGE" != "dev" ]; then \
echo "specified"; \ echo "specified"; \
ansible-galaxy collection install --force-with-deps --pre \ ansible-galaxy collection install --force-with-deps --pre \
$COLLECTION; \ $COLLECTION_PACKAGE; \
elif [ "$COLLECTION_PACKAGE" == "dev" ]; then \ elif [ "$COLLECTION_PACKAGE" == "dev" ]; then \
git clone \ git clone \
--depth=1 \ --depth=1 \
@ -106,7 +106,9 @@ RUN mkdir -p /tmp/collection; \
/tmp/collection/.; \ /tmp/collection/.; \
rm -Rf /tmp/collection; \ rm -Rf /tmp/collection; \
fi; \ fi; \
chmod +x /etc/cron.d/*; chmod +x /etc/cron.d/*; \
chown root:root -R /etc/phpipam; \
chmod 740 -R /etc/phpipam;
WORKDIR /root WORKDIR /root

17
docs/projects/ansible/collection/phpipam_scan_agent/docker.md
View File

@ -19,16 +19,11 @@ Launching the docker container can be done with
docker run \ docker run \
-d \ -d \
-e "API_URL=<your value here>" \
-e "MYSQL_HOST=<your value here>" \
-e "MYSQL_USER=<your value here>" \
-e "MYSQL_PASSWORD=<your value here>" \
-e "SCANNER_TOKEN=<your value here>" \
-e "SCANNER_NAME=<your value here>" \
-e "SCANNER_CODE=<your value here>" \
-p "5000:5000" \ -p "5000:5000" \
-v "./scan_agent.yaml:/etc/phpipam/scan_agent.yaml" \
-v "./scan_server.yaml:/etc/phpipam/scan_server.yaml" \
--name scan-agent \ --name scan-agent \
scan-agent:latest; nofusscomputing/phpipam-scan-agent:latest;
``` ```
@ -44,7 +39,11 @@ During the build of the container environmental variable `ANSIBLE_FORCE_COLOR='t
### Volumes ### Volumes
There are no volumes for this container. You will need to configure the scan components:
- scanner config file at path `/etc/phpipam/scan_agent.yaml`, see [scanner docs](scanner.md#variables) for details.
- server config at path `/etc/phpipam/scan_server.yaml`, see [server docs](server.md#variables) for details.
If you wish to customize the cronjob for the scan component within the container, mount a new cron file to path `/etc/cron.d/scanner`. The default cron file is as follows: If you wish to customize the cronjob for the scan component within the container, mount a new cron file to path `/etc/cron.d/scanner`. The default cron file is as follows:

24
docs/projects/ansible/collection/phpipam_scan_agent/index.md
View File

@ -6,14 +6,16 @@ template: project.html
about: https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent about: https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent
--- ---
<span align="center"> <span style="text-align: center;">
![Project Status - Active](https://img.shields.io/badge/Project%20Status-Active-green?logo=gitlab&style=plastic) ![Project Status - Active](https://img.shields.io/badge/Project%20Status-Active-green?logo=gitlab&style=plastic)
[![Latest Version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgalaxy.ansible.com%2Fapi%2Fv3%2Fplugin%2Fansible%2Fcontent%2Fpublished%2Fcollections%2Findex%2Fnofusscomputing%2Fphp_scan_agent%2F&query=%24.highest_version.version&style=plastic&logo=ansible&logoColor=white&label=Latest%20Release&labelColor=black&color=cyan)](https://galaxy.ansible.com/ui/repo/published/nofusscomputing/ci_test_collection/)
![Downloads](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgalaxy.ansible.com%2Fapi%2Fv3%2Fplugin%2Fansible%2Fcontent%2Fpublished%2Fcollections%2Findex%2Fnofusscomputing%2Fphp_scan_agent%2F&query=%24.download_count&style=plastic&logo=ansible&logoColor=white&label=Downloads&labelColor=black&color=cyan)
[![Docker Image Version](https://img.shields.io/docker/v/nofusscomputing/phpipam-scan-agent?sort=semver&style=plastic&logo=docker&logoColor=0db7ed&color=0db7ed&label=Latest%20Release)](https://hub.docker.com/r/nofusscomputing/phpipam-scan-agent) ![branch release version](https://img.shields.io/badge/dynamic/yaml?color=ff782e&logo=gitlab&style=plastic&label=Stable%20Release&query=%24.commitizen.version&url=https%3A//gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent%2F-%2Fraw%2Fmaster%2F.cz.yaml)
![branch release version](https://img.shields.io/badge/dynamic/yaml?color=ff782e&logo=gitlab&style=plastic&label=Dev%20Release&query=%24.commitizen.version&url=https%3A//gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent%2F-%2Fraw%2Fdevelopment%2F.cz.yaml)
[![Downloads](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgalaxy.ansible.com%2Fapi%2Fv3%2Fplugin%2Fansible%2Fcontent%2Fpublished%2Fcollections%2Findex%2Fnofusscomputing%2Fphpipam_scan_agent%2F&query=%24.download_count&style=plastic&logo=ansible&logoColor=white&label=Galaxy%20Downloads&labelColor=black&color=cyan)](https://galaxy.ansible.com/ui/repo/published/nofusscomputing/phpipam_scan_agent/)
[![Docker Pulls](https://img.shields.io/docker/pulls/nofusscomputing/phpipam-scan-agent?style=plastic&logo=docker&logoColor=0db7ed&color=0db7ed)](https://hub.docker.com/r/nofusscomputing/phpipam-scan-agent) [![Docker Pulls](https://img.shields.io/docker/pulls/nofusscomputing/phpipam-scan-agent?style=plastic&logo=docker&logoColor=0db7ed&color=0db7ed)](https://hub.docker.com/r/nofusscomputing/phpipam-scan-agent)
@ -68,6 +70,11 @@ When this setting is enabled, the scanner will scan the entire subnet that has b
the work in [Hosts check](https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent/-/issues/3), will adjust this behaviour to only add hosts that dont exist. the work in [Hosts check](https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent/-/issues/3), will adjust this behaviour to only add hosts that dont exist.
- Location `Subnet -> Discover new hosts [Last discovery time]`
This is displayed within the subnet interface next to the `Discover new hosts` field. Whenever a scan report is received by the server this filed is updated to reflect the last scan time.
## Development Notes ## Development Notes
Contributions to this project are welcome. Below you will find some useful commands for use during development. Contributions to this project are welcome. Below you will find some useful commands for use during development.
@ -80,13 +87,8 @@ docker build . --tag scan-agent:dev --build-arg COLLECTION_BRANCH=<your feature
# Launch your build container # Launch your build container
docker run \ docker run \
-d \ -d \
-e "API_URL=<your value here>" \ -v "./scan_agent.yaml:/etc/phpipam/scan_agent.yaml" \
-e "MYSQL_HOST=<your value here>" \ -v "./scan_server.yaml:/etc/phpipam/scan_server.yaml" \
-e "MYSQL_USER=<your value here>" \
-e "MYSQL_PASSWORD=<your value here>" \
-e "SCANNER_TOKEN=<your value here>" \
-e "SCANNER_NAME=<your value here>" \
-e "SCANNER_CODE=<your value here>" \
-e "ANSIBLE_LOG_PATH=/var/log/ansible.log" \ -e "ANSIBLE_LOG_PATH=/var/log/ansible.log" \
-p "5000:5000" \ -p "5000:5000" \
--name scan-agent \ --name scan-agent \

32
docs/projects/ansible/collection/phpipam_scan_agent/scanner.md
View File

@ -11,15 +11,11 @@ The Scan Agent Scanner component is intended to scan networks that are assigned
## Usage ## Usage
After installing the collection, running the agent is as simple as running the following command: After installing the collection and configuring. Running the agent is as simple as running the following command:
``` bash ``` bash
ansible-playbook nofusscomputing.phpipam_scan_agent.agent \ ansible-playbook nofusscomputing.phpipam_scan_agent.agent
--extra-vars "api_url=<your value here>" \
--extra-vars "client_token=<your value here>" \
--extra-vars "client_name=<your value here>" \
--extra-vars "scanagent_code=<your value here>"
``` ```
@ -33,24 +29,24 @@ The scanner component requires API access to phpIPAM. THe API user that is used,
### Variables ### Variables
The variables described below, if optional the value specified here is the default value. Any variable that can be set via environmental variables have the variable name enclosed in `[]` Variables for the scanner are set in a variables file at path `/etc/phpipam/scan_agent.yaml`. The variables described below, if optional the value specified here is the default value.
``` yaml ``` yaml
nofusscomputing_phpipam_scan_agent:
client_token: "" # Mandatory, String client api token to connect to phpIPAM API [SCANNER_TOKEN] api_url: # Mandatory, String. url with protocol of the phpIPAM API to connect to.
client_name: "" # Mandatory, String. The scanner name as set in phpIPAM interface [SCANNER_NAME]
scanagent_code: "" # Mandatory, String. Scan Agent Code as set in phpIPAM interface [SCANNER_CODE]
http_port: 5000 # Optional, Integer. http port to connect to the server.
http_server: http://127.0.0.1 # Optional, Integer. url with protocol of the Scan Server to connect to.
nfc_c_http_port: 5000 # Optional, Integer. http port to connect to the server. [HTTP_PORT] cache_expire_time: 1800 # Optional, Integer. Time in seconds to expire the phpIPAM cache.
nfc_c_http_server: http://127.0.0.1 # Optional, Integer. url with protocol of the Scan Server to connect to. [HTTP_URL] epoch_time_offset: 0 # optional, int. Value in seconds to offset the time
# phpIPAM Scan Agent Settings
client_token: # Mandatory, String client api token to connect to phpIPAM API [client_token]
client_name: # Mandatory, String. The scanner name as set in phpIPAM interface [client_name]
scanagent_code: # Mandatory, String. Scan Agent Code as set in phpIPAM interface [scanagent_code]
api_url: http://127.0.0.1 # Optional, String. url with protocol of the phpIPAM API to connect to. [API_URL]
nfc_c_cache_expire_time: 1800 # Optional, Integer. Time in seconds to expire the phpIPAM cache.
nfc_c_epoch_time_offset: 0 # optional, int. Value in seconds to offset the time
``` ```
@ -63,13 +59,11 @@ nfc_c_epoch_time_offset: 0 # optional, int. Value in seconds to offs
These images are of the phpIPAM interface that show in green text the variable name that would be set as detailed above. These images are of the phpIPAM interface that show in green text the variable name that would be set as detailed above.
![phpIPAM API](images/phpipam_api.png) ![phpIPAM API](images/phpipam_api.png)
phpIPAM API Settings phpIPAM API Settings
---- ----
![phpIPAM Scan Agent](images/phpipam_scan_agent_details.png) ![phpIPAM Scan Agent](images/phpipam_scan_agent_details.png)
phpIPAM Scan Agent Settings phpIPAM Scan Agent Settings

22
docs/projects/ansible/collection/phpipam_scan_agent/server.md
View File

@ -22,24 +22,26 @@ ansible-rulebook -r nofusscomputing.phpipam_scan_agent.agent_receive
### Variables ### Variables
The variables described below, if optional the value specified here is the default value. All variables that are used by the server component are environmental variables that must be set before execution. The variables described below, if optional the value specified here is the default value. The variables are to be set in a variables file at path `/etc/phpipam/scan_server.yaml`
``` bash ``` yaml
# phpIPAM MariaDB/MySQL Variables nofusscomputing_phpipam_scan_server:
MYSQL_HOST= # Mandatory, String. IP/DNS of host to connect.
MYSQL_PORT=3306 # Optional, Integer. port to use for connection. # phpIPAM MariaDB/MySQL Variables
MYSQL_USER= # Mandatory, String. User to authenticate with. mysql_host: # Mandatory, String. IP/DNS of host to connect. [nfc_c_]
MYSQL_PASSWORD= # Mandatory, String. Password for the user to connect with. mysql_port: 3306 # Optional, Integer. port to use for connection. [nfc_c_]
mysql_user: # Mandatory, String. User to authenticate with. [nfc_c_]
mysql_password: # Mandatory, String. Password for the user to connect with. [nfc_c_]
# Server Component Variables # Server Component Variables
HTTP_PORT=5000 # Optional, Integer. The port for the Server component to listen for connections. http_port: 5000 # Optional, Integer. The port for the Server component to listen for connections.
``` ```
# Workflow ## Workflow
The Server componet has the following workflow: The Server componet has the following workflow:

3
extensions/eda/rulebooks/agent_receive.yml
View File

@ -1,12 +1,11 @@
- name: Agent Webhook - name: Agent Webhook
hosts: all hosts: all
execution_strategy: parallel
sources: sources:
- name: Webhook - name: Webhook
ansible.eda.webhook: ansible.eda.webhook:
host: 0.0.0.0 host: 0.0.0.0
port: "{{ HTTP_PORT }}" port: "{{ nofusscomputing_phpipam_scan_server.http_port | default(5000) | int }}"
rules: rules:

2
galaxy.yml
View File

@ -8,7 +8,7 @@ namespace: nofusscomputing
name: phpipam_scan_agent name: phpipam_scan_agent
# The version of the collection. Must be compatible with semantic versioning # The version of the collection. Must be compatible with semantic versioning
version: 0.1.1 version: 0.2.0-a2
# The path to the Markdown (.md) readme file. This path is relative to the root of the collection # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
readme: README.md readme: README.md

2
gitlab-ci

Submodule gitlab-ci updated: d29064f149...34c81c9849

18
includes/etc/phpipam/scan_agent.yaml Normal file
View File

@ -0,0 +1,18 @@
---
nofusscomputing_phpipam_scan_agent:
# api_url: http://127.0.0.1 # Mandatory, String. url with protocol of the phpIPAM API to connect to.
# http_port: 5000 # Optional, Integer. http port to connect to the server.
# http_server: http://127.0.0.1 # Optional, Integer. url with protocol of the Scan Server to connect to.
# cache_expire_time: 1800 # Optional, Integer. Time in seconds to expire the phpIPAM cache.
# epoch_time_offset: 0 # optional, int. Value in seconds to offset the time
# phpIPAM Scan Agent Settings
client_token: # Mandatory, String client api token to connect to phpIPAM API [client_token]
client_name: # Mandatory, String. The scanner name as set in phpIPAM interface [client_name]
scanagent_code: # Mandatory, String. Scan Agent Code as set in phpIPAM interface [scanagent_code]

13
includes/etc/phpipam/scan_server.yaml Normal file
View File

@ -0,0 +1,13 @@
---
nofusscomputing_phpipam_scan_server:
# phpIPAM MariaDB/MySQL Variables
# mysql_host: # Mandatory, String. IP/DNS of host to connect. [nfc_c_]
# mysql_port: 3306 # Optional, Integer. port to use for connection. [nfc_c_]
# mysql_user: # Mandatory, String. User to authenticate with. [nfc_c_]
# mysql_password: # Mandatory, String. Password for the user to connect with. [nfc_c_]
# Server Component Variables
# http_port: 5000 # Optional, Integer. The port for the Server component to listen for connections.

2
includes/etc/supervisor/conf.d/rulebook.conf
View File

@ -1,7 +1,7 @@
[program:rulebook] [program:rulebook]
startsecs=0 startsecs=0
stopwaitsecs=55 stopwaitsecs=55
command=ansible-rulebook -r nofusscomputing.phpipam_scan_agent.agent_receive --env-vars "HTTP_PORT" -i /root/hosts.yaml -v command=ansible-rulebook -r nofusscomputing.phpipam_scan_agent.agent_receive --vars /etc/phpipam/scan_server.yaml -i /root/hosts.yaml -v
autorestart=true autorestart=true
autostart=true autostart=true
stdout_logfile=/dev/fd/1 stdout_logfile=/dev/fd/1

58
playbooks/agent.yaml
View File

@ -5,64 +5,48 @@
tasks: tasks:
- name: Check for Existance of config file
ansible.builtin.stat:
path: /etc/phpipam/scan_agent.yaml
register: config_file_check
- name: Fetch Required Environmental Variables
ansible.builtin.set_fact: - name: Load Config File
client_token: "{{ lookup('ansible.builtin.env', 'SCANNER_TOKEN') | default('') }}" ansible.builtin.include_vars:
client_name: "{{ lookup('ansible.builtin.env', 'SCANNER_NAME') }}" file: /etc/phpipam/scan_agent.yaml
scanagent_code: "{{ lookup('ansible.builtin.env', 'SCANNER_CODE') | default('') }}"
api_url: "{{ lookup('ansible.builtin.env', 'API_URL') | default('') }}"
no_log: true
when: > when: >
client_token is not defined config_file_check.stat.exists
and
client_name is not defined
and
scanagent_code is not defined
and
api_url is not defined
- name: Fetch Required Environmental Variable - HTTP_URL
ansible.builtin.set_fact:
nfc_c_http_server: "{{ lookup('ansible.builtin.env', 'HTTP_URL') | default('') }}"
when: >
lookup('ansible.builtin.env', 'HTTP_URL') | default('') != ''
- name: Fetch Required Environmental Variable - HTTP_PORT
ansible.builtin.set_fact:
nfc_c_http_port: "{{ lookup('ansible.builtin.env', 'HTTP_PORT') | default('') }}"
when: >
lookup('ansible.builtin.env', 'HTTP_PORT') | default('') != ''
- name: Confirm 'api_url' is Set - name: Confirm 'api_url' is Set
ansible.builtin.assert: ansible.builtin.assert:
that: that:
- api_url is defined - nofusscomputing_phpipam_scan_agent.api_url is defined
- api_url != '' - nofusscomputing_phpipam_scan_agent.api_url != ''
msg: "missing Required Variables" msg: "missing Required Variables"
- name: Confirm 'client_token' is Set - name: Confirm 'client_token' is Set
ansible.builtin.assert: ansible.builtin.assert:
that: that:
- client_token is defined - nofusscomputing_phpipam_scan_agent.client_token is defined
- nofusscomputing_phpipam_scan_agent.client_token != ''
msg: "missing Required Variables" msg: "missing Required Variables"
- name: Confirm 'client_name' is Set - name: Confirm 'client_name' is Set
ansible.builtin.assert: ansible.builtin.assert:
that: that:
- client_name is defined - nofusscomputing_phpipam_scan_agent.client_name is defined
- nofusscomputing_phpipam_scan_agent.client_name != ''
msg: "missing Required Variables" msg: "missing Required Variables"
- name: Confirm 'scanagent_code' is Set - name: Confirm 'scanagent_code' is Set
ansible.builtin.assert: ansible.builtin.assert:
that: that:
- scanagent_code is defined - nofusscomputing_phpipam_scan_agent.scanagent_code is defined
- nofusscomputing_phpipam_scan_agent.scanagent_code != ''
msg: "missing Required Variables" msg: "missing Required Variables"
@ -84,17 +68,17 @@
- name: Scan Subnet - name: Scan Subnet
ansible.builtin.include_tasks: ansible.builtin.include_tasks:
file: tasks/scan_subnet.yaml file: tasks/scan_subnet.yaml
loop: "{{ nfc_c_scan_agent_subnets }}" loop: "{{ nfc_c_scan_agent_subnets | default([]) }}"
loop_control: loop_control:
loop_var: subnet loop_var: subnet
vars: # ToDo: remove the below t4est vars vars:
nfc_c_cache_expire_time: 1800
nfc_c_http_port: 5000 nfc_c_http_port: 5000
nfc_c_http_server: http://127.0.0.1 nfc_c_http_server: http://127.0.0.1
nfc_c_path_cache: "{{ playbook_dir }}/../cache"
api_address: addresses api_address: addresses
api_subnets: subnets api_subnets: subnets
api_scanagents: tools/scanagents api_scanagents: tools/scanagents
nfc_c_path_cache: "{{ playbook_dir }}/../cache"
nfc_c_cache_expire_time: 1800

37
playbooks/server.yaml
View File

@ -7,26 +7,29 @@
tasks: tasks:
- name: Fetch Required Environmental Variables
ansible.builtin.set_fact:
nfc_c_mysql_host: "{{ lookup('ansible.builtin.env', 'MYSQL_HOST') | default('') }}"
nfc_c_mysql_port: "{{ lookup('ansible.builtin.env', 'MYSQL_PORT') | default(3306) | int }}"
nfc_c_mysql_user: "{{ lookup('ansible.builtin.env', 'MYSQL_USER') | default('') }}"
nfc_c_mysql_password: "{{ lookup('ansible.builtin.env', 'MYSQL_PASSWORD') | default('') }}"
no_log: true
- name: TRACE Inbound data Received - name: TRACE Inbound data Received
ansible.builtin.debug: ansible.builtin.debug:
msg: "{{ inbound_data }}" msg: "{{ inbound_data }}"
- name: Check for Existance of config file
ansible.builtin.stat:
path: /etc/phpipam/scan_server.yaml
register: config_file_check
- name: Load Config File
ansible.builtin.include_vars:
file: /etc/phpipam/scan_server.yaml
when: >
config_file_check.stat.exists
- name: Fetch Agent Details - name: Fetch Agent Details
community.mysql.mysql_query: community.mysql.mysql_query:
login_host: "{{ nfc_c_mysql_host }}" login_host: "{{ nofusscomputing_phpipam_scan_server.mysql_host }}"
login_port: "{{ nfc_c_mysql_port | default(3306) | int }}" login_port: "{{ nofusscomputing_phpipam_scan_server.mysql_port | default(3306) | int }}"
login_user: "{{ nfc_c_mysql_user }}" login_user: "{{ nofusscomputing_phpipam_scan_server.mysql_user }}"
login_password: "{{ nfc_c_mysql_password }}" login_password: "{{ nofusscomputing_phpipam_scan_server.mysql_password }}"
login_db: 'phpipam' login_db: 'phpipam'
query: > query: >
@ -37,10 +40,10 @@
- name: Confirm Subnet Assignment - name: Confirm Subnet Assignment
community.mysql.mysql_query: community.mysql.mysql_query:
login_host: "{{ nfc_c_mysql_host }}" login_host: "{{ nofusscomputing_phpipam_scan_server.mysql_host }}"
login_port: "{{ nfc_c_mysql_port | default(3306) | int }}" login_port: "{{ nofusscomputing_phpipam_scan_server.mysql_port | default(3306) | int }}"
login_user: "{{ nfc_c_mysql_user }}" login_user: "{{ nofusscomputing_phpipam_scan_server.mysql_user }}"
login_password: "{{ nfc_c_mysql_password }}" login_password: "{{ nofusscomputing_phpipam_scan_server.mysql_password }}"
login_db: 'phpipam' login_db: 'phpipam'
query: > query: >

6
playbooks/tasks/agent_id.yaml
View File

@ -4,10 +4,10 @@
ansible.builtin.include_tasks: ansible.builtin.include_tasks:
file: tasks/api_call.yaml file: tasks/api_call.yaml
vars: vars:
api_client_name: "{{ client_name }}" api_client_name: "{{ nofusscomputing_phpipam_scan_agent.client_name }}"
api_token: "{{ client_token }}" api_token: "{{ nofusscomputing_phpipam_scan_agent.client_token }}"
api_path: "{{ api_scanagents }}" api_path: "{{ api_scanagents }}"
api_query_string: "filter_by=code&filter_value={{ scanagent_code }}" api_query_string: "filter_by=code&filter_value={{ nofusscomputing_phpipam_scan_agent.scanagent_code }}"
- name: My ScanAgent ID - name: My ScanAgent ID

48
playbooks/tasks/api_call.yaml
View File

@ -3,15 +3,6 @@
block: block:
- name: Mandatory Variables set
ansible.builtin.assert:
that:
- api_client_name is defined
- api_path is defined
- api_token is defined
- api_url is defined
- name: API Facts - name: API Facts
ansible.builtin.set_fact: ansible.builtin.set_fact:
epoch: "{{ ((('%Y-%m-%d %H:%M:%S' | strftime) | string | to_datetime) - ('1970-01-01 00:00:00' | to_datetime)).total_seconds() | int }}" epoch: "{{ ((('%Y-%m-%d %H:%M:%S' | strftime) | string | to_datetime) - ('1970-01-01 00:00:00' | to_datetime)).total_seconds() | int }}"
@ -26,34 +17,36 @@
- name: check Cache Files - name: check Cache Files
ansible.builtin.stat: ansible.builtin.stat:
path: "{{ cache_filepath }}" path: "{{ cache_filepath }}"
register: cache_files register: cached_file
- name: Expire - name: Expire
ansible.builtin.set_fact: ansible.builtin.set_fact:
expired: "{{ ((epoch | int + (nfc_c_epoch_time_offset | default(0)) | int) >= ((cache_files.stat.mtime | int) + nfc_c_cache_expire_time | int) | int ) | bool }}" expired: "{{ ((epoch | int + (nfc_c_epoch_time_offset | default(0)) | int) >= ((cached_file.stat.mtime | int) +
when: cache_files.stat.exists (nofusscomputing_phpipam_scan_agent.cache_expire_time | default(nfc_c_cache_expire_time)) | int) | int ) | bool }}"
when: cached_file.stat.exists
- name: TRACE - Cached file - name: TRACE - Cached file
ansible.builtin.debug: ansible.builtin.debug:
msg: msg:
- "exists: {{ cache_files.stat.exists | default('') }}" - "exists: {{ cached_file.stat.exists | default('') }}"
- "mtime: {{ cache_files.stat.mtime | default(0) | int }}" - "mtime: {{ cached_file.stat.mtime | default(0) | int }}"
- "expire: {{ (cache_files.stat.mtime | int) + nfc_c_cache_expire_time | int }}" - "expire: {{ (cached_file.stat.mtime | int) + (nofusscomputing_phpipam_scan_agent.cache_expire_time | default(nfc_c_cache_expire_time)) | int }}"
- "epoch: {{ (epoch | int + (nfc_c_epoch_time_offset | default(0)) | int) | int }} [{{ nfc_c_cache_expire_time }}]" - "epoch: {{ (epoch | int + (nfc_c_epoch_time_offset | default(0)) | int) | int }} [{{
(nofusscomputing_phpipam_scan_agent.cache_expire_time | default(nfc_c_cache_expire_time)) }}]"
- "epoch: {{ epoch }}" - "epoch: {{ epoch }}"
- "expired: {{ expired }}" - "expired: {{ expired }}"
when: cache_files.stat.exists when: cached_file.stat.exists
- name: Expire Cache - name: Expire Cache
ansible.builtin.file: ansible.builtin.file:
path: "{{ cache_files.stat.path }}" path: "{{ cached_file.stat.path }}"
state: absent state: absent
when: > when: >
expired expired
and and
cache_files.stat.exists cached_file.stat.exists
- name: > - name: >
@ -62,7 +55,7 @@
{%- endif %} {%- endif %}
ansible.builtin.uri: ansible.builtin.uri:
url: >- url: >-
{{ api_url }}/api/{{ api_client_name }}/{{ api_path }} {{ nofusscomputing_phpipam_scan_agent.api_url }}/api/{{ api_client_name }}/{{ api_path }}
{%- if api_query_string is defined -%} {%- if api_query_string is defined -%}
/?{{ api_query_string }} /?{{ api_query_string }}
{%- endif %} {%- endif %}
@ -73,17 +66,17 @@
- 200 - 200
- 404 - 404
validate_certs: false validate_certs: false
changed_when: api_call.json | length | int > 0 changed_when: api_call.json | default([]) | length | int > 0
no_log: true no_log: true
register: api_call register: api_call
when: > when: >
( (
expired expired
and and
cache_files.stat.exists cached_file.stat.exists
) )
or or
not cache_files.stat.exists not cached_file.stat.exists
- name: Create Cache DIR - name: Create Cache DIR
@ -104,9 +97,14 @@
( (
expired expired
and and
cache_files.stat.exists cached_file.stat.exists
) )
or or
not cache_files.stat.exists not cached_file.stat.exists
and and
api_call.status | default(0) | int != 404 api_call.status | default(0) | int != 404
- name: check Cache Files
ansible.builtin.stat:
path: "{{ cache_filepath }}"
register: cached_file

29
playbooks/tasks/scan_subnet.yaml
View File

@ -1,21 +1,23 @@
--- ---
- name: Scan subnet - name: Scan subnet - {{ subnet.address }}
ansible.builtin.command: ansible.builtin.command:
cmd: nmap -sn "{{ subnet.address }}" -oX - cmd: nmap -sn "{{ subnet.address }}" -oX -
become: true become: true
register: nmap_scan register: nmap_scan
- name: Get subnets Address' - name: Get subnets Address'
ansible.builtin.include_tasks: ansible.builtin.include_tasks:
file: tasks/api_call.yaml file: tasks/api_call.yaml
vars: vars:
api_client_name: "{{ client_name }}" api_client_name: "{{ nofusscomputing_phpipam_scan_agent.client_name }}"
api_token: "{{ client_token }}" api_token: "{{ nofusscomputing_phpipam_scan_agent.client_token }}"
api_path: "{{ api_address }}" api_path: "{{ api_address }}"
api_query_string: "filter_by=subnetId&filter_value={{ subnet.id }}" api_query_string: "filter_by=subnetId&filter_value={{ subnet.id }}"
- name: Load Subnet - name: Load Subnet - {{ subnet.address }}
ansible.builtin.set_fact: ansible.builtin.set_fact:
cached_subnet: "{{ lookup('file', cache_filepath) }}" cached_subnet: "{{ lookup('file', cache_filepath) }}"
cacheable: false cacheable: false
@ -24,7 +26,7 @@
api_call.status | default(0) | int != 404 api_call.status | default(0) | int != 404
- name: Process Scan Results - name: Process Scan Results - {{ subnet.address }}
ansible.builtin.set_fact: ansible.builtin.set_fact:
subnet_scan_results: |- subnet_scan_results: |-
[ [
@ -43,6 +45,13 @@
"subnetId": "{{ subnet.id }}", "subnetId": "{{ subnet.id }}",
"ip": "{{ scanned_host.address['@addr'] | default(scanned_host.address[0]['@addr']) }}", "ip": "{{ scanned_host.address['@addr'] | default(scanned_host.address[0]['@addr']) }}",
"lastSeen": "{{ nmap_scan.start }}", "lastSeen": "{{ nmap_scan.start }}",
{% if scanned_host.hostnames.hostname is defined %}
{% if '.' in scanned_host.hostnames.hostname['@name'] | string %}
"hostname": "{{ (scanned_host.hostnames.hostname['@name'] | split('.'))[0] }}",
{% else %}
"hostname": "{{ scanned_host.hostnames.hostname['@name'] }}",
{% endif %}
{% endif %}
{% if scanned_host.address['@addrtype'] | default(scanned_host.address[1]['@addrtype']) == 'mac' %} {% if scanned_host.address['@addrtype'] | default(scanned_host.address[1]['@addrtype']) == 'mac' %}
"mac": "{{ scanned_host.address['@addr'] | default(scanned_host.address[1]['@addr']) | upper }}" "mac": "{{ scanned_host.address['@addr'] | default(scanned_host.address[1]['@addr']) | upper }}"
{% endif %} {% endif %}
@ -51,18 +60,20 @@
{% endfor %} {% endfor %}
] ]
- name: To JSON - name: To JSON - {{ subnet.address }}
ansible.builtin.set_fact: ansible.builtin.set_fact:
subnet_scan_results: "{{ subnet_scan_results | from_yaml }}" subnet_scan_results: "{{ subnet_scan_results | from_yaml }}"
- name: Upload Scan Results - name: Upload Scan Results - {{ subnet.address }}
ansible.builtin.uri: ansible.builtin.uri:
url: "{{ nfc_c_http_server }}:{{ nfc_c_http_port }}/" url: "{{
nofusscomputing_phpipam_scan_agent.http_server | default(nfc_c_http_server)
}}:{{ nofusscomputing_phpipam_scan_agent.http_port | default(nfc_c_http_port) }}/"
method: POST method: POST
body_format: json body_format: json
body: { body: {
"code": "{{ scanagent_code }}", "code": "{{ nofusscomputing_phpipam_scan_agent.scanagent_code }}",
"scan": { "scan": {
"subnet": "{{ subnet.address }}", "subnet": "{{ subnet.address }}",
"results": "{{ subnet_scan_results }}" "results": "{{ subnet_scan_results }}"

23
playbooks/tasks/server/ipaddress.yaml
View File

@ -1,12 +1,12 @@
--- ---
- name: Update IP Address' found - name: "Update IP Address' found - {{ scan_address.ipaddress.ip }}"
community.mysql.mysql_query: community.mysql.mysql_query:
login_host: "{{ nfc_c_mysql_host }}" login_host: "{{ nofusscomputing_phpipam_scan_server.mysql_host }}"
login_port: "{{ nfc_c_mysql_port | default(3306) | int }}" login_port: "{{ nofusscomputing_phpipam_scan_server.mysql_port | default(3306) | int }}"
login_user: "{{ nfc_c_mysql_user }}" login_user: "{{ nofusscomputing_phpipam_scan_server.mysql_user }}"
login_password: "{{ nfc_c_mysql_password }}" login_password: "{{ nofusscomputing_phpipam_scan_server.mysql_password }}"
login_db: 'phpipam' login_db: 'phpipam'
query: |- query: |-
@ -18,6 +18,12 @@
SET SET
lastSeen = '{{ scan_address.ipaddress.lastSeen }}' lastSeen = '{{ scan_address.ipaddress.lastSeen }}'
{% if scan_address.ipaddress.hostname | default('') != '' %},
hostname = '{{ scan_address.ipaddress.hostname }}'
{% endif %}
{% if scan_address.ipaddress.mac | default('') != '' %}, {% if scan_address.ipaddress.mac | default('') != '' %},
mac = '{{ scan_address.ipaddress.mac }}' mac = '{{ scan_address.ipaddress.mac }}'
@ -36,6 +42,7 @@
subnetId, subnetId,
ip_addr, ip_addr,
description, description,
{% if scan_address.ipaddress.hostname | default('') != '' %}hostname,{% endif %}
{% if scan_address.ipaddress.mac | default('') != '' %}mac,{% endif %} {% if scan_address.ipaddress.mac | default('') != '' %}mac,{% endif %}
note, note,
lastSeen lastSeen
@ -46,6 +53,12 @@
'{{ scan_address.ipaddress.ip | ip2ipam }}', '{{ scan_address.ipaddress.ip | ip2ipam }}',
'-- autodiscovered --', '-- autodiscovered --',
{% if scan_address.ipaddress.hostname | default('') != '' %}
'{{ scan_address.ipaddress.hostname }}',
{% endif %}
{% if scan_address.ipaddress.mac | default('') != '' %} {% if scan_address.ipaddress.mac | default('') != '' %}
'{{ scan_address.ipaddress.mac }}', '{{ scan_address.ipaddress.mac }}',

26
playbooks/tasks/server/subnet_scan.yaml
View File

@ -3,10 +3,10 @@
- name: Match Scan Addresses to DB Details - name: Match Scan Addresses to DB Details
community.mysql.mysql_query: community.mysql.mysql_query:
login_host: "{{ nfc_c_mysql_host }}" login_host: "{{ nofusscomputing_phpipam_scan_server.mysql_host }}"
login_port: "{{ nfc_c_mysql_port | default(3306) | int }}" login_port: "{{ nofusscomputing_phpipam_scan_server.mysql_port | default(3306) | int }}"
login_user: "{{ nfc_c_mysql_user }}" login_user: "{{ nofusscomputing_phpipam_scan_server.mysql_user }}"
login_password: "{{ nfc_c_mysql_password }}" login_password: "{{ nofusscomputing_phpipam_scan_server.mysql_password }}"
login_db: 'phpipam' login_db: 'phpipam'
query: |- query: |-
@ -26,6 +26,24 @@
loop_var: ipaddress loop_var: ipaddress
- name: Update Subnet Discovery Time
community.mysql.mysql_query:
login_host: "{{ nofusscomputing_phpipam_scan_server.mysql_host }}"
login_port: "{{ nofusscomputing_phpipam_scan_server.mysql_port | default(3306) | int }}"
login_user: "{{ nofusscomputing_phpipam_scan_server.mysql_user }}"
login_password: "{{ nofusscomputing_phpipam_scan_server.mysql_password }}"
login_db: 'phpipam'
query: |-
UPDATE
subnets
SET
lastDiscovery = '{{ inbound_data.scan.results[0].lastSeen }}'
WHERE
subnet = '{{ (inbound_data.scan.subnet | split('/'))[0] | ip2ipam }}'
single_transaction: true
- name: Update IP Addresses - name: Update IP Addresses
ansible.builtin.include_tasks: ansible.builtin.include_tasks:
file: tasks/server/ipaddress.yaml file: tasks/server/ipaddress.yaml

40
playbooks/tasks/subnets.yaml
View File

@ -9,21 +9,33 @@
ansible.builtin.include_tasks: ansible.builtin.include_tasks:
file: tasks/api_call.yaml file: tasks/api_call.yaml
vars: vars:
api_client_name: "{{ client_name }}" api_client_name: "{{ nofusscomputing_phpipam_scan_agent.client_name }}"
api_token: "{{ client_token }}" api_token: "{{ nofusscomputing_phpipam_scan_agent.client_token }}"
api_path: "{{ api_subnets }}" api_path: "{{ api_subnets }}"
api_query_string: "filter_by=scanAgent&filter_value={{ nfc_c_scan_agent_id }}" api_query_string: "filter_by=scanAgent&filter_value={{ nfc_c_scan_agent_id }}"
- name: Update Subnets List - name: Try/Catch
ansible.builtin.set_fact: block:
nfc_c_scan_agent_subnets: "{{ nfc_c_scan_agent_subnets + [{
'id': network.id,
'address': network.subnet + '/' + network.mask - name: Update Subnets List
}] }}" ansible.builtin.set_fact:
loop: "{{ data | default ([]) }}" nfc_c_scan_agent_subnets: "{{ nfc_c_scan_agent_subnets + [{
loop_control: 'id': network.id,
loop_var: network 'address': network.subnet + '/' + network.mask
vars: }] }}"
data: "{{ lookup('file', cache_filepath) }}" loop: "{{ lookup('file', cache_filepath) | default ([]) }}"
when: network.discoverSubnet | int == 1 loop_control:
loop_var: network
when: >
network.discoverSubnet | int == 1
rescue:
- name: Confirm 'Subnets List' Error is Expected
ansible.builtin.assert:
that:
- not cached_file.stat.exists
success_msg: "OK. Success. The error occured as there is no cache file. This normally means there are no subnets assigned to the agent."
fail_msg: "ERROR. Something went wrong, Cache file exists."