icontrol 0.3.1 → 0.3.2

data/lib/icontrol/arx.rb

@@ -19,6 +19,34 @@ module IControl::ARX
   class VirtualServiceDefinition < IControl::Base::Struct; end
   class VirtualServiceStats < IControl::Base::Struct; end
   class VolumeDefinition < IControl::Base::Struct; end
+  class ARXStatusTypeSequence < IControl::Base::Sequence ; end
+  class ExportDefinitionSequence < IControl::Base::Sequence ; end
+  class FileChangeDefinitionSequence < IControl::Base::Sequence ; end
+  class FileChangeResponseSequence < IControl::Base::Sequence ; end
+  class FileChangeTypeSequence < IControl::Base::Sequence ; end
+  class FileServerDefinitionSequence < IControl::Base::Sequence ; end
+  class FileServerTypeSequence < IControl::Base::Sequence ; end
+  class HARoleTypeSequence < IControl::Base::Sequence ; end
+  class HAStatusSequence < IControl::Base::Sequence ; end
+  class HealthDefinitionSequence < IControl::Base::Sequence ; end
+  class NamespaceDefinitionSequence < IControl::Base::Sequence ; end
+  class NetworkDefinitionSequence < IControl::Base::Sequence ; end
+  class NetworkStatsSequence < IControl::Base::Sequence ; end
+  class PolicyDefinitionSequence < IControl::Base::Sequence ; end
+  class PolicyScheduleIntervalTypeSequence < IControl::Base::Sequence ; end
+  class PolicyScheduleSequence < IControl::Base::Sequence ; end
+  class PolicyTypeSequence < IControl::Base::Sequence ; end
+  class ProcessorStatsSequence < IControl::Base::Sequence ; end
+  class ProtocolDefinitionSequence < IControl::Base::Sequence ; end
+  class ProtocolTypeSequence < IControl::Base::Sequence ; end
+  class ProtocolVersionSequence < IControl::Base::Sequence ; end
+  class ShareDefinitionSequence < IControl::Base::Sequence ; end
+  class SnapshotDefinitionSequence < IControl::Base::Sequence ; end
+  class StorageStatusSequence < IControl::Base::Sequence ; end
+  class VirtualServiceDefinitionSequence < IControl::Base::Sequence ; end
+  class VirtualServiceStatsSequence < IControl::Base::Sequence ; end
+  class VolumeDefinitionSequence < IControl::Base::Sequence ; end
+  class VolumeTypeSequence < IControl::Base::Sequence ; end
   class Api < IControl::Base; end
   class Chassis < IControl::Base; end
   class Export < IControl::Base; end
@@ -30,7 +58,8 @@ module IControl::ARX
   class Share < IControl::Base; end
   class VirtualService < IControl::Base; end
   class Volume < IControl::Base; end
-  # The ARXStatusType class defines the status types that can be returned by methods that return the status of an object or module.
+  # The ARXStatusType class defines the status types that can be returned by methods
+  # that return the status of an object or module.
   class ARXStatusType < IControl::Base::Enumeration; end
   # Possible File Change Types.
   class FileChangeType < IControl::Base::Enumeration; end
@@ -89,7 +118,7 @@ module IControl::ARX
   # @attr [String] change_idx The change index is used as a placeholder while retrieving batches of file changes. This value is provided to get_notifications in order to get the next set of file changes.
   # @attr [String] src_root Parent directory path of all file sources returned in this response.
   # @attr [String] dst_root Parent directory path of all file destinations returned in this response. This field is empty if it is the same as FileChangeResponse ::src_root. In this case, the caller must use the source root to reconstruct the file destination's full path.
-  # @attr [IControl::ARX::FileChangeDefinition] changes A list of file change details.
+  # @attr [IControl::ARX::FileChangeDefinitionSequence] changes A list of file change details.
   class FileChangeResponse < IControl::Base::Struct
     icontrol_attribute :count, Numeric
     icontrol_attribute :more, Object
@@ -97,7 +126,7 @@ module IControl::ARX
     icontrol_attribute :change_idx, String
     icontrol_attribute :src_root, String
     icontrol_attribute :dst_root, String
