Data Model Reference

$VAR is an associative array that contains the data model. Below is a detailed list explaining available paths and values.

$VAR->

• $VAR->domainsIpDefaultBootstrap

  The full path to the bootstrap file for a domain set as default on an IP address; string

• $VAR->domainsBootstrap

  The full path to the bootstrap file for domains; string

• $VAR->domainsWebmailHordeBootstrap

  The full path to the bootstrap file for Horde; string

• $VAR->domainsWebmailAtmailBootstrap

  The full path to the bootstrap file for Atmail; string

• $VAR->domainsWebmailAtmailcomBootstrap

  The full path to the bootstrap file for Atmail Commerce; string

1. $VAR->server->

• $VAR->server->fullHostName

  Full name of the host where the Panel is installed; string

• $VAR->server->ipAddress->all

  List of IP addresses registered with the Panel; array with elements $VAR->ipAddress

• $VAR->server->admin->email

  E-mail address of the Panel administrator; string

• $VAR->server->productRootDir

  The full path to the root directory of the Panel installation; string

• $VAR->server->productConfigDir

  The full path to the directory where the Panel configuration is stored; string

• $VAR->server->getSslLibraryPath

  The full path to the system SSL library; string

• $VAR->server->getCryptoLibraryPath

  The full path to the system cryptographic library; string

1.2. $VAR->server->domains->

• $VAR->server->domains->allWithHosting

  List of domains where hosting (both web hosting and forwarding) is set up; array with elements $VAR->domain

• $VAR->server->domains->allWithoutHosting

  List of domain accounts where no hosting is set up (neither web hosting nor forwarding); array with elements $VAR->domain

1.3. $VAR->server->webserver->

• $VAR->server->webserver->vhostDir

  The full path to the system vhosts/ directory; string

• $VAR->server->webserver->httpLogsDir

  The full path to the logs/ directory; string

• $VAR->server->webserver->httpIncludeDir

  The full path to the Apache conf.d directory; string

• $VAR->server->webserver->httpDir

  The full path to the directory with content of the server default website available via HTTP; string

• $VAR->server->webserver->httpsDir

  The full path to the directory with content of the server default website available via HTTPS; string

• $VAR->server->webserver->httpPort

  Apache HTTP port number; string

• $VAR->server->webserver->httpsPort

  Apache HTTPS port number; string

• $VAR->server->webserver->cgiBinDir

  The full path to the cgi-bin directory of the server default site; string

• $VAR->server->webserver->clientGroup

  System group of users using Apache web hosting (a user group in which all FTP users of web hosting are included); string

1.3.1. $VAR->server->webserver->apache->

• $VAR->server->webserver->apache->pipelogEnabled

  Defines if writing Apache logs to a pipe is enabled; boolean

• $VAR->server->webserver->apache->traceEnableCompliance

  Determines the behaviour on TRACE requests; boolean

• $VAR->server->webserver->apache->allowOverrideDefault

  Defines the value of the AllowOverride directive in Apache configuration; string

• $VAR->server->webserver->apache->php4ModuleName

  Name of the Apache module used for PHP 4; string

• $VAR->server->webserver->apache->phpCgiBin

  Binary file used to run PHP in CGI mode; string

• $VAR->server->webserver->apache->coldfusionModuleName

  Name of Apache module used for ColdFusion; string

• $VAR->server->webserver->apache->vhostIpCapacity

  Maximum number of IP addresses that can be defined in the <VirtualHost> tag in Apache configuration; integer

1.3.2. $VAR->server->webserver->horde->

• $VAR->server->webserver->horde->confD

  The full path to the directory with Horde configuration; string

• $VAR->server->webserver->horde->logD

  The full path to the directory with Horde logs; string

• $VAR->server->webserver->horde->docD

  The full path to the Horde doc directory; string

• $VAR->server->webserver->horde->dataD

  The full path to the folder with Horde PEAR data; string

1.4. $VAR->server->tomcat->

