Class: IControl::GlobalLB::VirtualServer

Inherits:

Base

Object
Base
IControl::GlobalLB::VirtualServer

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

#add_dependency(opts) ⇒ Object

Adds the virtual server to the dependency list that this virtual server depend on.
#all_statistics ⇒ VirtualServerStatistics

Gets the statistics for all the virtual server.
#create(opts) ⇒ Object

Creates this virtual server.
#delete_all_virtual_servers ⇒ Object

Deletes all virtual server.
#delete_virtual_server ⇒ Object

Deletes this virtual server.
#dependency ⇒ VirtualServerDefinition[]

Gets the list of virtual server that this virtual server depend on.
#enabled_state ⇒ EnabledState

Gets the enabled states for this virtual server.
#limit ⇒ VirtualServerMetricLimit

Gets all metrics limits for a sequence of virtual server.
#list ⇒ VirtualServerDefinition

Gets a list of virtual server.
#monitor_association ⇒ MonitorAssociation

Gets the monitor associations for this virtual server, i.e.
#object_status ⇒ ObjectStatus

Gets the statuses of this virtual server.
#parent_link ⇒ String

Gets a parent links this virtual server belong to.
#remove_all_dependencies ⇒ Object

Removes any and all dependencies of this virtual server.
#remove_dependency(opts) ⇒ Object

Removes the virtual server from the dependency list that this virtual server depend on.
#remove_monitor_association ⇒ Object

Removes the monitor associations for this virtual server.
#reset_statistics ⇒ Object

Resets the statistics for this virtual server.
#server ⇒ String

Gets a list of servers this virtual server belong to.
#set_enabled_state(opts) ⇒ Object

Sets the enabled states for this virtual server.
#set_limit(opts) ⇒ Object

Sets the limits for virtual server metrics.
#set_monitor_association(opts) ⇒ Object

Sets/creates the monitor associations for this virtual server.
#set_server(opts) ⇒ Object

Sets the servers this virtual server belong to.
#set_translation(opts) ⇒ Object

Sets the translation IP addresses and ports for this virtual server.
#statistics ⇒ VirtualServerStatistics

Gets the statistics for this virtual server.
#translation ⇒ IPPortDefinition

Gets the translation IP addresses and ports for this virtual server.
#version ⇒ String

Gets the version information for this interface.

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

#add_dependency(opts) ⇒ `Object`

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

Parameters:

opts (Hash)

Options Hash (opts):

:dependencies (IControl::GlobalLB::VirtualServerDefinition[]) —

The dependency list of VSes that the specified virtual servers depend on.

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.

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

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

#all_statistics ⇒ `VirtualServerStatistics`

Gets the statistics for all the virtual server.

Returns:

(VirtualServerStatistics)

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

#create(opts) ⇒ `Object`

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.

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

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

#delete_all_virtual_servers ⇒ `Object`

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

#delete_virtual_server ⇒ `Object`

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

#dependency ⇒ `VirtualServerDefinition[]`

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

Returns:

(VirtualServerDefinition[])

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

#enabled_state ⇒ `EnabledState`

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

#limit ⇒ `VirtualServerMetricLimit`

Gets all metrics limits for a sequence of virtual server.

Returns:

(VirtualServerMetricLimit)

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

#list ⇒ `VirtualServerDefinition`

Gets a list of virtual server.

Returns:

(VirtualServerDefinition)

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

#monitor_association ⇒ `MonitorAssociation`

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

Returns:

(MonitorAssociation)

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

#object_status ⇒ `ObjectStatus`

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

#parent_link ⇒ `String`

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

#remove_all_dependencies ⇒ `Object`

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

#remove_dependency(opts) ⇒ `Object`

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

Parameters:

opts (Hash)

Options Hash (opts):

:dependencies (IControl::GlobalLB::VirtualServerDefinition[]) —

The dependency list of VSes that the specified virtual servers depend on.

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.

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

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

