Infoblox::DHCP::FilterRule::MAC - DHCP MAC Address Filter Rule object.

NAME
DESCRIPTION
CONSTRUCTOR
MODULE METHODS

Infoblox::DHCP::Range->filters( )

METHODS

filter_name( )
permission( )

SAMPLE CODE
AUTHOR
SEE ALSO
COPYRIGHT

NAME

Infoblox::DHCP::FilterRule::MAC - DHCP MAC Address Filter Rule object.

DESCRIPTION

MAC Address Filter Rule allows a user to grant/deny the lease of an IP defined in DHCP Range.

CONSTRUCTOR

 my $mac_filter_rule = Infoblox::DHCP::FilterRule::MAC->new(
       filter_name   => $string,          #Required
       permission    => "grant" | "deny", #Required
 );

MODULE METHODS

The following functions can be applied to a DHCP MAC Filter Rule object.

Infoblox::DHCP::Range->filters( )

Use this method to add a DHCP MAC Address Filter Rule object to the DHCP Range on an Infoblox appliance. See Infoblox::DHCP::Range->filters() for parameters and return values.

Example

 #Construct a DHCP MAC Address Filter Rule object
 my $mac_filter_rule1 = Infoblox::DHCP::FilterRule::MAC->new(
       filter_name   => "filter1",
       permission    => "grant",
 );

 #Add MAC Address Filter Rule to the DHCP Range object.
 my $response = $dhcp_range->filters([$mac_filter_rule1]);

METHODS

This section describes all the methods that can be used to set and retrieve the attribute values of a DHCP MAC Address Filter Rule object.

filter_name( )

Use this method to set or retrieve the filter_name of a DHCP MAC Address Filter Rule object.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

Name of the DHCP MAC Address filter. Maximum length up to 1024 bytes is supported.

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example

 #Get filter_name
 my $filter_name = $mac_filter_rule->filter_name();
 #Modify filter_name
 $mac_filter_rule->filter_name("filter2");

permission( )

Use this method to set or retrieve the permission of a DHCP MAC Address Filter Rule object.

Permission indicates whether members of this MAC address filter are allowed or denied an IP address from the defined DHCP range.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

Permission value can be either "grant" or "deny".

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example

 #Get permission
 my $permission = $mac_filter_rule->permission();
 #Modify permission
 $mac_filter_rule->permission("deny");

SAMPLE CODE

The following sample code demonstrates different functions that can be applied to an object such as modify. Also, this sample includes error handling for the operations.

#Preparation prior to a DHCP MAC Address Filter Rule object insertion

 #PROGRAM STARTS: Include all the modules that will be used
 use strict;
 use Infoblox;

 #Create a session to the Infoblox appliance

 my $session = Infoblox::Session->new(
                master   => "192.168.1.2", #appliance host ip
                username => "admin",       #appliance user login
                password => "infoblox"     #appliance password
 );

 unless ($session) {
        die("Construct session failed: ",
                Infoblox::status_code() . ":" . Infoblox::status_detail());
 }
 print "Session created successfully\n";

 #Create the Network object
 my $network = Infoblox::DHCP::Network->new(
     network => "10.0.0.0/8",
     comment => "add network",
 );
 unless($network) {
        die("Construct Network object failed: ",
             Infoblox::status_code() . ":" . Infoblox::status_detail());
 }
 print "Network object created successfully\n";

 #Add the Network object into the Infoblox appliance through a session
 $session->add($network)
     or die("Add Network object failed: ",
             $session->status_code() . ":" . $session->status_detail());
 print "Network object added to Infoblox appliance successfully\n";

 #Construct a DHCP MAC Address Filter object
 my $mac_filter = Infoblox::DHCP::Filter::MAC->new(
        name => "filter1",
 );

 unless ( $mac_filter ) {
        die("Construct MAC Address Filter failed: ",
                Infoblox::status_code() . ":" . Infoblox::status_detail() );
 }
 print "MAC Address Filter object created successfully\n";

 #Add the MAC Address Filter to the Infoblox appliance through a session
 $session->add($mac_filter)
     or die("Add MAC Address Filter object failed: ",
             $session->status_code() . ":" . $session->status_detail());
 print "MAC Address Filter object added to Infoblox appliance successfully\n";

#Create a DHCP MAC Address Filter Rule object

 #Construct a DHCP MAC Address Filter Rule object
 my $mac_filter_rule1 = Infoblox::DHCP::FilterRule::MAC->new(
       filter_name   => "filter1",
       permission    => "grant",
 );

 unless ( $mac_filter_rule1 ) {
        die("Construct MAC Address Filter Rule failed: ",
                Infoblox::status_code() . ":" . Infoblox::status_detail() );
 }
 print "MAC Address Filter Rule object created successfully\n";

 #Create the DHCP Range object with this MAC Address Filter Rule.
 my $dhcp_range = Infoblox::DHCP::Range->new(
         end_addr   => "10.0.0.10",
         network    => "10.0.0.0/8",
         start_addr => "10.0.0.1",
         filters    => [ $mac_filter_rule1 ],
 );
 unless($dhcp_range) {
        die("Construct DHCP Range object failed: ",
             Infoblox::status_code() . ":" . Infoblox::status_detail());
 }
 print "DHCP Range object created successfully\n";

 #Add the DHCP Range object into the Infoblox appliance through a session
 $session->add($dhcp_range)
     or die("Add DHCP Range object failed: ",
             $session->status_code() . ":" . $session->status_detail());
 print "DHCP Range object added to Infoblox appliance successfully\n";

#Get and modify a MAC Address Filter Rule object

 #Get MAC Address Filter Rule object from the DHCP Range object through session
 my @retrieved_objs = $session->get(
     object      => "Infoblox::DHCP::Range",
     start_addr  => "10.0.0.1",
 );

 my $object = $retrieved_objs[0];
 my $filter = $object->filters();

 my @filters = @{$filter};

 my $mac_filterrule = $filters[0];

 #Modify one of the attributes of the obtained MAC Address Filter Rule object
 $mac_filterrule->permission("deny");
 $object->filters([$mac_filterrule]);

 #Apply the changes
 $session->modify($object)
     or die("Modify MAC Address Filter Rule object failed: ",
            $session->status_code() . ":" . $session->status_detail());
 print "MAC Address Filter Rule object modified and added to the DHCP Range object successfully \n";

#Remove a MAC Address Filter Rule object

 $object->filters([]);

 my $response = $session->modify($object);
 unless($response) {
        die("Remove MAC Address Filter Rule failed: ",
                session->status_code() . ":" . session->status_detail() );
 }
 print "MAC Address Filter Rule object removed successfully \n";

 #Submit the network object for removal
 $session->remove($network)
     or die("Remove Network object failed: ",
         $session->status_code() . ":" . $session->status_detail());
 print "Network object removed successfully \n";

 #Submit the mac address filter object for removal
 $session->remove($mac_filter)
     or die("Remove MAC Address Filter object failed: ",
         $session->status_code() . ":" . $session->status_detail());
 print "MAC Address Filter object removed successfully \n";

 ####PROGRAM ENDS####

AUTHOR

Infoblox Inc. http://www.infoblox.com/