Class: IControl::LocalLB::NodeAddress

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

Overview

The NodeAddress interface enables you to work with the states, statistics, limits, availability, ratios, application response deltas, and monitors of a local load balancer's node address.

Defined Under Namespace

Classes: MonitorAssociation, MonitorAssociationRemoval, MonitorAssociationRemovalSequence, MonitorAssociationSequence, NodeAddressStatisticEntry, NodeAddressStatisticEntrySequence, NodeAddressStatistics

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

- (NodeAddressStatistics) all_statistics

Gets the statistics for all the node addresse.

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.



56
57
58
 
# File 'lib/icontrol/local_lb/node_address.rb', line 56

def all_statistics
  super
end

- (ULong64) connection_limit

Gets the connection limits for this node addresse.

Returns:

  • (ULong64)

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.



67
68
69
 
# File 'lib/icontrol/local_lb/node_address.rb', line 67

def connection_limit
  super
end

- (Object) create(opts)

Creates this node addresse.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :limits (long) —

    The connection limits.

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.



24
25
26
27
 
# File 'lib/icontrol/local_lb/node_address.rb', line 24

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

- (Object) delete_all_node_addresses

Deletes all node addresse.

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.



35
36
37
 
# File 'lib/icontrol/local_lb/node_address.rb', line 35

def delete_all_node_addresses
  super
end

- (Object) delete_node_address

Deletes this node addresse.

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.



45
46
47
 
# File 'lib/icontrol/local_lb/node_address.rb', line 45

def delete_node_address
  super
end

- (short) dynamic_ratio

Gets the dynamic ratios of a node addresse.

Returns:

  • (short)

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.



78
79
80
 
# File 'lib/icontrol/local_lb/node_address.rb', line 78

def dynamic_ratio
  super
end

- (String) list

Gets a list of all node addresse.

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.



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

def list
  super
end

- (MonitorAssociation) monitor_association(opts)

Gets the monitor associations used by this node addresse, i.e. the monitor rules used by the node addresse.

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.



103
104
105
106
 
# File 'lib/icontrol/local_lb/node_address.rb', line 103

def monitor_association(opts)
  check_params(opts,[:addresses])
  super
end

- (MonitorInstanceState[]) monitor_instance(opts)

Gets the monitor instance information for this node addresse.

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.



117
118
119
120
 
# File 'lib/icontrol/local_lb/node_address.rb', line 117

def monitor_instance(opts)
  check_params(opts,[:addresses])
  super
end

- (MonitorStatus) monitor_status

Gets the current availability status of this node addresse.

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.



129
130
131
 
# File 'lib/icontrol/local_lb/node_address.rb', line 129

def monitor_status
  super
end

- (ObjectStatus) object_status

Gets the statuses of this node addresse.

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.



140
141
142
 
# File 'lib/icontrol/local_lb/node_address.rb', line 140

def object_status
  super
end

- (long) ratio

Gets the ratios for this node addresse.

Returns:

  • (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.



151
152
153
 
# File 'lib/icontrol/local_lb/node_address.rb', line 151

def ratio
  super
end

- (Object) remove_monitor_association(opts)

Removes the monitor associations for this node addresse. This basically deletes the monitor associations between a node address and a monitor rule, i.e. this node address 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.



218
219
220
221
 
# File 'lib/icontrol/local_lb/node_address.rb', line 218

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

- (Object) reset_statistics

Resets the statistics for this node addresse.

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.



229
230
231
 
# File 'lib/icontrol/local_lb/node_address.rb', line 229

def reset_statistics
  super
end

- (String) screen_name

Gets the screen names for this node addresse.

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.



162
163
164
 
# File 'lib/icontrol/local_lb/node_address.rb', line 162

def screen_name
  super
end

- (EnabledState) session_enabled_state

Note: This function has been deprecated. Please use get_session_status. Gets the states that allows new sessions to be established for this node addresse.

Returns:

  • (EnabledState)

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.



174
175
176
 
# File 'lib/icontrol/local_lb/node_address.rb', line 174

def session_enabled_state
  super
end

- (SessionStatus) session_status

Gets the current session statuses of this node addresse.

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.



185
186
187
 
# File 'lib/icontrol/local_lb/node_address.rb', line 185

def session_status
  super
end

- (Object) set_connection_limit(opts)

Sets the connection limits for a sequence of node addresse.

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.



241
242
243
244
 
# File 'lib/icontrol/local_lb/node_address.rb', line 241

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

- (Object) set_dynamic_ratio(opts)

Sets the dynamic ratios for this node addresse

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :dynamic_ratios (short) —

    The dynamic ratios for the specified node addresses.

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.



254
255
256
257
 
# File 'lib/icontrol/local_lb/node_address.rb', line 254

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

- (Object) set_monitor_association(opts)

Sets/creates the monitor associations for this node addresse. This basically creates the monitor associations between a node address 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.



268
269
270
271
 
# File 'lib/icontrol/local_lb/node_address.rb', line 268

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

- (Object) set_monitor_state(opts)

Sets the availability states for a sequence of node addresse, either enabled/disabled or up/down.

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.



282
283
284
285
 
# File 'lib/icontrol/local_lb/node_address.rb', line 282

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

- (Object) set_ratio(opts)

Sets the ratios for this node addresse.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ratios (long) —

    The ratios to be set.

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.



295
296
297
298
 
# File 'lib/icontrol/local_lb/node_address.rb', line 295

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

- (Object) set_screen_name(opts)

Sets the screen names for this node addresse.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :names (String) —

    The screen names to be set.

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.



308
309
310
311
 
# File 'lib/icontrol/local_lb/node_address.rb', line 308

def set_screen_name(opts)
  check_params(opts,[:names])
  super
end

- (Object) set_session_enabled_state(opts)

Sets the states that allows new sessions to be established for this node addresse.

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.



321
322
323
324
 
# File 'lib/icontrol/local_lb/node_address.rb', line 321

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

- (NodeAddressStatistics) statistics

Gets the statistics for this node.

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.



196
197
198
 
# File 'lib/icontrol/local_lb/node_address.rb', line 196

def statistics
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


204
205
206
 
# File 'lib/icontrol/local_lb/node_address.rb', line 204

def version
  super
end