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. Registered constraints can be applied to default input fields. See Constraints for more details.

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.

Contacts Action Menu:

The Action Menu (wrench icon) in the contacts gadget has three options:

Set Role: Opens a dialog box to select a role to assign to the contact, add a new role, or delete an existing role. 

Unassign: Unassigns the contact from the resource

View: Redirects to the contact's detail page in the Contact Manager

Refer to the Contact Manager page in the documentation for more detail on working with the Contacts gadget and the Contact Manager. 

To enable the DHCP Management Gadget, select the "On" radio button next to "DHCP Services", and click the "Update" Button.

The DHCP Management Gadget in the "On" configuration:

Each of the sections in the DHCP Management Gadget - Group Management, Connection Configuration, Server Details, Scan Server, DHCP Pools, and Create a New DHCP Pool - may be expanded to change settings in each area. 

Additional sections may appear in the Gadget once unpushed or pushed configurations are saved:

For detailed information on working with the DHCP Management Gadget, see DHCP Tab - Managing DHCP Server Configurations.

Before You Begin

Before using the DHCP Customer Configuration Gadget, the following should be set up in ProVision:

• The associated DHCP server should be created in ProVision and set up in the DHCP Management Gadget or DHCP Tab - DHCP  Servers list (See: DHCP Tab).
• Add the DHCP Customer Configuration Gadget to the desired Section. You may want to create a specific "DHCP Customer" Section for DHCP customer entries (See: Customizing Sections).
• Have, or set up APNIC Aggregates for DHCP use from the IPAM Tab with the desired IP space type, Region(s), Tags, and any desired VLAN criteria. Regions are a required field when assigning IPs from the DHCP Customer Configuration Gadget. Any APNIC aggregate may be used for DHCP, so you may want to create a "DHCP" IPAM Tag to help denote the desired aggregate(s).
• If you are planning on Direct Assigning the DHCP blocks in the Customer Configuration Gadget, ensure that the desired blocks in the DHCP are split to individual /32 or /128 size. Smart Assign and Smart Browse will automatically split the block to assign the correct size. 

Associate with DHCP Server

Once the Gadget is enabled, the first step is to associate it with an already-created DHCP server in ProVision. Select the DHCP Server to link to, and click "Continue". 

Assign IP's

Next, Assign IP's for Pools from DHCP Aggregates. You may Direct Assign, Smart Assign, or assign from Smart Browse based on the selected criteria. 

Once assigned, a Pool Name will be automatically generated under "Resource". Pools may be unassigned by clicking the "Unassign" button. 

Set up Configuration

Once IP's have been assigned, the "Configuration" tab will appear. Click on the tab, and then select or deselect the DNS Server associated with the Customer, add Option 82 Elements, Add Circuit ID text, and add notes if desired. Use the "Preview" field to confirm the accuracy of the data, and select the status as "Activate" or "Terminate". 

When done, click "Update Configuration". The configuration will be sent to the associated DHCP server's DHCP Management Gadget. 

Enabling the DNS Autogenerator

To set up this Gadget, ensure that the Section of the Resource (typically, "Resource Holder" ), has the "Hostname" field (6c-hostname-fqdn) and the DNS Autogenerator Gadget added to the Section. (See: Customizing Sections and Customizing Fields). 

Then, check that the Resource itself has information entered into the "Hostname" field. If the field is already filled out, it will show in the "Fields" information area at the bottom of the Resource Entry page. To add or edit the hostname, click "Edit" at the bottom of the resource entry page, add the information to the Hostname field, and click "Save". 

Once a hostname has been associated with a Resource, and the page refreshed, the DNS Autogenerator Gadget will be visible.

Before you Begin

Before starting, check that the blocks assigned to the Resource in the IPAM Gadget are correct and up-to-date - the Autogenerator uses these blocks to create the records. If using a DNS Group other than "Default" to hold zones, ensure that the desired DNS Group to hold the generated records has been set up. (See: Working with DNS Groups).

Working with the DNS Autogenerator

One enabled and visible, the DNS Autogenerator Gadget will initially show a short description, the hostname, and a button to "Autogenerate Records".  

When ready, click the "Autogenerate Records" button. The Gadget will search through the blocks in the IPAM gadget and provide a list of found blocks. 

Add Subdomain / DNS Group

Next, add in a subdomain if desired (optional), and select the DNS Group to hold the records (required). Click on the listed blocks to select (highlighted green) or deselect (grey) for DNS zone / record creation.

Save and Push

Finally, hit the "Save" button at the bottom of the gadget - the selected forward and reverse DNS records will be created and added into the DNS Group, viewable in the  DNS Tab.

At this point, you may choose to immediately push the autogenerated zone(s), schedule a push, or re-run the workflow to edit the subdomain or group.

Upload Files

First, ensure the Document Storage gadget is enable for the Section type. Then, select the "Uploader" tab under the Document Manager gadget. 

Click on the "Choose Files" button, and select the file(s) you would like to upload. 

The selected files will show in a list under the Uploader tab. To upload the file(s), click on either the "Upload" button adjacent to the file to upload the individual file, or the "Upload All" button to upload all files listed. You may also choose to remove files from the upload list, or cancel. 

Once the progress bar is filled in, your upload is complete! Your files will show under the "Files" tab.  

Download Available Files

Successfully uploaded files are listed under the "Files" tab of the Document Manager gadget. From here, you can see the file Name, Size, Type, Date, and available Actions. 

To download a file to your local machine, ensure you are on the "Files" tab, then click on the "Download from Cloud" icon. 

If a file is no longer needed, you may delete the file from the Document Manager by clicking on the Delete (trash can) icon. 

Using this gadget, you can:

• Direct Assign with or without additional filtering options. In cases where duplicate blocks exist, using the filter options with Direct Assign allows you to specifically control which of the duplicate blocks is assigned.
  • To open the Direct Assign section of the Gadget and the advanced options, click the expansion caret in the upper right section, and then click "Advanced Options". 
    
• Smart Assign with or without additional filtering options. Required fields for Smart assign are: "Type", "RIR", and "Size", but additional fields such as "Region", "VLAN", "LIR", "Resource" (for blocks that allow subassignments), and various "Tag" mode options.
• Smart Browse using smart assign filter options to bring up a browsable list of blocks meeting that criteria, from which you may assign or assign out of. 
  • To open the Smart Assign / Smart Browse section of the Gadget and the advanced options, click the expansion caret in the upper right Smart Assign section, and then click "Advanced Options". 
    
• View, Filter, and Sort Assigned Blocks for the resource via the "IP Blocks" list.
  • To Filter: click the "filter" link in the top right area of the header to open filter options. Enter your desired criteria and hit "Apply". 
    
  • To Sort: Click on the header name you wish to sort by, and the field will toggle between ascending and descending order.
    
• Manage Assigned Blocks for the resource by going into the "IP Blocks" list, and using the Action Menu (Gear Icon) to perform actions for the selected block.
  All options available in IPAM Manage for a block are also available in the IPAM Gadget Action menu, although the "Templates" option will be applicable in the IPAM Gadget.
  
• Edit Multiple Blocks: by shift-clicking or cmd-clicking to select multiple blocks, and then right click to show the multi-block Action options, then select "Edit". The Edit Block Attributes screen will display.
  

For more information on assigning and managing blocks, see Working with IP Blocks - Assigning IP Space.

Enabling "VRF Support" in the Admin home page under "Peering Settings" will automatically add the VRF gadget to the router Section.