#remove_monitor_association ⇒ `Object`

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

#reset_statistics ⇒ `Object`

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

#server ⇒ `String`

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

#set_enabled_state(opts) ⇒ `Object`

Sets the enabled states for this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:states (IControl::Common::EnabledState) —

The states to 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.

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

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

#set_limit(opts) ⇒ `Object`

Sets the limits for virtual server metrics.

Parameters:

opts (Hash)

Options Hash (opts):

:limits (IControl::GlobalLB::VirtualServer::VirtualServerMetricLimit) —

The virtual servers’ metric 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.

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

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

#set_monitor_association(opts) ⇒ `Object`

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):

:monitor_associations (IControl::GlobalLB::VirtualServer::MonitorAssociation) —

The monitor associations that will be used to evaluate the specified virtual 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.

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

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

#set_server(opts) ⇒ `Object`

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.

# File 'lib/icontrol/global_lb/virtual_server.rb', line 285

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

#set_translation(opts) ⇒ `Object`

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

Parameters:

opts (Hash)

Options Hash (opts):

:translations (IControl::Common::IPPortDefinition) —

The translation IP addresses and ports.

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.

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

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

#statistics ⇒ `VirtualServerStatistics`

Gets the statistics for this virtual server.

Returns:

(VirtualServerStatistics)

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

#translation ⇒ `IPPortDefinition`

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

#version ⇒ `String`

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

Class: IControl::GlobalLB::VirtualServer

Overview

Defined Under Namespace

Instance Method Summary collapse

Dynamic Method Handling

Instance Method Details

#add_dependency(opts) ⇒ Object

#all_statistics ⇒ VirtualServerStatistics

#create(opts) ⇒ Object

#delete_all_virtual_servers ⇒ Object

#delete_virtual_server ⇒ Object

#dependency ⇒ VirtualServerDefinition[]

#enabled_state ⇒ EnabledState

#limit ⇒ VirtualServerMetricLimit

#list ⇒ VirtualServerDefinition

#monitor_association ⇒ MonitorAssociation

#object_status ⇒ ObjectStatus

#parent_link ⇒ String

#remove_all_dependencies ⇒ Object

#remove_dependency(opts) ⇒ Object

#remove_monitor_association ⇒ Object

#reset_statistics ⇒ Object

#server ⇒ String

#set_enabled_state(opts) ⇒ Object

#set_limit(opts) ⇒ Object

#set_monitor_association(opts) ⇒ Object

#set_server(opts) ⇒ Object

#set_translation(opts) ⇒ Object

#statistics ⇒ VirtualServerStatistics

#translation ⇒ IPPortDefinition

#version ⇒ String

#add_dependency(opts) ⇒ `Object`

#all_statistics ⇒ `VirtualServerStatistics`

#create(opts) ⇒ `Object`

#delete_all_virtual_servers ⇒ `Object`

#delete_virtual_server ⇒ `Object`

#dependency ⇒ `VirtualServerDefinition[]`

#enabled_state ⇒ `EnabledState`

#limit ⇒ `VirtualServerMetricLimit`

#list ⇒ `VirtualServerDefinition`

#monitor_association ⇒ `MonitorAssociation`

#object_status ⇒ `ObjectStatus`

#parent_link ⇒ `String`

#remove_all_dependencies ⇒ `Object`

#remove_dependency(opts) ⇒ `Object`

#remove_monitor_association ⇒ `Object`

#reset_statistics ⇒ `Object`

#server ⇒ `String`

#set_enabled_state(opts) ⇒ `Object`

#set_limit(opts) ⇒ `Object`

#set_monitor_association(opts) ⇒ `Object`

#set_server(opts) ⇒ `Object`

#set_translation(opts) ⇒ `Object`

#statistics ⇒ `VirtualServerStatistics`

#translation ⇒ `IPPortDefinition`

#version ⇒ `String`