Retrieving File System Information

This operation makes sense only if performing migration in Plesk for Unix.

Before starting a migration, you may want to get information on the source or destination file system, in order to specify the most suitable directory for storing migration dump. To get a server file system information, send request packet containing the get_fs operation node structured as follows:

<packet>
 <migration>
   <get_fs/>
 </migration>
</packet>  
Response Packet Structure

The get_fs node in the response packet received from server is structured as follows:

  • The result node is required. It wraps the result of the get_fs operation. Data type: MigrationOutputGetFsResultType.
  • The status node is required. It returns the execution status of the get_fs operation. Data type: string. Allowed values: ok | error.
  • The errcode node is optional. It returns the error code when the get_fs operation fails. Data type: unsignedInt.
  • The errtext node is optional. It returns the error message if the get_fs operation fails. Data type: string.
  • The fs node is required. It holds the collection of data describing a file system on the host. The number of the fs nodes in the response packet is equal to number of partitions on the host (ignoring swap partition). Data type: FS.
  • The mountpoint node is required. It returns the partition mount point. Data type: string.
  • The device node is required. It returns the device on which the file system exists. Data type: string.
  • The mode node is required. It returns mount options of the file system. Data type: FsReadWriteStatus. Allowed values: rw | r.
  • The size node is required. It returns total size of the file system (in bytes). Data type: string.
  • The free node is required. It returns the amount of free space on the file system (in bytes). Data type: string.
  • The type node is required. It returns the file system type. Data type: string
Response Samples

A positive response received from server can look as follows:

<packet>
<migration>
<get_fs>
   <result>
      <status>ok</status>
      <fs>
         <mountpoint>/</mountpoint>
         <device>/dev/sda1</device>
         <mode>rw</mode>
         <size>4015644672</size>
         <free>1549070336</free>
         <type>ext3</type>
      </fs>
   </result>
</get_fs>
</migration>
</packet>

 

A negative response received from Plesk for Windows server looks as follows:

<packet>
  <migration>
    <get_fs>
      <result>
        <status>error</status>
        <errcode>1017</errcode>
        <errtext>operator get_fs is  not supported</errtext>
      </result>
    </get_fs>
  </migration>
</packet>
 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.