Class: IControl::GlobalLB::VirtualServer

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

Overview

The VirtualServer interface enables you to work with virtual servers associated with a server.

Defined Under Namespace

Classes: MonitorAssociation, MonitorAssociationSequence, VirtualServerMetricLimit, VirtualServerMetricLimitSequence, VirtualServerStatisticEntry, VirtualServerStatisticEntrySequence, VirtualServerStatistics

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

- (Object) add_dependency(opts)

Adds the virtual server to the dependency list that this virtual server depend on.

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.



23
24
25
26
# File 'lib/icontrol/global_lb/virtual_server.rb', line 23

def add_dependency(opts)
  check_params(opts,[:dependencies])
  super
end

- (VirtualServerStatistics) all_statistics

Gets the statistics for all the virtual 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.



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

def all_statistics
  super
end

- (Object) create(opts)

Creates this virtual server.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String)

    The servers that the virtual servers belong to.

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.



36
37
38
39
# File 'lib/icontrol/global_lb/virtual_server.rb', line 36

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

- (Object) delete_all_virtual_servers

Deletes all virtual 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.



47
48
49
# File 'lib/icontrol/global_lb/virtual_server.rb', line 47

def delete_all_virtual_servers
  super
end

- (Object) delete_virtual_server

Deletes this virtual 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.



57
58
59
# File 'lib/icontrol/global_lb/virtual_server.rb', line 57

def delete_virtual_server
  super
end

- (VirtualServerDefinition[]) dependency

Gets the list of virtual server that this virtual server depend on.

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.



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

def dependency
  super
end

- (EnabledState) enabled_state

Gets the enabled states for this 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.



90
91
92
# File 'lib/icontrol/global_lb/virtual_server.rb', line 90

def enabled_state
  super
end

- (VirtualServerMetricLimit) limit

Gets all metrics limits for a sequence of virtual 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.



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

def limit
  super
end

- (VirtualServerDefinition) list

Gets a list of virtual 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.



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

def list
  super
end

- (MonitorAssociation) monitor_association

Gets the monitor associations for this virtual server, i.e. the monitor rules used by the virtual 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.



124
125
126
# File 'lib/icontrol/global_lb/virtual_server.rb', line 124

def monitor_association
  super
end

- (ObjectStatus) object_status

Gets the statuses of this virtual 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.



135
136
137
# File 'lib/icontrol/global_lb/virtual_server.rb', line 135

def object_status
  super
end

Gets a parent links this virtual 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.



146
147
148
# File 'lib/icontrol/global_lb/virtual_server.rb', line 146

def parent_link
  super
end

- (Object) remove_all_dependencies

Removes any and all dependencies of this virtual 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.



197
198
199
# File 'lib/icontrol/global_lb/virtual_server.rb', line 197

def remove_all_dependencies
  super
end

- (Object) remove_dependency(opts)

Removes the virtual server from the dependency list that this virtual server depend on.

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.



210
211
212
213
# File 'lib/icontrol/global_lb/virtual_server.rb', line 210

def remove_dependency(opts)
  check_params(opts,[:dependencies])
  super
end

- (Object) remove_monitor_association

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

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/virtual_server.rb', line 223

def remove_monitor_association
  super
end

- (Object) reset_statistics

Resets the statistics for this virtual 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.



233
234
235
# File 'lib/icontrol/global_lb/virtual_server.rb', line 233

def reset_statistics
  super
end

- (String) server

Gets a list of servers this virtual 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.



157
158
159
# File 'lib/icontrol/global_lb/virtual_server.rb', line 157

def server
  super
end

- (Object) set_enabled_state(opts)

Sets the enabled states for this 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.



245
246
247
248
# File 'lib/icontrol/global_lb/virtual_server.rb', line 245

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

- (Object) set_limit(opts)

Sets the limits for virtual 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.



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

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

- (Object) set_monitor_association(opts)

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



272
273
274
275
# File 'lib/icontrol/global_lb/virtual_server.rb', line 272

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

- (Object) set_server(opts)

Sets the servers this virtual server belong to.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String)

    The servers that the virtual servers belong to.

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/global_lb/virtual_server.rb', line 285

def set_server(opts)
  check_params(opts,[:servers])
  super
end

- (Object) set_translation(opts)

Sets the translation IP addresses and ports for this 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.



298
299
300
301
# File 'lib/icontrol/global_lb/virtual_server.rb', line 298

def set_translation(opts)
  check_params(opts,[:translations])
  super
end

- (VirtualServerStatistics) statistics

Gets the statistics for this virtual 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.



168
169
170
# File 'lib/icontrol/global_lb/virtual_server.rb', line 168

def statistics
  super
end

- (IPPortDefinition) translation

Gets the translation IP addresses and ports for this virtual server.

Returns:

  • (IPPortDefinition)

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.



179
180
181
# File 'lib/icontrol/global_lb/virtual_server.rb', line 179

def translation
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


187
188
189
# File 'lib/icontrol/global_lb/virtual_server.rb', line 187

def version
  super
end