getVolumeInfo

Returns detailed information about an existing NSS logical volume. To get information about a traditional NetWare volume, use the getTraditionalVolumeInfo command.

Request

<getVolumeInfo type=" ">
   <volumeName/>
</getVolumeInfo>

Reply

<getVolumeInfo>
   <basicInfo>
      <mountPoint/>
      <volumeName/>
      <poolName/>
      <ndsVolumeName/>
      <ndsVolumeGUID/>
      <volumeGUID/>
      <owner/>
      <volumeState/>
      <nameSpaces value=" "/>
      <blockSize/>
      <volumeQuota/>
      <usedSize/>
      <totalObjects/>
      <totalFiles/>
      <createdTime value=" "/>
      <modifiedTime value=" "/>
      <archivedTime value=" "/>
      <volumeReadAhead/>
   </basicInfo>
   <attributeInfo>
      <supportedAttributes value=" ">
         <volumeEncrypted/>
         <readonly/>
         <salvage/>
         <compression/>
         <directoryQuota/>
         <userQuota/>
         <flushFiles/>
         <mfl/>
         <snapshot/>
         <backup/>
         <shredding/>
         <userTransaction/>
         <migration/>
      </supportedAttributes>
      <enabledAttributes value=" ">
         <readonly/>
         <salvage/>
         <compression/>
         <directoryQuota/>
         <userQuota/>
         <flushFiles/>
         <mfl/>
         <snapshot/>
         <backup/>
         <shredding/>
         <userTransaction/>
         <migration/>
      </enabledAttributes>
   </attributeInfo>
   <salvageInfo>
      <freeableSize/>
      <nonFreeableSize/>
      <deletedFiles/>
      <oldestDeletedTime value=" "/>
      <minKeepTime/>
      <maxKeepTime/>
      <lowWaterMark/>
      <highWaterMark/>
   </salvageInfo>
   <compressionInfo>
      <compressedFiles/>
      <compressedDeletedFiles/>
      <uncompressibleFiles/>
      <precompressionBytes/>
      <compressedBytes/>
   </compressionInfo>
   <deletedVolumeInfo>    
      <deleteState value=" ">
      <originalVolumeName/>
      <originalVolumeGUID/>
      <deletedTime value=" "/>
      <scheduledPurgeTime value=" "/>
      <lastStatus/>
      <lastStatusSetter/>
   </deletedVolumeInfo>
   <result value=" ">
      <description/>
   </result>
</getVolumeInfo>

Elements

volumeName

Specifies the name of the volume to return information for.

basicInfo

Specifies that type is all or basic.

mountPoint

Linux only. Specifies the pool's mount point.

poolName

Specifies the name of the NSS storage pool on which the volume resides.

ndsVolumeName

Specifies the fully distinguished name of the eDirectory volume object.

ndsVolumeGUID

Specifies the GUID that identifies the eDirectory volume object.

volumeGUID

Specifies the GUID that identifies the NSS volume.

owner

Specifies the user's name of the volume's owner.

volumeState

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

nameSpaces

Specifies a list of name spaces. The lookup value can be the following:

dos
long
mac
unix

blockSize

Specifies the size of the volume's block.

volumeQuota

Specifies the size quota assigned to the NSS logical volume. If a number, the volume is restricted not to grow larger than the specified size. If none is returned, the volume has no assigned quota and can grow as big as the physical size of the NSS storage pool allows.

usedSize

Specifies the total number of used bytes on the volume.

totalObjects

Specifies the total number of objects that are stored on the volume.

totalFiles

Specifies the total number of file objects that are stored on the volume.

createdTime

Specifies a string representation of the UTC time when the volume was created.

modifiedTime

Specifies a string representation of the UTC time when the volume was last modified.

archivedTime

Specifies a string representation of the UTC time when the volume was archived.

volumeReadAhead

Specifies the current read ahead setting for the volume.

attributeInfo

Specifies that type is all or attributes.

supportedAttributes

