WHM API 1 Functions - create_remote_root_transfer_session

Description

This function creates a transfer session as the root user.

Authentication

There are several methods that you can use to authenticate a transfer session with the remote server:

Authenticate as root

If you use SSH to authenticate as the  root  user, the remote server's SSH must accept root logins. For more information read OpenSSH's  sshd_config  documentation.

The following table displays the correct parameters and values for this authentication method:

You can also use an SSH public key to authenticate the root user. If the SSH public key is encrypted, include the SSH key's passphrase.

The following table displays the correct parameters and values for this authentication method:

Authenticate as a user

Many server administrators do not permit direct root logins via SSH on their servers.

• If the remote server forbids root logins, you must use another user and their password on the remote server, and then escalate to the root user. For more information read OpenSSH's sshd_config  documentation.
• If the system administrator used WHM's  Manage Wheel Group Users  interface (WHM >> Home >> Security Center >> Manage Wheel Group Users) to grant the user su access, then you will need to specify su and the root password.
• If the user has sudo access, you do not need the root password.

The following table displays the correct parameters and values for this authentication method:

You can also use an SSH public key instead of a password to authenticate that user. If the SSH public key is encrypted, include the SSH key's passphrase.

The following table displays the correct parameters and values for this authentication method:

https://hostname.example.com:2087/cpsess##########/json-api/create_remote_root_transfer_session?api.version=1&remote_server_type=cpanel&host=remote.example.com&port=22&user=root&password=12345luggage&transfer_threads=1&restore_threads=1&unrestricted_restore=1&copy_reseller_privs=0&compressed=0&unencrypted=0&low_priority=0

https://hostname.example.com:2087/cpsess##########/xml-api/create_remote_root_transfer_session?api.version=1&remote_server_type=cpanel&host=remote.example.com&port=22&user=root&password=12345luggage&transfer_threads=1&restore_threads=1&unrestricted_restore=1&copy_reseller_privs=0&compressed=0&unencrypted=0&low_priority=0

whmapi1 create_remote_root_transfer_session remote_server_type=cpanel host=remote.example.com port=22 user=root password=12345luggage transfer_threads=1 restore_threads=1 unrestricted_restore=1 copy_reseller_privs=0 compressed=0 unencrypted=0 low_priority=0

{
  "data": {
    "analyze_rawout":"Fetching information from remote host: \u201c10.1.100.35\u201d \u2026 \u2026\nDone\nFetching information from remote host: \u201c10.1.100.35\u201d \u2026 \u2026\nDone\n",
    "create_rawout":"Basic credential check \u2026 \u2026\nDone\nFetching information from remote host: \u201c10.1.100.35\u201d \u2026 \u2026\nDone\nFetching WHM Version \u2026\nDone\nTesting \u201cvm5.docs.cpanel.net\u201d for transfer streaming support with password authentication....<strong>Streaming Supported</strong>\nRemote Server Type: \u201cWHM1130\u201d\n",
    "transfer_session_id": "vm5docscpanelcopya20140430200447f69g"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "create_remote_root_transfer_session"
  }
}

<result>
    <data>
        <analyze_rawout>Fetching information from remote host: &#x201C;10.1.100.35&#x201D; &#x2026; &#x2026;
        Done
        Fetching information from remote host: &#x201C;10.1.100.35&#x201D; &#x2026; &#x2026;
        Done
    </analyze_rawout>
    <create_rawout>Basic credential check &#x2026; &#x2026;
    Done
    Fetching information from remote host: &#x201C;10.1.100.35&#x201D; &#x2026; &#x2026;
    Done
    Fetching WHM Version &#x2026;
    Done
    Testing
 &#x201C;vm5.docs.cpanel.net&#x201D; for transfer streaming 
support with password authentication....<strong>Streaming 
Supported</strong>
    Remote Server Type: &#x201C;WHM1130&#x201D;
</create_rawout>
<transfer_session_id>vm5docscpanelcopya20140430200606V06z</transfer_session_id>
</data>
<metadata>
    <version>1</version>
    <reason>OK</reason>
    <result>1</result>
    <command>create_remote_root_transfer_session</command>
</metadata>
</result>

Parameters

Returns

Fetching information from remote host: “10.1.100.35” … …
        Done
        Fetching information from remote host: “10.1.100.35” … …
        Done

Basic credential check … …
    Done
    Fetching information from remote host: “10.1.100.35” … …
    Done
    Fetching WHM Version …
    Done
    Testing
 “vm5.docs.cpanel.net” for transfer streaming 
support with password authentication....<strong>Streaming 
Supported</strong>
    Remote Server Type: &#x201C;WHM1130&#x201D;

vm5docscpanelcopya20140430200606V06z