getPoolInfo

Returns detailed information about an existing NSS storage pool on the server. Also returns the pool's segment information.

Request

<getPoolInfo type=" ">
   <poolName/>
<getPoolInfo>

Reply

<getPoolInfo> 
   <basicInfo>
      <mountPoint/>
      <poolName/>
      <ndsPoolName/>
      <ndsPoolGUID/>
      <poolGUID/>
      <poolState/>
      <nameSpaces value=" "/>
      <blockSize/>
      <size/>
      <usedSize/>
      <createdTime value=" "/>
      <modifiedTime value=" "/>
      <lssType/>
   </basicInfo>
   <attributeInfo>
      <supportedAttributes value=" ">
         <readonly/>
         <shared/>
      </supportedAttributes>
      <enabledAttributes value=" ">
         <readonly/>
         <shared/>
      </enabledAttributes>
   </attributeInfo>
   <salvageInfo>
      <freeableSize/>
      <nonFreeableSize
   </salvageInfo/>
   <volumeInfo>
      <volumeName/>
   </volumeInfo>
   <deletedVolumeInfo>
      <volumeName/>
   </deletedVolumeInfo>
   <segmentInfo>
      <segment>
         <deviceName/>
         <segmentName/>
         <deviceID/>
         <segmentID/>
         <label/>
         <offset/>
         <size/>
      </segment>
   </segmentInfo>
   <result value=" ">
      <description/>
   </result>
</getPoolInfo>

Elements

poolName

Specifies the name of the pool.

basicInfo

Specifies that the type was either all or basic.

mountPoint

Linux only. Specifies the pool's mount point.

ndsPoolName

Specifies the name of the pool's eDirectory object.

ndsPoolGUID

Specifies the globally unique ID (GUID) of the eDirectory pool object.

poolGUID

Specifies the GUID of the NSS pool.

poolState

Specifies the state of the pool:

mounted
active
deactive
maintenance
unknown

nameSpaces

Specifies a list of name spaces, separated by spaces:

DOS
Long
Macintosh
Unix

blockSize

Specifies the size of the pool's block.

size

Specifies the total size of the pool (in bytes).

usedSize

Specifies the total number of bytes used by the pool. This number also includes all files that are contained in the salvage system.

createdTime

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

modifiedTime

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

lddType

Specifies the LSS type for the pool:

ZLSS
CD9660
unknown

attributeInfo

Specifies the type was all or attributes

supportedAttributes

Specifies a list of tags that represent the attributes that are supported by the pool.

readonly

If exists, specifies that the read only feature is supported on the pool.

shared

If exists, specifies that the shareable-for-clustering feature is supported on the pool.

enabledAttributes

Specifies a list of elements that represent supported pool attributes.

salvageInfo

Specifies that the type is all or salvage.

freeableSize

Specifies the number of purgeable bytes on the pool. A purgeable file is one that is deleted but which still exists in the file system so it can be either purged or salvaged.

nonFreeableSize

Specifies the number of nonpurgeable bytes on the pool. A nonpurgeable file is one that is deleted and still exists in the file system but has not yet met the criteria for being purged automatically.

volumeInfo

Specifies that the type is all or volumes.

volumeName

(Repeating) Specifies a list of all NSS logical volume names that are contained in the pool. Each NSS logical volume is represented by one instance.

deletedVolumeInfo

Specifies that the type is all or deletedVolumes.

segmentInfo

Specifies that the type is all or segments.

deviceName

NetWare only. Specifies the name of the device on which the segment resides as assigned by Media Manager and the disk driver.

segmentName

NetWare only. Specifies the name of the segment assigned by Media Manager and the disk driver.

deviceID

On NetWare, specifies the device ID received from Media Manager. On Linux, specifies the device name.

segmentID

On NetWare, specifies the partition ID received from Media Manager. On Linux, specifies the partition name.

label

(Optional) Specifies a label that was assigned to the partition when it was created. If there is no label, an empty element is returned.

offset

Specifies the starting offset (in bytes) where the segment begins on the device.

size

Specifies the length of the segment (in bytes).

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 is returned. (See Section 11.7, Pool Types.) If not specified, all information is returned.
nameSpaces value: Specifies the decimal value of the name space mask for the pool.
value: (For createdTime and modifiedTime) Specifies the decimal UTC time.
value: (For supportedAttributes and enabledAttributes) Specifies the decimal value of the pool's bit masks.

Example

A nssRequest packet to return information on the SYS pool is as follows:

<nssRequest>
   <pool>
      <getPoolInfo type="all">
         <poolName>SYS</poolName>
      </getPoolInfo>
   </pool>
</nssRequest>

A nssReply packet to the get pool information command follows:

<nssReply>
   <pool>
      <getPoolInfo>
         <basicInfo>
            <poolName>SYS</poolName>
            <ndsPoolName>
               .CN=BRENDAL_SYS_POOL.O=novell.T=BRENDAL_TREE.
            </ndsPoolName>
            <ndsPoolGUID>
               8ABF1880-E425-11D5-B7-C1-00C04FA33547
            </ndsPoolGUID>
            <poolGUID> 
               C252E4EE-E3E8-01D5-80-00-F26070A1467D
            </poolGUID>
            <poolState>active</poolState>
            <nameSpaces value="0"></nameSpaces>
            <blockSize>4096</blockSize>
            <size>2102394880</size>
            <usedSize>1199800320</usedSize>
            <createdTime value="1015426180">
               Mar 6, 2002   7:49:40 am
            </createdTime>
            <modifiedTime value="1015426180">
               Mar 6, 2002   7:49:40 am
            </modifiedTime>
            <lssType>ZLSS</lssType>
         </basicInfo>

         <attributeInfo>
            <supportedAttributes value="123">
               <shared>
            </supportedAttributes>
            <enabledAttributes value="57">
            </enabledAttributes>
         </attributeInfo>

         <salvageInfo>
            <freeableSize>569831424</freeableSize>
            <nonFreeableSize>0</nonFreeableSize>
         </salvageInfo>

         <volumeInfo>
            <volumeName>SYS</volumeName>
         </volumeInfo>

         <deletedVolumeInfo>
         </deletedVolumeInfo>

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

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