Zend Server API documentation¶

<?php
public function getSystemInfo() { }

<?php
use ZendService\ZendServerAPI\Server;

$server = new Server();
$systemInfo = $server->getSystemInfo();

<?php
public function clusterGetServerStatus(array $parameters = array()) { }

<?php
use ZendService\ZendServerAPI\Server;

$server = new Server();
$serversList = $server->clusterGetServerStatus(array($serverId1, $serverId2));

foreach ($serversList as $server) {
    /** @var $server \ZendService\ZendServerAPI\DataTypes\ServersList */
    echo "Id: " . $server->getId() . PHP_EOL;
    echo "Name: " . $server->getName() . PHP_EOL;
 }

<?php
public function clusterAddServer($serverName, $serverUrl, $guiPassword, $propagateSettings = false) { }

<?php
use ZendService\ZendServerAPI\Server;

$server = new Server();
$serverName = "server10";
$serverUrl = "https://10.0.0.10:10082/ZendServer";
$guiPassword = "test";
$propagateSettings = false;
$serverInfo = $server->clusterAddServer($serverName, $serverUrl, $guiPassword, $propagateSettings);

<?php
public function clusterRemoveServer($serverId, $force = false) { }

<?php
use ZendService\ZendServerAPI\Server;

$server = new Server();
$serversList = $server->clusterGetServerStatus();

// removes all server from the 'general' cluster
foreach ($serversList as $server) {
    $server->clusterRemoveServer($server->getId());
}

<?php
public function clusterEnableServer($serverId)

<?php
use ZendService\ZendServerAPI\Server;

$server = new Server();
$serversList = $server->clusterGetServerStatus();

// enables all server from the 'general' cluster
foreach ($serversList as $server) {
    $server->clusterEnableServer($server->getId());
}

<?php
public function clusterDisableServer($serverId)

<?php
use ZendService\ZendServerAPI\Server;

$server = new Server();
$serversList = $server->clusterGetServerStatus();

// disables all server from the 'general' cluster
foreach ($serversList as $server) {
    $server->clusterDisableServer($server->getId());
}

<?php
public function clusterReconfigureServer($serverId, $doRestart = false)

<?php
use ZendService\ZendServerAPI\Server;

$server = new Server();
$serverInfo = $server->clusterGetServerStatus();

// reconfigure all server from the 'general' cluster
foreach ($serversList as $server) {
    $server->clusterReconfigureServer($server->getId());
}

<?php
public function restartPhp($serverIds = array(), $parallelRestart = false) { }

<?php
use ZendService\ZendServerAPI\Server;

$server = new Server();
$server->restartPhp();

<?php
public function filterGetByType($type) { }

<?php
use ZendService\ZendServerAPI\Filter;

$server = new Filter();
$filters = $server->filterGetByType("issue");

foreach($filters as $filter) {
    echo $filter->getName() . PHP_EOL;
}

<?php
public function filterSave($type, $name, $id = null, $data = array()) { }

<?php
use ZendService\ZendServerAPI\Filter;

$server = new Filter();
$filter = $server->filterSave("issue", "foo", array("eventTypes" => array("function-slow-exec")));

echo $filter->getName() . " successfully added with id " . $filter->getId() . PHP_EOL;

<?php
public function filterDelete($name) { }

<?php
use ZendService\ZendServerAPI\Filter;

$server = new Filter();
$filter = $server->filterDelete("foo");

echo $filter->getName() . " successfully removed" . PHP_EOL;

<?php
public function auditGetList($limit = null, $offset = null, $order = null, $direction = null, $filters = array()) { }

<?php
use ZendService\ZendServerAPI\Audit;

$audit = new Audit();
$auditMesssages = $audit->auditGetList();

foreach($auditMessages as $auditMessage) {
    echo $auditMessage->getAuditTypeTranslated() . " by " . $auditMessage->getUsername() . PHP_EOL;
}

<?php
public function auditGetDetails($auditId) { }

<?php
use ZendService\ZendServerAPI\Audit;

$audit = new Audit();
$auditMesssages = $audit->auditGetList();

foreach($auditMessages as $auditMessage) {
    $details = $audit->auditGetDetails($auditMessage->getId());
    echo $details->getAuditProgress()->getServerName() . PHP_EOL
}

<?php
public function auditSetSettings($history, $email = null, $callbackUrl = null) { }

<?php
use ZendService\ZendServerAPI\Audit;

$audit = new Audit();
$audit->auditSetSettings(20, "a@b.com", "http://www.test.com");

<?php
public function userAuthenticateSettings($type, $password, $confirmNewPassword, $ldap = array()) { }

