Class: IControl::System::Failover

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/system/failover.rb,
lib/icontrol/system.rb

Overview

The Failover interface enables you to manipulate a device's fail-over states. For example, you can get the state, active or standby, in which a device is running in a redundant configuration. You can also switch a device's state from active to standby.

Defined Under Namespace

Classes: FailoverMode, FailoverModeSequence, FailoverState, FailoverStateSequence

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

#failover_modeFailoverMode

Gets the current fail-over mode that the device is running in.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.


22
23
24
# File 'lib/icontrol/system/failover.rb', line 22

def failover_mode
  super
end

#failover_stateFailoverState

Gets the current fail-over state that the device is running in.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.


33
34
35
# File 'lib/icontrol/system/failover.rb', line 33

def failover_state
  super
end

#is_redundantboolean

Checks to see if this device is part of a redundant pair.

Returns:

  • (boolean)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.


65
66
67
# File 'lib/icontrol/system/failover.rb', line 65

def is_redundant
  super
end

#peer_addressString

Gets the peer IP address(es) in a redundant pair. There will be a primary address and possibly a secondary address. The primary will be the first entry in the returned list.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.


46
47
48
# File 'lib/icontrol/system/failover.rb', line 46

def peer_address
  super
end

#set_failbackObject

Restores an active-active device configuration after a failure. You can only use this command after the DB key "Failover.ManFailBack“ has been created, and set to a value of "enable”.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.


77
78
79
# File 'lib/icontrol/system/failover.rb', line 77

def set_failback
  super
end

#set_offlineObject

Sets the device to "forced offline“ state.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.


87
88
89
# File 'lib/icontrol/system/failover.rb', line 87

def set_offline
  super
end

#set_offline_releaseObject

Sets the device to release the "forced offline“ state.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.


97
98
99
# File 'lib/icontrol/system/failover.rb', line 97

def set_offline_release
  super
end

#set_standbyObject

Sets the device to standby mode.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.


107
108
109
# File 'lib/icontrol/system/failover.rb', line 107

def set_standby
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)

54
55
56
# File 'lib/icontrol/system/failover.rb', line 54

def version
  super
end