Phpipam icon

Phpipam

Consume Phpipam API (v.0.4.1)
Join our community

Actions7

Overview

This node interacts with the Phpipam API to manage IP address management resources. Specifically, for the 'Subnets' resource with the 'List All Subnets' operation, it retrieves a comprehensive list of all subnets available in the Phpipam system. This is useful for network administrators who need to audit, monitor, or manage subnet allocations across their network infrastructure. For example, it can be used to fetch all subnet details for reporting or integration with other network management tools.

Use Case Examples

  1. Retrieve all subnets from Phpipam to display in a network monitoring dashboard.
  2. Fetch all subnet data to synchronize with an external IP address management system.

Output

JSON

  • ``
    • id - Unique identifier of the subnet
    • description - Description or name of the subnet
    • subnet - Subnet address in CIDR notation
    • mask - Subnet mask
    • sectionId - Identifier of the section the subnet belongs to
    • vrfId - Identifier of the VRF (Virtual Routing and Forwarding) associated with the subnet
    • permissions - Permissions related to the subnet
    • customFields - Custom fields associated with the subnet
    • isFolder - Indicates if the subnet is a folder (container) or an actual subnet
    • isFull - Indicates if the subnet is fully allocated

Dependencies

  • Phpipam API with authentication credentials (URL, app ID, user, password)

Troubleshooting

  • Ensure that the Phpipam API credentials (URL, app ID, user, password) are correctly configured and valid, as authentication failures will prevent data retrieval.
  • If the API returns an error, check the error message for details such as invalid URL or missing permissions.
  • Network connectivity issues to the Phpipam server can cause request timeouts or failures; verify network access and firewall settings.
  • If the node returns empty data, verify that there are subnets configured in the Phpipam system and that the authenticated user has permission to view them.

Links

Discussion