listPools

Lists basic information about all of the NSS storage pools residing on the server. This command is implemented only on NetWare and not on Linux.

Request

<listPools>

Reply

<listPools>
   <poolInfo>
      <poolName/>
      <poolState/>
      <totalBytes/>
      <freeBytes/>
      <enabledAttributeBits/>
      <result value=" ">
         <description/>
      </result>
   </poolInfo>
   <result value=" ">
      <description/>
   </result>
</listPools>

Elements

poolInfo: Repeats for each pool.
poolName: Specifies the name of the pool.
poolState: Specifies a numeric value that represents the internal state of the pool (see Pool States).
totalBytes: Specifies the total size (in bytes) of the pool.
freeBytes: Specifies the total number of bytes that are available for use in the pool. This value is calculated by taking the total size of the pool, subtracting how many bytes are actually in use, adding back the number of used bytes in the salvage system that are currently purgeable, and subtracting a free space adjustment amount (which is used by the LSS to reserve a certain amount of free space for internal use so that it always has enough free space to logging and transaction operations).
enabledAttributeBits: Specifies a hex bit value, such as 0x39 (see Enabled Attributes Bits).
result: Specifies an error value or 0 (for no error).
description: Specifies a text description of the result.

Example

A nssRequest packet to list pools is as follows:

<nssRequest>
   <pool>
      <listPools>
      </listPools>
   </pool>
</nssRequest>

A nssReply packet to the modify device command follows:

<nssReply>
   <pool>
      <listPools>
         <poolInfo>
            <poolName>SYS</poolName>
            <poolState>6</poolState>
            <totalBytes>2102394880</totalBytes>
            <freeBytes>1471926272</freeBytes>
            <enabledAttributeBits>
               0X39
            </enabledAttributeBits>
            <result value="0">
               <description/>success</description>
            </result>
         </poolInfo>

         <poolInfo>
            <poolName>MYPOOL</poolName>
            <poolState>6</poolState>
            <totalBytes>103809024</totalBytes>
            <freeBytes>94285824</freeBytes>
            <enabledAttributeBits>
               0X39
            </enabledAttributeBits>
            <result value="0">
               <description/>success</description>
            </result>
         </poolInfo>

         <result value="0">
            <description/>success</description>
         </result>
      </listPools>
   </pool>

   <result value="0">
      <description/>zOK</description>
   </result>
</nssReply>