Class: IControl::GlobalLB::Server

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/global_lb/server.rb,
lib/icontrol/global_lb.rb

Overview

The Server interface enables you to work with servers within a data center.

Defined Under Namespace

Classes: MonitorAssociation, MonitorAssociationSequence, ServerIPDefinition, ServerIPSequence, ServerIPsForUnitID, ServerIPsForUnitIDSequence, ServerMetricLimit, ServerMetricLimitSequence, ServerStatisticEntry, ServerStatisticEntrySequence, ServerStatistics

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

#add_ip(opts) ⇒ Object

Adds the IP addresses to this server.

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.



26
27
28
29
# File 'lib/icontrol/global_lb/server.rb', line 26

def add_ip(opts)
  check_params(opts,[:ips])
  super
end

#all_statisticsServerStatistics

Gets the statistics for all the server.

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.



72
73
74
# File 'lib/icontrol/global_lb/server.rb', line 72

def all_statistics
  super
end

#allow_path_stateEnabledState

Gets the states indicating whether path information gathering is allowed for this server.

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.



84
85
86
# File 'lib/icontrol/global_lb/server.rb', line 84

def allow_path_state
  super
end

#allow_service_check_stateEnabledState

Gets the states indicating whether service check is allowed for this server.

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.



95
96
97
# File 'lib/icontrol/global_lb/server.rb', line 95

def allow_service_check_state
  super
end

#allow_snmp_stateEnabledState

Gets the states indicating whether SNMP information gathering is allowed for this server.

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.



107
108
109
# File 'lib/icontrol/global_lb/server.rb', line 107

def allow_snmp_state
  super
end

#auto_configuration_stateAutoConfigurationState

Gets the states indicating whether autoconfig is enabled/disabled. If enabled, GTM will attempt to gather all virtual server based on this server.

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.



119
120
121
# File 'lib/icontrol/global_lb/server.rb', line 119

def auto_configuration_state
  super
end

#create(opts) ⇒ Object

Creates this server.

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.



40
41
42
43
# File 'lib/icontrol/global_lb/server.rb', line 40

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

#data_centerString

Gets the data centers that this server belong to.

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.



130
131
132
# File 'lib/icontrol/global_lb/server.rb', line 130

def data_center
  super
end

#delete_all_serversObject

Deletes all server.

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.



51
52
53
# File 'lib/icontrol/global_lb/server.rb', line 51

def delete_all_servers
  super
end

#delete_serverObject

Deletes this server.

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.



61
62
63
# File 'lib/icontrol/global_lb/server.rb', line 61

def delete_server
  super
end

#enabled_stateEnabledState

Gets the enabled states for this server.

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.



141
142
143
# File 'lib/icontrol/global_lb/server.rb', line 141

def enabled_state
  super
end

#ipServerIPDefinition

Gets the IP addresses that belong to this server.

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.



152
153
154
# File 'lib/icontrol/global_lb/server.rb', line 152

def ip
  super
end

#limitServerMetricLimit

Gets all metrics limits for a sequence of server.

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.



163
164
165
# File 'lib/icontrol/global_lb/server.rb', line 163

def limit
  super
end

Gets the states indicating whether autoconfig is enabled/disabled. If enabled, GTM will attempt to look up the links's default gateways.

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.



175
176
177
# File 'lib/icontrol/global_lb/server.rb', line 175

def link_auto_configuration_state
  super
end

#listString

Gets a list of server.

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.



186
187
188
# File 'lib/icontrol/global_lb/server.rb', line 186

def list
  super
end

#monitor_association(opts) ⇒ MonitorAssociation

Gets the monitor associations for this server, i.e. the monitor rules used by the server.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :server_names (String)

    The names of the servers.

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.



200
201
202
203
# File 'lib/icontrol/global_lb/server.rb', line 200

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

#object_statusObjectStatus

Gets the statuses of this server.

Returns:

  • (ObjectStatus)

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.



