icontrol 0.3.1 → 0.3.2

data/lib/icontrol/management/license_administration.rb

@@ -1,6 +1,9 @@
 module IControl::Management
   ##
-  # The LicenseAdministration interface exposes methods that enable you to authorize the system, either manually or in an automated fashion. This interface allows you to generate license files, install previously generated licenses, and view other licensing characteristics.
+  # The LicenseAdministration interface exposes methods that enable you to authorize
+  # the system, either manually or in an automated fashion. This interface allows you
+  # to generate license files, install previously generated licenses, and view other
+  # licensing characteristics.
   class LicenseAdministration < IControl::Base
 
     set_id_name "modules"
@@ -9,12 +12,16 @@ module IControl::Management
     class ModuleExpiry < IControl::Base::Struct; end
     class ModuleKey < IControl::Base::Struct; end
     class ModuleKeyTimeLimits < IControl::Base::Struct; end
-    class TimeLimitedModuleKey < IControl::Base::Struct; end    ##
+    class TimeLimitedModuleKey < IControl::Base::Struct; end
+    class ModuleExpirySequence < IControl::Base::Sequence ; end
+    class ModuleKeySequence < IControl::Base::Sequence ; end
+    class TimeLimitedModuleKeySequence < IControl::Base::Sequence ; end    ##
     # Checks to see if this registration keys will pass the CRC validation.
+    # @rspec_example
     # @return [boolean]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [String] :registration_keys The list of registration keys to do a CRC check.
     def check_registration_key_crc(opts)
@@ -24,100 +31,123 @@ module IControl::Management
 
     ##
     # Retrieves the copyright file.
+    # @rspec_example
     # @return [char]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def copyright_file
       super
     end
 
     ##
     # Retrieves the EULA agreement file.
+    # @rspec_example
     # @return [char]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def eula_file
       super
     end
 
     ##
     # Gets information on when the evaluation license will expire.
+    # @rspec_example
     # @return [EvaluationExpiration]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def evaluation_license_expiration
       super
     end
 
     ##
     # Checks to see whether the device has been licensed.
+    # @rspec_example
     # @return [EnabledState]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def license_activation_status
       super
     end
 
     ##
     # Retrieves the active license file.
+    # @rspec_example
     # @return [char]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def license_file
       super
     end
 
     ##
-    # Gets information indicating whether the given module are enabled in the license. Caution! This enabled state is what is specified in the license for the module without regard for whether the module is provisionable or provisioned under this hardware and configuration. See the Provision interface.
+    # Gets information indicating whether the given module are enabled in the license.
+    # Caution! This enabled state is what is specified in the license for the module without
+    # regard for whether the module is provisionable or provisioned under this hardware
+    # and configuration. See the Provision interface.
+    # @rspec_example
     # @return [EnabledState]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def module_enabled_state
       super
     end
 
     ##
-    # Gets information about expiry of the given module. Caution! The expiry information does not indicate whether a module is provisionable or provisioned. See the Provision interface. Note: This returns the enabled state as well. When getting the module expiry information, we suggest making use of the enabled state returned here rather than getting enabled state separately.
+    # Gets information about expiry of the given module. Caution! The expiry information
+    # does not indicate whether a module is provisionable or provisioned. See the Provision
+    # interface. Note: This returns the enabled state as well. When getting the module
+    # expiry information, we suggest making use of the enabled state returned here rather
+    # than getting enabled state separately.
+    # @rspec_example
     # @return [ModuleExpiry]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def module_expiry
       super
     end
 
     ##
-    # Gets the module keys used to license the device, including descriptive information about them. You will get active and inactive keys (and the record has a field describing whether it is active). See also get_time_limited_module_keys.
+    # Gets the module keys used to license the device, including descriptive information
+    # about them. You will get active and inactive keys (and the record has a field describing
+    # whether it is active). See also get_time_limited_module_keys.
+    # @rspec_example
     # @return [ModuleKey]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def module_keys
       super
     end
 
     ##
-    # Gets the list of registration keys used to license the device. This returns the base key first, then add-on keys. As of v10.0.0, there are new add-on keys that are time limited; with this method you can tell they are there but not when they expire. If that matters, you should use the newer method get_time_limited_module_keys. All of the keys returned are active keys.
+    # Gets the list of registration keys used to license the device. This returns the base
+    # key first, then add-on keys. As of v10.0.0, there are new add-on keys that are time
+    # limited; with this method you can tell they are there but not when they expire. If
+    # that matters, you should use the newer method get_time_limited_module_keys. All of
+    # the keys returned are active keys.
+    # @rspec_example
     # @return [String]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def registration_keys
       super
     end
 
     ##
     # Gets the kernel dossier based on this registration keys.
