addTraditionalVolume

Request

<addTraditionalVolume state=" ">
   <volumeName/>
   <ndsName/>
   <context/>
   <noNDSObject/>
   <noDFSGUID/>
   <dfsGUID/>
   <blockSize/>
   <compression/>
   <suballocation/>
   <migration/>
   <volSegments>
      <segment>
         <partitionID/>
         <volStartingSector/>
         <volNumSectors/>
      </segment>
   </volSegments>
   <updateVLDB>
</addTraditionalVolume>

Reply

<addTraditionalVolume> 
   <result value=" ">
      <description/>
   </result>
</addTraditionalVolume>

Elements

volumeName

(Required) Specifies the name to give the volume being created.

ndsName

(Required unless noNDSObject is specified) Specifies the name of the eDirectory volume object to create that represents the created volume. If NULL is specified, the name of the eDirectory volume object is generated by prepending the server name and an underscore to the volumeName element.

context

(Required unless noNDSObject is specified) Specifies the eDirectory context in which the eDirectory volume object is created. If NULL is specified, the eDirectory volume object is created in the same eDirectory context where the server object resides.

noNDSObject

(Optional) Specifies that no eDirectory objects should be created for the volume. The ndsName and context elements are ignored.

noDFSGUID

(Optional) Specifies that no DFS GUID is assigned to the volume when it is created. If specified, dfsGUID and updateVLDB might not be used.

dfsGUID

(Optional) Specifies the value of the DFS GUID that is used to identify the volume in distributed file system (DFS) operations. If not specified, the file system generates a new DFS GUID for each volume being created.

blockSize

(Required) Specifies the block size (in bytes) of the traditional volume:

• 4096
• 8192
• 16384
• 32768
• 65536

compression

Specifies that the traditional volume is created with the compression feature enabled.

suballocation

Specifies that the traditional volume is created with the suballocation feature enabled.

migration

Specifies that the traditional volume is created with the data migration feature enabled.

volSegments

Repeats for each volume segment on the traditional volume. A volume segment can be either a whole partition or a portion of a partition.

segment

Repeats for each volume segment that needs to be included in the traditional volume.

partitionID

Specifies the logical ID of a partition that's being added to the new traditional volume. If the partition has HotFix and mirroring, it is the mirror group ID for the partition. If the partition does not have HotFix and mirroring, it is the ID of the raw physical partition.

volStartingSector

Specifies the starting sector offset within the partition of the segment to include.

volNumSectors

Specifies the number of sectors to include.

updateVLDB

Specifies that the DFS Volume Location Database (VLDB) is updated by the XML processing code. This element is added for backward-compatibility with ConsoleOne, which does not know about this element but does its own VLDB updating. All new code should include this element.

result

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

description

Specifies a text description of the result.

Attributes

state

(Optional) Specifies what state the volume should be set to after it is created:

• mounted
• dismounted

If a state is not specified, the volume defaults to whatever state the file system policies dictate.

Example

The following is an example of adding a traditional volume called "VOL1" on partition 28. It adds an eDirectory volume object using the default name of "servername_VOL1" and puts the eDirectory volume object in the same eDirectory context as the server itself.

<nssRequest>
   <volume>
      <addTraditionalVolume state="mounted">
         <volumeName>VOL1</volumeName>
         <ndsName>
         <context>
         <blockSize>65536</blockSize>
         <suballocation>
         <volSegments>
            <segment>
               <partitionID>28</partitionID>
               <volStartingSector>0</volStartingSector>
               <volNumSectors>202752</volNumSectors>
            </segment>
         </volSegments>
      </addTraditionalVolume>
   </volume>
</nssRequest>

A nssReply packet to the add traditional volume command follows:

<nssReply>
   <volume>
      <addTraditionalVolume>
         <result value="0">
            <description/>success</description>
         </result>
      </addTraditionalVolume>
   </volume>

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