Infoblox::Grid::ServiceRestart::Status - A Grid Service Restart Status object.


NAME

Infoblox::Grid::ServiceRestart::Status - A Grid Service Restart Status object.


DESCRIPTION

The Grid Service Restart Status object provides information and statistics about restart service routine of the Grid or Restart Service Group.


SESSION METHODS

This section describes all the methods in a Session module that you can apply to a Grid Service Restart Status 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:
 parent  - Optional. A Grid Service Restart Group or Grid object.
 grouped - Optional. A grouping type of the status which can be either 'GRID' or 'GROUP'.
Example
 my @retrieved_objs = $session->get(
     object  => 'Infoblox::Grid::ServiceRestart::Status',
     parent  => $test_group,
     grouped => 'GROUP',
 );

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 search for a specific object:
 parent  - Optional. A Grid Service Restart Group or Grid object.
 grouped - Optional. A grouping type of the status which can be either 'GRID' or 'GROUP'.
Example
 my @retrieved_objs = $session->get(
     object  => 'Infoblox::Grid::ServiceRestart::Status',
     parent  => $test_group,
     grouped => 'GROUP',
 );


MODULE METHODS

The following functions are available to apply to a Grid Service Restart Status object.

Infoblox::Grid::ServiceRestart::Group->status( )

Use this method to retrieve the Grid Service Restart restart status. This is a read-only attribute. See Infoblox::Grid::ServiceRestart::Group->status() for parameters and return values.

Example
 #Get status
 my $status = $svcrst_group->status();

Infoblox::Grid->restart_status( )

Use this method to retrieve the Grid restart status. This is a read-only attribute. See Infoblox::Grid->restart_status() for parameters and return values.

Example
 #Get status
 my $status = $grid->restart_status();


METHODS

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

failures( )

Use this method to retrieve the number of failed service restart requests. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns attribute value.

Example
 #Get failures
 my $failures = $svcrst_status->failures();

finished( )

Use this method to retrieve the number of completed service restart requests. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns attribute value.

Example
 #Get finished
 my $finished = $svcrst_status->finished();

parent( )

Use this method to retrieve the Grid or Grid Service Restart Group objects. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The valid return value can be either Infoblox::Grid or Infoblox::Grid::ServiceRestart::Group object.

Example
 #Get group
 my $group = $svcrst_status->group();

grouped( )

Use this method to retrieve the grouping type of the status which can be either 'GRID' or 'GROUP'. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns attribute value.

Example
 #Get failures
 my $failures = $svcrst_status->failures();

needed_restart( )

Use this method to retrieve the number of created but unprocessed restart requests. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns attribute value.

Example
 #Get no_restart
 my $needed_restart = $svcrst_status->needed_restart();

no_restart( )

Use this method to retrieve the number of service restarts that are not required. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns attribute value.

Example
 #Get no_restart
 my $no_restart = $svcrst_status->no_restart();

pending( )

Use this method to retrieve the number of pending service restart requests. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns attribute value.

Example
 #Get pending
 my $pending = $svcrst_status->pending();

pending_restart( )

Use this method to retrieve the number of required force restart requests that are still pending. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns attribute value.

Example
 #Get pending_restart
 my $pending_restart = $svcrst_status->pending_restart();

processing( )

Use this method to retrieve the number of pending restart requests that are not required and not forced. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns attribute value.

Example
 #Get processing
 my $processing = $svcrst_status->processing();

restarting( )

Use this method to retrieve the number of restarting services. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns attribute value.

Example
 #Get restarting
 my $restarting = $svcrst_status->restarting();

success( )

Use this method to retrieve the number of successful service restart requests. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns attribute value.

Example
 #Get success
 my $success = $svcrst_status->success();

timeouts( )

Use this method to retrieve the number of timeouts for service restart requests. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns attribute value.

Example
 #Get timeouts
 my $timeouts = $svcrst_status->timeouts();


AUTHOR

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


SEE ALSO

Infoblox::Session, Infoblox::Session->get(), Infoblox::Session->search(), Infoblox::Grid::ServiceRestart::Group, Infoblox::Grid::ServiceRestart::Group->status(), Infoblox::Grid, Infoblox::Grid->restart_status().


COPYRIGHT

Copyright (c) 2017 Infoblox Inc.