Class: IControl::LocalLB::ProfileDNS

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

Overview

The ProfileDNS interface enables you to manipulate a local load balancer's DNS profile.

Defined Under Namespace

Classes: ProfileDNSStatisticEntry, ProfileDNSStatisticEntrySequence, ProfileDNSStatistics

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

- (ProfileDNSStatistics) all_statistics

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



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

def all_statistics
  super
end

- (Object) create

Creates this DNS 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_dns.rb', line 16

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.



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

def default_profile
  super
end

- (Object) delete_all_profiles

Deletes all DNS 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_dns.rb', line 26

def delete_all_profiles
  super
end

- (Object) delete_profile

Deletes this DNS 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_dns.rb', line 36

def delete_profile
  super
end

- (ProfileEnabledState) gtm_enabled_state

Gets the state that if true, allows GTM to handle DNS resolution for DNS queries and responses that contain wide IP 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.



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

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



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

def is_base_profile
  super
end

- (String) list

Gets a list of all DNS 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_dns.rb', line 82

def list
  super
end

- (Object) reset_statistics

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



123
124
125
# File 'lib/icontrol/local_lb/profile_dns.rb', line 123

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.



136
137
138
139
# File 'lib/icontrol/local_lb/profile_dns.rb', line 136

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

- (Object) set_gtm_enabled_state(opts)

Sets the state that if true, allows GTM to handle DNS resolution for DNS queries and responses that contain wide IP names.

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.



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

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

- (ProfileDNSStatistics) statistics

Gets the statistics for this DNS 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_dns.rb', line 93

def statistics
  super
end

- (String) version

Gets the version information for this interface.



101
102
103
# File 'lib/icontrol/local_lb/profile_dns.rb', line 101

def version
  super
end