icontrol 0.3.1 → 0.3.2

data/lib/icontrol/system/connections.rb

@@ -1,61 +1,71 @@
 module IControl::System
   ##
-  # The Connections interface enables you to get information about a device's connections. For example, use Connection interface to get a list of all active connections or to get a list of all active connections for a specific client.
+  # The Connections interface enables you to get information about a device's connections.
+  # For example, use Connection interface to get a list of all active connections or
+  # to get a list of all active connections for a specific client.
   class Connections < IControl::Base
 
     set_id_name "connections"
 
     class ActiveConnection < IControl::Base::Struct; end
-    class ConnectionID < IControl::Base::Struct; end    ##
+    class ConnectionID < IControl::Base::Struct; end
+    class ActiveConnectionSequence < IControl::Base::Sequence ; end
+    class ConnectionIDSequence < IControl::Base::Sequence ; end    ##
     # Deletes this connection from the connection table.
-    # @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 delete_active_connection
       super
     end
 
     ##
     # Deletes all active connection from the connection table.
-    # @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 delete_all_active_connections
       super
     end
 
     ##
     # Gets the active connection in details for this connection.
+    # @rspec_example
     # @return [ActiveConnection]
-    # @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 active_connection
       super
     end
 
     ##
     # Gets all active connection in details on the local load balancer.
+    # @rspec_example
     # @return [ActiveConnection]
-    # @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 all_active_connections
       super
     end
 
     ##
     # Gets the list of active connection.
+    # @rspec_example
     # @return [ConnectionID]
-    # @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 list
       super
     end
 
     ##
     # Gets the version information for this interface.
+    # @rspec_example
     # @return [String]
     def version
       super

data/lib/icontrol/system/disk.rb

@@ -1,17 +1,43 @@
 module IControl::System
   ##
-  # The Disk interface enables you to manage the disks in the system. The disk objects come in two flavors. "Physical disks" are the actual hardware disk drives, which can be anything from a true hard disk to a compact flash drive to a USB flash drive. Physical disks are addressed by their serial numbers. "Logical disks" are the view of the disk drives from the system's point of view, abstracting the disk itself, making all disk drives look the same whether they are a true hard disk, a flash drive, or a full disk array. In other words, a logical disk can hold one or more physical disks. Logical disks are addressed by the LogicalDisk identifier, which includes their logical name (e.g., "HD2", "CF1", "MD1") and their chassis slot identifier. It is important to note the potentially confusing relationship between logical and physical disks and their identifiers. All physical disks can be addressed by a LogicalDisk identifier, though it is not guaranteed that all physical disks have an entry in the logical disk table. The logical disk identifier for a physical disk is dependent on the connection of the disk drive to the system, so can change if the system's disk drive configuration changes. On the other hand, all logical disks hold one or more physical disks, which can have a direct one-to-one mapping for a single disk drive or a one-to-many mapping for a disk array. To avoid problems, physical disks should be ideally addressed only by their serial numbers and logical disks only by their LogicalDisk identifiers. Addressing physical disks by their LogicalDisk identifier is supported as a convenience for any user-generated input. Be careful with these distinctions as you use this interface.
+  # The Disk interface enables you to manage the disks in the system. The disk objects
+  # come in two flavors. "Physical disks" are the actual hardware disk drives,
+  # which can be anything from a true hard disk to a compact flash drive to a USB flash
+  # drive. Physical disks are addressed by their serial numbers. "Logical disks"
+  # are the view of the disk drives from the system's point of view, abstracting the
+  # disk itself, making all disk drives look the same whether they are a true hard disk,
+  # a flash drive, or a full disk array. In other words, a logical disk can hold one
+  # or more physical disks. Logical disks are addressed by the LogicalDisk identifier,
+  # which includes their logical name (e.g., "HD2", "CF1", "MD1")
+  # and their chassis slot identifier. It is important to note the potentially confusing
+  # relationship between logical and physical disks and their identifiers. All physical
+  # disks can be addressed by a LogicalDisk identifier, though it is not guaranteed that
+  # all physical disks have an entry in the logical disk table. The logical disk identifier
+  # for a physical disk is dependent on the connection of the disk drive to the system,
+  # so can change if the system's disk drive configuration changes. On the other hand,
+  # all logical disks hold one or more physical disks, which can have a direct one-to-one
+  # mapping for a single disk drive or a one-to-many mapping for a disk array. To avoid
+  # problems, physical disks should be ideally addressed only by their serial numbers
+  # and logical disks only by their LogicalDisk identifiers. Addressing physical disks
+  # by their LogicalDisk identifier is supported as a convenience for any user-generated
+  # input. Be careful with these distinctions as you use this interface.
   class Disk < IControl::Base
 
     set_id_name "disks"
 
     class LogicalDisk < IControl::Base::Struct; end
