Child pages
  • UAPI Functions - Ftp::set_homedir

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt
This function changes the home directory for FTP accounts.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledFTPRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/Ftp/set_homedir?user=example1&domain=example.com&homedir=example1%2F

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Set the home directory for the example1 FTP user.
$new_quota = $cpanel->uapi(
    'Ftp', 'set_homedir',
    array(
        'user' 	   	=> 'example1',
        'domain'  	=> 'example.com',
		'homedir'	=> 'example1/",
         )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Set the home directory for the example1 FTP user.
my $set_homedir = $cpliveapi->uapi(
    'Ftp', 'set_quota',
    {
        'user'  	=>	'example1',
        'domain' 	=>	'example.com',
		'homedir'	=>	'example1/',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Template Toolkit


Code Block
languagexml
linenumberstrue
<!-- Set the home directory for the ftpaccount FTP user. -->
[% execute( 'Ftp', 'set_homedir', { user => 'example1', domain => 'example.com', homedir => 'example1/' } ); %]

Include Page
LIB:_TTLink
LIB:_TTLink

 


Expand
titleCommand Line


Code Block
languagexml
uapi --user=username Ftp set_homedir user=example1 domain=example.com homedir=example1/

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":null
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The FTP account username.

The username of an FTP account on the cPanel account.

example1
domainstring

The user's associated domain.

This parameter defaults to the cPanel account's primary domain.

A domain that the cPanel account owns.example.com
homedirstring

The FTP account's home directory.

This parameter defaults to the user@domain subdirectory in the cPanel account's home directory with the name, where user and domain represent the user and domain parameters.

A relative path from the cPanel account's home directory.

example1/

Returns

This function returns only metadata.