addPool

Request

<addPool state=" ">
   <poolName/>
   <ndsName/>
   <context/>
   <noNDSOjbect/>
   <partitions>
      <partitionID/>
   </partitions>
   <lssType/>
   <ignoreShareState/>
   <cluster>
      <advertisingProtocol/>
      <ipAddress/>
      <virtualServerName/>
      <cifsVirtualServerName/>
   </cluster>
</addPool>

Reply

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

Elements

poolName

Specifies the name to be given to the new pool.

ndsName

(Required unless noNDSObject is used) Specifies the name of the eDirectory pool object that represents the pool. If NULL is passed, the name of the eDirectory pool object is generated by prepending the server name and an underscore to the poolName value and adding “_POOL” to the end of the name.

context

(Required unless noNDSObject is used) Specifies the eDirectory context in which the eDirectory pool object is created. If NULL is passed, the eDirectory pool 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 pool. If used, the ndsName and context elenments are ignored.

partitions

Specifies a list of one or more partitionID elements.

partitionID

Repeats for each partition being added to the new pool. Specifies the logical ID. If the partition has HotFix and mirroring, the ID is the mirror group ID for the partition. If the partition does not have HotFix and mirroring, the ID is the raw physical partition ID.

lssType

Specifies the loadable storage system type to be used by the new pool. Currently, the only supported type is “ZLSS.”

ignoreShareState

(Optional) Specifies that no check is performed to see if the device is marked shareable for clustering. Usually, the server checks to validate that the clustering software is loaded and operaitonal before allowing pools to be created on a device that is marked shareable.

cluster

(Optional) Specifies that the NSS pool should be auto-enabled to work with clustering software. Use this element only if the device on which the pool is being created is marked shareable for clustering.

advertisingProtocol

(Optional) Specifies a space-separated list of protocols on which the clustered pool advertises its clustering services:

• cifs
• afp
• ncp

ipAddress

(Required) Specifies the IP address to assign to the virtual server for the clustered pool.

virtualServerName

(Required) Specifies the name to assign to the eDirectory virtual server object. If you do not choose your own name, call getDefaultClusterNames to retrieve the suggested default virtualServerName before calling addPool.

cifsVirtualServerName

(Required if advertisingProtocol is cifs) Specifies the name to be used to advertise the cluster virtual server on the CIFS protocol. If advertisingProtocol does not specify cifs, this element is ignored.

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

• active
• deactive

Example

The following is an example of adding a pool named MYPOOL. addPool creates the pool and adds a pool object into eDirectory in the same eDirectory container as the server. The name of the eDirectory pool object is <serverName>_MYPOOL. The pool consumes two partition with IDs 20 and 23.

<nssRequest>
   <pool>
      <addPool state="active">
         <poolName>MYPOOL</poolName>
         <ndsName>
         <context>
         <lssType>ZLSS</lssType>
         <partitions>
            <partitionID>20</partitionID>
            <partitionID>23</partitionID>
         </partitions>
      </addPool>
   </pool>
</nssRequest>

A nssReply packet to the add pool command follows:

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

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