Class: IControl::LocalLB::ProfileUserStatistic

Inherits:

Base

• Object
• Base
• IControl::LocalLB::ProfileUserStatistic

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

• #all_statistics ⇒ ProfileUserStatisticStatistics

  Gets the statistics for all the user-defined statistic profile.

• #create ⇒ Object

  Creates this user-defined statistic profile.

• #default_profile ⇒ String

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

• #delete_all_profiles ⇒ Object

  Deletes all user-defined statistic profile.

• #delete_profile ⇒ Object

  Deletes this user-defined statistic profile.

• #is_base_profile ⇒ boolean

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

• #list ⇒ String

  Gets a list of all user-defined statistic profile.

• #reset_statistics ⇒ Object

  Resets the statistics for this user-defined statistic profile.

• #set_default_profile(opts) ⇒ Object

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

• #set_statistic_name(opts) ⇒ Object

  Sets the user-defined statistic names in this profile.

• #statistic_name(opts) ⇒ UserStatisticName[]

  Gets the user-defined statistic names in this profile.

• #statistics ⇒ ProfileUserStatisticStatistics

  Gets the statistics for this user-defined statistic profile.

• #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

#all_statistics ⇒ ProfileUserStatisticStatistics

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:

• (ProfileUserStatisticStatistics)

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/local_lb/profile_user_statistic.rb', line 61

def all_statistics
  super
end

#create ⇒ Object

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.

# File 'lib/icontrol/local_lb/profile_user_statistic.rb', line 26

def create
  super
end

#default_profile ⇒ String

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.

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

def default_profile
  super
end

#delete_all_profiles ⇒ Object

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.

# File 'lib/icontrol/local_lb/profile_user_statistic.rb', line 36

def delete_all_profiles
  super
end

#delete_profile ⇒ Object

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.

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

def delete_profile
  super
end

#is_base_profile ⇒ boolean

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.

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

def is_base_profile
  super
end

#list ⇒ String

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.

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

def list
  super
end

#reset_statistics ⇒ Object

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.

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

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.

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

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

#set_statistic_name(opts) ⇒ Object

Sets the user-defined statistic names in this profile.

Parameters:

• opts (Hash)

Options Hash (opts):

• :statistic_names (IControl::LocalLB::ProfileUserStatistic::UserStatisticName[]) —

  The user-defined statistic names in the specified profiles. Each “inner” sequence of statistic names corresponds to a profile specified in profile_names.

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/local_lb/profile_user_statistic.rb', line 169

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

#statistic_name(opts) ⇒ UserStatisticName[]

Gets the user-defined statistic names in this profile.

Parameters:

• opts (Hash)

Options Hash (opts):

• :statistic_keys (IControl::LocalLB::ProfileUserStatistic::UserStatisticKey[]) —

  The statistic keys used to index the statistic names. Each “inner” sequence of statistic keys corresponds to a profile specified in profile_names.

Returns:

• (UserStatisticName[])

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/local_lb/profile_user_statistic.rb', line 97

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

#statistics ⇒ ProfileUserStatisticStatistics

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:

• (ProfileUserStatisticStatistics)

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/local_lb/profile_user_statistic.rb', line 113

def statistics
  super
end

#version ⇒ String

Gets the version information for this interface.

Returns:

• (String)

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

def version
  super
end