• $VAR->server->tomcat->workersFile

  The full path to the Tomcat workers file; string

• $VAR->server->tomcat->workerName

  Tomcat worker ID; string

• $VAR->server->tomcat->warpPort

  Tomcat WARP port; string

1.5. $VAR->server->mailman->

• $VAR->server->mailman->rootDir

  The full path to the Mailman root directory; string

• $VAR->server->mailman->varDir

  The full path to the Mailman var directory; string

• $VAR->server->mailman->scriptAliases

  ScriptAliases required for the web panel of the Mailman service to work; array with elements 'url => path'

• $VAR->server->mailman->aliases

  Aliases required for the web panel of the Mailman service to work; array with elements 'url => path'

1.6. $VAR->server->coldfusion->

• $VAR->server->coldfusion->port

  ColdFusion port number; string

• $VAR->server->coldfusion->serverStorePath

  The full path to the file that contains information for the associated JRun server (default file name is jrunserver.store); string

1.7. $VAR->server->miva->

• $VAR->server->miva->libDir

  The full path to the Miva lib directory; string

• $VAR->server->miva->binDir

  The full path to the Miva bin directory; string

• $VAR->server->miva->shareDir

  The full path to the Miva shared directory; string

1.8. $VAR->server->awstats->

• $VAR->server->awstats->docsDir

  The full path to the AWStats docs directory; string

2. $VAR->domain->

The content of $VAR->domain is defined by the value of the domainId key in $metainfo.

• $VAR->domain->id

  Domain ID; string

• $VAR->domain->www

  Defines if the website is accessible with the www prefix; boolean

• $VAR->domain->enabled

  Defines the website status; boolean

• $VAR->domain->idnName

  International domain name; string

• $VAR->domain->asciiName

  Domain name in ASCII format; string

• $VAR->domain->isIpDefault

  Defines if the website is set as default for the IP address; boolean

• $VAR->domain->hasPhysicalHosting

  Defines if the website is set up for web hosting; boolean

• $VAR->domain->hasStandardForwarding

  Defines if the website is set up as standard forwarding; boolean

• $VAR->domain->hasFrameForwarding

  Defines if the website is set up as frame forwarding; boolean

• $VAR->domain->webAliases

  Web aliases of the website; array where elements are objects $object->asciiName

• $VAR->domain->mailAliases

  Mail aliases of the website; array where elements are objects $object->asciiName

• $VAR->domain->client->email

  E-mail address of the website owner; string

• $VAR->domain->email

  E-mail address of the Domain Administrator of the website; string

2.1. $VAR->domain->physicalHosting->

• $VAR->domain->physicalHosting->login

  Username of FTP account used to access the website content; string

• $VAR->domain->physicalHosting->ipAddress

  IP address on which the website is hosted; see $VAR->ipAddress

• $VAR->domain->physicalHosting->vhostDir

  The absolute path to the website's vhost directory; string

• $VAR->domain->physicalHosting->logsDir

  The absolute path to the website's logs directory; string

• $VAR->domain->physicalHosting->webUsersDir

  The absolute path to the website's directory designated for web users' content; string

• $VAR->domain->physicalHosting->httpDir

  The absolute path to thewebsite's httpdocs directory; string

• $VAR->domain->physicalHosting->httpsDir

  The absolute path to thewebsite's httpsdocs directory; string

• $VAR->domain->physicalHosting->cgiBinDir

  The absolute path to thewebsite's cgi-bin directory; string

• $VAR->domain->physicalHosting->statisticsDir

  The absolute path to the website's statistics directory;string

• $VAR->domain->physicalHosting->siteAppsConfigDir

  The absolute path to the website's directory where configuration files of the installed non-SSL site applications are stored; string

• $VAR->domain->physicalHosting->customConfigFile

  The absolute path to the directory <vhostdir>/conf/vhost.conf for a non-SSL website; string

• $VAR->domain->physicalHosting->siteAppsSslConfigDir

  The absolute path to the website's directory where configuration files of the installed SSL site applications are stored; string

• $VAR->domain->physicalHosting->customSslConfigFile

  The absolute path to the directory <vhostdir>/conf/vhost.conf for a non-SSL website; string

• $VAR->domain->physicalHosting->ssl

  Defines if the SSL support is enabled on the website; boolean

• $VAR->domain->physicalHosting->trafficBandwidth

  Defines a limit imposed on the traffic bandwidth usage by the domain; string

• $VAR->domain->physicalHosting->maximumConnection

  Defines a limit imposed on the maximum allowed number of connections to the domain; string

• $VAR->domain->physicalHosting->php

  Defines if the PHP support is enabled on the website; boolean

• $VAR->domain->physicalHosting->phpHandlerType

  Defines PHP handler type; string

• $VAR->domain->physicalHosting->phpSafeMode

  Defines if PHP operates in safe mode; boolean

• $VAR->domain->physicalHosting->ssi

  Defines if SSI is supported on the website; boolean

• $VAR->domain->physicalHosting->cgi

  Defines if CGI is supported on the website; boolean

• $VAR->domain->physicalHosting->miva

  Defines if Miva support is enabled for the website; boolean

• $VAR->domain->physicalHosting->mivaDataDir

  The full path to the Miva data directory; string

• $VAR->domain->physicalHosting->perl

  Defines if Perl is supported on the website; boolean

• $VAR->domain->physicalHosting->asp

  Defines if ASP is supported on the website; boolean

• $VAR->domain->physicalHosting->python

  Defines if python is supported on the website; boolean

• $VAR->domain->physicalHosting->fastcgi

  Defines if FastCGI is supported on the website; boolean

• $VAR->domain->physicalHosting->errordocs

  Defines if custom error pages are supported on the website; boolean

• $VAR->domain->physicalHosting->hasWebstat

  Defines if a web statistics service is supported on the website; boolean

• $VAR->domain->physicalHosting->webuserScriptingEnabled

  Defines if using scripts is allowed to web users on the website; boolean

• $VAR->domain->physicalHosting->frontpage

  Defines if Microsoft FrontPage is supported on the website; boolean

• $VAR->domain->physicalHosting->frontpageSsl

  Defines if Microsoft FrontPage over SSL is supported on the website; boolean

• $VAR->domain->physicalHosting->coldfusion

  Defines if ColdFusion is supported on the website; boolean

• $VAR->domain->physicalHosting->subdomains

  List of the website subdomains; array with elements $VAR->subdomain

• $VAR->domain->physicalHosting->webusers

  Accesses web user specific data; array where elements are objects of type $object-><webuser-parameter> where <webuser-parameter> is one of the following:

  • dir

    The absolute path to the directory with the web user's content; string

  • ssi

    Defines if SSI support is enabled for the web user; boolean

  • cgi

    Defines if CGI support is enabled for the web user; boolean

  • perl

    Defines if perl support is enabled for the web user; boolean

  • asp

    Defines if ASP support is enabled for the web user; boolean

  • php

    Defines if PHP support is enabled for the web user; boolean

  • python

    Defines if python support is enabled for the web user; boolean

  • fastcgi

    Defines if fastCGI support is enabled for the web user; boolean

2.2. $VAR->domain->forwarding->

• $VAR->domain->forwarding->ipAddress

  IP address on which the website forwarding is set up; $VAR->ipAddress

• $VAR->domain->forwarding->redirectUrl

  URL to which requests for the website are redirected; string

2.3. $VAR->domain->tomcat->

• $VAR->domain->tomcat->enabled

  Defines if Tomcat is enabled on the website; boolean

• $VAR->domain->tomcat->all

  Gets data on all Tomcat applications running on the domain; array where elements are objects $object->name where 'name' is an application name

2.4. $VAR->domain->protectedDirectories->

• $VAR->domain->protectedDirectories->sslDirectories

  Password-protected directories of the website available via SSL; array with elements array('directory' => '', 'realm' => '', 'authFile' => '',) where

  • directory is a path (relative to the virtual host root) to a directory being protected
  • realm is a text displayed when requesting password from a user
  • authFile is the absolute path to a file listing users who are authorized to access the directory
• $VAR->domain->protectedDirectories->nonSslDirectories

  Password-protected non-SSL directories of the website; array with elements array('directory' => '', 'realm' => '', 'authFile' => '',) where

  • directory is a path (relative to the virtual host root) to a directory being protected
  • realm is a text displayed when requesting password from a user
  • authFile is the absolute path to a file listing users who are authorized to access the directory

3. $VAR->subDomain->

The content of $VAR->subDomain is defined by the value of the domainId and subDomainId keys in $metainfo.

• $VAR->subDomain->id

  Subdomain ID; string

• $VAR->subDomain->asciiName

  Subdomain name in ASCII format (without the domain name part, i.e. "forum" if the full domain name is "forum.example.com"); string

• $VAR-subDomain->asciiFullName

  Full subdomain name (including the domain name part) in ASCII format; string

• $VAR->subDomain->httpDir

  The absolute path to the website's httpdocs directory; string

• $VAR->subDomain->httpsDir

  The absolute path to the website's httpsdocs directory; string

• $VAR->subDomain->siteAppsConfigDir

  The absolute path to the website's directory where configuration files of the installed non-SSL site applications are stored; string

• $VAR->subDomain->siteAppsSslConfigDir

  The absolute path to the website's directory where configuration files of the installed SSL site applications are stored; string

• $VAR->subDomain->customConfigFile

  The absolute path to the directory conf/vhost.conf for a non-SSL website; string

• $VAR->subDomain->customSslConfigFile

  The absolute path to the directory conf/vhost.conf for an SSL website; string

• $VAR->subDomain->login

  Username of FTP account used to access the website content; string

• $VAR->subDomain->cgi

  Defines if the CGI support is enabled on the website; boolean

• $VAR->subDomain->cgiBinDir

  The full path to the cgi-bin directory of the website; string

• $VAR->subDomain->miva

  Defines if the Miva support is enabled on the website; boolean

• $VAR->subDomain->mivaDataDir

  The full path to the Miva data directory; string

• $VAR->subDomain->perl

  Defines if the perl support is enabled on the website; boolean

• $VAR->subDomain->asp

  Defines if the ASP support is enabled on the website; boolean

• $VAR->subDomain->coldfusion

  Defines if the ColdFusion support is enabled on the website; boolean

• $VAR->subDomain->php

  Defines if the PHP support is enabled on the website; boolean

• $VAR->subDomain->phpHandlerType

  Defines PHP handler type; string

• $VAR->subDomain->python

  Defines if the python support is enabled on the website; boolean

• $VAR->subDomain->fastcgi

  Defines if the FastCGI support is enabled on the website; boolean

• $VAR->subDomain->ssi

  Defines if the SSI support is enabled on the website; boolean

• $VAR->subDomain->ssl

  Defines if the SSL support is enabled on the website; boolean

4. $VAR->ipAddress->

The content of $VAR->ipAddress is defined by the value of the ipAddressId key in $metainfo.

• $VAR->ipAddress->id

  ID of the IP address; string

• $VAR->ipAddress->address

  IP address; string

• $VAR->ipAddress->sslCertificate->ce

  SSL certificate file content; string

• $VAR->ipAddress->sslCertificate->ca

  CA certificate file content; string

• $VAR->ipAddress->sslCertificate->ceFilePath

  The full path to the certificate file; string

• $VAR->ipAddress->sslCertificate->caFilePath

  The full path to the CA certificate file; string

• $VAR->ipAddress->defaultDomainId

  ID of the domain set as default for the IP address; string

• $VAR->ipAddress->hostedDomains

  List of domains hosted on the IP address; array with elements $VAR->domain