Class: IControl::LocalLB::ProfileDiameter

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

Overview

The ProfileDiameter interface enables you to manipulate a local load balancer's Diameter profile.

Defined Under Namespace

Classes: ProfileDiameterStatisticEntry, ProfileDiameterStatisticEntrySequence, ProfileDiameterStatistics

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

- (ProfileDiameterStatistics) all_statistics

Gets the statistics for all the Diameter 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_diameter.rb', line 48

def all_statistics
  super
end

- (Object) create

Creates this Diameter 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_diameter.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.

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

def default_profile
  super
end

- (Object) delete_all_profiles

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

def delete_all_profiles
  super
end

- (Object) delete_profile

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

def delete_profile
  super
end

- (ProfileString) destination_realm

Gets the realm to which a Diameter message is to be routed, overriding a destination realm present in the message. See set_destination_realm for more information.

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.



72
73
74
 
# File 'lib/icontrol/local_lb/profile_diameter.rb', line 72

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



151
152
153
 
# File 'lib/icontrol/local_lb/profile_diameter.rb', line 151

def is_base_profile
  super
end

- (String) list

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



83
84
85
 
# File 'lib/icontrol/local_lb/profile_diameter.rb', line 83

def list
  super
end

- (ProfileEnabledState) overwrite_destination_host_state

Gets the states to indicate whether overwrite destination host is enabled. See set_overwrite_destination_host_state for more information.

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.



95
96
97
 
# File 'lib/icontrol/local_lb/profile_diameter.rb', line 95

def overwrite_destination_host_state
  super
end

- (ProfileString) parent_avp

Gets the Diameter Attribute Value Pair (AVP) used to indicate the parent AVP when the persist AVP is embedded in a grouped AVP. See set_persist_avp for more information on the AVP specification.

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.



108
109
110
 
# File 'lib/icontrol/local_lb/profile_diameter.rb', line 108

def parent_avp
  super
end

- (ProfileString) persist_avp

Gets the the Diameter Attribute Value Pair (AVP) on which to persist for each of the profile given. See set_persist_avp for more information on the AVP specification.

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.



120
121
122
 
# File 'lib/icontrol/local_lb/profile_diameter.rb', line 120

def persist_avp
  super
end

- (Object) reset_statistics

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



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

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.



174
175
176
177
 
# File 'lib/icontrol/local_lb/profile_diameter.rb', line 174

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

- (Object) set_destination_realm(opts)

Sets the realm to which a Diameter message is to be routed, overriding a destination realm present in the message. If a message does not have a destination realm, then this setting has no effect.

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.



189
190
191
192
 
# File 'lib/icontrol/local_lb/profile_diameter.rb', line 189

def set_destination_realm(opts)
  check_params(opts,[:realms])
  super
end

- (Object) set_overwrite_destination_host_state(opts)

Sets the states to indicate whether overwrite destination host is enabled. If it is enabled, the system will overwrite the Destination-Host AVP (in a request) with the pool member's address.

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.



204
205
206
207
 
# File 'lib/icontrol/local_lb/profile_diameter.rb', line 204

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

- (Object) set_parent_avp(opts)

Sets the Diameter Attribute Value Pair (AVP) used to indicate the parent AVP when the persist AVP is embedded in a grouped AVP. See set_persist_avp for more information on the AVP specification.

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.



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

def set_parent_avp(opts)
  check_params(opts,[:avps])
  super
end

- (Object) set_persist_avp(opts)

Sets the Diameter Attribute Value Pair (AVP) on which to persist for each of the profile given. The AVP specification can be a string or a numeric code (1-4294967295), encoded as string. If the string is empty, or the code does not exist in the traffic coming to the system, then persist is disabled (if the name is not recognized, this method will produce an error). See RFC 3588, section 4.5, for valid base numeric codes. Valid names are as follows, in any mix of upper and lower case: "auth-application-id", "destination-host", "destination-realm", "origin-host", "origin-realm", "session-id", "subscription-id", "subscription-id-data".

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.



239
240
241
242
 
# File 'lib/icontrol/local_lb/profile_diameter.rb', line 239

def set_persist_avp(opts)
  check_params(opts,[:avps])
  super
end

- (ProfileDiameterStatistics) statistics

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



131
132
133
 
# File 'lib/icontrol/local_lb/profile_diameter.rb', line 131

def statistics
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


139
140
141
 
# File 'lib/icontrol/local_lb/profile_diameter.rb', line 139

def version
  super
end