Infoblox::Grid::DNS::ResponseRateLimiting - a DNS Response Rate Limiting object.


NAME

Infoblox::Grid::DNS::ResponseRateLimiting - a DNS Response Rate Limiting object.


DESCRIPTION

The DNS Response Rate Limiting object provides information about DNS response rate limiting configuration.


CONSTRUCTOR

 my $response_rate_limiting = Infoblox::Grid::DNS::ResponseRateLimiting->new(
        enable_rrl           => 'true' | 'false', # Optional
        log_only             => 'true' | 'false', # Optional
        responses_per_second => $uint,            # Optional
        window               => $uint,            # Optional
        slip                 => $uint,            # Optional
 );


SESSION METHODS

The object does not support any session methods.


MODULE METHODS

The following functions can be applied to a DNS Response Rate Limiting object.

Infoblox::Grid::DNS->response_rate_limiting( )

+Use this method to set or retrieve DNS response rate limiting settings. See Infoblox::Grid::DNS->response_rate_limiting() for parameters and return values.

Example
 #Get response_rate_limiting value
 my $response_rate_limiting = $grid_dns->response_rate_limiting();
 #Modify bind_check_response_rate_limiting
 $grid_dns->response_rate_limiting($response_rate_limiting);

Infoblox::Grid::Member::DNS->response_rate_limiting( )

Use this method to set or retrieve DNS response rate limiting settings on the member. See Infoblox::Grid::Member::DNS->response_rate_limiting() for parameters and return values.

Example
 #Get response_rate_limiting value
 my $response_rate_limiting = $member_dns->response_rate_limiting();
 #Modify response_rate_limiting
 $member_dns->response_rate_limiting($response_rate_limiting);

Infoblox::DNS::View->response_rate_limiting( )

Use this method to set or retrieve DNS response rate limiting settings for the DNS view. See Infoblox::DNS::View->response_rate_limiting() for parameters and return values.

Example
 #Get response_rate_limiting value
 my $response_rate_limiting = $dns_view->response_rate_limiting();
 #Modify response_rate_limiting
 $dns_view->response_rate_limiting($response_rate_limiting);


METHODS


enable_rrl( )

Use this method to enabel or disable response rate limiting.

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

Parameter

Specify 'true' to enable response rate limiting or 'false' to disable it.

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 enable_rrl value
 my $enable_rrl = $response_rate_limiting->enable_rrl();
 #Modify enable_rrl 
 $response_rate_limiting->enable_rrl('true');


log_only( )

Use this method to enable or disable logging for response rate limiting without dropping any requests.

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

Parameter

Specify 'true' to enable logging for response rate limiting without dropping any requests or 'false' to disable it.

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 log_only value
 my $log_only = $response_rate_limiting->log_only();
 #Modify log_only 
 $response_rate_limiting->log_only('true');


responses_per_second( )

Use this method to set or retrieve the number of responses per client per second.

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

Parameter

The valid value is an unsigned integer.

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 responses_per_second value
 my $responses_per_second = $response_rate_limiting->responses_per_second();
 #Modify responses_per_second 
 $response_rate_limiting->responses_per_second(50);


slip( )

Use this method to set or retrieve the response rate limiting slip.

Note that if a slip does not equal 0, instead of dropping the request, a truncated response is sent to each n-th rate-limited UDP request.

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

Parameter

The valid value is an unsigned integer.

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 slip value
 my $slip = $response_rate_limiting->slip();
 #Modify slip 
 $response_rate_limiting->slip(50);


window( )

Use this method to set or retrieve the time interval in seconds over which responses are tracked.

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

Parameter

The valid value is an unsigned integer.

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 window value
 my $window = $response_rate_limiting->window();
 #Modify window 
 $response_rate_limiting->window(10);


AUTHOR

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


SEE ALSO

Infoblox::Grid::DNS, Infoblox::Grid::DNS->response_rate_limiting(), Infoblox::Grid::Member::DNS, Infoblox::Grid::Member::DNS->response_rate_limiting(), Infoblox::DNS::View->response_rate_limiting()


COPYRIGHT

Copyright (c) 2017 Infoblox Inc.