multiPath

Allows the user to control the behavior of multiple adaptors that are connected to the same device(s). The controllable behaviors include listing the current configuration, setting priorities for each path, setting path on-line and off-line, and selecting the path to use. Multiple paths can exist due to multiple adaptors and/or ports to the same device.

Request

<multiPath>
   <resetRegistry/>
   <multiPathInfo/>
   <setPathPriority>
      <pathID/>
      <priority/>
      <insert/>
   </setPathPriority>
   <selectPath>
      <pathID/>
   </selectPath>
   <setPathState>
      <pathID/>
      <state/>
   </setPathState>
   <selectDefaultPath>
      <deviceID/>
   </selectDefaultPath>
</multiPath>

Reply

<multiPath>
   <resetRegistry>
      <result value=" "/>
      <description/>
   </resetRegistry>
   <multiPathInfo>
      <deviceName/>
      <deviceID/>
      <pathInfo>
         <pathName/>
         <pathID/>
         <priority/>
         <adapterID/>
         <port/>
         <status>
            <up/>
            <selected/>
            <loadBalance/>
         </status>
         <result value=" ">
            <description/>
         </result>
      </pathInfo>
      <result value=" ">
         <description/>
      </result>
   </multiPathInfo>
   <setPathPriority>
      <result value=" ">
         <description/>
      </result>
   </setPathPriority>
   <selectPath>
      <result value=" ">
         <description/>
   </selectPath>
   <setPathState>
      <result value=" ">
         <description/>
      </result>
   </setPathState>
   <selectDefaultPath>
      <deviceID/>
      <result value=" ">
         <description/>
   </selectDefaultPath>
   <result value=" ">
      <description/>
   </result>         
</multiPath>

Elements

resetRegistry: Specifies to reset the Media Manager failover registry entries.
multiPathInfo: Specifies to request all paths for all devices.
setPathPriority: Specifies the path priority.
pathID: (Required) On NetWare, specifies the path ID received from Media Manager. On Linux, specifies the path name.
priority: (Required) Specifies the priority value (0 equals highest priority).
insert: (Optional) Specifies to bump all entries with an equal priority to a priority lower than the one being set.
selectPath: Specifies the path to be used to get to a device.
setPathState: Specifies to set a path either up or down.
state: Specifies up or down.
selectDefaultPath: Specifies to select the path with the highest priority.
deviceID: On NetWare, specifies the device ID received from Media Manager. On Linux, specifies the device object name.
result: Specifies an error value or 0 (for no error).
description: Specifies a text description of the returned result.
deviceName: NetWare only.
pathInfo: Repeats for each path to a device.
adapterID: NetWare only.
status: Specifies the set states.

Example

The following example returns information from a system where two different devices are connected to the same two adaptors:

<nssRequest>
   <device>
      <multiPath>
         <multiPathInfo/>
      </multipath>
   </device>
</nssRequest>

A nssReply packet to the multiple path command follows:

<nssReply>
   <device>
      <multiPath>
         <multiPathInfo>
            <deviceName>
               [V345-A2-D2:0] SEAGATE ST34573W
               rev:5764
            </deviceName>
            <deviceID>23</deviceID>
            <pathInfo>
               <pathName>
                  [V345-A2-D2:0] SEAGATE ST34573W
                  rev:5764
               </pathName>
               <pathID>8</pathID>
               <priority>0</priority>
               <adaptorID>6</adaptorID>
               <port>0</port>
               <status><up><selected></status>
               <result value="0">
                  <description/>success
                  </description>
               </result>
            </pathInfo>
            <pathInfo>
               <pathName>
                  [V345-A3-D2:0] SEAGATE ST34573W
                  rev:5764
               </pathName>
               <pathID>15</pathID>
               <priority>0</priority>
               <adaptorID>13</adaptorID>
               <port>0</port>
               <status><up></status>
               <result value="0">
                  <description/>success
                  </description>
               </result>
            </pathInfo>

            <result value="0">
               <description/>success
               </description>
            </result>
         </multiPathInfo>

         <multiPathInfo>
            <deviceName>
               [V345-A3-D0:0] SEAGATE ST34573W
               rev:5764
            </deviceName>
            <deviceID>32</deviceID>
            <pathInfo>
               <pathName>
                  [V345-A2-D0:0] SEAGATE ST34573W
                  rev:5764
               </pathName>
               <pathID>7</pathID>
               <priority>2</priority>
               <adaptorID>6</adaptorID>
               <port>0</port>
               <status><up></status>
               <result value="0">
                  <description/>success
                  </description>
               </result>
            </pathInfo>
            <pathInfo>
               <pathName>
                  [V345-A3-D0:0] SEAGATE ST34573W
                  rev:5764
               </pathName>
               <pathID>14</pathID>
               <priority>1</priority>
               <adaptorID>13</adaptorID>
               <port>0</port>
               <status><up><selected></status>
               <result value="0">
                  <description/>success
                  </description>
               </result>
            </pathInfo>

            <result value="0">
               <description/>success
               </description>
            </result>
         </multiPathInfo>
         
         <result value="0">
            <description/>success
            </description>
         </result>
      </multiPath>
   </device>
</nssreply>