Class: IControl::LocalLB::ProfileUserStatistic

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

Overview

The ProfileUserStatistic interface enables you to manage user-defined statistics in a profile. The user can define up to 32 user-defined statistics in each profile.

Defined Under Namespace

Classes: ProfileUserStatisticStatisticEntry, ProfileUserStatisticStatisticEntrySequence, ProfileUserStatisticStatistics, UserStatistic, UserStatisticKey, UserStatisticKeySequence, UserStatisticKeySequenceSequence, UserStatisticName, UserStatisticNameSequence, UserStatisticNameSequenceSequence, UserStatisticSequence

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

- (ProfileUserStatisticStatistics) all_statistics

Gets the statistics for all the user-defined statistic profile. Only the statistic values of the user-defined statistics will be returned, i.e. even though there are up to 32 custom statistics in any given profile, but if only 3 of those custom statistics have been defined by the user, then only the values of those 3 statistics will be returned.

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.



61
62
63
 
# File 'lib/icontrol/local_lb/profile_user_statistic.rb', line 61

def all_statistics
  super
end

- (Object) create

Creates this user-defined statistic 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_user_statistic.rb', line 26

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.

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.



73
74
75
 
# File 'lib/icontrol/local_lb/profile_user_statistic.rb', line 73

def default_profile
  super
end

- (Object) delete_all_profiles

Deletes all user-defined statistic 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_user_statistic.rb', line 36

def delete_all_profiles
  super
end

- (Object) delete_profile

Deletes this user-defined statistic 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.



46
47
48
 
# File 'lib/icontrol/local_lb/profile_user_statistic.rb', line 46

def delete_profile
  super
end

- (boolean) is_base_profile

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.



133
134
135
 
# File 'lib/icontrol/local_lb/profile_user_statistic.rb', line 133

def is_base_profile
  super
end

- (String) list

Gets a list of all user-defined statistic 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.



84
85
86
 
# File 'lib/icontrol/local_lb/profile_user_statistic.rb', line 84

def list
  super
end

- (Object) reset_statistics

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



143
144
145
 
# File 'lib/icontrol/local_lb/profile_user_statistic.rb', line 143

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.

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.



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

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

- (Object) set_statistic_name(opts)

Sets the user-defined statistic names in this 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.



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

def set_statistic_name(opts)
  check_params(opts,[:statistic_names])
  super
end

- (UserStatisticName[]) statistic_name(opts)

Gets the user-defined statistic names in this profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

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.



97
98
99
100
 
# File 'lib/icontrol/local_lb/profile_user_statistic.rb', line 97

def statistic_name(opts)
  check_params(opts,[:statistic_keys])
  super
end

- (ProfileUserStatisticStatistics) statistics

Gets the statistics for this user-defined statistic profile. Only the statistic values of the user-defined statistics will be returned, i.e. even though there are up to 32 custom statistics in any given profile, but if only 3 of those custom statistics have been defined by the user, then only the values of those 3 statistics will be returned.

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.



113
114
115
 
# File 'lib/icontrol/local_lb/profile_user_statistic.rb', line 113

def statistics
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


121
122
123
 
# File 'lib/icontrol/local_lb/profile_user_statistic.rb', line 121

def version
  super
end