Class: IControl::LocalLB::PoolMember

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/local_lb/pool_member.rb,
lib/icontrol/local_lb.rb

Overview

The PoolMember interface enables you to work with the pool members and their settings, and statistics.

Defined Under Namespace

Classes: MemberConnectionLimit, MemberConnectionLimitSequence, MemberConnectionLimitSequenceSequence, MemberDynamicRatio, MemberDynamicRatioSequence, MemberDynamicRatioSequenceSequence, MemberMonitorAssociation, MemberMonitorAssociationRemoval, MemberMonitorAssociationRemovalSequence, MemberMonitorAssociationRemovalSequenceSequence, MemberMonitorAssociationSequence, MemberMonitorAssociationSequenceSequence, MemberMonitorInstanceState, MemberMonitorInstanceStateSequence, MemberMonitorInstanceStateSequenceSequence, MemberMonitorState, MemberMonitorStateSequence, MemberMonitorStateSequenceSequence, MemberMonitorStatus, MemberMonitorStatusSequence, MemberMonitorStatusSequenceSequence, MemberObjectStatus, MemberObjectStatusSequence, MemberObjectStatusSequenceSequence, MemberPriority, MemberPrioritySequence, MemberPrioritySequenceSequence, MemberRatio, MemberRatioSequence, MemberRatioSequenceSequence, MemberSessionState, MemberSessionStateSequence, MemberSessionStateSequenceSequence, MemberSessionStatus, MemberSessionStatusSequence, MemberSessionStatusSequenceSequence, MemberStatisticEntry, MemberStatisticEntrySequence, MemberStatistics, MemberStatisticsSequence

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

- (MemberStatistics) all_statistics

Gets the statistics for all pool members of this pool.

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.



55
56
57
# File 'lib/icontrol/local_lb/pool_member.rb', line 55

def all_statistics
  super
end

- (MemberConnectionLimit[]) connection_limit

Gets the connection limits for all members in this pool.

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.



66
67
68
# File 'lib/icontrol/local_lb/pool_member.rb', line 66

def connection_limit
  super
end

- (MemberDynamicRatio[]) dynamic_ratio

Gets the dynamic ratios for all members of this pool.

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.



77
78
79
# File 'lib/icontrol/local_lb/pool_member.rb', line 77

def dynamic_ratio
  super
end

- (MemberMonitorAssociation[]) monitor_association

Gets the monitor associations used by this pool members, i.e. the monitor rules used by the pool members.

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.



89
90
91
# File 'lib/icontrol/local_lb/pool_member.rb', line 89

def monitor_association
  super
end

- (MemberMonitorInstanceState[]) monitor_instance

Gets the monitor instance information for the pool members in this pool.

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.



100
101
102
# File 'lib/icontrol/local_lb/pool_member.rb', line 100

def monitor_instance
  super
end

- (MemberMonitorStatus[]) monitor_status

Gets the monitor/availability status for all members of this pool.

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.



111
112
113
# File 'lib/icontrol/local_lb/pool_member.rb', line 111

def monitor_status
  super
end

- (MemberObjectStatus[]) object_status

Gets the object statuses for all members of this pool.

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.



122
123
124
# File 'lib/icontrol/local_lb/pool_member.rb', line 122

def object_status
  super
end

- (MemberPriority[]) priority

Gets the priorities for all members in this pool.

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.



133
134
135
# File 'lib/icontrol/local_lb/pool_member.rb', line 133

def priority
  super
end

- (MemberRatio[]) ratio

Gets the ratios for all members in this pool.

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.



144
145
146
# File 'lib/icontrol/local_lb/pool_member.rb', line 144

def ratio
  super
end

- (Object) remove_monitor_association(opts)

Removes the monitor associations for this pool members. Depending on the monitor association removal rule specified, this basically deletes any explicit monitor associations between a pool member and a monitor rule and thus causing the pool member to use the default monitor association of its parent pool, or this will delete any monitor association for the pool members altogether, i.e. this pool members will no longer be monitored.

Parameters:

  • opts (Hash)

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.



206
207
208
209
# File 'lib/icontrol/local_lb/pool_member.rb', line 206

def remove_monitor_association(opts)
  check_params(opts,[:monitor_associations])
  super
end

- (Object) reset_statistics(opts)

Resets the statistics for this set of pool members.

Parameters:

  • opts (Hash)

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.



219
220
221
222
# File 'lib/icontrol/local_lb/pool_member.rb', line 219

def reset_statistics(opts)
  check_params(opts,[:members])
  super
end

- (MemberSessionState[]) session_enabled_state

Note: This function has been deprecated. Please use get_session_status. Gets the session states for all members of this pool.

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.



156
157
158
# File 'lib/icontrol/local_lb/pool_member.rb', line 156

def session_enabled_state
  super
end

- (MemberSessionStatus[]) session_status

Gets the session status for all members of this pool.

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.



167
168
169
# File 'lib/icontrol/local_lb/pool_member.rb', line 167

def session_status
  super
end

- (Object) set_connection_limit(opts)

Sets the connection limits for this pool members.

Parameters:

  • opts (Hash)

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.



232
233
234
235
# File 'lib/icontrol/local_lb/pool_member.rb', line 232

def set_connection_limit(opts)
  check_params(opts,[:limits])
  super
end

- (Object) set_dynamic_ratio(opts)

Sets the dynamic ratios for this pool members.

Parameters:

  • opts (Hash)

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.



245
246
247
248
# File 'lib/icontrol/local_lb/pool_member.rb', line 245

def set_dynamic_ratio(opts)
  check_params(opts,[:dynamic_ratios])
  super
end

- (Object) set_monitor_association(opts)

Sets/creates the monitor associations for this pool members. This basically creates the monitor associations between a pool member and a monitor rule.

Parameters:

  • opts (Hash)

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.



259
260
261
262
# File 'lib/icontrol/local_lb/pool_member.rb', line 259

def set_monitor_association(opts)
  check_params(opts,[:monitor_associations])
  super
end

- (Object) set_monitor_state(opts)

Sets the monitor/availability states for this pool members.

Parameters:

  • opts (Hash)

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.



272
273
274
275
# File 'lib/icontrol/local_lb/pool_member.rb', line 272

def set_monitor_state(opts)
  check_params(opts,[:monitor_states])
  super
end

- (Object) set_priority(opts)

Sets the priorities for this pool members.

Parameters:

  • opts (Hash)

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.



285
286
287
288
# File 'lib/icontrol/local_lb/pool_member.rb', line 285

def set_priority(opts)
  check_params(opts,[:priorities])
  super
end

- (Object) set_ratio(opts)

Sets the ratios for this pool members.

Parameters:

  • opts (Hash)

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.



298
299
300
301
# File 'lib/icontrol/local_lb/pool_member.rb', line 298

def set_ratio(opts)
  check_params(opts,[:ratios])
  super
end

- (Object) set_session_enabled_state(opts)

Sets the session states for this pool members. If session state is enabled or true, this means that new sessions will be allowed to be established with the pool members.

Parameters:

  • opts (Hash)

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.



312
313
314
315
# File 'lib/icontrol/local_lb/pool_member.rb', line 312

def set_session_enabled_state(opts)
  check_params(opts,[:session_states])
  super
end

- (MemberStatistics) statistics(opts)

Gets the statistics for this set of pool members.

Parameters:

  • opts (Hash)

Options Hash (opts):

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.



180
181
182
183
# File 'lib/icontrol/local_lb/pool_member.rb', line 180

def statistics(opts)
  check_params(opts,[:members])
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


189
190
191
# File 'lib/icontrol/local_lb/pool_member.rb', line 189

def version
  super
end