Infoblox::Grid::UpgradeStatus - Information about the Grid's upgrade status.

• NAME
• DESCRIPTION
• CONSTRUCTOR
• SESSION METHODS
• Infoblox::Session->get( )
• METHODS
• allow_distribution( )
• allow_upgrade( )
• allow_upgrade_cancel( )
• allow_upgrade_pause( )
• allow_upgrade_resume( )
• allow_upgrade_scheduling( )
• allow_upgrade_test( )
• allow_upload( )
• distribution_schedule_active( )
• grid_state( )
• group_state( )
• message( )
• status_time( )
• upgrade_schedule_active( )
• upgrade_state( )
• upgrade_test_status( )
• AUTHOR
• SEE ALSO
• COPYRIGHT

NAME

Infoblox::Grid::UpgradeStatus - Information about the Grid's upgrade status.

DESCRIPTION

The Upgrade Status object is used to view the upgrade status of an Infoblox Grid.

CONSTRUCTOR

The Infoblox::Grid::UpgradeStatus object is automatically generated. It does not require manual construction.

SESSION METHODS

This section describes all the methods in an Infoblox::Session that can be applied to an Upgrade Status object.

Infoblox::Session->get( )

Use this method to retrieve the existing objects from an Infoblox appliance. See Infoblox::Session->get() for parameters and return values.

Example

  my @statistics = $session->get(object => "Infoblox::Grid::UpgradeStatus");

METHODS

This section describes all the methods that can be used to retrieve the attribute values of an Upgrade Status object.

allow_distribution( )

Use this method to determine if distribution is allowed for the Grid.

Parameter

none

Returns

The method returns the attribute value. Valid values are "true" or "false".

Example

 #Get allow_distribution
 my $allow_distribution = $upgstatus->allow_distribution();

allow_upgrade( )

Use this method to determine if upgrade is allowed for the Grid.

Parameter

none

Returns

The method returns the attribute value. Valid values are "true" or "false".

Example

 #Get allow_upgrade
 my $allow_upgrade = $upgstatus->allow_upgrade();

allow_upgrade_cancel( )

Use this method to determine if the Grid is allowed to cancel an upgrade.

Parameter

none

Returns

The method returns the attribute value. Valid values are "true" or "false".

Example

 #Get allow_upgrade_cancel
 my $allow_upgrade_cancel = $upgstatus->allow_upgrade_cancel();

allow_upgrade_pause( )

Use this method to determine if the Grid is allowed to pause an upgrade.

Parameter

none

Returns

The method returns the attribute value. Valid values are "true" or "false".

Example

 #Get allow_upgrade_pause
 my $allow_upgrade_pause = $upgstatus->allow_upgrade_pause();

allow_upgrade_resume( )

Use this method to determine if the Grid is allowed to resume an upgrade.

Parameter

none

Returns

The method returns the attribute value. Valid values are "true" or "false".

Example

 #Get allow_upgrade_resume
 my $allow_upgrade_resume = $upgstatus->allow_upgrade_resume();

allow_upgrade_scheduling( )

Use this method to determine if the Grid is allowed to schedule an upgrade.

Parameter

none

Returns

The method returns the attribute value. Valid values are "true" or "false".

Example

 #Get allow_upgrade_scheduling
 my $allow_upgrade_scheduling = $upgstatus->allow_upgrade_scheduling();

allow_upgrade_test( )

Use this method to determine if the Grid is allowed to test an upgrade.

Parameter

none

Returns

The method returns the attribute value. Valid values are "true" or "false".

Example

 #Get allow_upgrade_test
 my $allow_upgrade_test = $upgstatus->allow_upgrade_test();

allow_upload( )

Use this method to determine if the Grid is allowed to upload a build.

Parameter

none

Returns

The method returns the attribute value. Valid values are "true" or "false".

Example

 #Get allow_upload
 my $allow_upload = $upgstatus->allow_upload();

distribution_schedule_active( )

Use this method to determine if the distribution schedule is active for the Grid.

Parameter

none

Returns

The method returns the attribute value. Valid values are "true" or "false".

Example

 #Get distribution_schedule_active
 my $distribution_schedule_active = $upgstatus->distribution_schedule_active();

grid_state( )

Use this method to retrieve the Grid state.

Parameter

none

Returns

The method returns the attribute value. Valid values are

 "NONE", "DISTRIBUTING_COMPLETE", "DISTRIBUTING_ENDED", "DISTRIBUTING_PAUSED",
 "DISTRIBUTING", "DISTRIBUTING_FAILED", "DEFAULT", "UPGRADING", "REVERT",
 "TEST_UPGRADING", "UPGRADING_COMPLETE", "UPGRADING_FAILED",
 "REVERTING_COMPLETE", "DOWNGRADING_COMPLETE", "UPLOADED",
 "DOWNGRADING_FAILED", "UPGRADING_PAUSED"

Example

 #Get grid_state
 my $grid_state = $upgstatus->grid_state();

group_state( )

Use this method to retrieve the group state.

Parameter

none

Returns

The method returns the attribute value. Valid values are

 "GROUP_NONE", "GROUP_DISTRIBUTING_WAITING", "GROUP_DISTRIBUTING",
 "GROUP_DISTRIBUTING_COMPLETE", "GROUP_UPGRADING_WAITING", "GROUP_UPGRADING",
 "GROUP_UPGRADING_COMPLETE", "GROUP_DISTRIBUTING_FAILED"

Example

 #Get group_state
 my $group_state = $upgstatus->group_state();

message( )

Use this method to retrieve the grid message.

Parameter

none

Returns

The method returns the attribute value.

Example

 #Get message
 my $message = $upgstatus->message();

status_time( )

Use this method to retrieve the status time.

Parameter

none

Returns

The method returns the attribute value.

Example

 #Get status_time
 my $status_time = $upgstatus->status_time();

upgrade_schedule_active( )

Use this method to determine if the upgrade schedule is active.

Parameter

none

Returns

The method returns the attribute value. Valid values are "true" or "false".

Example

 #Get upgrade_schedule_active
 my $upgrade_schedule_active = $upgstatus->upgrade_schedule_active();

upgrade_state( )

Use this method to retrieve the upgrade state of the Grid.

Parameter

none

Returns

The method returns the attribute value. Valid values are "NONE" or "PROGRESSING".

Example

 #Get upgrade_state
 my $upgrade_state = $upgstatus->upgrade_state();

upgrade_test_status( )

Use this method to retrieve the upgrade test status of the Grid.

Parameter

none

Returns

The method returns the attribute value. Valid values are "NONE", "PROGRESSING", "COMPLETED" or "FAILED".

Example

 #Get upgrade_test_status
 my $upgrade_test_status = $upgstatus->upgrade_test_status();

AUTHOR

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

SEE ALSO

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

COPYRIGHT

Copyright (c) 2017 Infoblox Inc.