Infoblox::Grid::ServiceRestart::Group::Schedule - A Grid Service Restart Group Schedule object.


NAME

Infoblox::Grid::ServiceRestart::Group::Schedule - A Grid Service Restart Group Schedule object.


DESCRIPTION

The Grid Service Restart Group Schedule object provides information about restart service schedule settings for Service Restart Group.


CONSTRUCTOR

 my $svcrst_schedule = Infoblox::Grid::ServiceRestart::Group::Schedule->new(
    schedule => $schedule,                                 # Required
    services => $array_of_services,                        # Optional / Default is ['ALL']
    mode     => 'GROUPED' | 'SEQUENTIAL' | 'SIMULTANEOUS', # Optional / Default is 'GROUPED'
    force    => 'true' | 'false',                          # Optional / Default is 'false'
 );


MODULE METHODS

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

Use this method to set or retrieve the Grid Service Restart Group Schedule. See Infoblox::Grid::ServiceRestart::Group->recurring_schedule() for parameters and return values.

Example
 #Get recurring_schedule
 my $recurring_schedule = $svcrst_group->recurring_schedule();
 #Modify recurring_schedule
 $svcrst_group->recurring_schedule($sched);


METHODS

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

services( )

Use this method to set or retrieve the list of services for a scheduled restart for a particular Grid Service Restart Group.

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

Parameter

The valid value is an array which contains following values: 'ALL', 'DNS', 'DHCP', 'DHCPV4', 'DHCPV6'.

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 services
 my $services = $svcrst_schedule->services();
 #Modify services
 $svcrst_schedule->services('DHCP');

mode( )

Use this method to set or retrieve the service restart mode for a scheduled restart for a particular Grid Service Restart Group.

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

Parameter

The valid values are 'GROUPED', 'SEQUENTIAL' and 'SIMULTANEOUS'.

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 mode
 my $mode = $svcrst_schedule->mode();
 #Modify mode
 $svcrst_schedule->mode('SEQUENTIAL');

force( )

Use this method to set or retrieve the flag that indicates whether a forced scheduled restart will be performed for a particular Grid Service Restart Group.

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

Parameter

Specify 'true' to set the flag, and 'false' to unset/deactivate it. The default value is '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 force
 my $force = $svcrst_schedule->force();
 #Modify force
 $svcrst_schedule->force('true');

schedule( )

Use this method to set or retrieve the schedule settings for a particular Grid Service Restart Group.

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

Parameter

The valid value is an Infoblox::Grid::ScheduleSetting object.

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 schedule
 my $schedule = $svcrst_schedule->schedule();
 #Modify schedule
 $svcrst_schedule->schedule($sched);


AUTHOR

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


SEE ALSO

Infoblox::Grid::ServiceRestart::Group, Infoblox::Grid::ServiceRestart::Group->recurring_schedule(), Infoblox::Grid::ScheduleSetting.


COPYRIGHT

Copyright (c) 2017 Infoblox Inc.