Infoblox::Grid::ObjectsChangesTrackingSetting - the object changes tracking setting.


NAME

Infoblox::Grid::ObjectsChangesTrackingSetting - the object changes tracking setting.


DESCRIPTION

The object changes tracking setting object is used to display the object changes state and to enable or disable the object changes tracking feature.


CONSTRUCTOR

 my $object_changes = Infoblox::Grid::ObjectsChangesTrackingSetting->new(
     enable => 'true' | 'false', #Optional / Default is 'false'
 );


MODULE METHODS

+The following functions can be applied to an object changes tracking setting object.

Infoblox::Grid->objects_changes_tracking_setting( )

Use this function to specify the object changes tracking settings for the Grid. See Infoblox::Grid/objects_changes_tracking_setting() for parameters and return values.

Example
 #Get objects_changes_tracking_setting value
 my $value = $object->objects_changes_tracking_setting();
 #Construct objects_changes_tracking_setting value
 my $objects_changes_tracking_setting = Infoblox::Grid::ObjectsChangesTrackingSetting->new(
     enable => 'true',
 );
 #Modify objects_changes_tracking_setting value
 $object->objects_changes_tracking_setting($objects_changes_tracking_setting);


METHODS

This section describes all the methods that you can use to set and retrieve the attribute values of an object changes tracking setting object.

enable( )

Use this method to set or retrieve the flag that indicates whether the object changes tracking feature 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 object changes tracking feature 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 value
 my $value = $object->enable();
 #Modify enable value
 $object->enable('true');

enable_completion( )

Use this method to retrieve the object changes tracking completion percentage. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The valid return value is an unsigned integer between 0 and 100.

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

max_objs_to_track( )

Use this method to set or retrieve the maximum number of objects retained for change tracking.

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

max_time_to_track( )

Use this method to set or retrieve the maximum time period (in seconds) to track the deleted object changes.

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 that represents time period (in seconds).

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

state( )

Use this method to retrieve the object changes tracking state. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The valid values are 'ENABLING', 'ENABLED', 'DISABLED' and 'ENABLING_ERROR'.

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


AUTHOR

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


SEE ALSO

Infoblox::Grid, Infoblox::Grid/objects_changes_tracking_setting()


COPYRIGHT

Copyright (c) 2017 Infoblox Inc.