Class: IControl::LocalLB::ProfileOneConnect

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

Overview

The ProfileOneConnect interface enables you to manipulate a local load balancer's OneConnect profile.

Defined Under Namespace

Classes: ProfileOneConnectStatisticEntry, ProfileOneConnectStatisticEntrySequence, ProfileOneConnectStatistics

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

#all_statisticsProfileOneConnectStatistics

Gets the statistics for all the OneConnect profile.

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.



48
49
50
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 48

def all_statistics
  super
end

#createObject

Creates this OneConnect profile.

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.



17
18
19
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 17

def create
  super
end

#default_profileString

Gets the names of the default profile from which this profile will derive default values for its attributes.

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.



60
61
62
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 60

def default_profile
  super
end

#delete_all_profilesObject

Deletes all OneConnect profile.

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
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 27

def delete_all_profiles
  super
end

#delete_profileObject

Deletes this OneConnect profile.

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.



37
38
39
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 37

def delete_profile
  super
end

#idle_timeoutProfileULong

Gets the idle timeouts for connections in this connection pools.

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.



71
72
73
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 71

def idle_timeout
  super
end

#is_base_profileboolean

Determines whether this profile are base/pre-configured profile, or user-defined profile.

Returns:

  • (boolean)

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.



158
159
160
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 158

def is_base_profile
  super
end

#listString

Gets a list of all OneConnect profile.

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.



82
83
84
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 82

def list
  super
end

#maximum_ageProfileULong

Gets the maximum age (in seconds) after which a connection should not be reused.

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.



93
94
95
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 93

def maximum_age
  super
end

#maximum_connectionProfileULong

Gets the maximum number of connections for this OneConnect profile.

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.



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

def maximum_connection
  super
end

#maximum_reuseProfileULong

Gets the maximum times the connections in the pool can be reused.

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.



115
116
117
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 115

def maximum_reuse
  super
end

#reset_statisticsObject

Resets the statistics for this OneConnect profile.

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/local_lb/profile_one_connect.rb', line 168

def reset_statistics
  super
end

#set_default_profile(opts) ⇒ Object

Sets the names of the default profile from which this profile will derive default values for its attributes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :defaults (String)

    The default profiles from which the specified profiles will get default values.

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.



181
182
183
184
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 181

def set_default_profile(opts)
  opts = check_params(opts,[:defaults])
  super(opts)
end

#set_idle_timeout(opts) ⇒ Object

Sets the idle timeouts for connections in this connection pools.

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.



194
195
196
197
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 194

def set_idle_timeout(opts)
  opts = check_params(opts,[:timeouts])
  super(opts)
end

#set_maximum_age(opts) ⇒ Object

Sets the maximum age (in seconds) after which a connection should not be reused.

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.



207
208
209
210
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 207

def set_maximum_age(opts)
  opts = check_params(opts,[:maximum_ages])
  super(opts)
end

#set_maximum_connection(opts) ⇒ Object

Sets the maximum number of connections for this OneConnect profile.

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.



220
221
222
223
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 220

def set_maximum_connection(opts)
  opts = check_params(opts,[:maximum_connections])
  super(opts)
end

#set_maximum_reuse(opts) ⇒ Object

Sets the maximum times the connections in the pool can be reused.

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.



233
234
235
236
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 233

def set_maximum_reuse(opts)
  opts = check_params(opts,[:maximum_reuses])
  super(opts)
end

#set_source_mask(opts) ⇒ Object

Sets the masks applied to the source addresses to determine eligibility for connection reuse.

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.



247
248
249
250
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 247

def set_source_mask(opts)
  opts = check_params(opts,[:source_masks])
  super(opts)
end

#source_maskProfileIPAddress

Gets the masks applied to the source addresses to determine eligibility for connection reuse.

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.



127
128
129
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 127

def source_mask
  super
end

#statisticsProfileOneConnectStatistics

Gets the statistics for this OneConnect profile.

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.



138
139
140
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 138

def statistics
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


146
147
148
# File 'lib/icontrol/local_lb/profile_one_connect.rb', line 146

def version
  super
end