Utilization

Quickview

Assign Blocks to VLAN

Edit VLAN

VLAN Advanced (Global View)

VLAN Advanced displays a list of all domains / vlans added to ProVision. Here, you can perform domain level management tasks, view data on added VLANs, including Domain, VLAN Name, applied Numbering Domains, associated routers, and any enabled VLAN metacolumn data.

CFR - 148a: Added user-customizable Resource Reports, including the ability to filter by Section and Category; export to .csv

IM - 3351: Added DNS Zone Reports with zone filter options

CFR - 149: Added user-customizable DNS Zone Reports, including the ability to filter by zone record type(s); export to .csv

IM - 3564: Added new Default Reports, including IPAM, Peering, DNS, Users, and Resource reports.

IPAM Reports

IPAM Utilization reports display IPv4/IPv4 utilization charts organized by RIR and SWIP status, and provide a listing of ProVision blocks meeting the applied filter criteria. The report view includes the block data for all applied IPAM Columns, in the order set under IPAM Admin → IPAM Columns. IPAM Reports may be exported to .csv (limit: 100,000 records; no chart provided) or PDF (limit: 1000 records; chart included). Default reports include:

• Default Utilization: IPAM utilization report for all aggregates

• Default Utilization - 30 days: IPAM utilization report for all aggregates assigned in the past 30 days

Peering Reports

Two new peering report types are available - Peering Health and Peering Status. Peering Health reports display the sessions existing in ProVision, with the associated fields of Router Name, Peer Name, IP, Session Type, Session State, Peer Group, and session Created Date. Peering Status reports are set per-exchange, and display pie charts for Peer Status/Qualification Status, as well as a data table of the Peer Name, Request Status, Peer Status, Qualification Status, Message Count, and Last Message Time. 

All Peering Reports may be exported to .csv (limit: 100,000 records; no chart provided). Default reports include:

• Default Peering Health Report: Displays the peering session state for all currently existing sessions in ProVision
• Default Peering Status: Displays Peer, Request, and Qualified status for the default (first available) exchange in ProVision

DNS Reports

DNS Zone reports provide a list of zones existing in ProVision, along with the fields of Zone ID, Name, Last Modified Date, Forward/Reverse Type, and Record Count information. DNS Zone Reports may be exported to .csv (limit: 100,000 records). Default reports include:

• Default DNS Zones: All DNS zones in ProVision
• Default DNS Zones - 30 days: All DNS zones in ProVision modified within the past 30 days

User Reports

Users reports provide a listing of ProVision log events associated with user actions. Provided fields include the Timestamp, User, IP, Log Level, and the Action, and the report may be filtered to include one or more users / user groups, as well as basic data filters. User Reports may be exported to .csv (limit: 100,000 records). Default reports include:

• Default User Activity - 30 days: All ProVision user activity within the past 30 days
• Default User Activity - Year to date: All ProVision user activity for the current calendar year ( ISO Standard/Gregorian calendar)

Resource Reports

Resource reports provide a list of all (non-DNS) ProVision resources, and field data from the Contact, Billing, Tech Info, and Resource Field Gadget(s) associated with the resource. The report may be filtered to include one or more Sections or Categories, as well filtered by resource name. Resource Reports may be exported to .csv (limit: 100,000 records). Default reports include:

• Customer List Report: ProVision resources which are of the "Resource Holder" Section and "Customer" Category; matching the reporting v1 Customer List report.
• Default Resource Report: All ProVision resource entries - matching resources listed in the Resource Tab -> Entries page list, and all applicable resource fields
  • TIP: Due to the large scope of the ProVision resource system and its fields, we strongly recommend using the Default Resource Report as starting template from which to further define more specific resource reports. Simply "Copy" the Default Resource Report, apply your desired Section/Category filter combination(s), and click the Gear Icon → Save to create a more manageable data set.

For additional information, see Reporting and Working with Reports.

Add the IPAM Stats Widget

To add the IPAM Stats widget to a dashboard, click "Add Widget" from that Dashboard (Note: Default Dashboards require admin permissions to edit or save changes to the Dashboard). 

In the "Add new widget" list, click on "IPAM Stats". The IPAM Stats Widget will be added to the Dashboard. If using the Default Dashboard, be sure to save your changes.

