Class: IControl::GlobalLB::WideIP

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

Overview

The WideIP interface enables you to work with wide IPs, as well as with the pools and the virtual servers that make them up. For example, use the WideIP interface to get a list of wide IPs, to add a wide IP, or to remove a wide IP.

Defined Under Namespace

Classes: WideIPPool, WideIPPoolSequence, WideIPPoolSequenceSequence, WideIPRule, WideIPRuleSequence, WideIPRuleSequenceSequence, WideIPStatisticEntry, WideIPStatisticEntrySequence, WideIPStatistics

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_alias(opts) ⇒ Object

Adds/associates aliases to this wide IPs. A given wide IP can have more than one alias.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :aliases (String[])

    The aliases to add to the wide IPs .

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.


27
28
29
30
# File 'lib/icontrol/global_lb/wide_ip.rb', line 27

def add_alias(opts)
  opts = check_params(opts,[:aliases])
  super(opts)
end

#add_wideip_pool(opts) ⇒ Object

Adds/associates wide IP pools to this wide IPs.

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/wide_ip.rb', line 40

def add_wideip_pool(opts)
  opts = check_params(opts,[:wideip_pools])
  super(opts)
end

#add_wideip_rule(opts) ⇒ Object

Adds/associates wide IP rules to this wide IPs.

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.


53
54
55
56
# File 'lib/icontrol/global_lb/wide_ip.rb', line 53

def add_wideip_rule(opts)
  opts = check_params(opts,[:wideip_rules])
  super(opts)
end

#aliasString[]

Gets the lists of aliases this wide IPs are associated with. A given wide IP can have more than one alias.

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.


101
102
103
# File 'lib/icontrol/global_lb/wide_ip.rb', line 101

def alias
  super
end

#all_statisticsWideIPStatistics

Gets the statistics for all the wide IPs.

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.


112
113
114
# File 'lib/icontrol/global_lb/wide_ip.rb', line 112

def all_statistics
  super
end

#applicationString

Gets the names of the applications for this wide IPs.

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.


123
124
125
# File 'lib/icontrol/global_lb/wide_ip.rb', line 123

def application
  super
end

#create(opts) ⇒ Object

Creates this wide IPs with some basic attributes.

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.


68
69
70
71
# File 'lib/icontrol/global_lb/wide_ip.rb', line 68

def create(opts)
  opts = check_params(opts,[:lb_methods,:wideip_pools,:wideip_rules])
  super(opts)
end

#delete_all_wideipsObject

Deletes all wide IPs.

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.


79
80
81
# File 'lib/icontrol/global_lb/wide_ip.rb', line 79

def delete_all_wideips
  super
end

#delete_wideipObject

Deletes this wide IPs.

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/global_lb/wide_ip.rb', line 89

def delete_wideip
  super
end

#enabled_stateEnabledState

Gets the enabled states for this wide IPs.

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.


134
135
136
# File 'lib/icontrol/global_lb/wide_ip.rb', line 134

def enabled_state
  super
end

#last_resort_poolString

Gets the names of the last resort pools for this wide IPs.

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.


145
146
147
# File 'lib/icontrol/global_lb/wide_ip.rb', line 145

def last_resort_pool
  super
end

#lb_methodLBMethod

Gets the load balancing methods for this wide IPs.

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/global_lb/wide_ip.rb', line 156

def lb_method
  super
end

#listString

Gets a list of wide IPs.

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.


167
168
169
# File 'lib/icontrol/global_lb/wide_ip.rb', line 167

def list
  super
end

#object_statusObjectStatus

Gets the statuses of this wide IPs.

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.


178
179
180
# File 'lib/icontrol/global_lb/wide_ip.rb', line 178

def object_status
  super
end

#persistence_stateEnabledState

Gets the states indicating whether to maintain a connection between an LDNS and a particular virtual 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.


190
191
192
# File 'lib/icontrol/global_lb/wide_ip.rb', line 190

def persistence_state
  super
end

#persistence_ttllong

Gets the persistence TTL values of this wide IPs. These values (in seconds) indicate the time to maintain a connection between an LDNS and a particular virtual server.

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.


202
203
204
# File 'lib/icontrol/global_lb/wide_ip.rb', line 202

def persistence_ttl
  super
end

#remove_alias(opts) ⇒ Object

Removes aliases from this wide IPs. A given wide IP can have more than one alias.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :aliases (String[])

    The aliases to remove from the wide IPs .

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.


270
271
272
273
# File 'lib/icontrol/global_lb/wide_ip.rb', line 270

def remove_alias(opts)
  opts = check_params(opts,[:aliases])
  super(opts)
end

#remove_all_aliasesObject

Removes all aliases from this wide IPs.

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.


