Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 7.3.0

...

HTML
<div id="google_translate_element"></div>
<script type="text/javascript">
function googleTranslateElementInit() {
  new google.translate.TranslateElement({pageLanguage: 'en'}, 'google_translate_element');
}
</script>
<script type="text/javascript" src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"></script>

Working with

...

VLANs

Table of Contents
 

Step 1) Add Domain

Users will already have a non-editable Default Domain created, which may house VLANs entered under the previous VLAN text field, however, you may choose to create new domains.

To create a new VLAN domain, navigate to the VLAN Admin Tab, in the Admin area of ProVision, and click on Add a new domain by clicking the "Add Domain" .

Image Removed

Enter the domain name, and select whether it is standard or extended - Standard has a range of VLAN IDs from 1-1005;  Extended includes up to 4094. 

Image Removed

Info
NOTE: The ProVision UI and API has restricted usage of VLANs 1 and 1002-1005 in tagging and selecting or searching VLANs. 

Click "Add", and your new domain will be added to the Domain list belowbutton at the top right of the VLAN Home page. Optionally, you may add VLANs to the domain at the same time.

Viewing the Domain List

Image Removed

If a domain already has VLANs enabled for it, clicking on the "+" sign in front of the domain name will expand the domain list to show enabled VLANs.

The numbers in parentheses under the domain name (shown as 21/1000 in the above image for a standard domain; an extended domain would show as 21/4089) indicate the quantity of enabled VLANs over the available pool of VLANs to select from. There are 5 VLANs (1, 1002-1005) which are reserved, and not included in the count. 

Edit a Domain

The Default Domain is not editable, however users may edit the name of user-created domains.

Once a domain has been created, users may not edit the range (standard / extended) of a domain - if a domain is created with a mistaken range, it must be deleted and re-created. 

To edit a domain name, click on the "Manage" button next to the domain name.

Image Removed

Under the "Edit Domain Name" section of the page, edit the name as desired, then hit "Save". 

Image Removed

Remove a Domain

To edit a domain, click on the "Manage" button next to the domain name.

Image Removed

Then, edit the name as desired and hit "Save". 

Step 2) Add VLANs to a Domain

...

After creating domains, VLANs need to be added (enabled) for that domain out of the pool of available VLANs. 

...

Go to the IPAM Tab, and then either select VLAN from the IPAM dropdown menu, or click "VLAN" from the subtab buttons that appear on the IPAM page. 

 


This takes you to the IPAM - VLAN page, which shows an overview of Domains and VLANs on the left sidebar (click the + next to the domain names to see the enabled VLANs under each domain), and similar to the IPAM page, shows IPAM Utilization data for each Domain / VLAN pair. Clicking on the wrench VLAN Name will open "VLAN Manage", which has the same type of functionality for IP blocks as IPAM Manage, but organized under the scope of that VLAN. 

Add VLANs to a Domain (Enable)

In the IPAM - VLAN page VLAN sidebar, click the "EnableAdd VLAN"

Image Removed

This changes the sidebar into a VLAN search module. Select the desired domain, button. Select the Domain, and enter the individual or range of VLANs to viewadd. When done, and click "SearchSave". 

Image Removed

Info
Note: If VLAN Tags have already been applied to a range of VLANs, you may also include VLAN tag criteria in your search. If tags have not been created or applied to a range of VLANs, searching by tags will not return results.

Below the search criteria, the results list will show VLANs meeting your criteria. 

Select the desired VLANs to enable for the domain - you may either select all VLANs in your results list, or check VLANs individually.

Image Removed

When done selecting the VLANs, click "Enable Selected". The selected VLANs will now be enabled for the domain, show in Domain / VLAN lists, and be available to edit or add blocks to. To add more VLANs to another domain, click "Reset" and repeat the process. If done, hit the "Cancel" button at the top of the Add VLAN module, and you will return to the main IPAM - VLAN page view. 

Remove VLANs from a Domain (Disable) - API

Disabling a VLAN (removing the VLAN from a domain) may be done through the VLAN API "update" endpoint.

