Infoblox::Grid::Member::ThreatProtection - Member Threat Protection object.


NAME

Infoblox::Grid::Member::ThreatProtection - Member Threat Protection object.


DESCRIPTION

This object provides information about the member Threat protection settings.


SESSION METHODS

The following functions can be applied to a Grid::Member::ThreatProtection object.

Infoblox::Session->get( )

Use this method to retrieve all the matching objects from the Infoblox appliance. See Infoblox::Session->get() for parameters and return values.

Key References
 Apply the following attributes to get a specific Member Threat Protection object.
  grid_member    - Optional. The Grid member name.
  hardware_model - Optional. The Grid member hardware model name.
  hardware_type  - Optional. The Grid member hardware type.
  profile        - Optional. The Threat Protection profile object.
Example
 my @retrieved_objs = $session->get(
     'object'      => 'Infoblox::Grid::Member::ThreatProtection',
     'grid_member' => 'host.com',
 );

Infoblox::Session->modify( )

Use this method to modify an object in the Infoblox appliance. See Infoblox::Session->modify() for parameters and return values.

Example
 # Use this method to modify attributes of an member object.
 $member->enable_service('true');
 $member->override_events_per_second_per_rule('true');
 $member->events_per_second_per_rule('2');
 $member->override_disable_multiple_dns_tcp_request('true');
 $member->disable_multiple_dns_tcp_request('true');
 # Submit modification
 my $response = $session->modify( $member );

Infoblox::Session->search( )

Use this method to retrieve all the matching objects from the Infoblox appliance. See Infoblox::Session->search() for parameters and return values.

Key References
 Apply the following attributes to search a specific Member Threat Protection object.
  grid_member    - Optional. The Grid member name.
  hardware_model - Optional. The Grid member hardware model name (regular expression).
  hardware_type  - Optional. The Grid member hardware type (regular expression).
  profile        - Optional. The Threat Protection profile object.
Example
 my @retrieved_objs = $session->search(
     'object'      => 'Infoblox::Grid::Member::ThreatProtection',
     'grid_member' => 'host.com',
 );


METHODS

This object provides information about the member threat protection settings.

current_ruleset( )

Use this method to set or retrieve the current member ruleset.

Setting this method to a defined value implicitly sets the override_current_ruleset method to "true". Setting the parameter to undefined causes the appliance to use the grid default and automatically resets the override_current_ruleset attribute to "false".

Note that when current_ruleset is set to a defined value and override_dcurrent_ruleset is set to "false", the last operation takes precedence. Thus the sequence $object->current_ruleset($rs); $object->override_current_ruleset("false"); will set override_current_ruleset to "false", and the sequence $object->override_current_ruleset("false"); $object->current_ruleset($rs); will result in override_current_ruleset="true".

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

Parameter

Valid value is an Infoblox::Grid::ThreatProtection::Ruleset object.

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 attribute value
 my $value = $obj->current_ruleset();
 #Modify attribute value
 $obj->current_ruleset($rs);

enable_nat_rules( )

Use this method to enable or disable NAT (Network Address Translation) mapping for threat protection at the member level.

Setting this method to a defined value implicitly sets the override_enable_nat_rules method to "true". Setting the parameter to undefined causes the appliance to use the Grid default and automatically resets the override_enable_nat_rules attribute to "false".

Note that when enable_nat_rules is set to a defined value and override_denable_nat_rules is set to "false", the last operation takes precedence. Thus the sequence $object->enable_nat_rules($nat_rules); $object->override_enable_nat_rules("false"); will set override_enable_nat_rules to "false", and the sequence $object->override_enable_nat_rules("false"); $object->enable_nat_rules($nat_rules); will result in override_enable_nat_rules="true".

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

Paramter

Specify 'true' to enable NAT mapping for threat protection or 'false' to disable it. The default value is 'false.'

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 attribute value
 my $value = $object->enable_nat_rules();
 #Modify attribute value
 $object->enable_nat_rules('true');

enable_service( )

Use this method to enable or disable the Threat protection service on the member.

Parameter

Set the parameter to "true" to enable Threat protection service on the member. Set the parameter to "false" to disable the service.

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 attribute value
 my $value = $object->enable_service();
 # Modify attribute value
 $object->enable_service('true');

events_per_second_per_rule( )

Use this method to set or retrieve the number of events logged per second per rule.

Parameter

The number of events logged per second per rule in string format.

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 attribute value
 my $value = $object->events_per_second_per_rule();
 # Modify attribute value
 $object->events_per_second_per_rule('2');

