IPAM Tab

To assign the resource during creation, you may either select an existing resource, or create a new resource to assign to the aggregate. Note: A resource must be selected to enable sub assignments.

When done, click "Add Aggregate". A link to the newly created aggregate will be available or you may hit "Clear" and create another aggregate. New aggregates will be listed under the Host Utilization and Aggregate Blocks list of the IPAM Tab for further management.

Enabling Map View

The IPAM aggregate map view may be enabled / disabled from the IPAM Configuration page. Once enabled, a map module will be able to be expanded in the IPAM Tab.

The following criteria must be met for Map view to correctly show data:

1. Map View enabled on the IPAM Configuration page

2. A valid Geocoding API Key must be provided in the Edit Regions page:

   1. Get a Google or Radar Geocoding Key from one of the following resources:

      1. How to get a Google Geocoding API Key

      2. How to get a Radar Geocoding API Key 

   2. Click on the Geocode API Key Button on the Edit Regions page.

      

   3. In the Geocode form, select the appropriate Geocode API Key type and enter the API Key obtained. You may check the API key by clicking Test API Key.

      

      When done, click Save.

      
      

3. Regions must be created with a valid "Address" (location) field. The "Address" field may be a street address, city, airport code, or geo-coordinates. See Edit Regions for additional detail.

4. Regions must be enabled in IPAM Columns and assigned to aggregates / blocks for the IPAM Map view to populate data. If the regions column has been disabled in IPAM columns, or not associated with blocks, then Map View will not have data to display.

Map View Settings

• Positioning Dropdown: Select a predefined area for the map view range (US, US & Europe, Europe, South America, or World) or chose a custom area set by zooming / navigating to the desired map area. Click “Save current position” to save a custom view position.

• Visualization Dropdown: Select "Aggregates" to view all available aggregates with region data, or "Recent Assignments" to view block assignments made within the past 30 days.

• Save current Position: Click to save the current map view range as the default view.

• Toggle Full Screen (square icon): Click to view full screen map.

• Aggregate Detail Box: Click on an icon image to view details.

The detail box provides utilization data and a shortcut link to the IPAM Manage screen for that aggregate if in "Aggregates" view, or assignment details if in "Recent Assignments" view. 

Search / Filter Aggregates

Search for and filter IPAM Aggregates from the Aggregate Blocks List:

• Filter by type: Select "All", "IPv4", IPv6", or "DHCP" to sort the list by type (You may also access the type filters by right clicking in the list of Aggregate Blocks)

• Search by CIDR: User the filter / search box to search by CIDR

• More filters: Filter by Region, RIR, or LIR by clicking the "more filters" link, then selecting an item from the dropdown menus.

• Zoom to aggregate: Single click on the CIDR to zoom to the aggregate details in the Host Utilization list

• Open IPAM Manage: A shortcut to IPAM Manage for an aggregate is provided by clicking the "open" link that appears when hovering over an aggregate block in the list.

To reset the list, right click anywhere in the Aggregates Blocks list and select "Reset View". 

Header:

• CIDR: Single-click to IPAM Manage for the aggregate

• RIR information: displays the aggregate's RIR, as set at creation (1918, ARIN, RIPE, LACNIC, AfriNIC, APNIC)

• Aggregate Chart Views: Four Aggregate chart views are available - Pie, Bar, Tree, and Grid view.

  

  • Switch between each chart by clicking on the respective icons in the Aggregate header. 

• Aggregate Actions (Gear Icon): Click to open aggregate-level options

  • Manage Aggregate: Opens IPAM Manage for the aggregate. Clicking on the Block CIDR in the header also opens the IPAM Manage page.

  • Delete: Deletes theaggregate (provides a warning).

  • Enable / Disable Sparse Allocation (IPv6 only): Enable or disable Sparse Allocation for an IPv6 aggregate. Enabling will automatically generate a Numbering Authority Sparse Allocate Domain for use with the aggregate. 

  • Sparse Allocate (IPv6 only): Appears only when Sparse Allocation is enabled for an IPv6 aggregate. Opens a menu to select or create a resource to assign a block to, using the sparse allocate algorithm to disperse the assignment(s) throughout the aggregate. See: Working with IP Aggregates

Chart Area (left side):

• Region(s): Displays the primary region(s) associated with the aggregate, either at aggregate creation or from regions associated with blocks under that aggregate. Clicking on the region link for an aggregate will open IPAM Manage for the aggregate, filtered to view blocks associated with that region.

• Utilization Chart: Utilization displayed as both a pie chart and detailed percentages. Utilization statuses include:

  • Available: A status of "Available" indicates the block is free and able to immediately be assigned or allocated to a resource.

  • Allocated: Allocated blocks have been assigned to an overarching resource, but have subassignments enabled and may have smaller blocks assigned out of them to other Resources, such as customers or DHCP Pools. 

  • Assigned: A status of "Assigned" indicates that the block has been assigned to a Resource, with no subassignment capability, and is unavailable.

  • Holding: Blocks in "Holding" have recently been unassigned, and are held for a set duration in the IPAM Holding Tank, unless otherwise overridden, reassigned, or reclaimed from Holding.

Resource Listings (right side):

• Resources: The top five Resources assigned under that aggregate with the most assigned block space.

• Recent Assignments: The five most recent block assignments under that aggregate, with the CIDR, assigned resource link, and assignment date.

Setup

The ProVision WHOIS Server is a thin client for our REST API that listens on port 43 and accepts WHOIS requests that gets forwarded to our API. It is written in Python 3 using the socketserver module, and uses the ProVision endpoint /api/ipam/whois to receive all requests from the WHOIS server.

The main business logic is located in services/WhoisService.php

sudo apt install -y python3-pip
pip3 install requests

sudo yum install python3-pip OR sudo dnf install python3-pip
pip3 install requests

self.url = "https://localhost/qa-7.4.0/api/v2/ipam/whois"
self.username = "apiUserName"
self.password = "apiPassword"

sudo python3 main.py

Installing the WHOIS server as a service

Different Linux distributions might have different ways to setup a service that runs on startup.

sudo cp whois_server/provision_whois.service /etc/systemd/system/provision_whois.service

service provision_whois start

chmod +x /etc/init.d/provision_whois -v

1. Enter GEO IP data to Resources

Add GEO IP location data to a Resource by selecting "Edit" for the Contact Info Gadget.

Enter a separate address to denote as the GEO IP location, or you may select "Same as Mailing Address":

2. Set up the Geo IP Export Scheduler Task

Create a Scheduler task to export GEO IP data:

3. Run the Scheduler Task / File Access

Run the GEO IP scheduler task, either via "Run Now" or as a scheduled run - the task will search for resources with an assigned IP address, and either Geo IP location data or a Mailing Address entered in the Contact Info Gadget, and add the data to the .csv output.

Once the task has completed, the GEO IP data will be written to the ProVision root directory as "geoip_feed.csv":