A VLAN may be enabled or disabled by setting its "enabled" parameter to true (enable) or false (disable), after providing the required id. 

An example API call to disable a VLAN with id=41438 would look like:

Code Block
(instance url)/api/v1/api.php?target=vlan&action=update&id=41438&enabled=false

Remove VLANs from a Domain

Removing VLANs may be performed from multiple areas:

  • On the VLAN Home page sidebar, by right clicking on the VLAN and selecting "Remove VLAN" from the menu
  • From the VLAN Utilization Box for the VLAN, by clicking the gear icon and selecting "Remove VLAN"
  • From VLAN Advanced, by right clicking on the desired VLAN in the list, and selecting "Remove VLAN"

For details on the VLAN update endpoint, see API Module - VLAN - (update).

...

You can edit a VLAN by clicking on the VLAN in the VLAN List sidebar, then selecting "Edit VLAN". 

Image Removed

You cannot change the Domain of the VLAN, but you can add a descriptive text name , apply a VLAN tag (if using the tag system), or edit VLAN Metadata (if enabled).

Image Removed

After making your changes, click the "Save" button. The named VLAN will now show both VLAN number and name when viewing Domain / VLAN lists or when working with blocks. 

...

Add / Update Blocks to VLAN from VLAN - Manage IPs:

While in on the IPAM Tab -> VLAN Home Page, expand the desired domain in the sidebar and right click on a VLAN. Then select "Manage IPs". 

Image Removed

Assign Blocks". You should automatically be taken to that VLAN's Utilization Box, with the "Assign Blocks" panel open. You may also access the panel directly from the Utilization Box or VLAN Manage by clicking on the plus-sign icon.

This opens up a window panel where IP Blocks may be associated to the VLAN. From here, you can "Direct Assign" a block to the VLAN,  or use filter criteria to " Smart Browse Assign" blocks, or Search for a block to add to the VLAN. 

Direct Add Block to VLAN:

Directly add a known, available IP Block by typing in the CIDR, then hitting "Add IP Block". 

Image Removed

When complete, the block will be added to the "Assigned IP Blocks" list on the right of the window, with the option to remove if desired. 

Image Removed

Browse IP Blocks to add to VLAN:

Browse blocks available to add to the VLAN by clicking on the "List available blocks" link above the IP block input box. 

Image Removed

This opens a window similar to the "Smart Browse" used in assigning IPs to a resource - just select IPv4, IPv6 blocks, or Resources to browse from the radio buttons at the top of the list. 

When you have selected the block to add, click "add to VLAN". 

Image Removed

...


Add

...

Image Removed

When complete, the block will be added to the "Assigned IP Blocks" list on the right of the window, with the option to remove if desired. 

Image Removed

Search IP Blocks to add to VLAN:

...

/

...

Image Removed

This opens a window with filtered results matching your criteria. 

When you have selected the block to add, click "add to VLAN". 

Image Removed

The selected block will automatically fill in the block input box - just hit "Add to IP Block" below the input to finalize the addition. 

Image Removed

When complete, the block will be added to the "Assigned IP Blocks" list on the right of the window, with the option to remove if desired. 

Add / Update VLAN to Blocks from IPAM Manage or VLAN Manage:

...

From the VLAN Manage screen, click on the Action Menu (wrench gear icon) for the desired block, the select "Edit".  

Image Removed

You may also double-click on the block to open the same screen.

In the Edit Attributes page for the block, change the Domain to the desired item, then select the VLAN. Hit save when done. Image Removed

IPAM Manage:

...

Then, in the Edit Attributes box that pops up, search for or type the desired Domain, select VLAN information, and click "save". 

Working with VLAN

...

VLAN tags provide further organizational / search criteria when searching for VLANs to enable.

Creating VLAN Tags

Create VLAN Tags from the VLAN Admin Tab, in the Admin area of ProVision, and select "Edit Tags" from the dropdown.

Image Removed