Specifies a combination of the attribute elements that are supported by the volume.

volumeEncrypted

Specifies if the volume is encrypted (zATTR_ENCRYPTED).

readonly

Specifies the read only feature is supported or enabled.

salvage

Specifies the salvage feature is supported or enabled.

compression

Specifies the compression feature is supported or enabled.

directoryQuota

Specifies the directory quota feature is supported or enabled.

userQuota

Specifies the user quota feature is supported or enabled.

flushFiles

Specifies the flush files feature is supported or enabled.

mfl

Specifies the modified file list feature is supported or enabled.

snapshot

Specifies the snapshot feature is supported or enabled.

backup

Specifies the backup bit is supported or enabled.

shredding

Specifies the data shredding feature is supported or enabled.

userTransaction

Specifies the user transaction feature is supported or enabled.

migration

Specifies the migration feature is supported or enabled.

enabledAttributes

Specifies a list of attribute elements that are currently enabled on the volume.

salvageInfo

Specifies that the type is all or salvage.

freeableSize

Specifies the number of purgeable bytes on the volume.

nonFreeableSize

Specifies the number of nonpurgeable bytes on the volume.

deletedFiles

Specifies the number of deleted files on the volume.

oldestDeletedTime

Specifies a string representation of the UTC time.

minKeepTime

Specifies the number of seconds a file must remain in a salvageable state before the file system is allowed to automatically purge the file (if free space is needed). A value of 0 indicates that all deleted files are immediate candidates for automatic purging.

lowWaterMark

Specifies the low water mark percentage for the volume. If the amount of free space on the volume falls below this percentage, an automatic purge process is initiated.

highWaterMark

Specifies the high water mark percentage for the volum.e If the amount of free space on the volume rises above this percentage, an automatic purge process is initiated.

compressionInfo

Specifies that the type is all or compression.

compressedFiles

Specifies the number of compressed files.

compressedDeletedFiles

Specifies the number of compressed deleted files.

uncompressibleFiles

Specifies the number of uncompressible files.

precompressionBytes

Specifies the number of precompression bytes.

compressedBytes

Specifies the number of compressed bytes.

deletedVolumeInfo

Specifies that type is all or deletedVolume. This information is returned only if the volume is a volume that has been deleted but is not yet purged from the NSS storage pool.

deleteState

Specifies the current state of the volume.

originalVolumeName

Specifies the original name of the volume before it was deleted.

originalVolumeGUID

Specifies the original GUID of the volume before it was deleted.

deletedTime

Specifies a string representation of the UTC time.

scheduledPurgeTime

Specifies a string representation of the UTC time.

lastStatus

Specifies an error value or 0 (for no error) for the last reported error for the volume before it was deleted.

lastStatusSetter

Specifies the source (which is the NSS standard source file line number format) that reported the lastStatus error.

result

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

description

Specifies a text description of the returned result.

Attributes

type: (Optional) Specifies what type of information to return. (See Volume Types.) The default value is all.
nameSpaces value: Specifies the decimal value of the name space mask for the volume.
value: (For createdtime, modifiedTime, archivedTime, oldestDeletedTime, deletedTime, and scheduledPurgeTime) Specifies the decimal UTC time.
value: (For supportedAttributes and enabledAttributes) Specifies the decimal value of the volume's bit masks.
value: (For deleteState) Specifies the decimal value of the delete state of the volume.

Remarks

An encrypted volume uses the volumeEncrypted element, which cannot be modified on an existing volume. If you try to modify the volumeEncrypted element, the volume is not changed.

deleteState can have the following values:

unknown
salvageable
purging
purging paused
auto purging paused
purge error
salvaging
salvage error
salvaged

First Example

A nssRequest packet to return the volume information is as follows:

<nssRequest>
   <volume>
      <getVolumeInfo type="all">
         <volumeName>MYVOL</volumeName>
      </getVolumeInfo>
   </volume>
</nssRequest>

A nssReply packet to the get volume information command follows:

