Python Client for the cPanel API and CSF.
Project description
A Python client for the cPanel API and CSF.
Installation
Using pip:
$ pip install pycpanel
Authentication
You may use either remote access hash or basic user/password authentication. Remote access hash authentication is the prefered method.
Basic user/password authentication
Warning: Do not perform authentication this way over an unsecured connection (ssl=False). The use of this method over an unsecured connection can compromise your server.
import pycpanel
server = pycpanel.conn(hostname='myserver.com.au', password='mypassword')
Access hash authentication
http://docs.cpanel.net/twiki/bin/view/AllDocumentation/WHMDocs/RemoteAccess
import pycpanel
hash = remote_access_hash
server = pycpanel.conn(hostname='myserver.com.au', hash=hash)
Connection Options
The default options connect to the server as root using SSL on port 2087 without verifying the SSL certificate.
import pycpanel
server = pycpanel.conn(hostname, username='root', hash=None, password=None, ssl=True, verify=False, check_conn=False)
hostname (required) - the hostname or ip address of the cPanel server.
username (optional, default=’root’) - the authenticating user’s username.
hash (optional) - The remote access hash for the cPanel server. If not provided a password must be provided instead.
password (optional) - The password for the authenticating user. If not provided the remote access hash must be provided instead.
ssl (optional, boolean, default=True) - If set to False pycpanel will connect on HTTP port 2086 rather than HTTPS port 2087.
verify (optional, boolean, default=False) - If set to True the SSL certificate of the server will be verifying to ensure it is valid.
check_conn (optional, boolean, default=True) - If set to True pycpanel will test and authenticate against the server after setting up the connection.
cPanel External API
Detailed documentation for the cPanel External API can be found here: http://docs.cpanel.net/twiki/bin/view/SoftwareDevelopmentKit/XmlApi
pycpanel.api(function, params=None)
External API without params
This example will print a dict with all the cPanel accounts on the server. No additional params are passed in this example.
import pycpanel
server = pycpanel.conn(hostname='myserver.com.au', password='mypassword')
print server.api('listaccts')
External API with params
This exmaple will adjust the cPanel account with username ‘user1’ to have a limit of 10 addon domains.
import pycpanel
server = pycpanel.conn(hostname='myserver.com.au', password='mypassword')
params = {
'user' : 'user1',
'MAXADDON ' : 10,
}
server.api('modifyacct', params=params)
cPanel API 2 Functions
Detailed documentation for the cPanel API 2 Functions can be found here: http://docs.cpanel.net/twiki/bin/view/ApiDocs/Api2/WebHome
pycpanel.cpanel_api(module, function, user, params=None)
API 2 Function without params
This example retrieves a list of email accounts associated with a cPanel account with username ‘user1’.
import pycpanel
server = pycpanel.conn(hostname='myserver.com.au', password='mypassword')
print server.cpanel_api('Email', 'listpops', 'user1')
API 2 Function with params
This example creates a new email account (steve@mydomain.com.au) for the user account ‘user1’.
import pycpanel
server = pycpanel.conn(hostname='myserver.com.au', password='mypassword')
params = {
'domain' : 'mydomain.com.au',
'email' : 'steve',
'password' : '@#fwefq122442',
'quota' : 0
}
server.cpanel_api('Email', 'addpop', 'user1', params=params)
ConfigServer Firewall API
To use the ConfigServer Firewall (CSF) API, the CSF cPanel plugin must be installed and active on your cPanel server.
Unblock IP Address
This function will remove an IP address from the firewall (temp and perm blocks).
server = pycpanel.conn(hostname='myserver.com.au', password='mypassword')
server.csf.unblock('192.168.0.1')
# Returns True if succesfull.
Block IP Address
This function will block an IP address on the firewall and add it to the deny file (csf.deny).
server = pycpanel.conn(hostname='myserver.com.au', password='mypassword')
server.csf.deny('192.168.0.1')
# Returns True if succesfull.
Optionaly, a comment may be left to explain why the IP address was blocked:
server = pycpanel.conn(hostname='myserver.com.au', password='mypassword')
server.csf.deny('192.168.0.1', comment='Why the IP was blocked")
# Returns True if succesfull.
Allow IP Address
This function will allow an IP address through the firewall and add it to the allow file (csf.allow).
server = pycpanel.conn(hostname='myserver.com.au', password='mypassword')
server.csf.allow('192.168.0.1')
# Returns True if succesfull.
Optionaly, a comment may be left to explain why the IP address was allowed through the firewall:
server = pycpanel.conn(hostname='myserver.com.au', password='mypassword')
server.csf.allow('192.168.0.1', comment='Why the IP was allowed")
# Returns True if succesfull.
Ignore IP Address
This function will ignore an IP address in lfd and add it to the ignore file (csf.ignore) and restart lfd.
server = pycpanel.conn(hostname='myserver.com.au', password='mypassword')
server.csf.ignore('192.168.0.1')
# Returns True if succesfull.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pycpanel-0.1.4.macosx-10.8-x86_64.exe
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d3c43d1769a15065ebd5456ad11512d3fb03203727cddd78fcb9971e5236c1c |
|
MD5 | ff3458543fcc17ab87e0d1d0f131ccaf |
|
BLAKE2b-256 | df2c6026d4a5051c99600fba9536b582d932b9cd1c71b53ecf9f78d041ebc028 |