Class: IControl::LocalLB::ProfileUDP

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

Overview

The ProfileUDP interface enables you to manipulate a local load balancer's UDP profile.

Defined Under Namespace

Classes: ProfileUDPStatisticEntry, ProfileUDPStatisticEntrySequence, ProfileUDPStatistics

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_statisticsProfileUDPStatistics

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



47
48
49
# File 'lib/icontrol/local_lb/profile_udp.rb', line 47

def all_statistics
  super
end

#allow_no_payload_stateProfileEnabledState

Gets the states that if true, will allow UDP packets with no payload (just the UDP header) to propagate through the system.

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.



59
60
61
# File 'lib/icontrol/local_lb/profile_udp.rb', line 59

def allow_no_payload_state
  super
end

#createObject

Creates this UDP 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.



16
17
18
# File 'lib/icontrol/local_lb/profile_udp.rb', line 16

def create
  super
end

#datagram_lb_stateProfileEnabledState

Gets the states that if true, will load balance each UDP datagram separately.

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.



70
71
72
# File 'lib/icontrol/local_lb/profile_udp.rb', line 70

def datagram_lb_state
  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.



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

def default_profile
  super
end

#delete_all_profilesObject

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



26
27
28
# File 'lib/icontrol/local_lb/profile_udp.rb', line 26

def delete_all_profiles
  super
end

#delete_profileObject

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



36
37
38
# File 'lib/icontrol/local_lb/profile_udp.rb', line 36

def delete_profile
  super
end

#idle_timeoutProfileULong

Gets the idle timeout for this UDP 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.



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

def idle_timeout
  super
end

#ip_tos_to_clientProfileULong

Gets the client-side IP TOS values for this UDP 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_udp.rb', line 104

def ip_tos_to_client
  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.



169
170
171
# File 'lib/icontrol/local_lb/profile_udp.rb', line 169

def is_base_profile
  super
end

Gets the client-side link QoS values for this UDP 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.



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

def link_qos_to_client
  super
end

#listString

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



126
127
128
# File 'lib/icontrol/local_lb/profile_udp.rb', line 126

def list
  super
end

#no_checksum_stateProfileEnabledState

Gets the states that if true, disables checksum processing (note: if the datagram is IPv6, the system always performs checksum processing).

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_udp.rb', line 138

def no_checksum_state
  super
end

#reset_statisticsObject

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



179
180
181
# File 'lib/icontrol/local_lb/profile_udp.rb', line 179

def reset_statistics
  super
end

#set_allow_no_payload_state(opts) ⇒ Object

Sets the states that if true, will allow UDP packets with no payload (just the UDP header) to propagate through the system.

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.



192
193
194
195
# File 'lib/icontrol/local_lb/profile_udp.rb', line 192

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

#set_datagram_lb_state(opts) ⇒ Object

Sets the states that if true, will load balance each UDP datagram separately.

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.



205
206
207
208
# File 'lib/icontrol/local_lb/profile_udp.rb', line 205

def set_datagram_lb_state(opts)
  opts = check_params(opts,[:states])
  super(opts)
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.



219
220
221
222
# File 'lib/icontrol/local_lb/profile_udp.rb', line 219

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

#set_idle_timeout(opts) ⇒ Object

Sets the idle timeout for this UDP 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.



232
233
234
235
# File 'lib/icontrol/local_lb/profile_udp.rb', line 232

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

#set_ip_tos_to_client(opts) ⇒ Object

Sets the client-side IP TOS values for this UDP 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.



245
246
247
248
# File 'lib/icontrol/local_lb/profile_udp.rb', line 245

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

Sets the client-side link QoS values for this UDP 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.



258
259
260
261
# File 'lib/icontrol/local_lb/profile_udp.rb', line 258

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

#set_no_checksum_state(opts) ⇒ Object

Sets the states that if true, disables checksum processing (note: if the datagram is IPv6, the system always performs checksum processing).

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/local_lb/profile_udp.rb', line 272

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

#statisticsProfileUDPStatistics

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



149
150
151
# File 'lib/icontrol/local_lb/profile_udp.rb', line 149

def statistics
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


157
158
159
# File 'lib/icontrol/local_lb/profile_udp.rb', line 157

def version
  super
end