<?php
use ZendService\ZendServerAPI\Administration;

$administration = new Administration();
$administration->userAuthenticateSettings("extended", "currentPassword", "newPassword",
    array(
        "host" => "internalldap",
        "port" => 636,
        "encryption" => "ssl",
        "username" => "admin",
        "password" => "currentPassword",
        "baseDn" => "internal"
    )
);

<?php
public function userSetPassword($username, $password, $newPassword, $confirmNewPassword) { }

<?php
use ZendService\ZendServerAPI\Administration;

$administration = new Administration();
$administration->userSetPassword("admin", "oldpassword", "newpassword", "newpassword");

<?php
public function setPassword($password, $newPassword, $confirmNewPassword) { }

<?php
use ZendService\ZendServerAPI\Administration;

$administration = new Administration();
$administration->setPassword("oldpassword", "newpassword", "newpassword");

<?php
public function apiKeysGetList() { }

<?php
use ZendService\ZendServerAPI\Administration;

$administration = new Administration();
$apiKeys = $administration->apiKeysGetList();

<?php
public function apiKeysAddKey($name, $username) { }

<?php
use ZendService\ZendServerAPI\Administration;

$administration = new Administration();
$apiKeys = $administration->apiKeysAddKey("foo", "admin");

<?php
public function apiKeysRemoveKey($ids) { }

<?php
use ZendService\ZendServerAPI\Administration;

$administration = new Administration();
$apiKeys = $administration->apiKeysRemoveKey(array(5, 6, 7));

<?php
public function serverValidateLicense($licenseName, $licenseValue) { }

<?php
use ZendService\ZendServerAPI\Administration;

$administration = new Administration();
$licenseValidated = $administration->serverValidateLicense("TRIAL-1795-69", "V1Q26G1VUK185031C5ACF7165686C91B");

<?php
public function serverStoreLicense($licenseName, $licenseValue) { }

<?php
use ZendService\ZendServerAPI\Administration;

$administration = new Administration();
$licenseValidated = $administration->serverStoreLicense("TRIAL-1795-69", "V1Q26G1VUK185031C5ACF7165686C91B");

<?php
public function aclSetGroups($roleGroups, $appGroups = null) { }

<?php
use ZendService\ZendServerAPI\Administration;

$administration = new Administration();
$roleGroups = $administration->->aclSetGroups(array("developer" => "bar"));

<?php
public function bootstrapSingleServer(
        $adminPassword,
        $orderNumber,
        $licenseKey,
        $acceptEula,
        $production = null,
        $applicationUrl = null,
        $adminEmail = null,
        $developerPassword = null
    ) { }

<?php
use ZendService\ZendServerAPI\Administration;

$administration = new Administration();
$bootstrap = $administration->bootstrapSingleServer("test", "ON", "LC", true);

<?php
public function jobqueueJobsList($limit = null, $offset = null, $orderBy = null, $direction = null, $filter = null) { }

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$jobs = $jobqueue->jobqueueJobsList();

<?php
public function jobqueueJobInfo($id) { }

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$jobInfo = $jobqueue->jobqueueJobInfo(1);

<?php
public function jobqueueDeleteJobs(array $ids) { }

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$jobs = $jobqueue->jobqueueDeleteJobs(array(1));

<?php
public function jobqueueRequeueJobs(array $ids) { }

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$jobs = $jobqueue->jobqueueRequeueJobs(array(1));

<?php
public function jobqueueListRules($limit = null, $offset = null, $orderBy = null, $direction = null) { }

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$rules = $jobqueue->jobqueueListRules();

<?php
public function jobqueueRuleInfo($id) { }

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$ruleInfo = $jobqueue->jobqueueRuleInfo(1);

<?php
public function jobqueueSaveRule($url, $options, $vars = array()) { }

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$ruleInfo = $jobqueue->jobqueueSaveRule("http://www.example.com/foo", "1 */10");

<?php
public function jobqueueDisableRules(array $ruleIds) { }

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$rules = $jobqueue->jobqueueDisableRules(array(1));

<?php
public function jobqueueResumeRules(array $ruleIds) { }

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$rules = $jobqueue->jobqueueResumeRules(array(1));

<?php
public function jobqueueDeleteRules(array $ruleIds) { }

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$rules = $jobqueue->jobqueueDeleteRules(array(1));

<?php
public function jobqueueRunNowRule($ruleId) { }

<?php
use ZendService\ZendServerAPI\Jobqueue;

$jobqueue = new Jobqueue();
$ruleInfo = $jobqueue->jobqueueRunNowRule(1);