Overview

Dashboards

phpIPAM Inventory

The phpIPAM Inventory dashboard provides a centralized view of user network's key components, offering insights into the overall health and status of the phpIPAM environment. It enables network administrators to monitor crucial parameters such as locations, subnets, IP addresses, and alert statuses, helping to identify potential issues quickly. With this dashboard, users can effectively track collection states, availability, and other important metrics, allowing for proactive management and timely decision-making.

phpIPAM Inventory Dashboard

phpIPAM Subnet Utilization

The phpIPAM Subnet Utilization dashboard offers a comprehensive overview of subnet usage, helping administrators identify and manage network resources efficiently. It highlights key metrics related to location states, subnet utilization, and collection status, ensuring that network performance is optimized. By showcasing the top 10 most utilized subnets, this dashboard aids in pinpointing areas of high demand.

phpIPAM Subnet Utilization Dashboard

phpIPAM Owners

The phpIPAM Owners dashboard provides a clear and organized view of the owners within the phpIPAM system, offering valuable insights into IP address management. It helps users track the status and relationships of various objects, such as IP addresses, by displaying their respective statuses and interconnections.

phpIPAM Owners Dashboard

Reports

The reports provided by the 'IP Inventory Management with phpIPAM' Management Pack offer detailed insights into IP address and subnet utilization, as well as the availability of network resources within the phpIPAM environment.

phpIPAM Subnet Utilization

Displays the name of the subnet, the total number of allocated IP addresses, available IP addresses, and the percentage of used IP addresses.

phpIPAM IP Address Availability

Groups IP addresses by phpIPAM subnets and provides details including availability, hostname, description, and owner for each IP address.

Custom Groups

The 'IP Inventory Management with phpIPAM' Management Pack offers custom groups to help organize and manage the various objects within the phpIPAM environment. These groups help administrators manage different network components more effectively within VMware Aria Operations.

Custom Group NameDescription
phpIPAM GlobalContains all objects, such as 'phpIPAM IP Address', 'phpIPAM Location', 'phpIPAM Owner', and 'phpIPAM Subnet'
phpIPAM LocationsContains objects of type 'phpIPAM Location'
phpIPAM SubnetsContains objects of type 'phpIPAM Subnet'
phpIPAM IP AddressesContains objects of type 'phpIPAM IP Address'
phpIPAM OwnersContains objects of type 'phpIPAM Owner'

Object Naming Conventions in phpIPAM and Aria Operations

The object names in phpIPAM and Aria Operations differ. The table below outlines the corresponding object names used in each environment:

phpIPAMAria Operations
IP AddressphpIPAM IP Address
LocationphpIPAM Location
OwnerphpIPAM Owner
SubnetphpIPAM Subnet

Collected objects

Relationships

In the 'IP Inventory Management with phpIPAM' management pack, the relationships between objects play a crucial role in organizing and managing network resources. These relationships illustrate how various objects are interconnected within the phpIPAM environment and how data is collected and structured in VMware Aria Operations.

Relations between collected objects

The relationship diagram depicts a hierarchy that starts with the 'php IPAM Adapter Instance', which acts as the central element responsible for integrating data from the phpIPAM system. From there, the hierarchy flows as follows:

  • 'php IPAM Adapter Instance' connects to 'php IPAM Location', representing the locations of network resources.
  • 'php IPAM Location' connects to 'php IPAM Subnet', which defines the individual subnets associated with each location.
  • 'php IPAM Subnet' connects to 'php IPAM IP Address', providing details about the individual IP addresses within each subnet.

Additionally, a separate branch illustrates the relationship between 'php IPAM Owner' and 'php IPAM IP Address', highlighting the ownership of specific IP addresses within the network.

php IPAM Location

Represents a location where IP addresses or subnets are assigned within the environment.

Data NameTypeDescription
NamePropertyThe name of the phpIPAM location.
DescriptionPropertyA brief description of the phpIPAM location.
AddressPropertyThe physical or logical address associated with the location.
Total subnetsMetricThe total number of subnets defined in the phpIPAM location.

php IPAM Subnet

Represents a subnet in the environment, which can contain multiple IP addresses and their relevant attributes

Data NameTypeDescription
SubnetPropertyThe IP subnet associated with the phpIPAM entry.
MaskPropertyThe subnet mask that defines the network's address range.
DescriptionPropertyA brief description of the subnet in the phpIPAM tool.
VRFPropertyVirtual Routing and Forwarding (VRF) associated with the subnet.
Master SubnetPropertyIndicates the parent subnet if this is a subnet within a larger one.
Hosts checkPropertyWhether host discovery is enabled for the subnet.
Discover new hostsPropertyWhether new hosts can be discovered automatically in the subnet.
Resolve DNS namesPropertyWhether DNS names are resolved for the hosts in this subnet.
Scan agentPropertyThe agent used to scan and collect data for the subnet.
CustomerPropertyThe customer or client associated with the subnet.
LocationPropertyThe physical or logical location associated with the subnet.
VLANPropertyThe VLAN ID associated with the subnet.
NameserversPropertyList of nameservers associated with the subnet.
GatewayPropertyThe gateway IP address for the subnet.
Total IP AddressesPropertyThe total number of IP addresses in the subnet.
Total usedMetricThe total number of IP addresses used within the subnet.
UsedMetricThe percentage and numerical value of IP addresses used.
ReservedMetricThe percentage and numerical value of reserved IP addresses.
DHCPMetricThe percentage and numerical value of IP addresses assigned by DHCP.
FreeMetricThe percentage and numerical value of free (unused) IP addresses.

php IPAM IP Address

Represents an individual IP address within the environment, including its properties, status, and associations.

Data NameTypeDescription
IPPropertyThe IP address of the object within the phpIPAM system.
HostnamePropertyThe hostname associated with the IP address.
OwnerPropertyThe owner or user responsible for the IP address.
DescriptionPropertyA brief description or label for the IP address.
NotePropertyAdditional notes or comments related to the IP address.
MACPropertyThe MAC address associated with the IP address.
TagPropertyA tag or label assigned to the IP address for identification.
CustomerPropertyThe customer or client associated with the IP address.
Device IDPropertyThe unique identifier of the device associated with the IP address.
Last editPropertyThe timestamp of the last edit made to the IP address entry.
SubnetPropertyThe subnet to which the IP address belongs.
AvailabilityMetricThe availability status of the IP address (typically "1" for available and "0" for unavailable).
Custom fieldsGroupAdditional user-defined fields for customization.
ValuePropertyThe specific value of the custom field for the IP address.

php IPAM Owner

Represents the owner of the IP address within the phpIPAM system, typically used to track the person or entity responsible for an IP range

Data NameTypeDescription
NamePropertyThe name of the owner responsible for the IP addresses.
Total assigned IP addressesMetricThe total number of IP addresses assigned to the owner.

Alerts

The 'IP Inventory Management with phpIPAM' Management Pack provides alerts to help monitor the status and availability of network resources, ensuring prompt notifications for potential issues such as low IP address availability and unreachable IP addresses.

phpIPAM subnet is running out of IP addresses

  • Subnet has less than 5% free IP addresses: If Free (%) < 5, trigger Critical.
  • Subnet has less than 10% free IP addresses: If Free (%) < 10, trigger Immediate.
  • Subnet has less than 20% free IP addresses: If Free (%) < 20, trigger Warning.

phpIPAM IP address is no longer available

  • If Availability != 1, mark as Critical.