From here, you may move the widget to a new location, edit the name, or remove the Widget from the Dashboard. See Customizing the Dashboard and Working with Dashboard Widgets for details on performing basic Widget tasks. 

Using the IPAM Stats Widget

The IPAM Stats widget contains read-only IPAM data under three tabs - IPv4, IPv6, and 1918. Click on the desired tab for the block type you wish to view. 

Before you Begin

To use the Route53 connector, you must have Route53/AWS account set up and be able to provide the API Key, API Secret, and API Region provided to your Route53 account. For information on setting up a Route53 account, learning resources, or FAQ, see https://aws.amazon.com/route53/ . 

To add a new DNS Server in ProVision, you must be logged in as an Admin-level user.

Add a Route53 Server to ProVision

From the DNS Tab, click the DNS Servers sub-tab. From there, click "Add Server" to open the Server Settings page. 

In Add Server → Server Settings, enter a Display Name for the new Route53 server, skip FQDN, and select Server Type.

Under "DNS Service", select the "AWS Route53 (Beta) connector. The FQDN field will automatically be disabled, and AWS/Route53 specific settings will be enabled in the next section. 

If desired, adjust the other available settings in this section, then scroll down.

Set Route53 Specific Settings

Under the section for AWS Route53 (Beta) Settings, enter the API Key, API Secret, and API region provided to you for the AWS/Route53 account. You may choose to click "Test Server" at this time to verify the credentials and connection. 

Enter additional Dynamic Updates, NS Records, and Group settings if desired, then click "Save Changes". 

For information on working in the rest of ProVision's DNS system, see DNS Tab, DNS Administration, andWorking with DNS Servers.

Holding Tank Views

Select the desired view from the top of the "Process Holding Tank" page in IPAM Admin:

View Blocks over X days (Default View)

The default Holding Tank view is "View Blocks over X days", which only displays blocks over the "Holding Tank Days" setting in IPAM Configuration. To change to this view from a different view, click  "View Blocks over X days" from the view list in the top center of the Holding Tank. 

In this view, all processable blocks are shown, and you may select either specific blocks or all blocks for processing. 

View Pending Blocks

To view only Pending blocks, click  "View Pending Blocks " from the view list in the top center of the Holding Tank. "View Pending Blocks over X days" only displays blocks more recent than the "Holding Tank Days setting".

Pending blocks are not selectable or processable, but display the same data as processable blocks. You may view additional details for the block in IPAM Manage by clicking on CIDR link for the desired block.

View All Blocks

To all blocks, click  "View All" from the view list in the top center of the Holding Tank. "View All" displays both Pending and processable blocks, but only processable blocks older than the Holding Tank Days may be selected for release. 

Pending blocks display in a lighter color text than processable blocks, and do not have a selection box available. Any block may be viewed in IPAM manage by clicking on the CIDR link for the block, and the list may be sorted into ascending/descending order for any field.

Sort Blocks

From any view in the Holding Tank, click on the up/down arrows next to the column name to sort the results by ascending/descending order for that field. 

Viewing Templates

View the Template List by navigating to the Admin Preferences page, in the Admin area of ProVision. From there, scroll to the Peering Settings section. Next to "Templates", click "Manage Custom Templates". 

The Template List will open, displaying all existing Peering Templates. 

Click on any template to open Template Details, where you can edit, delete, or preview the template.

Add a Template

From any page in the Peering Templates area, click the "Add Template" button on the right side of the page header to start a new template.

In the Add Template form, enter a name for the template and the template body. When complete, click "Add". 

The "Template Details" view displays for the newly created template, here you can update, preview, or delete the template.

Edit a Template

From the Template Details view, edit the template by clicking inside the template body and typing the desired changes - if you need a reminder as to syntax or variables, click the help icon (Question Mark button) at top right to open the template editing guide.  

Click "Update" when done. 

Syntax

Templates use the  Mustache Format

The router name is {{router_name}}

The router name is TheName