-    icontrol_attribute :changes, IControl::ARX::FileChangeDefinition
+    icontrol_attribute :changes, IControl::ARX::FileChangeDefinitionSequence
   end
 
   ##
@@ -150,12 +179,12 @@ module IControl::ARX
   # @attr [String] name The namespace's name.
   # @attr [String] description A description of the namespace.
   # @attr [IControl::ARX::ARXStatusType] status The namespace's status.
-  # @attr [IControl::ARX::ProtocolDefinition] protocols A list of protocols configured for this namespace.
+  # @attr [IControl::ARX::ProtocolDefinitionSequence] protocols A list of protocols configured for this namespace.
   class NamespaceDefinition < IControl::Base::Struct
     icontrol_attribute :name, String
     icontrol_attribute :description, String
     icontrol_attribute :status, IControl::ARX::ARXStatusType
-    icontrol_attribute :protocols, IControl::ARX::ProtocolDefinition
+    icontrol_attribute :protocols, IControl::ARX::ProtocolDefinitionSequence
   end
 
   ##
@@ -312,12 +341,12 @@ module IControl::ARX
   # @attr [String] name The name of the snapshot.
   # @attr [Numeric] create_time The creation time of the snapshot.
   # @attr [String] volume_path The snapshot path relative to the root of the virtual volume in NFS format: {@literal //}
-  # @attr [String] backend_paths A list of paths to the physical snapshots that compose this virtual snapshot for all of the included shares in the virtual volume in NFS format: {@literal :///}
+  # @attr [StringSequence] backend_paths A list of paths to the physical snapshots that compose this virtual snapshot for all of the included shares in the virtual volume in NFS format: {@literal :///}
   class SnapshotDefinition < IControl::Base::Struct
     icontrol_attribute :name, String
     icontrol_attribute :create_time, Numeric
     icontrol_attribute :volume_path, String
-    icontrol_attribute :backend_paths, String
+    icontrol_attribute :backend_paths, StringSequence
   end
 
   ##
@@ -503,7 +532,8 @@ module IControl::ARX
   ## A sequence of VolumeType values.
   class VolumeTypeSequence < IControl::Base::Sequence ; end
 
-  # The ARXStatusType class defines the status types that can be returned by methods that return the status of an object or module.
+  # The ARXStatusType class defines the status types that can be returned by methods
+  # that return the status of an object or module.
   class ARXStatusType < IControl::Base::Enumeration
     # The status cannot be determined.
     ARX_UNKNOWN = :ARX_UNKNOWN

data/lib/icontrol/arx/api.rb

@@ -7,6 +7,7 @@ module IControl::ARX
 
     ##
     # Returns the ARX running release version.
+    # @rspec_example
     # @return [String]
     def version
       super

data/lib/icontrol/arx/chassis.rb

@@ -7,6 +7,7 @@ module IControl::ARX
 
     ##
     # Returns the status of this ARX's high availability peer.
+    # @rspec_example
     # @return [HAStatus]
     def ha_peer
       super
@@ -14,6 +15,7 @@ module IControl::ARX
 
     ##
     # Returns this ARX's high availability status.
+    # @rspec_example
     # @return [HAStatus]
     def ha_status
       super
@@ -21,6 +23,7 @@ module IControl::ARX
 
     ##
     # Returns a list of system health events.
+    # @rspec_example
     # @return [HealthDefinition]
     def health
       super
@@ -28,6 +31,7 @@ module IControl::ARX
 
     ##
     # Returns the system hostname.
+    # @rspec_example
     # @return [String]
     def hostname
       super
@@ -35,6 +39,7 @@ module IControl::ARX
 
     ##
     # Returns the ARX chassis hardware version.
+    # @rspec_example
     # @return [String]
     def hw_version
       super
@@ -42,6 +47,7 @@ module IControl::ARX
 
     ##
     # Returns the ARX model.
+    # @rspec_example
     # @return [String]
     def model
       super
@@ -49,6 +55,7 @@ module IControl::ARX
 
     ##
     # Returns a list of processor statistics for this system.
+    # @rspec_example
     # @return [ProcessorStats]
     def processor_stats
       super
@@ -56,6 +63,7 @@ module IControl::ARX
 
     ##
     # Returns the ARX serial number.