+    # @rspec_example
     # @return [String]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [String] :registration_keys The list of registration keys used to get the kernel dossier.
     def system_dossier(opts)
@@ -126,17 +156,21 @@ module IControl::Management
     end
 
     ##
-    # Gets the time limited module keys used to license the device, including descriptive information about them. You will get active and inactive keys (and the record has a field describing whether it is active).
+    # Gets the time limited module keys used to license the device, including descriptive
+    # information about them. You will get active and inactive keys (and the record has
+    # a field describing whether it is active).
+    # @rspec_example
     # @return [TimeLimitedModuleKey]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def time_limited_module_keys
       super
     end
 
     ##
     # Gets the version information for this interface.
+    # @rspec_example
     # @return [String]
     def version
       super
@@ -144,9 +178,10 @@ module IControl::Management
 
     ##
     # Installs and authorizes the device using this stream of license file data.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [char] :license_file_data The license file data.
     def install_license(opts)
@@ -156,9 +191,10 @@ module IControl::Management
 
     ##
     # Installs and authorizes the device using this license file somewhere on the device.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [String] :license_file The license file location.
     def install_license_from_file(opts)
@@ -168,10 +204,11 @@ module IControl::Management
 
     ##
     # Checks to see whether the device is running with an evaluation license.
+    # @rspec_example
     # @return [boolean]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def is_evaluation_license
       super
     end
@@ -199,15 +236,17 @@ module IControl::Management
     end
 
     ##
-    # A struct that describes a module key. Note: description fields in this structure are for information only and content in them is not guaranteed to remain constant. The primary programmatic use of this structure is to obtain license keys.
+    # A struct that describes a module key. Note: description fields in this structure
+    # are for information only and content in them is not guaranteed to remain constant.
+    # The primary programmatic use of this structure is to obtain license keys.
     # @attr [String] description A description of the module.
     # @attr [String] key The license key.
-    # @attr [String] child_description A sequence of strings giving child module descriptions.
+    # @attr [StringSequence] child_description A sequence of strings giving child module descriptions.
     # @attr [Object] active The key status (active or inactive).
     class ModuleKey < IControl::Base::Struct
       icontrol_attribute :description, String
       icontrol_attribute :key, String
-      icontrol_attribute :child_description, String
+      icontrol_attribute :child_description, StringSequence
       icontrol_attribute :active, Object
     end
 
@@ -223,7 +262,9 @@ module IControl::Management
     end
 
     ##
-    # A struct that describes a time limited module key. Note: description fields in this structure are for information only and content in them is not guaranteed to remain constant. The primary programmatic use of this structure is to obtain license keys.
+    # A struct that describes a time limited module key. Note: description fields in this
+    # structure are for information only and content in them is not guaranteed to remain
+    # constant. The primary programmatic use of this structure is to obtain license keys.
     # @attr [String] description A description of the module.
     # @attr [String] key The license key.
     # @attr [IControl::Management::LicenseAdministration::ModuleKeyTimeLimits] limits The time limits for the module key.

data/lib/icontrol/management/named.rb

@@ -1,15 +1,17 @@
 module IControl::Management
   ##
-  # The Named interface provides the calls to manipulate the named.conf and the named server
+  # The Named interface provides the calls to manipulate the named.conf and the named
+  # server
   class Named < IControl::Base
 
     set_id_name "statements"
 
     ##
     # Deletes the &amp;quot;acl" statement specified by the statement names.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [String] :statement_names The names of the acl Statements
     def delete_acl_statement(opts)
@@ -18,19 +20,22 @@ module IControl::Management
     end
 
     ##
-    # Deletes the &amp;quot;controls" statement. There can only be one &amp;quot;controls" statement in the file.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # Deletes the &amp;quot;controls" statement. There can only be one &amp;quot;controls"
+    # statement in the file.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def delete_controls_statement
       super
     end
 
     ##
     # Deletes the &amp;quot;include" statement.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [String] :path_names The path_names for the include files
     def delete_include_statement(opts)
@@ -40,9 +45,10 @@ module IControl::Management
 
     ##
     # Deletes this &amp;quot;key" statement.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [String] :statement_names The names of the statements to delete
     def delete_key_statement(opts)
@@ -51,28 +57,33 @@ module IControl::Management
     end
 
     ##
-    # Deletes an &amp;quot;logging" statement. There can only be one &amp;quot;logging" statement in the file.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # Deletes an &amp;quot;logging" statement. There can only be one &amp;quot;logging"
+    # statement in the file.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def delete_logging_statement
       super
     end
 
     ##
