ListVolumesRequest Class |
ListVolumesRequest
The ListVolumes method enables you to retrieve a list of volumes that are in a cluster. You can specify the volumes you want to
return in the list by using the available parameters.
Inheritance HierarchyNamespace: SolidFire.Element.Api
Assembly: SolidFire.SDK (in SolidFire.SDK.dll) Version: 12.3.0.0
SyntaxC#
public class ListVolumesRequest : RpcBase
The ListVolumesRequest type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ListVolumesRequest | Initializes a new instance of the ListVolumesRequest class |
Properties| Name | Description | |
|---|---|---|
 | Accounts |
Returns only the volumes owned by the accounts you specify here. Mutually exclusive with the volumeIDs parameter.
|
| IncludeVirtualVolumes |
Specifies that virtual volumes are included in the response by default.
To exclude virtual volumes, set to false.
|
| IsPaired |
Returns volumes that are paired or not paired.
Possible values are:
true: Returns all paired volumes.
false: Returns all volumes that are not paired.
|
| Limit |
Specifies the maximum number of volume
results that are returned. Mutually exclusive with the
volumeIDs parameter.
|
| ProtectionSchemes |
Only volumes that are using one of the protection schemes in this set are returned.
|
| StartVolumeID |
Only volumes with an ID greater than or equal to this
value are returned. Mutually exclusive with the
volumeIDs parameter.
|
| VolumeIDs |
A list of volume IDs. If you supply this parameter, other
parameters operate only on this set of volumes. Mutually
exclusive with the accounts, startVolumeID, and limit
parameters.
|
| VolumeName |
Only volume object information matching the volume
name is returned.
|
| VolumeStatus |
Only volumes with a status equal to the status value are
returned.
Possible values are:
creating
snapshotting
active
deleted
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString |
Builds a json-enabled string of all the properties and their values in this class.
(Inherited from RpcBase.) |
See Also