listPoolSnapshots (Linux)

Request

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

Reply

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

Elements

details

(optional) Specifies whether to return all information. Otherwise, only the snapshot names are returned.

poolName

(optional) Specifies to return only the snapshots of the specified pool.

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 segment or partition on which to store the snapshot data.

allocatedSize

Specifies the allocated size of the segment or partition on which to store the snapshot data.

poolSize

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

percentFull

Specifies how full (as a percentage) the segment or partition on which to store the snapshot is.

state

Specifies the state of the pool:

• active
• deactive

mountPoint

Specifies the mount point of the snapshot.

writeable

Specifies that the snapshot is writeable.

result

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

description

Specifies a text description of the result.

Example

The following is an example to list all pool snapshots and their related information.

An nss request to list pool snapshots and their information:

<nssRequest>
  <pool>
    <listPoolSnapshots>
      <details/>
    </listPoolSnapshots>
  </pool>
</nssRequest>    

An nss reply packet to list pool snapshots and their information:

<nssReply>
  <pool>
    <listPoolSnapshots>
    <poolSnapshotInfo>
      <snapName>MYPOOL_S1</snapName>
      <poolName>MYPOOL</poolName>
      <snapPoolName>sdb2</snapPoolName>
      <allocatedSize>102400</allocatedSize>
      <poolSize>200672</poolSize>
      <percentFull>1</percentFull>
      <state>Active</state>
      <mountPoint>not mounted</mountPoint>
      <writeable/>
    </poolSnapshotInfo>
    </listPoolSnapshots>      <result value="0">
        <description>success</description>
      </result>
    </listPoolSnapshots>
    </listPoolSnapshots>  </pool>      <result value="0">
        <description>zOK</description>
      </result>
</nssReply>