addVolume

Creates an NSS logical volume on an existing NSS storage pool. By default, addVolume also creates the corresponding eDirectory volume object (unless instructed not to). To create a traditional NetWare volume, use the addTraditionalVolume command.

Request

<addVolume state=" ">
   <volumeName/>
   <poolName/>
   <volumePassword/>
   <ndsName/>
   <context/>
   <ndsPoolName/>
   <noNDSOjbect/>
   <noDFSGUID/>
   <updateVLDB/>
   <volumeGUID/>
   <dfsGUID/>
</addVolume>

Reply

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

Elements

volumeName

(Required) Specifies the name of the volume to create.

poolName

(Required) Specifies the name of the NSS storage pool on which the volume is created.

volumePassword

Specifies to create an ecrypted volume.

ndsName

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

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.

ndsPoolName

(Required unless noNDSObject is specified) Specifies the value to use as the nssfsPool attribute for the eDirectory volume object. If NULL is specified, the pool's eDirectory name is retrieved and is used for the nssfsPool attribute.

noNDSObject

(Optional) Specifies that no eDirectory objects should be created for the volume. If this element is specified, the ndsName, context, and ndsPoolName elements are ignored.

noDFSGUID

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

updateVLDB

Specifies that the DFS Volume Location Database (VLDB) is updated by the XML processing code. This element was 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.

volumeGUID

(Optional) Specifies a globally unique ID (GUID) to be assigned to the volume that is being created. Usually, the file system assigns a new GUID to each volume that is being created.

dfsGUID

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

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 shoudl be set to after it is created:

  • deactive
  • active
  • mounted

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

Remarks

An encrypted volume uses the volumePassword field.

Example

The following is an example of the addVolume command that creates a volume called "MYVOL" on the "MYPOOL" pool. It adds an eDirectory volume object using the default name of "servername_MYVOL" and puts the eDirectory volume object in the same eDirectory context as the server itself. This example uses the actual eDirectory pool object name for the nssfsPool attribute of the volume object.

<nssRequest>
   <volume>
      <addVolume state="mounted">
         <volumeName>MYVOL</volumeName>
         <poolName>MYPOOL</poolName>
         <ndsName>
         <context>
         <ndsPoolName>
      </addVolume>
   </volume><
/nssRequest>

A nssReply packet to the add volume command follows:

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

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