+    # @rspec_example
     # @return [String]
     def serial
       super
@@ -63,6 +71,7 @@ module IControl::ARX
 
     ##
     # Returns a list of storage system statuses.
+    # @rspec_example
     # @return [StorageStatus]
     def storage_status
       super
@@ -70,6 +79,7 @@ module IControl::ARX
 
     ##
     # Returns the system software version.
+    # @rspec_example
     # @return [String]
     def sw_version
       super
@@ -77,6 +87,7 @@ module IControl::ARX
 
     ##
     # Returns the system type.
+    # @rspec_example
     # @return [String]
     def type
       super

data/lib/icontrol/arx/export.rb

@@ -6,7 +6,9 @@ module IControl::ARX
     set_id_name "virtual_service"
 
     ##
-    # Returns the list of export definitions for a list of exports from this virtual servic and protocol.
+    # Returns the list of export definitions for a list of exports from this virtual servic
+    # and protocol.
+    # @rspec_example
     # @return [ExportDefinition]
     # @param [Hash] opts
     # @option opts [IControl::ARX::ProtocolType] :protocol Protocol type.
@@ -18,6 +20,7 @@ module IControl::ARX
 
     ##
     # Returns the list of exports for this virtual servic and protocol.
+    # @rspec_example
     # @return [String]
     # @param [Hash] opts
     # @option opts [IControl::ARX::ProtocolType] :protocol The protocol type.

data/lib/icontrol/arx/file_change_notification.rb

@@ -1,12 +1,16 @@
 module IControl::ARX
   ##
-  # The FileChangeNotification Interface lets applications monitor and manage ARX file data storage activity.
+  # The FileChangeNotification Interface lets applications monitor and manage ARX file
+  # data storage activity.
   class FileChangeNotification < IControl::Base
 
     set_id_name "namespace"
 
     ##
-    # Complete the file change notification session established by FileChangeNotification::start_notifications. If the caller does not call this function, the file change notification session will be automatically cleared after no requests received for an hour.
+    # Complete the file change notification session established by FileChangeNotification::start_notifications.
+    # If the caller does not call this function, the file change notification session will
+    # be automatically cleared after no requests received for an hour.
+    # @rspec_example
     # @return [String]
     # @param [Hash] opts
     # @option opts [String] :session_id File change notification session identifier returned by FileChangeNotification ::start_notifications.
@@ -16,7 +20,13 @@ module IControl::ARX
     end
 
     ##
-    # Retrieve file and directory changes that took place during the window of time defined by from_snapshot and to_snapshot. The caller may call this function repeatedly until there are no more file changes. When a fault occurs, the caller must discard the current session and start a new session. When the fault is not arxFaultFcnRescan or arxFaultFcnSessionRestart, the caller can resume from where they left off by providing the last received change_idx to the first get_notifications call in the new session.
+    # Retrieve file and directory changes that took place during the window of time defined
+    # by from_snapshot and to_snapshot. The caller may call this function repeatedly until
+    # there are no more file changes. When a fault occurs, the caller must discard the
+    # current session and start a new session. When the fault is not arxFaultFcnRescan
+    # or arxFaultFcnSessionRestart, the caller can resume from where they left off by providing
+    # the last received change_idx to the first get_notifications call in the new session.
+    # @rspec_example
     # @return [FileChangeResponse]
     # @param [Hash] opts
     # @option opts [String] :session_id File change notification session identifier returned by FileChangeNotification ::start_notifications.
@@ -29,6 +39,7 @@ module IControl::ARX
 
     ##
     # Returns a list of snapshot definitions for a list of specified snapshots.
+    # @rspec_example
     # @return [SnapshotDefinition]
     # @param [Hash] opts
     # @option opts [String] :volume The volume name.
@@ -41,6 +52,7 @@ module IControl::ARX
 
     ##
     # Returns a list of snapshots for a notification rule.
+    # @rspec_example
     # @return [String]
     # @param [Hash] opts
     # @option opts [String] :volume The volume name.
@@ -51,7 +63,16 @@ module IControl::ARX
     end
 
     ##
