getState

Request

<getState>
   <volumeName/>
</getState>

Reply

<getState>
   <volumeName/>
   <volumeState/>
   <result value=" ">
      <description/>
   </result>
</getState>

Elements

volumeName

Specifies the name of the volume for which to return the state.

volumeState

Specifies the state of the volume (see Volume States).

result

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

description

Specifies a text description of the result.

Example

A nssRequest packet to get a volume's state is as follows:

<nssRequest>
   <volume>
      <getState>
         <volumeName>NSS1</volumeName>
      </getState>
   </volume>
</nssRequest>

A nssReply packet to the get state command follows:

<nssReply>
   <pool>
      <getState>
         <volumeName>SYS</volumeName>
         <volumeState>active</volumeState>
         <result value="0">
            <description/>success</description>
         </result>
      </getState>
   </pool>

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