docs: add images for scanner vars

!1
This commit is contained in:
2024-02-21 15:44:58 +09:30
parent 565eba3d0d
commit 9ac8cceb93
3 changed files with 20 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 273 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 139 KiB

View File

@ -26,6 +26,11 @@ ansible-playbook nofusscomputing.phpipam_scan_agent.agent \
_See below for the variable details_
### phpIPAM API
The scanner component requires API access to phpIPAM. THe API user that is used, must only be given read only access to the API.
### 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 `[]`
@ -53,6 +58,21 @@ nfc_c_epoch_time_offset: 0 # optional, int. Value in seconds to offs
You can specify environmental variable `ANSIBLE_LOG_PATH=/var/log/ansible.log`, which will tell the scanner component to log to a file at path `/var/log/ansible.log`
#### phpIPAM Interface variable Mapping
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 Settings
----
![phpIPAM Scan Agent](images/phpipam_scan_agent_details.png)
phpIPAM Scan Agent Settings
## Workflow
The scanner component has the following workflow: