.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "cPanel::PublicAPI::WHM::XMLAPI 3" .TH cPanel::PublicAPI::WHM::XMLAPI 3 "2019-03-06" "perl v5.16.3" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" cPanel::PublicAPI::WHM::API \- Legacy interface for querying the xml\-api. .PP NOTE: This module is provided for legacy purposes, cPanel::PublicAPI should be used instead .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides legacy compatibility support between cPanel::PublicAPI and Cpanel::Accounting (distributed with cPanel). This should never be used unless there is a very good reason to use it (such as having a script that uses Cpanel::Accounting). .PP Every method contained within this object can be queried using \fIcPanel::publicAPI::whm_api()\fR instead. .PP For more information on the calls within the methods contained here and what the parameter names mean, please read the documentation at: .SH "functions" .IX Header "functions" .ie n .SS """xmlapi_listaccts()""" .el .SS "\f(CWxmlapi_listaccts()\fP" .IX Subsection "xmlapi_listaccts()" Used to list the accounts on a server. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_listaccts( $search, $searchtype ); .Ve .ie n .SS """xmlapi_createacct()""" .el .SS "\f(CWxmlapi_createacct()\fP" .IX Subsection "xmlapi_createacct()" Create a new cPanel account. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_createacct( $username, $domain, $password, $plan ); .Ve .ie n .SS """xmlapi_removeacct()""" .el .SS "\f(CWxmlapi_removeacct()\fP" .IX Subsection "xmlapi_removeacct()" Terminate an account. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_removeacct( $user ); .Ve .ie n .SS """xmlapi_showversion()""" .el .SS "\f(CWxmlapi_showversion()\fP" .IX Subsection "xmlapi_showversion()" Get the version of cPanel running on the server. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_showversion( ); .Ve .ie n .SS """xmlapi_version()""" .el .SS "\f(CWxmlapi_version()\fP" .IX Subsection "xmlapi_version()" Get the version of cPanel running on the server (as as showversion) .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_version( ); .Ve .ie n .SS """xmlapi_applist()""" .el .SS "\f(CWxmlapi_applist()\fP" .IX Subsection "xmlapi_applist()" List out the available xml-api calls. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_applist( ); .Ve .ie n .SS """xmlapi_generatessl()""" .el .SS "\f(CWxmlapi_generatessl()\fP" .IX Subsection "xmlapi_generatessl()" Generate an ssl certificate. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_generatessl( $host, $pass, $country, $state, $city, $co, $cod, $email, $xemail ); .Ve .ie n .SS """xmlapi_generatessl_noemail()""" .el .SS "\f(CWxmlapi_generatessl_noemail()\fP" .IX Subsection "xmlapi_generatessl_noemail()" Generate an \s-1SSL\s0 certificate without an email. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_generatessl_noemail( $noemail=1 ); .Ve .ie n .SS """xmlapi_listcrts()""" .el .SS "\f(CWxmlapi_listcrts()\fP" .IX Subsection "xmlapi_listcrts()" List out the certificates that exist on the server. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_listcrts( ); .Ve .ie n .SS """xmlapi_setresellerlimits()""" .el .SS "\f(CWxmlapi_setresellerlimits()\fP" .IX Subsection "xmlapi_setresellerlimits()" Set the limits for a single reseller account. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_setresellerlimits( ); .Ve .ie n .SS """xmlapi_setresellerpackagelimit()""" .el .SS "\f(CWxmlapi_setresellerpackagelimit()\fP" .IX Subsection "xmlapi_setresellerpackagelimit()" Set which packages a reseller account can use. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_setresellerpackagelimit( $user, $package, $allowerd, $number, $no_limit ); .Ve .ie n .SS """xmlapi_setresellermainip()""" .el .SS "\f(CWxmlapi_setresellermainip()\fP" .IX Subsection "xmlapi_setresellermainip()" Set a reseller's main \s-1IP.\s0 .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_setresellermainip( $user, $ip ); .Ve .ie n .SS """xmlapi_setresellerips()""" .el .SS "\f(CWxmlapi_setresellerips()\fP" .IX Subsection "xmlapi_setresellerips()" Set the \s-1IP\s0 that a reseller has available to it. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_setresellerips( $user, $delegate, $ips ); .Ve .ie n .SS """xmlapi_setresellernameservers()""" .el .SS "\f(CWxmlapi_setresellernameservers()\fP" .IX Subsection "xmlapi_setresellernameservers()" Set the nameservers that a reseller uses by default. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_setresellernameservers( $user, $nameservers ); .Ve .ie n .SS """xmlapi_suspendreseller()""" .el .SS "\f(CWxmlapi_suspendreseller()\fP" .IX Subsection "xmlapi_suspendreseller()" Suspend a reseller and all of their accounts. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_suspendreseller( $user, $reason, $disallow ); .Ve .ie n .SS """xmlapi_unsuspendreseller()""" .el .SS "\f(CWxmlapi_unsuspendreseller()\fP" .IX Subsection "xmlapi_unsuspendreseller()" Unsuspend a reseller and all of their accounts. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_unsuspendreseller( $user ); .Ve .ie n .SS """xmlapi_addzonerecord()""" .el .SS "\f(CWxmlapi_addzonerecord()\fP" .IX Subsection "xmlapi_addzonerecord()" Add a record to a zone. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_addzonerecord( @args ); .Ve .ie n .SS """xmlapi_editzonerecord()""" .el .SS "\f(CWxmlapi_editzonerecord()\fP" .IX Subsection "xmlapi_editzonerecord()" Edit a zone record. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_editzonerecord(@args ); .Ve .ie n .SS """xmlapi_removezonerecord()""" .el .SS "\f(CWxmlapi_removezonerecord()\fP" .IX Subsection "xmlapi_removezonerecord()" Remove a line from a zone. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_removezonerecord( $domain, $Line ); .Ve .ie n .SS """xmlapi_getzonerecord()""" .el .SS "\f(CWxmlapi_getzonerecord()\fP" .IX Subsection "xmlapi_getzonerecord()" Get a record from a zone. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_getzonerecord( $domain, $Line ); .Ve .ie n .SS """xmlapi_servicestatus()""" .el .SS "\f(CWxmlapi_servicestatus()\fP" .IX Subsection "xmlapi_servicestatus()" Get the status of various services running on a system. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_servicestatus( $service ); .Ve .ie n .SS """xmlapi_configureservice()""" .el .SS "\f(CWxmlapi_configureservice()\fP" .IX Subsection "xmlapi_configureservice()" Enable/Disable various services. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_configureservice( $service, $enabled, $monitored ); .Ve .ie n .SS """xmlapi_acctcounts()""" .el .SS "\f(CWxmlapi_acctcounts()\fP" .IX Subsection "xmlapi_acctcounts()" Get the number of accounts on a system/that belong to a reseller. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_acctcounts( $user ); .Ve .ie n .SS """xmlapi_domainuserdata()""" .el .SS "\f(CWxmlapi_domainuserdata()\fP" .IX Subsection "xmlapi_domainuserdata()" Get the information about a specific domain's virtualhost. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_domainuserdata( $domain ); .Ve .ie n .SS """xmlapi_editquota()""" .el .SS "\f(CWxmlapi_editquota()\fP" .IX Subsection "xmlapi_editquota()" Edit a user's quota. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_editquota( $user, $quota ); .Ve .ie n .SS """xmlapi_nvget()""" .el .SS "\f(CWxmlapi_nvget()\fP" .IX Subsection "xmlapi_nvget()" Get non-volatile data. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_nvget( $key ); .Ve .ie n .SS """xmlapi_nvset()""" .el .SS "\f(CWxmlapi_nvset()\fP" .IX Subsection "xmlapi_nvset()" Set non-volatile data. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_nvset( $key, $value ); .Ve .ie n .SS """xmlapi_myprivs()""" .el .SS "\f(CWxmlapi_myprivs()\fP" .IX Subsection "xmlapi_myprivs()" See what privileges are available to your user. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_myprivs( ); .Ve .ie n .SS """xmlapi_listzones()""" .el .SS "\f(CWxmlapi_listzones()\fP" .IX Subsection "xmlapi_listzones()" List all the zones available to a user. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_listzones( ); .Ve .ie n .SS """xmlapi_sethostname()""" .el .SS "\f(CWxmlapi_sethostname()\fP" .IX Subsection "xmlapi_sethostname()" Set the hostname of a system. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_sethostname( $hostname ); .Ve .ie n .SS """xmlapi_setresolvers()""" .el .SS "\f(CWxmlapi_setresolvers()\fP" .IX Subsection "xmlapi_setresolvers()" Set the resolvers a system uses. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_setresolvers( $nameserver1, $nameserver2, $nameserver3 ); .Ve .ie n .SS """xmlapi_addip()""" .el .SS "\f(CWxmlapi_addip()\fP" .IX Subsection "xmlapi_addip()" Add a new \s-1IP\s0 to a server. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_addip( $ip, $netmask ); .Ve .ie n .SS """xmlapi_delip()""" .el .SS "\f(CWxmlapi_delip()\fP" .IX Subsection "xmlapi_delip()" Remove an \s-1IP\s0 from a server. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_delip( $ip, $ethernetdev, $skipifshutdown ); .Ve .ie n .SS """xmlapi_listips()""" .el .SS "\f(CWxmlapi_listips()\fP" .IX Subsection "xmlapi_listips()" List the IPs on a server. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_listips( ); .Ve .ie n .SS """xmlapi_dumpzone()""" .el .SS "\f(CWxmlapi_dumpzone()\fP" .IX Subsection "xmlapi_dumpzone()" Get the contents of a zone file. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_dumpzone( $domain ); .Ve .ie n .SS """xmlapi_listpkgs()""" .el .SS "\f(CWxmlapi_listpkgs()\fP" .IX Subsection "xmlapi_listpkgs()" List the packages available to your user. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_listpkgs( ); .Ve .ie n .SS """xmlapi_limitbw()""" .el .SS "\f(CWxmlapi_limitbw()\fP" .IX Subsection "xmlapi_limitbw()" Limit the amount of bandwidth available to an account. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_limitbw( $user, $bwlimit ); .Ve .ie n .SS """xmlapi_showbw()""" .el .SS "\f(CWxmlapi_showbw()\fP" .IX Subsection "xmlapi_showbw()" Show the amount of \s-1BW\s0 used by an account. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_showbw( $month, $year, $showres, $search, $searchtype ); .Ve .ie n .SS """xmlapi_killdns()""" .el .SS "\f(CWxmlapi_killdns()\fP" .IX Subsection "xmlapi_killdns()" Remove a \s-1DNS\s0 zone. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_killdns( $domain ); .Ve .ie n .SS """xmlapi_adddns()""" .el .SS "\f(CWxmlapi_adddns()\fP" .IX Subsection "xmlapi_adddns()" Add a dns zone. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_adddns( $domain, $ip, $trueowner ); .Ve .ie n .SS """xmlapi_changepackage()""" .el .SS "\f(CWxmlapi_changepackage()\fP" .IX Subsection "xmlapi_changepackage()" Change an Account's Package. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_changepackage( $user, $pkg ); .Ve .ie n .SS """xmlapi_modifyacct()""" .el .SS "\f(CWxmlapi_modifyacct()\fP" .IX Subsection "xmlapi_modifyacct()" Modify an Account's limits. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_modifyacct( $user, $domain, $HASCGI, $CPTHEME, $LANG, $MAXPOP, $MAXFTP, $MAXLST, $MAXSUB, $MAXPARK, $MAXADDON, $MAXSQL, $shell ); .Ve .ie n .SS """xmlapi_suspendacct()""" .el .SS "\f(CWxmlapi_suspendacct()\fP" .IX Subsection "xmlapi_suspendacct()" Suspend an account. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_suspendacct( $user, $reason ); .Ve .ie n .SS """xmlapi_unsuspendacct()""" .el .SS "\f(CWxmlapi_unsuspendacct()\fP" .IX Subsection "xmlapi_unsuspendacct()" Unsuspend an account. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_unsuspendacct( $user ); .Ve .ie n .SS """xmlapi_listsuspended()""" .el .SS "\f(CWxmlapi_listsuspended()\fP" .IX Subsection "xmlapi_listsuspended()" List the suspended accounts on a server. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_listsuspended( ); .Ve .ie n .SS """xmlapi_addpkg()""" .el .SS "\f(CWxmlapi_addpkg()\fP" .IX Subsection "xmlapi_addpkg()" Add a new package. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_addpkg( $pkgname, $quota, $ip, $cgi, $frontpage, $cpmod, $maxftp, $maxsql, $maxpop, $maxlst, $maxsub, $maxpark, $maxaddon, $featurelist, $hasshell, $bwlimit ); .Ve .ie n .SS """xmlapi_killpkg()""" .el .SS "\f(CWxmlapi_killpkg()\fP" .IX Subsection "xmlapi_killpkg()" Remove a package. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_killpkg( $pkg ); .Ve .ie n .SS """xmlapi_editpkg()""" .el .SS "\f(CWxmlapi_editpkg()\fP" .IX Subsection "xmlapi_editpkg()" Edit a package. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_editpkg( $pkgname, $quota, $ip, $cgi, $frontpage, $cpmod, $maxftp, $maxsql, $maxpop, $maxlst, $maxsub, $maxpark, $maxaddon, $featurelist, $hasshell, $bwlimit ); .Ve .ie n .SS """xmlapi_setacls()""" .el .SS "\f(CWxmlapi_setacls()\fP" .IX Subsection "xmlapi_setacls()" Change features available to a reseller. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_setacls( $reseller, $acllist ); .Ve .ie n .SS """xmlapi_terminatereseller()""" .el .SS "\f(CWxmlapi_terminatereseller()\fP" .IX Subsection "xmlapi_terminatereseller()" Remove a reseller. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_terminatereseller( $reseller, $verify ); .Ve .ie n .SS """xmlapi_resellerstats()""" .el .SS "\f(CWxmlapi_resellerstats()\fP" .IX Subsection "xmlapi_resellerstats()" Get statistics on a specific reseller. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_resellerstats( $reseller ); .Ve .ie n .SS """xmlapi_setupreseller()""" .el .SS "\f(CWxmlapi_setupreseller()\fP" .IX Subsection "xmlapi_setupreseller()" Make a cPanel account a Reseller account. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_setupreseller( $user, $makeowner ); .Ve .ie n .SS """xmlapi_lookupnsip()""" .el .SS "\f(CWxmlapi_lookupnsip()\fP" .IX Subsection "xmlapi_lookupnsip()" Get the \s-1IP\s0 for a nameserver. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_lookupnsip( $nameserver ); .Ve .ie n .SS """xmlapi_listresellers()""" .el .SS "\f(CWxmlapi_listresellers()\fP" .IX Subsection "xmlapi_listresellers()" List all the resellers on a system. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_listresellers( ); .Ve .ie n .SS """xmlapi_listacls()""" .el .SS "\f(CWxmlapi_listacls()\fP" .IX Subsection "xmlapi_listacls()" List all of the \s-1ACL\s0 lists available. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_listacls( ); .Ve .ie n .SS """xmlapi_saveacllist()""" .el .SS "\f(CWxmlapi_saveacllist()\fP" .IX Subsection "xmlapi_saveacllist()" Save a new \s-1ACL\s0 list. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_saveacllist( $acllist ); .Ve .ie n .SS """xmlapi_unsetupreseller()""" .el .SS "\f(CWxmlapi_unsetupreseller()\fP" .IX Subsection "xmlapi_unsetupreseller()" Remove reseller permissions from an account. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_unsetupreseller( $user ); .Ve .ie n .SS """xmlapi_gethostname()""" .el .SS "\f(CWxmlapi_gethostname()\fP" .IX Subsection "xmlapi_gethostname()" Get the hostname of the server currently being queried. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_gethostname( ); .Ve .ie n .SS """xmlapi_fetchsslinfo()""" .el .SS "\f(CWxmlapi_fetchsslinfo()\fP" .IX Subsection "xmlapi_fetchsslinfo()" Get information on a specific \s-1SSL\s0 certificate. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_fetchsslinfo( $domain, $crtdata ); .Ve .ie n .SS """xmlapi_installssl()""" .el .SS "\f(CWxmlapi_installssl()\fP" .IX Subsection "xmlapi_installssl()" Install a new \s-1SSL\s0 certificate. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_installssl( $domain, $user, $cert, $key, $cab, $ip ); .Ve .ie n .SS """xmlapi_passwd()""" .el .SS "\f(CWxmlapi_passwd()\fP" .IX Subsection "xmlapi_passwd()" Change an account's password. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_passwd( $user, $pass ); .Ve .ie n .SS """xmlapi_getlanglist()""" .el .SS "\f(CWxmlapi_getlanglist()\fP" .IX Subsection "xmlapi_getlanglist()" Get a list of languages available on a system. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_getlanglist( ); .Ve .ie n .SS """xmlapi_reboot()""" .el .SS "\f(CWxmlapi_reboot()\fP" .IX Subsection "xmlapi_reboot()" Reboot the server. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_reboot( $force ); .Ve .ie n .SS """xmlapi_accountsummary_user()""" .el .SS "\f(CWxmlapi_accountsummary_user()\fP" .IX Subsection "xmlapi_accountsummary_user()" Get a summary of an account. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_accountsummary_user( $user ); .Ve .ie n .SS """xmlapi_accountsummary_domain()""" .el .SS "\f(CWxmlapi_accountsummary_domain()\fP" .IX Subsection "xmlapi_accountsummary_domain()" Get the summary of an account by specifying the domain. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_accountsummary_domain( $domain ); .Ve .ie n .SS """xmlapi_loadavg()""" .el .SS "\f(CWxmlapi_loadavg()\fP" .IX Subsection "xmlapi_loadavg()" Get the loadavg on the system. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_loadavg( ); .Ve .ie n .SS """xmlapi_restartservice()""" .el .SS "\f(CWxmlapi_restartservice()\fP" .IX Subsection "xmlapi_restartservice()" Restart a service. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_restartservice( $service ); .Ve .ie n .SS """xmlapi_setsiteip_user()""" .el .SS "\f(CWxmlapi_setsiteip_user()\fP" .IX Subsection "xmlapi_setsiteip_user()" Set the \s-1IP\s0 for a specific user. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_setsiteip_user( $user, $ip ); .Ve .ie n .SS """xmlapi_setsiteip_domain()""" .el .SS "\f(CWxmlapi_setsiteip_domain()\fP" .IX Subsection "xmlapi_setsiteip_domain()" Set the \s-1IP\s0 for a specific domain. .PP Syntax: .PP .Vb 1 \& $pubapi\->xmlapi_setsiteip_domain( $domain, $ip ); .Ve .SH "Bugs" .IX Header "Bugs" see http://rt.cpan.org to report and view bugs .SH "License" .IX Header "License" Copyright (c) 2015, cPanel, Inc. All rights reserved. http://cpanel.net .PP Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of cPanel, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. .PP \&\s-1THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \*(L"AS IS\*(R" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES \&\s0(\s-1INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES\s0; \&\s-1LOSS OF USE, DATA, OR PROFITS\s0; \s-1OR BUSINESS INTERRUPTION\s0) \s-1HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT \&\s0(\s-1INCLUDING NEGLIGENCE OR OTHERWISE\s0) \s-1ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\s0