281
282
283
# File 'lib/icontrol/global_lb/wide_ip.rb', line 281

def remove_all_aliases
  super
end

#remove_all_wideip_poolsObject

Removes all wide IP pools from this wide IPs.

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.


291
292
293
# File 'lib/icontrol/global_lb/wide_ip.rb', line 291

def remove_all_wideip_pools
  super
end

#remove_all_wideip_rulesObject

Removes all wide IP rules from this wide IPs.

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.


301
302
303
# File 'lib/icontrol/global_lb/wide_ip.rb', line 301

def remove_all_wideip_rules
  super
end

#remove_wideip_pool(opts) ⇒ Object

Removes wide IP pools from this wide IPs.

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.


313
314
315
316
# File 'lib/icontrol/global_lb/wide_ip.rb', line 313

def remove_wideip_pool(opts)
  opts = check_params(opts,[:wideip_pools])
  super(opts)
end

#remove_wideip_rule(opts) ⇒ Object

Removes wide IP rules from this wide IPs.

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.


326
327
328
329
# File 'lib/icontrol/global_lb/wide_ip.rb', line 326

def remove_wideip_rule(opts)
  opts = check_params(opts,[:wideip_rules])
  super(opts)
end

#reset_applicationObject

Resets the names of the applications for this wide IPs (i.e., sets them to nothing). This function disassociates each wide IP given from any application.

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.


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

def reset_application
  super
end

#reset_statisticsObject

Resets the statistics for this wide IPs.

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.


348
349
350
# File 'lib/icontrol/global_lb/wide_ip.rb', line 348

def reset_statistics
  super
end

#set_application(opts) ⇒ Object

Sets the names of the applications for this wide IPs.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :applications (String)

    The names of the applications for the specified wide IPs .

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.


360
361
362
363
# File 'lib/icontrol/global_lb/wide_ip.rb', line 360

def set_application(opts)
  opts = check_params(opts,[:applications])
  super(opts)
end

#set_enabled_state(opts) ⇒ Object

Sets the enabled states for this wide IPs.

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.


373
374
375
376
# File 'lib/icontrol/global_lb/wide_ip.rb', line 373

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

#set_last_resort_pool(opts) ⇒ Object

Sets the names of the last resort pools for this wide IPs.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :pool_names (String)

    The names of the last resort pools for the specified wide IPs .

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.


386
387
388
389
# File 'lib/icontrol/global_lb/wide_ip.rb', line 386

def set_last_resort_pool(opts)
  opts = check_params(opts,[:pool_names])
  super(opts)
end

#set_lb_method(opts) ⇒ Object

Sets the load balancing methods for this wide IPs. This is used by the wide IPs when picking a pool to use when responding to a DNS request.

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.


400
401
402
403
# File 'lib/icontrol/global_lb/wide_ip.rb', line 400

def set_lb_method(opts)
  opts = check_params(opts,[:lb_methods])
  super(opts)
end

#set_persistence_state(opts) ⇒ Object

Sets the states indicating whether to maintain a connection between an LDNS and a particular virtual 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.


414
415
416
417
# File 'lib/icontrol/global_lb/wide_ip.rb', line 414

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

#set_persistence_ttl(opts) ⇒ Object

Sets the persistence TTL values of this wide IPs. These values (in seconds) indicate the time to maintain a connection between an LDNS and a particular virtual server.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long)

    The persistence TTLs of the specified wide IPs .

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.


428
429
430
431
# File 'lib/icontrol/global_lb/wide_ip.rb', line 428

def set_persistence_ttl(opts)
  opts = check_params(opts,[:values])
  super(opts)
end

#statisticsWideIPStatistics

Gets the statistics for this wide IPs.

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.


213
214
215
# File 'lib/icontrol/global_lb/wide_ip.rb', line 213

def statistics
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)

221
222
223
# File 'lib/icontrol/global_lb/wide_ip.rb', line 221

def version
  super
end

#wideip(opts) ⇒ String[]

Gets the lists of wide IPs associated with this aliases. Each alias maps to exactly one wide IP.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :aliases (String)

    The list of aliases.

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.


235
236
237
238
# File 'lib/icontrol/global_lb/wide_ip.rb', line 235

def wideip(opts)
  opts = check_params(opts,[:aliases])
  super(opts)
end

#wideip_poolWideIPPool[]

Gets the lists of wide IP pools this wide IPs are associated with.

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
# File 'lib/icontrol/global_lb/wide_ip.rb', line 247

def wideip_pool
  super
end

#wideip_ruleWideIPRule[]

Gets the lists of wide IP rules this wide IPs are associated with.

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.


258
259
260
# File 'lib/icontrol/global_lb/wide_ip.rb', line 258

def wideip_rule
  super
end