+    class LogicalDiskSequence < IControl::Base::Sequence ; end
+    class LogicalDiskSequenceSequence < IControl::Base::SequenceSequence ; end
+    class RAIDStatusSequence < IControl::Base::Sequence ; end
     # An enumeration of RAID status.
     class RAIDStatus < IControl::Base::Enumeration; end    ##
-    # Adds physical disk to a set of logical disk arrays. For a clustered system, this must be run on the chassis slot holding the disk array. This only works for logical disk which represent disk arrays.
-    # @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 physical disk to a set of logical disk arrays. For a clustered system, this
+    # must be run on the chassis slot holding the disk array. This only works for logical
+    # disk which represent disk arrays.
+    # @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[]] :serial_numbers The serial numbers of the physical disks to add to each specified logical disk array.
     def add_array_member(opts)
@@ -20,10 +46,16 @@ module IControl::System
     end
 
     ##
-    # Adds physical disk to a set of logical disk arrays. For a clustered system, this must be run on the chassis slot holding the disk array. This only works for logical disk which represent disk arrays. This method does exactly the same thing as &amp;quot;add_array_member", except that the added physical disk are specified by their LogicalDisk identifiers, more convenient for user input than the serial numbers used in &amp;quot;remove_array_member". It is supplied for convenience purposes only.
-    # @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 physical disk to a set of logical disk arrays. For a clustered system, this
+    # must be run on the chassis slot holding the disk array. This only works for logical
+    # disk which represent disk arrays. This method does exactly the same thing as &amp;quot;add_array_member",
+    # except that the added physical disk are specified by their LogicalDisk identifiers,
+    # more convenient for user input than the serial numbers used in &amp;quot;remove_array_member".
+    # It is supplied for convenience purposes only.
+    # @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::System::Disk::LogicalDisk[]] :names The identifiers of the logical disks to add to each specified logical disk array.
     def add_array_member_by_logical_id(opts)
@@ -32,21 +64,26 @@ module IControl::System
     end
 
     ##
-    # Gets a list of physical disk that are members of a logical disk. Note that this can be used for any type of logical disk -- single disk drives or disk arrays. However, it may not work for all physical disk logical identifiers.
+    # Gets a list of physical disk that are members of a logical disk. Note that this can
+    # be used for any type of logical disk -- single disk drives or disk arrays. However,
+    # it may not work for all physical disk logical identifiers.
+    # @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 array_member
       super
     end
 
     ##
-    # Gets RAID disk array statuses for a set of physical disk. Note: RAID status will be RAID_STATUS_UNDEFINED if the disk is not a member of a RAID disk array (see get_physical_disk_is_array_member).
+    # Gets RAID disk array statuses for a set of physical disk. Note: RAID status will
+    # be RAID_STATUS_UNDEFINED if the disk is not a member of a RAID disk array (see get_physical_disk_is_array_member).
+    # @rspec_example
     # @return [RAIDStatus]
-    # @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] :serial_numbers The serial numbers of the disks of interest.
     def array_status(opts)