grid_member( )

Use this method to retrieve a Grid member name. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->grid_member();

hardware_model( )

Use this method to retrieve the hardware model name of the Grid member. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 #Get hardware_model value
 my $value = $object->hardware_model();

hardware_type( )

Use this method to retrieve the type of the Grid member hardware. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 #Get hardware_type value
 my $value = $object->hardware_type();

override_events_per_second_per_rule( )

Use this method to set or retrieve the override flag for the number of events logged per second per rule.

Parameter

Specify "true" to set the override_events_per_second_per_rule flag or "false" to deactivate/unset it. The default value is "false".

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 attribute value
 my $value = $object->override_events_per_second_per_rule();
 # Modify attribute value
 $object->override_events_per_second_per_rule('true');

disable_multiple_dns_tcp_request( )

Use this method to disable multiple BIND responses via TCP connection.

Setting this method to a defined value implicitly sets the override_disable_multiple_dns_tcp_request method to "true". Setting the parameter to undefined causes the appliance to use the Grid default and automatically resets the override_disable_multiple_dns_tcp_request attribute to "false".

Note that when config is set to a defined value and override_disable_multiple_dns_tcp_request is set to "false", the last operation takes precedence. Thus the sequence $object->disable_multiple_dns_tcp_request($value); $object->override_disable_multiple_dns_tcp_request("false"); will set override_disable_multiple_dns_tcp_request to "false", and the sequence $object->override_disable_multiple_dns_tcp_request("false"); $object->disable_multiple_dns_tcp_request($value); will result in override_disable_multiple_dns_tcp_request="true".

Parameter

Set the parameter to "true" to disable multiple TCP requests. Set the parameter to "false" to enable multiple TCP requests.

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 attribute value
 my $value = $object->disable_multiple_dns_tcp_request();
 # Modify attribute value
 $object->disable_multiple_dns_tcp_request('true');

nat_rules( )

Use this method to set or retrieve the list of NAT mapping rules cofigured for the member.

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

Parameter

The valid value is an array of Infoblox::Grid::ThreatProtection::NATRule objects.

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 attribute value
 my $value = $obj->nat_rules();
 #Modify attribute value
 $obj->nat_rules($nat_rules);

override_current_ruleset( )

The override_current_ruleset attribute controls whether the member's current ruleset value is used, instead of the Grid default.

The override_current_ruleset attribute can be specified explicitly. It is also set implicitly when current_ruleset is set to a defined value.

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

Parameter

Specify "true" to set the override_current_ruleset flag or "false" to deactivate/unset it. The default value is "false".

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 override_current_ruleset from the member
 my $override = $object->override_current_ruleset();
 #Modify override_current_ruleset
 $object->override_current_ruleset("true");

override_disable_multiple_dns_tcp_request( )

Use this method to set or retrieve the override flag for disabling multiple BIND responses via TCP connection.

Parameter

Specify "true" to set the override_disable_multiple_dns_tcp_request flag or "false" to unset it. The default value is "false".

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 attribute value
 my $value = $object->override_disable_multiple_dns_tcp_request();
 # Modify attribute value
 $object->override_disable_multiple_dns_tcp_request('true');

override_enable_nat_rules( )

The override_enable_nat_rules attribute controls whether the member's current enable_nat_rules value is used, instead of the Grid default.

The override_enable_nat_rules attribute can be specified explicitly. It is also set implicitly when enable_nat_rules is set to a defined value.

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

Parameter

Specify "true" to set the override_enable_nat_rules flag or "false" to deactivate/unset it. The default value is "false".

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 override_enable_nat_rules from the member
 my $override = $object->override_enable_nat_rules();
 #Modify override_enable_nat_rules
 $object->override_enable_nat_rules("true");

profile( )

Use this method to set or retrieve the Threat Protection profile that is used to group this member.

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

Parameter

The valid value is an Infoblox::Grid::ThreatProtection::Profile object.

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 profile value
 my $value = $object->profile();
 #Modify profile value
 $object->profile($profile);


AUTHOR

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


SEE ALSO

Infoblox::Session, Infoblox::Session->get(), Infoblox::Session->modify(), Infoblox::Session->search(), Infoblox::Grid::ThreatProtection::NATRule, Infoblox::Grid::ThreatProtection::Profile, Infoblox::Grid::ThreatProtection,


COPYRIGHT

Copyright (c) 2017 Infoblox Inc.