Configuration Management Methods

The following is a list of the available methods used to manage your Zend Server or Zend Server ClusterManager configuration:

  • The configurationExport Method
  • The configurationImport Method
license New BSD License
link for the canonical source repository
author Ingo Walz
category Zend
package Zend_Service
subpackage ZendServerAPI

 Methods

Base constructor for all API-method implementations

__construct(string $name) 
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::__construct()

Parameters

$name

string

Name of the config

Check if connection is possible or not

canConnect() : bool
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::canConnect()

Returns

bool

<b>The configurationExport Method</b>

configurationExport(string $exportDirectory, string $fileName) : \SplFileInfo
Export the current server/cluster configuration into a file.

Parameters

$exportDirectory

string

Directory where to save the exported configs

$fileName

string

Filename to export config to

Returns

<b>The configurationImport Method</b>

configurationImport(string $importFile) : \ZendService\ZendServerAPI\DataTypes\ServersList
Import a saved configuration snapshot into the server.

Parameters

$importFile

string

File to import

Returns

Disables the logging

disableLogging() : void
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::disableLogging()

Enables the logging

enableLogging() : void
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::enableLogging()

Get the directory for saving the configs

getExportDirectory() : string

Returns

string

Get the config file to import

getImportFile() : string

Returns

string

Get the plugin manager

getPluginManager() : \Zend\ServiceManager\PluginManager
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::getPluginManager()

Returns

\Zend\ServiceManager\PluginManager

Returns the current request

getRequest() : \ZendService\ZendServerAPI\Request
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::getRequest()

Returns

Set the client.

setClient(\Zend\Http\Client $client) : void
Inherited

Most likly for testing

inherited_from \ZendService\ZendServerAPI\BaseAPI::setClient()

Parameters

$client

\Zend\Http\Client

Set the config file.

setConfigFile(string $configFile) : void
Inherited

Proxy to the pluginmanager for initialization

inherited_from \ZendService\ZendServerAPI\BaseAPI::setConfigFile()

Parameters

$configFile

string

Directory for exported config files

setExportDirectory(string $exportDirectory) : void

Parameters

$exportDirectory

string

Set the directory, where to export the config files to

Set the import config file

setImportFile(string $importFile) : void

Parameters

$importFile

string

Full path to file

Set the request for the current context

setRequest(\ZendService\ZendServerAPI\Request $request) : void
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::setRequest()

Parameters

Get the first event groups identifier by an given issue id.

getFirstEventGroupsIdByIssueId(int $issueId) : int
Inherited

This will perform an monitorGetIssuesDetails action.

inherited_from \ZendService\ZendServerAPI\BaseAPI::getFirstEventGroupsIdByIssueId()

Parameters

$issueId

int

Returns

int

 Properties

 

$exportDirectory : string
 

$importFile : string
 

$name : string
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::$$name
 

$pluginManager : \ZendService\ZendServerAPI\PluginManager
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::$$pluginManager