Infoblox::Grid::ThreatAnalytics - Grid Threat Analytics object.


NAME

Infoblox::Grid::ThreatAnalytics - Grid Threat Analytics object.


DESCRIPTION

The object provides information about Grid Threat Analytics settings.


SESSION METHODS

The following functions can be applied to a Infoblox::Grid::ThreatAnalytics 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 Grid Threat Analytics object
  object - Required. It must be set to "Infoblox::Grid::ThreatAnalytics".
Example
 my @retrieved_objs = $session->get(
     'object' => 'Infoblox::Grid::ThreatAnalytics',
 );

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 some of the attributes of the retrieved_objs object.
 $retrieved_objs->dns_tunnel_black_list_rpz_zones([$rpz]);
 # Submit modification
 my $response = $session->modify($retrieved_objs);


METHODS

This section describes all the methods that you can use to configure and retrieve values of the Grid Threat Analytics object.

current_moduleset( )

Use this method to set or retrieve the current threat analytics model set

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::ThreatAnalytics::ModuleSet 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 $current_moduleset = $obj->current_moduleset();
 #Modify attribute value
 $obj->current_moduleset($current_moduleset);

dns_tunnel_black_list_rpz_zones( )

Use this method to set or retrieve the list of Response Policy Zones for DNS tunnelling requests.

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

Parameter

The valid value is an array reference that contains Infoblox::DNS::Zone 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 $rpz_zones = $obj->dns_tunnel_black_list_rpz_zones();
 #Modify attribute value
 $obj->dns_tunnel_black_list_rpz_zones([$rpz_zone]);

download_threat_analytics_moduleset_update( )

Use this method to download and install the latest threar analytics module set update, available from the Infoblox threat analytics download server.

Key Reference

None

Returns

The method returns 1 when the operation succeeds, and 0 when the operation fails.

Example
 my $res = $obj->download_threat_analytics_moduleset_update();

enable_auto_download( )

Use this method to set or retrieve the flag that indicates whether the automatic threat analytics module set download is enabled or disabled.

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

Parameter

Specify 'true' to enable the automatic download of the threat analytics module set 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 enable_auto_download value
 my $enable_auto_download = $obj->enable_auto_download();
 #Modify enable_auto_download value
 $obj->enable_auto_download('false');

enable_scheduled_download( )

Use this method to set or retrieve the flag that indicates whether the scheduled download of the threat analytics module set is enabled or disabled.

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

Parameter

Specify 'true' to enable the scheduled download of the threat analytics module set 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 enable_scheduled_download value
 my $enable_scheduled_download = $obj->enable_scheduled_download();
 #Modify enable_scheduled_download value
 $obj->enable_scheduled_download('false');

last_checked_for_update( )

Use this method to retrieve the last checked for update time for the analytics module set.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns the number of seconds that have elapsed since January 1st, 1970 UTC.

Example
 #Get last_checked_for_update value
 my $last_checked_for_update = $obj->last_checked_for_update();

last_module_update_time( )

Use this method to retrieve the last update time for the threat analytics module set.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns the number of seconds that have elapsed since January 1st, 1970 UTC.

Example
 #Get last_module_update_time value
 my $last_module_update_time = $obj->last_module_update_time();

last_module_update_version( )

Use this method to retrieve the version number of the last updated threat analytics module set.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns the attribute value.

Example
 #Get last_module_update_version value
 my $last_module_update_version = $obj->last_module_update_version();

last_whitelist_update_time( )

Use this method to retrieve the last update time for the threat analytics whitelist.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns the number of seconds that have elapsed since January 1st, 1970 UTC.

Example
 #Get last_whitelist_update_time value
 my $last_whitelist_update_time = $obj->last_whitelist_update_time();

last_whitelist_update_version( )

Use this method to retrieve the version number of the last updated threat analytics whitelist.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns the attribute value.

Example
 #Get last_whitelist_update_version value
 my $last_whitelist_update_version = $obj->last_whitelist_update_version();

module_update_policy( )

Use this method to set or retrieve the updated policy for the threat analytics module set.

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

Parameter

The valid values are 'AUTOMATIC' and 'MANUAL'.

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 module_update_policy value
 my $module_update_policy = $obj->module_update_policy();
 #Modify module_update_policy value
 $obj->module_update_policy('MANUAL');

scheduled_download( )

Use this method to set or retrieve the schedule settings for the threat analytics module set download.

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::ScheduleSetting 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 scheduled_download value
 my $scheduled_download = $obj->scheduled_download();
 #Modify scheduled_download value
 $obj->scheduled_download($sched_download);

test_threat_analytics_server_connectivity( )

Use this method ot test the connectivity with the Infoblox threat analytics download server.

Key Reference

None

Returns

The method returns an Infoblox::Grid::TestResult object if connectivity test occurs and 0 otherwise.

Example
 my $res = $obj->test_threat_analytics_server_connectivity();

update_threat_analytics_moduleset( )

Use this method to update the threat analytics module set

Note that to update the threat analytics module set, the threat analytics update file should be uploaded via Infoblox::Session->import_data() method

Key Reference
 mode - Optional. Specify 'TEST' to check uploaded module set or 'EXECUTE' to apply updates to the current module set. The default value is 'EXECUTE'.
Returns

The method returns 1 when the operation succeeds, and 0 when the operation fails.

Example
 my $res = $obj->update_threat_analytics_moduleset(mode => 'TEST');


AUTHOR

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


SEE ALSO

Infoblox::Session, Infoblox::Session->get(), Infoblox::Session->modify(), Infoblox::DNS::Zone, Infoblox::Grid::ScheduleSetting, Infoblox::Grid::ThreatAnalytics::ModuleSet


COPYRIGHT

Copyright (c) 2017 Infoblox Inc.