poolFreezeStatus

Returns the status of a freeze request. This command is implemented only on NetWare and not on Linux.

Request

<poolFreezeStatus>
   <userKey/>
</poolFreezeStatus>

Reply

<poolFreezeStatus>
   <userKey value=" "/>
   <poolName value=" "/>
   <timeOut value=" "/>
   <holdSeconds value=" "/>
   <thawDone value=" "/>
   <thawStatus value=" "/>
   <thawOperationReturnCode value=" "/>
   <freezeDone value=" "/>
   <freezeStatus value=" "/>
   <results/>
   <count used=" " needed=" "/>
   <application>
      <status value=" "/>
      <source value=" "/>
      <sourceMessage value=" "/>
   </application>
</results>
<result value=" ">
   <description/>
</result>
</poolFreezeStatus>

Elements

userKey

Specifies the key (from the poolFreeze command) that indicates from which freeze to return the status.

poolName

Specifies the name of the pool.

timeOut

Specifies the number of seconds before the freeze times out.

holdSeconds

Specifies the number of seconds before the status is no longer available.

thawDone

Specifies whether the thaw is complete:

TRUE
FALSE

thawStatus

Specifies the zERR code of the thaw command (only if the thaw is complete and thawDone is TRUE). Otherwise, this element is not used.

thawOperationReturnCode

Specifies the zERR code that was supplied to the thaw command (only if the thaw is complete and thawDone is TRUE). This value might not be the same value that was passed to poolThaw. For example, if the thaw was automatically performed because of a timeout, this value is set to indicate that condition. If thawDone is FALSE, this element is not used.

freezeDone

Specifies whether the freeze portion is complete:

TRUE
FALSE

freezeStatus

Specifies the zERR code of the freeze command (only if the freeze is complete and freezeDone is TRUE). To determine if the applications have frozen their data, see the results element. Zero indicates that the freeze completed successfully. If freezeDone is FALSE, this element is not used.

results

Specifies application-specific results. This element is used only if freezeDone is TRUE.

count

Specifies the number of application results.

application

Repeats for each application that is registered to freeze its data.

status

Specifies the zERR code from the specified application freeze attempt.

source

Specifies the application name.

sourceMessage

Specifies an application help message. This message can contain information as to why an application cannot freeze its data.

result

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

description

Specifies a text description of the result.

Attributes

used: Specifies how many application results have been returned.
needed: Specifies the total number of application results. If this value does not equal the number specified in the used attribute, some results are not present. You can correct this state by performing another freeze and thaw on the pool.

Example

Before Calling a Thaw

The nssRequest packet to return the status of a freeze before calling a thaw follows:

<nssRequest>
   <pool>
      <poolFreezeStatus>
         <userKey>28B95AB0-DBB4-01D6-80-00-B78907429F66</userKey>
      </poolFreezeStatus>
   </pool>
</nssRequest>

The nssReply packet containing the freeze status follows:

<nssReply>
   <pool>
      <poolFreezeStatus>
         <userKey value="28B95AB0-DBB4-01D6-80-00-B78907429F66">
         <poolName value="SM">
         <timeOut value="39">
         <holdSeconds value="69">
         <thawDone value="FALSE">
         <freezeDone value="TRUE">
         <freezeStatus value="0">
         <results>
            <count used="2" needed="2">
            <application>
               <status value="0">
               <source value="Novell.FreezeEventUnitTest.Handler2">
               <sourceMessage value="Hi mom">
            </application>
            <application>
               <status value="0">
               <source value="Novell.FreezeEventUnitTest.Handler1">
               <sourceMessage value="Hello world">
            </application>
         </results>
         <result value="0">
            <description/>success</description>
         </result>
      </poolFreezeStatus>
   </pool>
   <result value="0">
      <description/>zOK</description>
   </result>
</nssReply>

After Calling a Thaw

The nssRequest packet to return the status of a freeze after calling a thaw follows:

<nssRequest>
   <pool>
      <poolFreezeStatus>
         <userKey>28B95AB0-DBB4-01D6-80-00-B78907429F66</userKey>
      </poolFreezeStatus>
   </pool>
</nssRequest>

The nssReply packet containing the freeze status follows:

<nssReply>
   <pool>
      <poolFreezeStatus>
         <userKey value="28B95AB0-DBB4-01D6-80-00-B78907429F66">
         <poolName value="SM">
         <timeOut value="34">
         <holdSeconds value="64">
         <thawDone value="TRUE">
         <thawStatus value="0">
         <thawOperationReturnCode value="0">
         <freezeDone value="TRUE">
         <freezeStatus value="0">
         <results>
            <count used="2" needed="2">
            <application>
               <status value="0">
               <source value="Novell.FreezeEventUnitTest.Handler2">
               <sourceMessage value="Hi mom">
            </application>
            <application>
               <status value="0">
               <source value="Novell.FreezeEventUnitTest.Handler1">
               <sourceMessage value="Hello world">
            </application>
         </results>
         <result value="0">
            <description/>success</description>
         </result>
      </poolFreezeStatus>
   </pool>
   <result value="0">
      <description/>zOK</description>
   </result>
</nssReply>