phpIPAM
  • 24 Mar 2022
  • 2 Minutes to read
  • Dark
    Light
  • PDF

phpIPAM

  • Dark
    Light
  • PDF

phpIPAM is an open-source web IP address management application (IPAM).

Types of Assets Fetched

This adapter fetches the following types of assets:

  • Devices
  • Users

Parameters

  1. phpIPAM Host Name (required) - The hostname or IP address of the phpIPAM server.
  2. Application ID (required) - Your application ID.
  3. User Name and Password (required) - The credentials for a user account that has the Required Permissions to fetch assets.
  4. Fetch Users (required, default: False) - Select whether to fetch users' data from the phpIPAM server.
    • If enabled, the connection for this adapter will fetch users data. Each user will be added as a unique user in Axonius.
    • If disabled, the connection for this adapter will not fetch users data.
  5. Verify SSL (required, default: False) - Verify the SSL certificate offered by the value supplied in phpIPAM Host Name. For more details, see SSL Trust & CA Settings.
    • If enabled, the SSL certificate offered by the value supplied in phpIPAM Host Name will be verified against the CA database inside of Axonius. If the SSL certificate can not be validated against the CA database inside of Axonius, the connection will fail with an error.
    • If disabled, the SSL certificate offered by the value supplied in phpIPAM Host Name will not be verified against the CA database inside of Axonius.
  6. HTTPS Proxy (optional, default: empty) - A proxy to use when connecting to the value supplied in phpIPAM Host Name.
    • If supplied, Axonius will utilize the proxy when connecting to the value supplied in phpIPAM Host Name.
    • If not supplied, Axonius will connect directly to the value supplied in phpIPAM Host Name.
  7. For details on the common adapter connection parameters and buttons, see Adding a New Adapter Connection.

image.png

Advanced Settings

Note:

Advanced settings can either apply for all connections for this adapter, or you can set different advanced settings and/or different scheduling for a specific connection, refer to ​Advanced Configuration for Adapters

  1. CIDR exclude list *(required, default: Empty) - Specify a comma-separated list of CIDRs to be excluded.
    * When supplied, all connections for this adapter will not fetch phpIPAM assets from IP addresses in the IP range of the specified CIDRs.
    * When not supplied, all connections for this adapter will fetch phpIPAM assets from IP addresses in any IP range.

  2. CIDR include list *(required, default: Empty) - Specify a comma-separated list of CIDRs to be included.

    • When enabled, all connections for this adapter will only fetch phpIPAM assets from IP addresses in the IP range of the specified CIDRs.
    • When disabled, all connections for this adapter will fetch phpIPAM assets from IP addresses in any IP range.
  3. Fetch subnets as devices *(required, default: False) - Select whether to fetch all the addresses under all the subnets in phpIPAM and create devices from these addresses

    • API used - /api/my_app/subnets/{id}/addresses/
NOTE

To learn more about Adapter Configuration tab advanced settings, see Adapter Advanced Settings.


APIs

Axonius uses the phpIPAM API.

Required Permissions

The value supplied in User Name must have read access to devices.
To read users, the supplied User Name must have rwa permissions.

To gain access to the API:

  1. Login to phpIPAM with a user that has admin permissions.

  2. Go to SettingsphpIPAM settingsFeature settings and enable API.

  3. Go to SettingsAPI and click Create API key to create a new application. The application should have Read permissions.
    image.png

  4. Use the App id in the Application ID field in the adapter connection configuration dialog.


What's Next
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.