Deployment

User Permissions and Connection Requirements

Category	Description
User Permissions	The addon requires the creation of a dedicated user with administrative privileges within phpIPAM environment.
Cloud Proxy to phpIPAM	Ensure a stable connection between the selected Cloud Proxy and the phpIPAM environment using the HTTPS protocol on port 443.
Cloud Proxy to Registry	A reliable connection between the Cloud Proxy and registry.indevops.com is required, accessible via port 443.

Installing addon

Pre-pull adapter's container image

Adapter's container must be pre-pulled on cloud proxy instances.

1. SSH as root to cloud-proxies belonging to the collector group where adapter is to be run.
2. Login to docker registry using docker login registry.indevops.com.
   • Use Harbor robot account designated for that deployment - provided by INDEVOPS.
3. Pull container image using docker pull <IMAGE NAME>.
   • Image name can be found on release page for a given version of the addon.

Install PAK file

1. Download PAK file for version matching the pre-pulled adapter container image.
   • PAK file can be found on release page for a given version of the addon.
2. Login to VMware Aria Operations and go to 'Data Sources > Integrations > Repository > Add' and upload the PAK file, selecting both:
   • Install the PAK file even if it is already installed
   • Ignore the PAK file signature checking
3. Install the addon.

Configure Adapter

1. Go to Administration > Integrations > Repository
   • Use filter on the right to put INDEVOPS
   • Click on brick with phpIPAM
2. Use button ADD ACCOUNT
3. Fill the fields

Adapter fields

Field Name	Definition
Name	A unique identifier or label for the adapter.
Description	A brief description of the adapter's purpose or function.
API Host	Optional. Hostname or IP address of the phpIPAM API endpoint. Leave empty to run the adapter in offline/standalone mode.
App ID	Optional. Identifier of the application, specified in the phpIPAM web UI: Administration -> API. Leave empty to run the adapter in offline/standalone mode.
Excluded IP addresses	Optional. Comma-separated list of single IPs, CIDRs or ranges to ignore when discovered on external resources. Default: 127.0.0.0/8, 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, 169.254.0.0/16, fe80::/10, fc00::/7, ::1/128. See Excluded IP addresses.
Credentials	Authentication details, including username and password. Aria Operations requires a credential entry to be configured even in offline mode, but valid phpIPAM credentials are only needed when API Host and App ID are provided.
Collector / Group	The collector or group managing data collection. Must be set to cloud proxy where the adapter's container image is pre-pulled.
API Port	The port used to connect to the phpIPAM API.
Skip TLS Certificate Validation (Insecure)	Flag to skip TLS/SSL certificate validation. Accepts true or false.
Adapter Memory Limit (MB)	Maximum memory (in MB) the adapter can use.
Log Level	Logging detail level: Debug for detailed logging, Normal for standard logs, Trace for extensive tracing.