getPoolSnapshotInfo (Linux)

Returns information for a specified pool snapshot.

Request

<getPoolSnapshotInfo>
   <snapName/>
</getPoolSnapshotInfo>

Reply

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

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 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 get a pool snapshot named MYPOOL_S1.

An nss request to get pool snapshot information:

<nssRequest>
  <pool>
    <getPoolSnapshotInfo>
      <snapName>MYPOOL_S1</snapName>
    </getPoolSnapshotInfo>
  </pool>
</nssRequest>    

An nss reply packet to get pool snapshot information:

<nssReply>
  <pool>
    <getPoolSnapshotInfo>
    <poolSnapshotInfo>
      <snapName>MYPOOL_S1</snapName>
      <poolName>MYPOOL</poolName>
      <snapPoolName>sdb2</snapPoolName>
      <allocatedSize>102400</allocatedSize>
      <poolSize>200672</poolSize>
      <percentFull>1</percentFull>
      <state>Active</state>
      <mountPoint>/opt/novell/nss/mnt/.pools/SNAP1</mountPoint>
      <writeable/>
    </poolSnapshotInfo>      <result value="0">
        <description>success</description>
      </result>
    </getPoolSnapshotInfo>  </pool>      <result value="0">
        <description>zOK</description>
      </result>
</nssReply>