Class: IControl::GlobalLB::DNSSECZone

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/global_lb/dnssec_zone.rb,
lib/icontrol/global_lb.rb

Overview

The DNSSECZone interface manages the zones in which securing DNS information, i.e., DNSSEC, is active. When a zone is active, its DNS record groups are digitally signed, the DNS record names are hashed, and keys sent to upstream DNS servers are digitally signed. A DNSSEC zone can contain any number of DNSSEC keys, and a single DNSSEC key can be used in more than one DNSSEC zone. Note that a large number of DNSSEC keys in a single DNSSEC zone can affect the responsiveness to DNS requests. Note that the term "zone" in this interface is not necessarily "zone" in a DNS sense. See the DNSSECKey interface for managing the keys themselves.

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

- (Object) add_key(opts)

Adds DNSSEC keys to a set of DNSSEC zone.

Options Hash (opts):

  • :keys (String[])

    Names of DNSSEC keys to add to each specified DNSSEC zone

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.



23
24
25
26
# File 'lib/icontrol/global_lb/dnssec_zone.rb', line 23

def add_key(opts)
  check_params(opts,[:keys])
  super
end

- (Object) create(opts)

Creates a set of DNSSEC zone.

Options Hash (opts):

  • :keys (String[])

    DNSSEC key names for each specified DNSSEC zone

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
39
# File 'lib/icontrol/global_lb/dnssec_zone.rb', line 36

def create(opts)
  check_params(opts,[:keys])
  super
end

- (Object) delete_all_zones

Deletes all DNSSEC zone.

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/global_lb/dnssec_zone.rb', line 47

def delete_all_zones
  super
end

- (Object) delete_zone

Deletes a set of DNSSEC zone.

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.



57
58
59
# File 'lib/icontrol/global_lb/dnssec_zone.rb', line 57

def delete_zone
  super
end

- (EnabledState) enabled_state

Gets the enabled state for a set of DNSSEC zone.

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.



68
69
70
# File 'lib/icontrol/global_lb/dnssec_zone.rb', line 68

def enabled_state
  super
end

- (String[]) key

Gets the DNSSEC keys for a set of DNSSEC zone.

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.



79
80
81
# File 'lib/icontrol/global_lb/dnssec_zone.rb', line 79

def key
  super
end

- (String) list

Gets the names of all DNSSEC zone.

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.



90
91
92
# File 'lib/icontrol/global_lb/dnssec_zone.rb', line 90

def list
  super
end

- (ObjectStatus) object_status

Gets the status of a set of DNSSEC zone.

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.



101
102
103
# File 'lib/icontrol/global_lb/dnssec_zone.rb', line 101

def object_status
  super
end

- (Object) remove_all_keys

Removes all DNSSEC keys from a set of DNSSEC zone.

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.



119
120
121
# File 'lib/icontrol/global_lb/dnssec_zone.rb', line 119

def remove_all_keys
  super
end

- (Object) remove_key(opts)

Removes DNSSEC keys from a set of DNSSEC zone.

Options Hash (opts):

  • :keys (String[])

    Names of DNSSEC keys to delete from each specified DNSSEC zone

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
134
# File 'lib/icontrol/global_lb/dnssec_zone.rb', line 131

def remove_key(opts)
  check_params(opts,[:keys])
  super
end

- (Object) set_enabled_state(opts)

Sets the enabled state for a set of DNSSEC zone. Note that individual keys can also be enabled and disabled. See the DNSSECKey interface for details.

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.



145
146
147
148
# File 'lib/icontrol/global_lb/dnssec_zone.rb', line 145

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

- (String) version

Get the version information for this interface.



109
110
111
# File 'lib/icontrol/global_lb/dnssec_zone.rb', line 109

def version
  super
end