To add a new VLAN tag, click on "Add Item" at the top of the Edit List: VLAN Tags page. 

Image Removed

Then, type in the desired name value for the new tag, and hit "Add Item". The new tag will be added to the list below. 

Image Removed

To edit a tag, simply type your changes in to the text box with the tag name. Tags with unsaved changes will be highlighted until saved. 

To delete a tag, click on the red "delete" symbol to the right of the tag name. 

Image Removed

When complete, be sure to click on the "Save" button to save your changes. 

Once VLAN tags have been created, they will be available to add to VLAN ranges and use in the "Add VLAN" search function. 

Add VLAN Tags to VLANs

VLAN tags may be added to VLANs in two ways: Editing an already-enabled VLAN (VLAN Edit), or by assigning the tag to a range of VLANs from the Domain VLAN pool (un-enabled VLANs, which are then available to search by VLAN tag to enable).

Add Tag to an Enabled VLAN

Edit an existing, already enabled VLAN by clicking on the VLAN in the VLAN List sidebar, then selecting "Edit". 

Image Removed

Apply a VLAN tag from clicking in the "VLAN Tags" box, and selecting one or more VLAN Tags. 

Image Removed

After making your changes, click the "Save" button. Tagged VLANs will be viewable in the VLAN Chart a single tag points under VLAN Admin - Domain Manage. 

Add Tag to a Range of  the VLAN Pool

You can also tag a range of the (un-enabled) VLANs in a domain's VLAN pool. Then, when moving on to enable a set of VLANs for a Domain, you can select those VLANs by tag. 

Go to the VLAN Admin Tab in the Admin area of ProVision. Then, next to the desired domain, click "Manage".

Image Removed

This brings up the page to edit the domain or view a chart of VLAN tags (y axis) to VLANs in the available pool (x axis).

 Image Removed

Hovering the mouse over a tag range will show details such as the range start, end, and count of vlans in the range.

Under the "Edit VLAN Tag Range" section, you can bulk assign tags to ranges by:

    1. Select the tag to edit in dropdown below chart
    2. Type desired VLAN start and end value for the range
    3. Click "Add Tag Range" to set and save. 
      Image Removed

To remove a range of tags, under "Edit VLAN Tag Range":

...

Once assigned, the tags show as a property of the VLAN block in the VLAN edit menu and may be used for VLAN Searches / Assignments. 

...

Metadata

...

Customizable metadata fields are available to hold VLAN-specific information such as Location, Client, Firewall, Gateway, and more.  

These fields can be enabled and disabled in the VLAN Admin section of ProVision, and viewed / edited under "Edit VLAN" in the VLAN Tab. 

Enable / Disable

...

VLAN Metadata Fields

VLAN Metadata fields can be enabled and disabled under the VLAN Admin the IPAM Admin → VLAN Columns area of ProVision. 

Image Removed

To enable a new Metadata Field, navigate to the Admin section of ProVision, and select "Metadata Fields" from the dropdown. 

Image Removed

To enable a new field, type the desired field name in an empty text input box under "Field Display Name", and select the check box next to the new name. Then, click "Save" to save your changes. Field display names may be edited at any time by simply typing the desired change into the "Field Display Name" box and saving your changes. 

Once enabled, a metadata field displays for all enabled VLANs. 

To disable a metadata field, deselect the check box next to the Field Display Name and click "Save". Any data that exists under a disabled field is retained, and will reappear once the field is re-enabled. Here, you may edit the order of columns, rename columns, and enable/disable column visibility. Any columns that are disabled will hide the column from VLAN Manage, as well as hide the applicable field from any VLAN filters or Edit VLAN actions.

View / Edit Metadata Field Information

...

While in the IPAM Tab -> VLAN Page, expand the desired domain from the left sidebar and right click on a VLAN. Then select "Edit VLAN". 

 

Image Removed

In the Edit VLAN screen, you may view the Metadata or enter your desired changes and click "Save" when done. 

Image Removed

VLAN Metadata may also be viewed from VLAN Advanced - Global View, if enabled.