scanSalvageableFiles

Request

<salvage>
   <scanSalvageableFiles>
      <volumeName/>
      <scanSequence/>
      <nameSpace/>
      <parentID/>
      <parentPath/>
      <parentFullPath/>
      <typeOfInfo>
         <rightsInfo/>
         <standardInfo/>
         <timeInfo/>
         <idInfo/>
         <symlink/>
         <dataStreamInfo/>
         <nameSpaceInfo/>
         <deletedInfo/>
      </typeOfInfo>
   </scanSalvageableFiles>
</salvage>

Reply

<salvage>
   <scanSalvageableFiles>
      <nextScanSequence/>
      <fileName/>
      <typeOfInfo>
         <rightsInfo>
            <trusteeList>
               <trusteeInfo>
                  <trustee>
                  <rights>
                     <supervisor/>
                     <read/>
                     <write/>
                     <create/>
                     <erase/>
                     <modify/>
                     <fileScan/>
                     <accessControl/>
                     <salvage/>
                     <secure/>
                  </rights>
                  </trustee>
               </trusteeInfo>
            </trusteeList>
            <inheritedRightsFilter>
               <supervisor/> 
               <read/>
               <write/>
               <create/>
               <erase/>
               <modify/>
               <fileScan/>
               <accessControl/>
               <salvage/>
               <secure/>
            </inheritedRightsFilter>
            <effectiveRights>
               <supervisor/>
               <read/>
               <write/>
               <create/>
               <erase/>
               <modify/>
               <fileScan/>
               <accessControl/>
               <salvage/>
               <secure/>
            </effectiveRights>
         </rightsInfo>
         <standardInfo>
            <volumeName/>
            <id/>
            <parentID/>
            <logicalEOF/>
            <physicalEOF/>
            <attributes>
               <readOnly/>
               <hidden/>
               <system/>
               <subdirectory/>
               <archive/>
               <shareable/>
               <noSuballoc/>
               <transaction/>
               <notVirtual/>
               <renameInhibit/>
               <deleteInhibit/>
               <copyInhibit/>
               <adminLink/>
               <link/>
               <remoteDataAccess/>
               <remoteDataInhibit/>
               <compressImmediatePurge/>
               <dataStreamCompress/>
               <doNotCompress/>
               <noStreamCompress/>
               <attrArchive/>
               <volatile/>
            </attributes>
         </standardInfo>
         <timeInfo>
            <createdTime>
               <utc/>
               <string/>
            </createdTime>
            <archivedTime>
               <utc/>
               <string/>
            </archivedTime>
            <modifiedTime>
                <utc/>
                <string/>
            </modifiedTime>
            <accessedTime>
               <utc/>
               <string/>
            </accessedTime>
            <metaDataModifiedTime>
               <utc/>
               <string/>
            </metaDataModifiedTime>
         </timeInfo>
         <idInfo>
            <creator>
               <name/>
               <id/>
            </creator>
            <archiver>
               <name/>
               <id/>
            </archiver>
            <modifier>
               <name/>
               <id/>
            </modifier>
            <metaDataModifier>
               <name/>
               <id/>
            </metaDataModifier>
         </idInfo>
         <dataStreamInfo/>
            <count/>
            <totalDataSize>
         </dataStreamInfo>
         <nameSpaceInfo>
         <deletedInfo>
            <deletedTime>
               <utc/>
               <string/>
            </deletedTime>
            <deletorID>
         </deletedInfo>
      </typeOfInfo>
      <result value=" ">
         <description/>
      </result>
   </scanSalvageableFiles>
</salvage>

Elements

volumeName

Specifies the name of the volume.

scanSequence

Specifies where to start the scan (in string format of a 64-bit unsigned integer). -1 specifies to start from the beginning.

nameSpace

Specifies the name space of the file name.

parentID

Specifies the zID of the directory to be scanned (in string format of a 64-bit unsigned integer).

parentPath

Specifies the path of the directory to scan. An empty string indicates the volume root directory.

parentFullPath

Specifies the path of the directory to scan. This path can be a rooted Linux path or a NetWare path that includes the volume name.

typeOfInfo

Specifies the categories of information to return.

rightsInfo

Specifies to return information on trustee rights.

standardInfo

Specifies to return general information about the file (EOF, ID, attributed, etc.).

timeInfo

Specifies to return the creation, modification, archival, and access times.

idInfo

Specifies to return the creation, modification, and archiver user names and IDs. If the ID cannot be found, the name returns Unknown User.

dataStreamInfo

Specifies to return the non-primary data stream count, size, etc.

nameSpaceInfo

Specifies to return the primary name space information.

deletedInfo

Specifies to return information about deleted files.

nextScanSequence

Specifies the next scan sequence (in 64-bit unsigned integer format).

fileName

Specifies the deleted file name (in CDATA format).

rightsInfo

Specifies the rights information (only if rightsInfo was specified in the request).

trusteeInfo

Repeats for each assigned trustee.

trustee

Specifies the right-rooted, dot-delimited trustee name.

rights

Specifies the assigned rights.

inheritedRightsFilter

Specifies the rights in the current filter.

standardInfo

Specifies the generic information for the file.

volumeName

Specifies the name of the logical volume that contains the file.

id

Specifies the unique ID for a file or a volume (in string format of a 64-bit unsigned integer).

(Optional) symLink

Specifies not to follow the link.

parentID

Specifies the primary parent ID (in string format of a 64-bit unsigned integer).

logicalEOF

Specifies the location of the end of good data in the file.

physicalEOF

Specifies the number of allocated bytes for the file (unless the file is sparse).

timeInfo

Specifies various time stamps for the file.

utc

Specifies the UTC time.

string

Specifies the date, converted to a string.

idInfo

Specifies various user IDs.

creator

Specifies the right-rooted, dot-delimited eDirectory name of the creator.

archiver

Specifies the right-rooted, dot-delimited eDirectory name of the archiver.

modifier

Specifies the right-rooted, dot-delimited eDirectory name of the modifier.

metaDataModifier

Specifies the right-rooted, dot-delimited eDirectory name of the metadata modifier.

dataStreamInfo

Specifies the non-primary data stream information.

count

Specifies the number of data streams.

totalDataSize

Specifies the total size (in bytes) of the data stream.

nameSpaceInfo

Specifies the primary name space:

• DOS
• Long
• Macintosh
• Unix

deletorID

Specifies the right-rooted, dot-delimited eDirectory name.

result

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

description

Specifies a text description of the result.

Example

<virtualIO>
   <datastream name="command"/>
</virtualIO>

<fileRequest>
   <salvage>
      <scanSalveageableFiles>
         <volumeName>test</volumeName>
         <scanSequence>-1</scanSequence>
         <nameSpace>DOS</nameSpace>
         <parentID/>
         <parentPath>test:\testdir</parentPath>
         <typeOfInfo>
            <rightsInfo/>
            <standardInfo/>
            <timeInfo/>
            <idInfo/>
            <dataStreamInfo/>
            <nameSpaceInfo/>
            <deletedInfo/>
         </typeOfInfo>
      </scanSalvageableFiles>
   </salvage>