<nssReply>
   <volume>
      <getVolumeInfo>
         <basicInfo>
            <volumeName>MYVOL</volumeName>
            <poolName>MYPOOL</poolName>
            <ndsVolumeName>
               .CN=MYSERVER_MYVOL.O=novell.T=MY_TREE.
            </ndsVolumeName>
            <ndsVolumeGUID>
               C2EAAA00-3211-11D6-B7-C7-00C04FA33547
            </ndsVolumeGUID>
            <volumeGUID>
               C2C86990-3211-01D6-80-00-BD09318C30CA
            </volumeGUID>
            <owner>.[Supervisor].</owner>
            <volumeState>mounted</volumeState>
            <nameSpaces value="23">
               DOS Long Macintosh Unix 
            </nameSpaces>
            <blockSize>4096</blockSize>
            <volumeQuota>none</volumeQuota>
            <usedSize>36864</usedSize>
            <totalObjects>7</totalObjects>
            <totalFiles>7</totalFiles>
            <createdTime value="1015536291">
               Mar 7, 2002   2:24:51 pm
            </createdTime>
            <modifiedTime value="1015536291">
               Mar 7, 2002   2:24:51 pm
            </modifiedTime>
            <archivedTime value="0">Invalid UTC Time
            </archivedTime>
         </basicInfo> 
         <attributeInfo>
            <supportedAttributes value="469762043">
               <salvage/>
               <compression>
               <directoryQuota>
               <userQuota>
               <flushFiles>
               <mfl>
               <snapshot>
               <shredding>
               <userTransaction>
               <migration>
            </supportedAttributes>
            <enabledAttributesvalue="50593779">
               <salvage/>
               <directoryQuota>
               <userQuota>
               <backup>
               <shredding>2</shredding>
            </enabledAttributes>
         </attributeInfo>
         <salvageInfo>
            <freeableSize>0</freeableSize>
            <nonFreeableSize>0</nonFreeableSize>
            <deletedFiles>0</deletedFiles>
            <oldestDeletedTime value="0">
               Invalid UTC Time
            </oldestDeletedTime>
            <minKeepTime>0</minKeepTime>
            <maxKeepTime>0</maxKeepTime>
            <lowWaterMark>10</lowWaterMark>
            <highWaterMark>20</highWaterMark>
         </salvageInfo>
         <compressionInfo>
            <compressedFiles>0</compressedFiles>
            <compressedDeletedFiles>0
               </compressedDeletedFiles>
            <uncompressibleFiles>0</uncompressibleFiles>
            <preCompressionBytes>0</preCompressionBytes>
            <compressedBytes>0</compressedBytes>
         </compressionInfo>
         <result value="0">
            <description/>success</description>
         </result>
      </getVolumeInfo>
   </volume>

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

Second Example

A nssRequest packet to return the volume information is as follows:

<nssRequest>
   <volume>
      <getVolumeInfo type="deletedVolume">
         <volumeName>2FNC78F4IHL3_DV</volumeName>
      </getVolumeInfo>
   </volume>
</nssRequest>

A nssReply packet to the get volume information command follows:

<nssReply>
   <volume>
      <getVolumeInfo>
          <deletedVolumeInfo>
             <deleteState value="3">auto purging paused
             </deleteState>
             <originalVolumeName>NSS2</originalVolumeName>
             <originalVolumeGUID>
                CA55AC24-3223-01D6-80-01-FBDA22AE6917
             </originalVolumeGUID>
             <deletedTime value="1015544045">
                Mar 7, 2002   4:34:05 pm
             </deletedTime>
             <scheduledPurgeTime value="1015889645">
                Mar 11, 2002   4:34:05 pm
             </scheduledPurgeTime>
             <lastStatus>0</lastStatus>
             <lastStatusSetter>zlssLogicalVolume.c[8326]
             </lastStatusSetter>
            </deletedVolumeInfo>
         <result value="0">
            <description/>success</description>
         </result>
      </getVolumeInfo>
   </volume>

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