-    # Start processing file and directory changes. If the from_snapshot parameter is non-zero, then the changes that occurred between the creation time of the snapshot specified by from_snapshot and the creation time of the snapshot specified by to_snapshot will be processed. If the from_snapshot parameter is 0, then all files that exist in the snapshot specified by to_snapshot will be processed. This function creates a new file change notification session that the caller uses to get all file changes that occurred between from_snapshot and to_snapshot. The caller passes the returned session id to FileChangeNotification::get_notifications to get file changes and FileChangeNotification::finish_notifications to complete the session. In case of error, this function generates a SOAP fault.
+    # Start processing file and directory changes. If the from_snapshot parameter is non-zero,
+    # then the changes that occurred between the creation time of the snapshot specified
+    # by from_snapshot and the creation time of the snapshot specified by to_snapshot will
+    # be processed. If the from_snapshot parameter is 0, then all files that exist in the
+    # snapshot specified by to_snapshot will be processed. This function creates a new
+    # file change notification session that the caller uses to get all file changes that
+    # occurred between from_snapshot and to_snapshot. The caller passes the returned session
+    # id to FileChangeNotification::get_notifications to get file changes and FileChangeNotification::finish_notifications
+    # to complete the session. In case of error, this function generates a SOAP fault.
+    # @rspec_example
     # @return [String]
     # @param [Hash] opts
     # @option opts [String] :volume Volume name.

data/lib/icontrol/arx/file_server.rb

@@ -7,6 +7,7 @@ module IControl::ARX
 
     ##
     # Returns a list of file server definitions for this file servers.
+    # @rspec_example
     # @return [FileServerDefinition]
     def definition
       super
@@ -14,6 +15,7 @@ module IControl::ARX
 
     ##
     # Returns the list of file server names.
+    # @rspec_example
     # @return [String]
     def list
       super

data/lib/icontrol/arx/namespace.rb

@@ -7,6 +7,7 @@ module IControl::ARX
 
     ##
     # Returns a list of namespace definitions for this namespace.
+    # @rspec_example
     # @return [NamespaceDefinition]
     def definition
       super
@@ -14,6 +15,7 @@ module IControl::ARX
 
     ##
     # Returns the list of configured namespace.
+    # @rspec_example
     # @return [String]
     def list
       super

data/lib/icontrol/arx/network.rb

@@ -7,6 +7,7 @@ module IControl::ARX
 
     ##
     # Returns a list of network interface definitions for this network interfaces.
+    # @rspec_example
     # @return [NetworkDefinition]
     def definition
       super
@@ -14,6 +15,7 @@ module IControl::ARX
 
     ##
     # Returns the list of network interfaces.
+    # @rspec_example
     # @return [String]
     def list
       super
@@ -21,6 +23,7 @@ module IControl::ARX
 
     ##
     # Returns a list of network interface statistics for this network interfaces.
+    # @rspec_example
     # @return [NetworkStats]
     def stats
       super

data/lib/icontrol/arx/policy.rb

@@ -7,6 +7,7 @@ module IControl::ARX
 
     ##
     # Returns the details of this policies.
+    # @rspec_example
     # @return [PolicyDefinition]
     # @param [Hash] opts
     # @option opts [String] :volume Volume name.
@@ -18,6 +19,7 @@ module IControl::ARX
 
     ##
     # Returns the list of policies for this namespac and volume.
+    # @rspec_example
     # @return [String]
     # @param [Hash] opts
     # @option opts [String] :volume Volume name.
@@ -28,6 +30,7 @@ module IControl::ARX
 
     ##
     # Returns the details of this schedule.
+    # @rspec_example
     # @return [PolicySchedule]
     # @param [Hash] opts
     # @option opts [String] :schedule Schedule name.

data/lib/icontrol/arx/share.rb

@@ -7,6 +7,7 @@ module IControl::ARX
 
     ##
     # Returns a list of share definitions for this shares.
+    # @rspec_example
     # @return [ShareDefinition]
     # @param [Hash] opts
     # @option opts [String] :volume The volume name.
@@ -18,6 +19,7 @@ module IControl::ARX
 
     ##
     # Returns the list of shares.
