Class: IControl::System::Cluster

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

Overview

The Cluster interface enables you to work with the definitions and attributes in a clustered device.

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

#cluster_enabled_stateEnabledState

Gets the cluster enabled states.

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



17
18
19
# File 'lib/icontrol/system/cluster.rb', line 17

def cluster_enabled_state
  super
end

#cluster_ha_stateHAState

Gets the cluster high-availability states.

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



29
30
31
# File 'lib/icontrol/system/cluster.rb', line 29

def cluster_ha_state
  super
end

#current_primary_slotlong

Gets the primary slot numbers.

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



41
42
43
# File 'lib/icontrol/system/cluster.rb', line 41

def current_primary_slot
  super
end

#is_clustered_environmentboolean

Checks to see whether the system is a clustered environment.

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



181
182
183
# File 'lib/icontrol/system/cluster.rb', line 181

def is_clustered_environment
  super
end

#listString

Gets a list of the cluster names.

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



53
54
55
# File 'lib/icontrol/system/cluster.rb', line 53

def list
  super
end

#member_enabled_state(opts) ⇒ EnabledState[]

Gets the cluster member enabled states.

Options Hash (opts):

  • :slot_ids (long[])

    The list of lists of slot ids.

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



67
68
69
70
# File 'lib/icontrol/system/cluster.rb', line 67

def member_enabled_state(opts)
  opts = check_params(opts,[:slot_ids])
  super(opts)
end

#member_ha_state(opts) ⇒ HAState[]

Gets the cluster member high-availability states.

Options Hash (opts):

  • :slot_ids (long[])

    The list of lists of slot ids.

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



82
83
84
85
# File 'lib/icontrol/system/cluster.rb', line 82

def member_ha_state(opts)
  opts = check_params(opts,[:slot_ids])
  super(opts)
end

#member_licensed_state(opts) ⇒ EnabledState[]

Gets the cluster member licensed states.

Options Hash (opts):

  • :slot_ids (long[])

    The list of lists of slot ids.

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



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

def member_licensed_state(opts)
  opts = check_params(opts,[:slot_ids])
  super(opts)
end

#member_priming_state(opts) ⇒ EnabledState[]

Gets the cluster member priming states.

Options Hash (opts):

  • :slot_ids (long[])

    The list of lists of slot ids.

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



112
113
114
115
# File 'lib/icontrol/system/cluster.rb', line 112

def member_priming_state(opts)
  opts = check_params(opts,[:slot_ids])
  super(opts)
end

#min_up_memberslong

Gets the minimum up members values.

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



125
126
127
# File 'lib/icontrol/system/cluster.rb', line 125

def min_up_members
  super
end

#min_up_members_actionHAAction

Gets the cluster minimum up members actions.

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



137
138
139
# File 'lib/icontrol/system/cluster.rb', line 137

def min_up_members_action
  super
end

#min_up_members_stateEnabledState

Gets the cluster minimum up members enabled states.

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



149
150
151
# File 'lib/icontrol/system/cluster.rb', line 149

def min_up_members_state
  super
end

#set_cluster_enabled_state(opts) ⇒ Object

Sets the cluster enabled states.

Options Hash (opts):

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



194
195
196
197
# File 'lib/icontrol/system/cluster.rb', line 194

def set_cluster_enabled_state(opts)
  opts = check_params(opts,[:cluster_states])
  super(opts)
end

#set_current_primary_slot(opts) ⇒ Object

Currently this is not implemented.

Options Hash (opts):

  • :primary_slots (long)

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



208
209
210
211
# File 'lib/icontrol/system/cluster.rb', line 208

def set_current_primary_slot(opts)
  opts = check_params(opts,[:primary_slots])
  super(opts)
end

#set_member_enabled_state(opts) ⇒ Object

Sets the cluster member enabled states.

Options Hash (opts):

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



223
224
225
226
# File 'lib/icontrol/system/cluster.rb', line 223

def set_member_enabled_state(opts)
  opts = check_params(opts,[:slot_ids,:member_states])
  super(opts)
end

#set_member_priming_state(opts) ⇒ Object

Sets the cluster member priming states.

Options Hash (opts):

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



238
239
240
241
# File 'lib/icontrol/system/cluster.rb', line 238

def set_member_priming_state(opts)
  opts = check_params(opts,[:slot_ids,:priming_states])
  super(opts)
end

#set_min_up_members(opts) ⇒ Object

Sets the minimum up members values.

Options Hash (opts):

  • :min_up_members (long)

    The list of minimum up members values.

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



252
253
254
255
# File 'lib/icontrol/system/cluster.rb', line 252

def set_min_up_members(opts)
  opts = check_params(opts,[:min_up_members])
  super(opts)
end

#set_min_up_members_action(opts) ⇒ Object

Sets the cluster minimum up members actions.

Options Hash (opts):

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



266
267
268
269
# File 'lib/icontrol/system/cluster.rb', line 266

def set_min_up_members_action(opts)
  opts = check_params(opts,[:min_up_actions])
  super(opts)
end

#set_min_up_members_state(opts) ⇒ Object

Sets the cluster minimum up members enabled states.

Options Hash (opts):

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



280
281
282
283
# File 'lib/icontrol/system/cluster.rb', line 280

def set_min_up_members_state(opts)
  opts = check_params(opts,[:min_up_states])
  super(opts)
end

#slot_idlong[]

Get a list of list of slot ids (the size of each list is the number of slots).

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.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



161
162
163
# File 'lib/icontrol/system/cluster.rb', line 161

def slot_id
  super
end

#versionString

Gets the version information for this interface.



169
170
171
# File 'lib/icontrol/system/cluster.rb', line 169

def version
  super
end