-    # Deletes the &amp;quot;options" statement. There can only be one &amp;quot;options" statement in the file.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # Deletes the &amp;quot;options" statement. There can only be one &amp;quot;options"
+    # statement in the file.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def delete_options_statement
       super
     end
 
     ##
     # Deletes the &amp;quot;server" statement.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [String] :statement_names The statements to delete.
     def delete_server_statement(opts)
@@ -81,55 +92,67 @@ module IControl::Management
     end
 
     ##
-    # Deletes an &amp;quot;trusted_keys" statement. There can only be one &amp;quot;trusted_keys" statement in the file.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # Deletes an &amp;quot;trusted_keys" statement. There can only be one &amp;quot;trusted_keys"
+    # statement in the file.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def delete_trusted_keys_statement
       super
     end
 
     ##
     # Get the version of bind (named) running on the server as a string
+    # @rspec_example
     # @return [String]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def bind_version
       super
     end
 
     ##
-    # Gets the entire contents of the named.conf file in a sequence of strings, one per line.
+    # Gets the entire contents of the named.conf file in a sequence of strings, one per
+    # line.
+    # @rspec_example
     # @return [String]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def named_configuration_file
       super
     end
 
     ##
     # Gets the version information for this interface.
+    # @rspec_example
     # @return [String]
     def version
       super
     end
 
     ##
-    # Adds the new &amp;quot;acl name" statement if they do not already exist. If the &amp;quot;acl name" statement already exists, it will delete the existing statement and replace it with this one.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # Adds the new &amp;quot;acl name" statement if they do not already exist. If the &amp;quot;acl
+    # name" statement already exists, it will delete the existing statement and replace
+    # it with this one.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def set_acl_statement
       super
     end
 
     ##
-    # Sets the &amp;quot;controls" statement. If there is no existing controls statement, one is added. If one exists, it is deleted and replaced with this new one. There can only be one &amp;quot;controls" statement in the file.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # Sets the &amp;quot;controls" statement. If there is no existing controls statement,
+    # one is added. If one exists, it is deleted and replaced with this new one. There
+    # can only be one &amp;quot;controls" statement in the file.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [IControl::Management::StatementDefinition] :statement The "controls" statement definition.
     def set_controls_statement(opts)
@@ -139,27 +162,33 @@ module IControl::Management
 
     ##
     # Adds this &amp;quot;include" statement
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def set_include_statement
       super
     end
 
     ##
-    # Sets the &amp;quot;key" statement. If a key statement with this name already exists, it is deleted and the new one is added. Otherwise the key statement will be added.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # Sets the &amp;quot;key" statement. If a key statement with this name already exists,
+    # it is deleted and the new one is added. Otherwise the key statement will be added.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def set_key_statement
       super
     end
 
     ##
-    # Sets a new &amp;quot;logging" statement. If the logging statement exists, it is deleted and replaced with the new statement. If there is no logging statement, this one is added. There can only be one &amp;quot;logging" statement in the file.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # Sets a new &amp;quot;logging" statement. If the logging statement exists, it is deleted
+    # and replaced with the new statement. If there is no logging statement, this one is
+    # added. There can only be one &amp;quot;logging" statement in the file.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [IControl::Management::StatementDefinition] :statement The statement definition.
     def set_logging_statement(opts)
@@ -168,10 +197,13 @@ module IControl::Management
     end
 
     ##
-    # If there is an existing &amp;quot;options" statement, it is replaced with this statement. If there is no existing &amp;quot;options" statement, this new one is added. There can only be one &amp;quot;options" statement in the file.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # If there is an existing &amp;quot;options" statement, it is replaced with this statement.
+    # If there is no existing &amp;quot;options" statement, this new one is added. There
+    # can only be one &amp;quot;options" statement in the file.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [IControl::Management::StatementDefinition] :statement The statement definition.
     def set_options_statement(opts)
@@ -180,19 +212,23 @@ module IControl::Management
     end
 
     ##
-    # Adds the new &amp;quot;server" statement if they do not exist. If they exist, these statement will replace them.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # Adds the new &amp;quot;server" statement if they do not exist. If they exist, these
+    # statement will replace them.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def set_server_statement
       super
     end
 
     ##
-    # Adds a new &amp;quot;trusted-keys" statement or replaces the existing one. There can only be one &amp;quot;trusted_keys" statement in the file.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # Adds a new &amp;quot;trusted-keys" statement or replaces the existing one. There
+    # can only be one &amp;quot;trusted_keys" statement in the file.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [IControl::Management::StatementDefinition] :statement The statement definition.
     def set_trusted_keys_statement(opts)