212
213
214
# File 'lib/icontrol/global_lb/server.rb', line 212

def object_status
  super
end

#prober_addressString

Gets the prober addresses for this server.

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.



223
224
225
# File 'lib/icontrol/global_lb/server.rb', line 223

def prober_address
  super
end

#remove_ip(opts) ⇒ Object

Removes the IP addresses from this server.

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/global_lb/server.rb', line 268

def remove_ip(opts)
  check_params(opts,[:ips])
  super
end

#remove_monitor_association(opts) ⇒ Object

Removes the monitor associations for this server. This basically deletes the monitor associations between a server and a monitor rule, i.e. this server will no longer be monitored.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :server_names (String)

    The names of the servers.

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.



283
284
285
286
# File 'lib/icontrol/global_lb/server.rb', line 283

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

#reset_statistics(opts) ⇒ Object

Resets the statistics for this server.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :server_names (String)

    The names of the servers.

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.



296
297
298
299
# File 'lib/icontrol/global_lb/server.rb', line 296

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

#server_typeServerType

Gets the server types of this server.

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.



234
235
236
# File 'lib/icontrol/global_lb/server.rb', line 234

def server_type
  super
end

#set_allow_path_state(opts) ⇒ Object

Sets the states indicating whether path information gathering is allowed for this server.

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.



310
311
312
313
# File 'lib/icontrol/global_lb/server.rb', line 310

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

#set_allow_service_check_state(opts) ⇒ Object

Sets the states indicating whether service check is allowed for this server.

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.



323
324
325
326
# File 'lib/icontrol/global_lb/server.rb', line 323

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

#set_allow_snmp_state(opts) ⇒ Object

Sets the states indicating whether SNMP information gathering is allowed for this server.

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.



337
338
339
340
# File 'lib/icontrol/global_lb/server.rb', line 337

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

#set_auto_configuration_state(opts) ⇒ Object

Sets the states indicating whether autoconfig is enabled/disabled. If enabled, GTM will attempt to gather all virtual server based on this server.

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.



351
352
353
354
# File 'lib/icontrol/global_lb/server.rb', line 351

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

#set_data_center(opts) ⇒ Object

Moves this server to the new data centers.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :data_centers (String)

    The names of the new data centers.

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.



364
365
366
367
# File 'lib/icontrol/global_lb/server.rb', line 364

def set_data_center(opts)
  check_params(opts,[:data_centers])
  super
end

#set_enabled_state(opts) ⇒ Object

Sets the enabled states for this server.

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.



377
378
379
380
# File 'lib/icontrol/global_lb/server.rb', line 377

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

#set_limit(opts) ⇒ Object

Sets the limits for server metrics.

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.



390
391
392
393
# File 'lib/icontrol/global_lb/server.rb', line 390

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

Sets the states indicating whether autoconfig is enabled/disabled for the server' links. If enabled, GTM will attempt to look up the links's default gateways.

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.



404
405
406
407
# File 'lib/icontrol/global_lb/server.rb', line 404

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

#set_monitor_association(opts) ⇒ Object

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



418
419
420
421
# File 'lib/icontrol/global_lb/server.rb', line 418

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

#set_prober_address(opts) ⇒ Object

Sets the prober addresses for this server.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :addresses (String)

    The prober 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.



431
432
433
434
# File 'lib/icontrol/global_lb/server.rb', line 431

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

#set_server_type(opts) ⇒ Object

Sets the server types of this server.

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.



444
445
446
447
# File 'lib/icontrol/global_lb/server.rb', line 444

def set_server_type(opts)
  check_params(opts,[:types])
  super
end

#statistics(opts) ⇒ ServerStatistics

Gets the statistics for this server.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :server_names (String)

    The names of the servers.

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.



247
248
249
250
# File 'lib/icontrol/global_lb/server.rb', line 247

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

#versionString

Gets the version information for this interface.

Returns:

  • (String)


256
257
258
# File 'lib/icontrol/global_lb/server.rb', line 256

def version
  super
end