Custom VLAN assignment behavior

Advanced

PacketFence is built with flexibility in mind allowing users to modify the standard behaviour. To ease this process, extension points were defined such that any function present in pf::vlan::custom will take precedence over the default behaviour in pf::vlan.

If you have many VLANs depending on node attributes (i.e.: categories), SSIDs or MAC attributes, you need to put some effort into redefining the getNormalVlan() function.

Have a look at the following file which already has many examples commented out:

/usr/local/pf/lib/pf/vlan/custom.pm

Here are a few of them. You only have to remove the comments to have them take effect.

sub getNormalVlan {
 my ($this, $switch, $ifIndex, $mac, $node_info, $connection_type, $user_name, $ssid) = @_;
 my $logger = Log::Log4perl->get_logger();

 # custom example: admin category
 # return customVlan5 to nodes in the admin category if (defined($node_info->{'category'}) && lc($node_info->{'category'}) eq "admin") {
 return $switch->getVlanByName('customVlan5');
 }

 return $switch->getVlanByName('normalVlan');

}

sub getNormalVlan {
 my ($this, $switch, $ifIndex, $mac, $node_info, $connection_type, $user_name, $ssid) = @_;
 my $logger = Log::Log4perl->get_logger();

 # custom example: simple guest user
 # return guestVlan for pid=guest
 if (defined($node_info->{pid}) && $node_info->{pid} =~ /^guest$/i) {
 return $switch->getVlanByName('guestVlan');
 }

 return $switch->getVlanByName('normalVlan');

}

sub getNormalVlan {
 my ($this, $switch, $ifIndex, $mac, $node_info, $connection_type, $user_name, $ssid) = @_;
 my $logger = Log::Log4perl->get_logger();

 # custom example: enforce a node's bypass VLAN 
 # If node record has a bypass_vlan prefer it over normalVlan
 if (defined($node_info->{'bypass_vlan'}) && $node_info->{'bypass_vlan'} ne '') {
 return $node_info->{'bypass_vlan'};
 }

 return $switch->getVlanByName('normalVlan');

}

sub getNormalVlan {
 my ($this, $switch, $ifIndex, $mac, $node_info, $connection_type, $user_name, $ssid) = @_;
 my $logger = Log::Log4perl->get_logger();

 # custom example: VLAN by SSID
 # return customVlan1 if SSID is 'PacketFenceRocks'
 if (defined($ssid) && $ssid eq 'PacketFenceRocks') {
 return $switch->getVlanByName('customVlan1');
 }

 return $switch->getVlanByName('normalVlan');

}

Instead of using the flexible VLAN name where actual VLAN numbers are looked up in switches.conf you can specify VLAN tags directly if you want to. For example a return 5; would put the user in VLAN 5. We favour using VLAN names because you don’t need to change the code to change a VLAN.