phpIPAM
  • 30 Jun 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

phpIPAM

  • Dark
    Light
  • PDF

Article summary

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
  • Networks

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.

  5. Verify SSL - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.

  6. HTTPS Proxy (optional) - Connect the adapter to a proxy instead of directly connecting it to the domain.

To learn more about 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 - Specify a comma-separated list of CIDRs to be excluded.
  2. CIDR include list - Specify a comma-separated list of CIDRs to be included.
  3. Fetch subnets addresses as devices - 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.


Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
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.