+    # @rspec_example
     # @return [String]
     # @param [Hash] opts
     # @option opts [String] :volume The volume name.

data/lib/icontrol/arx/virtual_service.rb

@@ -7,6 +7,7 @@ module IControl::ARX
 
     ##
     # Returns the details of this virtual service.
+    # @rspec_example
     # @return [VirtualServiceDefinition]
     def definition
       super
@@ -14,6 +15,7 @@ module IControl::ARX
 
     ##
     # Returns the list of virtual service names.
+    # @rspec_example
     # @return [String]
     def list
       super
@@ -21,6 +23,7 @@ module IControl::ARX
 
     ##
     # Returns the statistics of this virtual service.
+    # @rspec_example
     # @return [VirtualServiceStats]
     def stats
       super

data/lib/icontrol/arx/volume.rb

@@ -7,6 +7,7 @@ module IControl::ARX
 
     ##
     # Returns the volume definitions for this volumes.
+    # @rspec_example
     # @return [VolumeDefinition]
     # @param [Hash] opts
     # @option opts [String] :volumes A list of volume names.
@@ -17,6 +18,7 @@ module IControl::ARX
 
     ##
     # Returns the list of volumes for this namespac.
+    # @rspec_example
     # @return [String]
     def list
       super

data/lib/icontrol/asm.rb

@@ -9,6 +9,19 @@ module IControl::ASM
   class ViolationSeverity < IControl::Base::Struct; end
   class WebApplicationGroupDefinition < IControl::Base::Struct; end
   class WebObjectType < IControl::Base::Struct; end
+  class ApplyLearningSequence < IControl::Base::Sequence ; end
+  class DynamicSessionsInUrlSequence < IControl::Base::Sequence ; end
+  class ObjectTypeTypeSequence < IControl::Base::Sequence ; end
+  class ObjectTypeTypeSequenceSequence < IControl::Base::SequenceSequence ; end
+  class PolicyTemplateSequence < IControl::Base::Sequence ; end
+  class PolicyTemplateSequenceSequence < IControl::Base::SequenceSequence ; end
+  class ViolationSequence < IControl::Base::Sequence ; end
+  class ViolationSequenceSequence < IControl::Base::SequenceSequence ; end
+  class ViolationSeveritySequence < IControl::Base::Sequence ; end
+  class WebApplicationGroupDefinitionSequence < IControl::Base::Sequence ; end
+  class WebApplicationLanguageSequence < IControl::Base::Sequence ; end
+  class WebObjectTypeSequence < IControl::Base::Sequence ; end
+  class WebObjectTypeSequenceSequence < IControl::Base::SequenceSequence ; end
   class ObjectParams < IControl::Base; end
   class Policy < IControl::Base; end
   class SystemConfiguration < IControl::Base; end
@@ -51,10 +64,10 @@ module IControl::ASM
 
   ##
   # A struct that describes a file transfer context.
-  # @attr [String] file_data The actual file content for the transfer operation.
+  # @attr [StringSequence] file_data The actual file content for the transfer operation.
   # @attr [IControl::Common::FileChainType] chain_type The flag used to indicate whether this is FIRST, MIDDLE, or LAST chunk of the file data.
   class FileTransferContext < IControl::Base::Struct
-    icontrol_attribute :file_data, String
+    icontrol_attribute :file_data, StringSequence
     icontrol_attribute :chain_type, IControl::Common::FileChainType
   end
 
@@ -103,7 +116,9 @@ module IControl::ASM
   end
 
   ##
-  # A struct that represents a web application group. This is only used in contexts in which the &amp;quot;ungrouped" special group is relevant. Otherwise, the group is represented by its name.
+  # A struct that represents a web application group. This is only used in contexts in
+  # which the &amp;quot;ungrouped" special group is relevant. Otherwise, the group is
+  # represented by its name.
   # @attr [String] value The name of the web application group.
   # @attr [Object] ungrouped_flag The flag that indicates how the value should be interpreted.		 If the ungrouped_flag is false, then the value represents the actual		 web application group name.		 If the ungrouped_flag is true, then the value is ignored/meaningless,		 and represents the special group of "ungrouped" web applications.
   class WebApplicationGroupDefinition < IControl::Base::Struct