cPanel XMLAPI - setacls


DESCRIPTION

This function sets the ACL or specific ACL items for a reseller.


VARIABLES

NOTE: Calling the XML API function without defining an ACL option will disable that ACL option (See EXAMPLES for more detail).

INPUT

reseller (string)
This is the username of the reseller to effect.

acllist (string)
Name of the ACL list. NOTE: Can not be used with specific acl-x-x variables. You must either use a acllist or a set of specific variables.

acl-add-pkg (boolean)
Allow the creation of packages (Use

acl-add-pkg-ip (boolean)
Allow the creation of packages with dedicated IPs (Use

acl-add-pkg-shell (boolean)
Allow the creation of packages with shell access (Use

acl-all (boolean)
All features (Warning: Root Access!) (Use

acl-allow-addoncreate (boolean)
Allow the creation of packages with unlimited addon domains (Use

acl-allow-parkedcreate (boolean)
Allow the creation of packages with parked domains (Use

acl-allow-unlimited-disk-pkgs (boolean)
Allow the creation of packages with unlimited disk space (Use

acl-allow-unlimited-pkgs (boolean)
Allow the creation of packages with unlimited bandwidth (Use

acl-clustering (boolean)
Enable Clustering (Use

acl-create-acct (boolean)
Create a New Account (Use

acl-create-dns (boolean)
Add DNS Zones (Use

acl-demo-setup (boolean)
Turn an account into a demo account (Use

acl-disallow-shell (boolean)
Never allow creation of accounts with shell / ssh access (Use

acl-edit-account (boolean)
Modify an Account (Use

acl-edit-dns (boolean)
Edit DNS Zones (Use

acl-edit-mx (boolean)
Edit MX Entries (Use

acl-edit-pkg (boolean)
Edit Packages (Use

acl-frontpage (boolean)
Install / Uninstall FrontPage Extensions (Use

acl-kill-acct (boolean)
Terminate an Account (Use

acl-kill-dns (boolean)
Remove DNS Entry (Use

acl-limit-bandwidth (boolean)
Modify Bandiwdth Limits. WARNING: This will allow the reseller to circumvent package bandiwdth limits if you are not using resource limits! (Use

acl-list-accts (boolean)
List Accounts (Use

acl-mailcheck (boolean)
Mail Troubleshooter (Use

acl-mod-subdomains (boolean)
Enable / Disbale Subdomains (Use

acl-news (boolean)
Modify cPanel/WHM news (Use

acl-onlyselfandglobalpkgs (boolean)
Prevent creation of accounts with packages that are not global or not owned by this user (Use

acl-park-dns (boolean)
Park Domains (Use

acl-passwd (boolean)
Password Modification (Use

acl-quota (boolean)
Quota Modification WARNING: This will resellers to circumvent package limits for disk space if you are not using resource limits! (Use

acl-rearrange-accts (boolean)
Rearrange Accounts (Use

acl-res-cart (boolean)
Reset Shopping Cart (Use

acl-resftp (boolean)
Synchronize FTP Passwords (Use

acl-restart (boolean)
Restart Services (Use

acl-show-bandwidth (boolean)
View Account Bandwidth Usage (Use

acl-ssl (boolean)
SSL Manager (Use

acl-ssl-buy (boolean)
Purchase and Install SSL Certificates (Use

acl-ssl-gencrt (boolean)
SSL CSR/CRT Generator (Use

acl-stats (boolean)
View Account Statistics (Use

acl-status (boolean)
View Server Status (Use

acl-suspend-accts (boolean)
Suspend accounts (Use

acl-upgrade-account (boolean)
Account upgrades / downgrades (Use

OUTPUT

setacls
Operation information container

results
Results of the operation container

acls (string)
Name of an ACL that has been set.

statusmsg (string)
Related status / error message


EXAMPLES

Enabling / Disabling ACL Options

NOTE: If you do not explicitly enable an option when enabling/disabling ACL options, it will be disabled (even if you do not include that option in the URL string). For example:

Calling this URL in WebHost Manager: xml-api/sectacls?reseller=andy

will disable all ACL options for the reseller "andy"

Calling this URL in WebHost Manager: xml-api/sectacls?reseller=andy&acl-create-acct=1

will enable only the create account ACL option for the reseller "andy"

NOTE: Options that are not explicitly enabled during a call will be disabled.

Using an ACL list
Calling this URL in WebHost Manager: /xml-api/setacls?reseller=bob&acllist=bob

will produce output similar to:

<setacls>

    <result>

<acls>ssl</acls>

<status>1</status>

<statusmsg>Reseller Acls Saved</statusmsg>

</result>

</setacls>

Using specific ACL items
Calling this URL in WebHost Manager: /xml-api/setacls?reseller=bob&acl-all=1&acl-ssl=1

will produce output similar to:

<result>

<acls>ssl</acls>

<acls>all</acls>

<status>1</status>

<statusmsg>Reseller Acls Saved</statusmsg>

</result>

</setacls>


COPYRIGHT

Copyright 2007 cPanel Inc.