Cpanel::WebDisk::addwebdisk

This article documents the usage of the Cpanel::WebDisk::addwebdisk function in relation to the cPanel interface. This tag can be used inside cPanel pages.


SYNOPSIS

Cpanel::WebDisk::addwebdisk


DESCRIPTION

This function will create a web disk.


VARIABLES

INPUT

password (string)
Password for web disk user. Format: password

domain (string)
Domain the web disk will provide access to. Format: domain.com or sub.domain.com

homedir (string)
Directory the web disk will provide access to. Relative to /home/username/

user (string)
Web disk username. Format: username

OUTPUT

login (string)
Name of the user used to login to the web disk. Format: user@domain.com

domain (string)
Domain associated with the we disk. Format: domain.com or sub.domain.com

user (string)
Username of web disk user. Format: username


EXAMPLES

<?cp WebDisk::addwebdisk(% ,login) user=$FORM{'user'},password=$FORM{'password'},domain=$FORM{'do main'},homedir=$FORM{'homedir'} ?>

This example will add a web disk based on variables taken from an html form. It will also output the username used to access the web disk, upon creation.


COPYRIGHT

Copyright 2006 cPanel Inc.