@@ -56,10 +93,11 @@ module IControl::System
 
     ##
     # Gets a list of serial numbers of disk installed for a set of disk bays.
+    # @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 [long] :ids The identifiers for the disk bays of interest.
     def bay_disk_serial_number(opts)
@@ -69,80 +107,93 @@ module IControl::System
 
     ##
     # Gets a list of physical disk in the system, identified by serial number.
+    # @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 list
       super
     end
 
     ##
     # Gets a list of disk bays in the system.
+    # @rspec_example
     # @return [long]
-    # @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 list_of_bays
       super
     end
 
     ##
     # Gets a list of logical disk in the system.
+    # @rspec_example
     # @return [LogicalDisk]
-    # @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 list_of_logical_disks
       super
     end
 
     ##
-    # Gets device names for a set of logical disk. These are names like hda, hdb, etc. (Note: Currently, the strings are for descriptive purposes and are subject to change).
+    # Gets device names for a set of logical disk. These are names like hda, hdb, etc.
+    # (Note: Currently, the strings are for descriptive purposes and are subject to change).
+    # @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 logical_disk_device_name
       super
     end
 
     ##
-    # Gets the formats for a set of logical disk. These are strings like multiboot, lvm, etc. (Note: Currently, the strings are for descriptive purposes and are subject to change).
+    # Gets the formats for a set of logical disk. These are strings like multiboot, lvm,
+    # etc. (Note: Currently, the strings are for descriptive purposes and are subject to
+    # change).
+    # @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 logical_disk_format
       super
     end
 
     ##
-    # Gets media types for a set of logical disk. These are strings like hd, cf, cft, etc. (Note: Currently, the strings are for descriptive purposes and are subject to change).
+    # Gets media types for a set of logical disk. These are strings like hd, cf, cft, etc.
+    # (Note: Currently, the strings are for descriptive purposes and are subject to change).
+    # @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 logical_disk_media
       super
     end
 
     ##
     # Gets sizes (in MiB) for a set of logical disk.
+    # @rspec_example
     # @return [long]
-    # @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 logical_disk_size
       super
     end
 
     ##
-    # Gets names for a set of physical disk. This name is part of the physical disk's LogicalDisk identifier.
+    # Gets names for a set of physical disk. This name is part of the physical disk's LogicalDisk
+    # identifier.
+    # @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] :serial_numbers The serial numbers of the disks of interest.
     def name(opts)
@@ -151,11 +202,13 @@ module IControl::System
     end
 
     ##
-    # Gets slot identifiers for a set of physical disk. The slot identifier is part of the physical disk's LogicalDisk identifer.
+    # Gets slot identifiers for a set of physical disk. The slot identifier is part of
+    # the physical disk's LogicalDisk identifer.
+    # @rspec_example
     # @return [long]
-    # @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] :serial_numbers The serial numbers of the disks of interest.
     def slot_id(opts)
@@ -165,17 +218,20 @@ module IControl::System
 
     ##
     # Gets the version information for this interface.
+    # @rspec_example
     # @return [String]
     def version
       super
     end
 
     ##
-    # Gets states indicating whether a disk is a member of a RAID disk array for a set of physical disk.
+    # Gets states indicating whether a disk is a member of a RAID disk array for a set
+    # of physical disk.
+    # @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] :serial_numbers The serial numbers of the disks of interest.
     def is_array_member(opts)
@@ -185,19 +241,23 @@ module IControl::System
 
     ##
     # Gets an indication of whether the system is capable of RAID operations.
+    # @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_raid_capable
       super
     end
 
     ##
-    # Removes phyiscal disk from a set of logical disk arrays. For a clustered system, this must be run on the chassis slot holding the disk array. This only works for logical disk which represent disk arrays.
-    # @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.
+    # Removes phyiscal disk from a set of logical disk arrays. For a clustered system,
+    # this must be run on the chassis slot holding the disk array. This only works for
+    # logical disk which represent disk arrays.
+    # @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[]] :serial_numbers The serial numbers of the physical disks to add to each specified logical disk array.
     def remove_array_member(opts)
