Infoblox::Grid::ThreatProtection::Ruleset - A Grid Threat Protection Ruleset object.

NAME
DESCRIPTION
SESSION METHODS

Infoblox::Session->get( )
Infoblox::Session->search( )
Infoblox::Session->modify( )
Infoblox::Session->remove( )

METHODS

add_type( )
added_time( )
comment( )
do_not_delete( )
is_factory_reset_enabled( )
used_by( )
version( )

AUTHOR
SEE ALSO
COPYRIGHT

NAME

Infoblox::Grid::ThreatProtection::Ruleset - A Grid Threat Protection Ruleset object.

DESCRIPTION

This object represents the Grid Threat Protection ruleset.

SESSION METHODS

This section describes all the methods in an Infoblox::Session module that you can apply to a Grid ruleset object.

Infoblox::Session->get( )

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

Example

 my @retrieved_objs = $session->get(
     'object' => 'Infoblox::Grid::ThreatProtection::Ruleset',
 );

Infoblox::Session->search( )

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

Example

 my @retrieved_objs = $session->search(
     'object' => 'Infoblox::Grid::ThreatProtection::Ruleset',
 );

Infoblox::Session->modify( )

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

If you have applied an access control list to an object, you must restart services after you update the access control list for the changes to take effect. See Infoblox::Session->restart() method.

Example

 # Use this method to modify comments for the Grid member.
 $ruleset->comment("This is modified object");
 # Submit modification
 my $response = $session->modify( $ruleset );

Infoblox::Session->remove( )

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

To remove a specific object, first use get() or search() to retrieve the specific object, and then submit this object for removal.

Example

 # Submit for removal
 my $response = $session->remove( $desired_ruleset );

METHODS

This section describes all the methods that you can use to set or retrieve the attribute values of the struct.

add_type( )

Use this method to retrieve how the ruleset was added. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value, which is either "AUTOMATIC" or "MANUAL".

Example

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

added_time( )

Use this method to retrieve the time when the ruleset was added. This is a read-only attribute.

Parameter

None

Returns

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

Example

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

comment( )

Use this method to set or retrieve a descriptive comment.

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

Parameter

Desired comment in string format with a maximum of 256 bytes.

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 comment
 my $comment = $object->comment();
 #Modify comment
 $object->comment("Modified comment");

do_not_delete( )

Use this method to set or retrieve the do_not_delete attribute of the ruleset. If set to "true", the ruleset will not be deleted during a ruleset upgrade.

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

Parameter

None

Returns

The method returns the attribute value, which is "true" or "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 do_not_delete from the ruleset
 my $do_not_delete = $object->do_not_delete();
 #Modify do_not_delete
 $object->do_not_delete("true");

is_factory_reset_enabled( )

Use this method to retrieve the flag that indicates whether the factory reset of this object is enabled or disabled. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example

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

used_by( )

Use this method to retrieve the users of the ruleset. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value, which is a list of strings.

Example

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

version( )

Use this method to retrieve the ruleset version. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example

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

AUTHOR

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