renamePool

Renames an NSS storage pool on the server (and optionally renames the corresponding eDirectory pool object).

Request

<renamePool>
   <poolName/>
   <newPoolName/>
   <newNDSName/>
   <dontRenameNDSObject/>
</renamePool>

Reply

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

Elements

poolName: Specifies the current name of the pool.
newPoolName: Specifies the new name the pool is known by on the server.
newNDSName: (Required unless dontRenameNDSObject is specified) Specifies the new name to assign to the pool's eDirectory object. If NULL is passed, a default name is generated by prepending the server name and adding “_POOL” to the end of the name.
dontRenameNDSObject: Specifies not to rename the eDirectory object for the pool. If this element is used, newNDSName is ignored.
result: Specifies an error value or 0 (for no error).
description: Specifies a text description of the result.

Example

The following example renames MYPOOL to YOURPOOL and also renames the eDirectory pool object to the new default name:

<nssRequest>
   <pool>
      <renamePool>
         <poolName>MYPOOL</poolName>
         <newPoolName>YOURPOOL</newPoolName>
         <newNDSName>
      </renamePool>
   </pool>
</nssRequest>

A nssReply packet to the rename pool command follows:

<nssReply>
   <pool>
      <renamePool>
         <result value="0">
            <description/>success</description>
         </result>
      </renamePool>
   </pool>
 
   <result value="0">
      <description/>zOK</description>
   </result>
</nssReply>