listPoolSnapshots

Lists all existing pool snapshots and their related information.

Request

<listPoolSnapshots>
   <poolName/>
   <details/>
</listPoolSnapshots>

Reply

<listPoolSnapshots>
   <poolSnapshotInfo>
      <snapName/>
      <poolName/>
      <snapPoolName/>
      <poolSize/>
      <time/>
      <allocatedSize/>
      <state/>
      <result value="">
         <description/>
      </result>
   </poolSnapshotInfo>
   <result value="">
      <description/>
   </result>
</listPoolSnapshots>

Elements

poolName

Specifies the name of the pool to return information for.

details

Specifies to return the detailed information for the existing pools. If this element isn’t included, listPoolSnapshots returns only a list of snapPoolName elements.

snapName

Specifies the name of the pool snapshot.

poolName

Specifies the name of the pool of which to take a snapshot.

snapPoolName

Specifies the name of the pool on which to store the snapshot data.

time

Specifies the UTC time when the pool snapshot was created.

allocatedSize

Specifies the number of sectors allocated to the snapshot.

state

Specifies the state of the pool:

  • active
  • deactive
result

Specifies an error value or 0 (for no error).

description

Specifies a text description of the result.