@@ -206,10 +266,17 @@ module IControl::System
     end
 
     ##
-    # Removes physical disk from a set of logical disk arrays. For a clustered system, this must be run on the chassis slot holding the disk array. This only works for logical disk which represent disk arrays. This method does exactly the same thing as &amp;quot;remove_array_member", except that the removed physical disk are specified by their LogicalDisk identifiers, more convenient for user input than the serial numbers used in &amp;quot;remove_array_member". It is supplied for convenience purposes only.
-    # @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.
+    # Removes physical disk from a set of logical disk arrays. For a clustered system,
+    # this must be run on the chassis slot holding the disk array. This only works for
+    # logical disk which represent disk arrays. This method does exactly the same thing
+    # as &amp;quot;remove_array_member", except that the removed physical disk are specified
+    # by their LogicalDisk identifiers, more convenient for user input than the serial
+    # numbers used in &amp;quot;remove_array_member". It is supplied for convenience purposes
+    # only.
+    # @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::System::Disk::LogicalDisk[]] :names
     def remove_array_member_by_logical_id(opts)

data/lib/icontrol/system/failover.rb

@@ -1,45 +1,55 @@
 module IControl::System
   ##
-  # The Failover interface enables you to manipulate a device's fail-over states. For example, you can get the state, active or standby, in which a device is running in a redundant configuration. You can also switch a device's state from active to standby.
+  # The Failover interface enables you to manipulate a device's fail-over states. For
+  # example, you can get the state, active or standby, in which a device is running in
+  # a redundant configuration. You can also switch a device's state from active to standby.
   class Failover < IControl::Base
 
     set_id_name "nil"
 
+    class FailoverModeSequence < IControl::Base::Sequence ; end
+    class FailoverStateSequence < IControl::Base::Sequence ; end
     # A list of fail-over modes of operation.
     class FailoverMode < IControl::Base::Enumeration; end
     # A list of fail-over states.
     class FailoverState < IControl::Base::Enumeration; end    ##
     # Gets the current fail-over mode that the device is running in.
+    # @rspec_example
     # @return [FailoverMode]
-    # @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 failover_mode
       super
     end
 
     ##
     # Gets the current fail-over state that the device is running in.
+    # @rspec_example
     # @return [FailoverState]
-    # @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 failover_state
       super
     end
 
     ##
-    # Gets the peer IP address(es) in a redundant pair. There will be a primary address and possibly a secondary address. The primary will be the first entry in the returned list.
+    # Gets the peer IP address(es) in a redundant pair. There will be a primary address
+    # and possibly a secondary address. The primary will be the first entry in the returned
+    # list.
+    # @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 peer_address
       super
     end
 
     ##
     # Gets the version information for this interface.
+    # @rspec_example
     # @return [String]
     def version
       super
@@ -47,46 +57,53 @@ module IControl::System
 
     ##
     # Checks to see if this device is part of a redundant pair.
+    # @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_redundant
       super
     end
 
     ##
-    # Restores an active-active device configuration after a failure. You can only use this command after the DB key &amp;quot;Failover.ManFailBack" has been created, and set to a value of &amp;quot;enable".
-    # @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.
+    # Restores an active-active device configuration after a failure. You can only use
+    # this command after the DB key &amp;quot;Failover.ManFailBack" has been created, and
+    # set to a value of &amp;quot;enable".
+    # @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_failback
       super
     end
 
     ##
     # Sets the device to &amp;quot;forced offline" state.
-    # @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_offline
       super
     end
 
     ##
     # Sets the device to release the &amp;quot;forced offline" state.
-    # @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_offline_release
       super
     end
 
     ##
     # Sets the device to standby mode.
-    # @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_standby
       super
     end