Class: IControl::LocalLB::ProfileStream

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

Overview

The ProfileStream interface enables you to manipulate a local load balancer's stream profile.

Defined Under Namespace

Classes: ProfileStreamStatisticEntry, ProfileStreamStatisticEntrySequence, ProfileStreamStatistics

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

- (ProfileStreamStatistics) all_statistics

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



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

def all_statistics
  super
end

- (Object) create

Creates this stream 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_stream.rb', line 17

def create
  super
end

- (String) default_profile

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

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_stream.rb', line 60

def default_profile
  super
end

- (Object) delete_all_profiles

Deletes all stream 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_stream.rb', line 27

def delete_all_profiles
  super
end

- (Object) delete_profile

Deletes this stream 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_stream.rb', line 37

def delete_profile
  super
end

- (boolean) is_base_profile

Determines whether this profile are base/pre-configured profile, or user-defined 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.



124
125
126
# File 'lib/icontrol/local_lb/profile_stream.rb', line 124

def is_base_profile
  super
end

- (String) list

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



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

def list
  super
end

- (Object) reset_statistics

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



134
135
136
# File 'lib/icontrol/local_lb/profile_stream.rb', line 134

def reset_statistics
  super
end

- (Object) set_default_profile(opts)

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

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.



147
148
149
150
# File 'lib/icontrol/local_lb/profile_stream.rb', line 147

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

- (Object) set_source_string(opts)

Sets the source strings to search for in this profile.

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.



160
161
162
163
# File 'lib/icontrol/local_lb/profile_stream.rb', line 160

def set_source_string(opts)
  check_params(opts,[:sources])
  super
end

- (Object) set_tarstring(opts)

Sets the target strings to replace with in this profile.

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.



173
174
175
176
# File 'lib/icontrol/local_lb/profile_stream.rb', line 173

def set_tarstring(opts)
  check_params(opts,[:targets])
  super
end

- (ProfileString) source_string

Gets the source strings to search for in 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.



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

def source_string
  super
end

- (ProfileStreamStatistics) statistics

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



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

def statistics
  super
end

- (ProfileString) tarstring

Gets the target strings to replace with in 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.



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

def tarstring
  super
end

- (String) version

Gets the version information for this interface.



112
113
114
# File 'lib/icontrol/local_lb/profile_stream.rb', line 112

def version
  super
end