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

• NAME
• DESCRIPTION
• SESSION METHODS
• Infoblox::Session->get( )
• Infoblox::Session->search( )
• MODULE METHODS
• Infoblox::Grid::ServiceRestart::Group->requests( )
• METHODS
• error( )
• forced( )
• group( )
• last_updated_time( )
• member( )
• needed( )
• order( )
• result( )
• service( )
• state( )
• AUTHOR
• SEE ALSO
• COPYRIGHT

NAME

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

DESCRIPTION

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

SESSION METHODS

This section describes all the methods in a Session module that you can apply to a Grid Service Restart Request 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:

 group  - Optional. A Grid Service Restart Group object.
 member - Optional. A Grid Member name or object.

Example

 my @retrieved_objs = $session->get(
     object => 'Infoblox::Grid::ServiceRestart::Request',
     group  => $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:

 group  - A Grid Service Restart Group object.
 member - A Grid Member name or object.

Example

 my @retrieved_objs = $session->search(
     object => 'Infoblox::Grid::ServiceRestart::Request',
     group  => $group,
 );

MODULE METHODS

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

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

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

Example

 #Get requests
 my $requests = $svcrst_group->requests();

METHODS

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

error( )

Use this method to retrieve error messages for failed restart requests. 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 error
 my $error = $svcrst_request->error();

forced( )

Use this method to retrieve the flag that indicates whether this is force restart request or not. 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 forced
 my $forced = $svcrst_request->forced();

group( )

Use this method to retrieve the Grid Service Restart Group object that is associated with the request. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The valid return value is an Infoblox::Grid::ServiceRestart::Group object.

Example

 #Get group
 my $group = $svcrst_request->group();

last_updated_time( )

Use this method to retrieve the time when the request status has changed. This is a read-only attribute.

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_updated_time
 my $last_updated_time = $svcrst_request->last_updated_time();

member( )

Use this method to retrieve the Grid Member name for the restart. 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 member
 my $member = $svcrst_request->member();

needed( )

Use this method to retrieve the value that indicates whether a restart is required or not. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The valid return values are 'UNKNOWN', 'CHECKING', 'YES', 'NO' and 'FAILURE'.

Example

 #Get needed
 my $needed = $svcrst_request->needed();

order( )

Use this method to retrieve the restart order for the Grid Service Restart Request. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns attribute value.

Example

 #Get order
 my $order = $svcrst_request->order();

result( )

Use this method to retrieve the result of a service restart for a particular Grid Service Restart Request. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The valid return values are 'SUCCESS', 'TIMEOUT', 'FAILURE' and 'NORESTART'.

Example

 #Get result
 my $result = $svcrst_request->result();

service( )

Use this method to retrieve the service to restart for a particular Grid Service Restart Request. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The valid return values are 'DNS', 'DHCP', 'DHCPV4' and 'DHCPV6'.

Example

 #Get service
 my $service = $svcrst_request->service();

state( )

Use this method to retrieve the state of a particular Grid Service Restart Request. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The valid return values are 'NEW', 'QUEUED', 'PROCESSING' and 'FINISHED'.

Example

 #Get state
 my $state = $svcrst_request->state();

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->requests().

COPYRIGHT

Copyright (c) 2017 Infoblox Inc.