listPartitions

Obtains a detailed list of all partitions. listPartitions can be used to list either all of the partitions on the entire server or all the partitions that exist on a single device.

Request

<listPartitions> 
   <deviceID/>
</listPartitions>

Reply

<listPartition>
   <partitionInfo>
      <deviceName/>
      <partitionName/>
      <deviceID/>
      <partitionType/>
      <partitionID/>
      <label/>
      <startingSector/>
      <numSectors/>
      <logicalPartitionID/>
      <logicalPartitionCapacity/>
      <mirrorID/>
      <hotFixID/>
      <hotFixSize/>
      <hotFixAvailSize/>
      <poolName/>
      <volumes>
         <volumeInfo>
            <volumeName/>
            <volStartingSector/>
            <volNumSectors/>
         </volumeInfo>
      </volumes>
      <raidID/>
      <result value=" ">
         <description/>
      </result>
   </partitionInfo>
</listPartition>

Elements

deviceName

Specifies the name of the device on which the partition resides, as assigned by Media Manager and the disk driver.

partitionName

Specifies the name of the partition, as assigned by Media Manager and the disk driver.

deviceID

On input, specifies that only the partitions on this device are returned. If not used, all partition on all devices are returned.

On output, specifies the device on which the partition resides, as assigned by Media Manager at boot time.

partitionID

Specifies the physical partition ID, as assigned by Media Manager. The ID represents the physical partition itself but does not represent any HotFix or mirror objects of the partition.

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.

startingSector

Specifies the starting sector offset where the partitions begins on the device.

numSectors

Specifies the length (in sectors) of the partition.

logicalPartitionID

Specifies the logical partition ID that should be used when creating NSS pools or traditional volumes on the partition. If the partition does not have HotFix and mirroring, this ID is the same as the physical partition ID. Otherwise, this ID is the same as the mirrorID. This element is filled only if partitionType is NSS or traditional NetWare.

logicalPartitionCapacity

Specifies the actual capacity (in sectors) of the logical partition. If the partition contains HotFix and mirroring objects, the capacity is smaller than the size of the physical partition due to the overhead associated with HotFix. This element is filled only if partitionType is NSS or traditional NetWare.

mirrorID

Specifies the ID of the mirror group. If the partition does not belong to a mirror group, the ID is 0. This element is filled only if partitionType is NSS or traditional NetWare.

hotFixID

Specifies the ID of the HotFix object. If the partition does not have a HotFix object, the ID is 0. This element is filled only if partitionType is NSS or traditional NetWare.

hotFixSize

Specifies the size (in sectors) of the HotFix area that is reserved to track bad block redirection. If the partition does not have a HotFix object, the size is 0. This element is filled only if partitionType is NSS or traditional NetWare.

hotFixAvailSize

Specifies the useable size (in sectors) of the HotFix area that is reserved to track bad block redirection. HotFix has some overhead, so this size is smaller than the size in hotFixSize. If the partition does not have a HotFix object, the size is 0. This element is filled only if partitionType is NSS or traditional NetWare.

poolName

Specifies the name of the pool if the partition is an NSS partition and a pool has been created that uses the partition. This element is filled only if partitionType is NSS and if the partition is currently owned by an NSS pool.

volumes

Specifies that the partition has one or more traditional volume segments on it. This element is filled only if partitionType is traditional NetWare.

volumeInfo

Repeats for each volume segment on the partition.

volumeName

Specifies the name of the traditional NetWare volume that owns this segment of the partition.

volStartingSector

Specifies the starting sector number of the piece of the partition that is owned by the volume.

volNumSectors

Specifies the number of sectors that are owned by the volume at the starting sector offset.

raidID

Specifies the Media Manager device ID of the RAID device that consumes this virtual device partition. This element is filled only if partitionType is virtual device.

result

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

description

Specifies a text description of the result.

Example

A nssRequest packet to list partitions is as follows:

<nssRequest>
   <partition>
      <listPartitions>
   </partition>
</nssRequest>

The following nssReply packet shows three partitions, all on deviceID one. The first partitionInfo represents a DOS partition, the second partitionInfo represents an NSS partition, and the third partitionInfo represents an unpartitioned free space at the end of the device.

<nssReply>
   <partition>
      <partitionInfo>
         <deviceName>
            [V312-A0-D0:0] WDIGTL WDE4360-1807A3 rev:1.80
         </deviceName>
         <partitionName>
            [V312-A0-D0:0-P0] Big DOS; OS/2; Win95 Partition
         </partitionName>
         <deviceID>1</deviceID>
         <partitionType>6</partitionType>
         <partitionID>10</partitionID>
         <label></label>
         <startingSector>63</startingSector>
         <numSectors>417627</numSectors>
         <result value="0">
            <description/>success</description>
         </result>
      </partitionInfo>

      <partitionInfo>
         <deviceName>
            [V312-A0-D0:0] WDIGTL WDE4360-1807A3 rev:1.80
         </deviceName>
         <partitionName>
            [V312-A0-D0:0-PCB] NSS Partition
         <partitionName>
         <deviceID>1</deviceID>
         <partitionType>105</partitionType>
         <partitionID>11</partitionID>
         <label></label>
         <startingSector>417690</startingSector>
         <numSectors>4116480</numSectors>
         <logicalPartitionID>23</logicalPartitionID>
         <logicalPartitionCapacity>
            4108200
         </logicalPartitionCapacity>
         <mirrorID>23</mirrorID>
         <hotFixID>22</hotFixID>
         <hotFixSize>8280</hotFixSize>
         <hotFixAvailSize>8056</hotFixAvailSize>
         <poolName>SYS</poolName>
         <result value="0">
            <description/>success</description>
         </result>
      </partitionInfo>

      <partitionInfo>
         <deviceName>
            [V312-A0-D0:0] WDIGTL WDE4360-1807A3 rev:1.80
         </deviceName>
         <partitionName>
            [V312-A0-D0:0-P8A5] Free Partition Space
         </partitionName>
         <deviceID>1</deviceID>
         <partitionType>0</partitionType>
         <partitionID>13</partitionID>
         <label></label>
         <startingSector>4534170</startingSector>
         <numSectors>3851760</numSectors>
         <result value="0">
            <description/>success</description>
         </result>
      </partitionInfo>
   </partition>

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