{{#color}}The color is {{color}}.{{/color}}
{{#city}}
The city is {{city}}.
{{/city}}
	

The color is blue.

Preview Template

While editing or viewing a template, you may preview the template's output against a specific session by clicking the "Preview" button. A "Preview Template" section appears.

Select an existing Router/Session from the dropdown list to use to generate the preview. Once selected, the template output will display directly underneath the selected session. 

Template Revisions

The Revision History area will display on the Template Details page after an update has been made to the template, with each update displaying as a separate revision item. 

Click "View" under the "Actions" columns for a revision to see the template contents at that revision snapshot. 

To restore the template back to that revision number, click the "Restore" button for the revision preview.

Using Router File Connectors

Step 1

Generate a router response data text file (it should be named “cisco_router_data.txt”, “juniper_router_data.txt” or “arista_router_data.txt”) and place it in ProVision's /data directory. 

To generate the router response, run the following commands:

Step 2

Create a new 'Router' in ProVision, selecting the appropriate file connector as the Router Make type - CiscoFile, JuniperFile, or AristaFile.

Note: These connector types are only used for this direct data import process - do not select these for standard ProVision router/session creation, as management functions (config pushes, session states, etc) do not obtain a router connection while using File Connectors.

Step 3

Navigate to Admin → Data Import → Peering BGP Import.

Select the appropriate exchange, then the File Connector Router that you created.

Click "Load Sessions", and the sessions contained within the router data file will be available to review, select, and/or import into ProVision.

Via APIv2

The same import process may also be performed via APIv2, using the following information:

1) "router id" contained within the URL for an already-created File Connector Router

2) "ix_id" (the ID of the exchange) in the body

3) "router_response" (the output from the router) in the body

The APIv2 details can be view from ProVision swagger documentation at  ['instance']/dev/swagger/spec.php?family=peering#/default/single_parse_bgp_info

That command will parse the router output and return an array of detected sessions and groups. The sessions and groups then need to be individually added using POST /peering/sessions and POST /peering/peergroups.

Example .csv Output

To export .csv information for the linked resource in the Resource Linkage Gadget, click on the wrench icon for the linked resource, then select "Export to .csv". The file will download from your browser.

The .csv outputs data in two columns, arranged as Field Name (column 1) and Field Data (column 2). 

Standard resource metadata fields ("Name", "Section","Category", "Created", "Modified") will always be exported for a resource.

Additional custom fields - those that have been added to the Section / Resource Field Gadget and contain data - will also be exported if they exist, and included after the standard metadata information. 

In this example,  "Hostname", "Resource Holder ID", "Contract Number", "URL", "Text Area", "Text Input", and "Status"  are custom fields. 

Setting up ACP Access in ProVision

Before using the ACP Workflow Gadget, you must set the ACP URL and user credentials in Admin → Admin Preferences.

Enter the ACP URL for a licensed ACP instance, then provide the ACP Username and Password for the user that should be used to execute Workflows. To verify the account, click "Test Configuration" - you will be notified whether the account is valid. 

When done, click "Update".

After setup, the ACP Workflows Gadget will load with the available Workflows from your ACP instance, and can be configured to select which Workflow and inputs you wish to use.

Configuring the ACP Workflow Form

The ACP Workflow form is access from the Edit Section page, under "Manage Gadgets".

Once ACP settings have been added to Admin Preferences, the "ACP Workflow Form" Gadget can be added to a Section, and Workflows from the associated ACP instance will be available to select. containing fields to select the desired Workflow to Run, Title, and map input options.

Select a Workflow, then edit the title to display on the gadget and map input options. Input options will vary according to the selected Workflow.

You may also choose to refresh the page once the workflow execution is complete, and/or show JSON results. 

Multiple Forms may be added to a Section, in order to run additional Workflows or option settings.  When complete, click "Save".

Working with the ACP Workflow Form

Once enabled, the Gadget will show on the resource page for any resource of the section type.

Input the field data necessary for the Workflow - here, it's adding a hostname - then click "Execute Workflow" to process the chain of workflow calls. 

If "Display JSON Results" has been enabled, a display modal will appear showing the JSON response of the executed workflow.

When done reviewing the response, click "Close". 

If the page has not refreshed, you will see a message informing you whether the Workflow has successfully executed.

In this example, a "Customer Turn-Up" Workflow was selected (created in ProVision's ACP product) that performed six functions with one button click. The successful "Execute" for "Customer Turn-Up" created a new customer resource entry, assigned IPv4 and IPv6 blocks to them, created a DNS zone for the hostname, and lastly created 'A' and 'AAAA' records for the zone.