Infoblox::Grid::DNS::ScavengingTask - A DNS scavenging task object.

NAME
DESCRIPTION
SESSION METHODS

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

METHODS

action( )
associated_object( )
end_time( )
processed_records( )
reclaimable_records( )
reclaimed_records( )
start_time( )
status( )

AUTHOR
SEE ALSO
COPYRIGHT

NAME

Infoblox::Grid::DNS::ScavengingTask - A DNS scavenging task object.

DESCRIPTION

The DNS scavenging task object provides information on scavenging process state. This is a read-only object.

The object is created as a result of Infoblox::Session->run_scavenging() function call and cannot be added or removed manually.

SESSION METHODS

This section describes all the methods in the Infoblox::Session module that you can apply to a DNS scavenging task 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 Reference

 Apply the following attribute to get a specific object:
     associated_object - Optional. The DNS object associated with scavenging process.
     action            - Optional. The scavenging action.
     status            - Optional. The scavenging status.

Example

 my @retrieved_objs = $session->get(
     object => 'Infoblox::Grid::DNS::ScavengingTask',
     action => 'ANALYZE',
 );

Infoblox::Session->search( )

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

Key Reference

 Apply the following attribute to get a specific object:
     associated_object - Optional. The DNS object associated with scavenging process.
     action            - Optional. The scavenging action.
     status            - Optional. The scavenging status.

Example

 my @retrieved_objs = $session->search(
     object => 'Infoblox::Grid::DNS::ScavengingTask',
     action => 'ANALYZE',
 );

METHODS

This section describes all the methods that you can use to retrieve the attribute values of a DNS scavenging task object.

action( )

Use this method to retrieve the scavenging action. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The valid return values are 'ANALYZE', 'RECLAIM', 'ANALYZE_RECLAIM' and 'RESET'.

Example

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

associated_object( )

Use this method to retrieve the object associated with the scavenging task. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The valid return values are Infoblox::Grid::DNS, Infoblox::DNS::View and Infoblox::DNS::Zone.

Example

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

end_time( )

Use this method to retrieve the end time for the scavenging task. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

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

Example

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

processed_records( )

Use this method to retrieve the number of resource records being processed during the scavenging process. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns the attribute value.

Example

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

reclaimable_records( )

Use this method to retrieve the number of scavenged resource records during the scavenging process. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns the attribute value.

Example

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

reclaimed_records( )

Use this method to retrieve the number of reclaimed during the scavenging process resource records. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns the attribute value.

Example

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

start_time( )

Use this method to retrieve the start time for the scavenging process. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

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

Example

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

status( )

Use this method to retrieve the scavenging process status. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The valid return values are 'CREATED', 'RUNNING'. 'COMPLETED' and 'ERROR'.

Example

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

AUTHOR

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