poolFreeze

Freezes the specified pool (as an asynchronous request). Call poolFreezeStatus to check on the freeze status. Call poolThaw to indicate that you are finished with the freeze. This command is implemented only on NetWare and not on Linux.

Request

<poolFreeze>
   <poolName/>
   <timeout/>
   <holdSeconds/>
</poolFreeze>

Reply

<poolFreeze>
   <userKey value=" "/>
   <poolName value=" "/>
   <result value=" ">
      <description/>
   </result>
</poolFreeze>

Elements

poolName: Specifies the name of the pool.
timeout: Specifies the number of seconds to wait before a timeout is generated.
holdSeconds: Specifies the number of seconds to hold the results for the command.
userKey: Specifies for which freeze the results match.
result: Specifies an error value or 0 (for no error). The result applies to the freeze command.
description: Specifies a text description of the result.

Remarks

poolFreeze causes NSS to inform all registered applications to synchronize their data. After all the data for registered applications is synchronized, NSS flushes all user and system-cached data on the pool.

Only active pools can be frozen. If the specified pool is not active when poolFreeze is called, the function returns an NSS error.

If poolFreeze returns success, you must call poolThaw in a timely manner. However, if poolFreeze returns failure, do not call poolThaw.

Example

The nssRequest packet to freeze a pool follows:

<nssRequest>
   <pool>
      <poolFreeze>
         <poolName>SM</poolName>
         <timeOut>40</timeOut>
         <holdSeconds>70</holdSeconds>
      </poolFreeze>
   </pool>
</nssRequest>

The nssReply packet to freeze a pool follows:

<nssReply>
   <pool>
      <poolFreeze>
         <userKey value="28B95AB0-DBB4-01D6-80-00-B78907429F66">
         <poolName value="SM">
         <result value="0">
            <description/>success</description>
         </result>
      </poolFreeze>
   </pool>
   <result value="0">
      <description/>zOK</description>
   </result>
</nssReply>