CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($reportObj, $parent)
  __get ($name)
  __set ($name, $value)
  addListener ($address)
  addSNMPTrapDestination ($address)
  getDomainEnable ()
  getDomainObjectEnable ()
  getLogHost ()
  getLogLevel ()
  getLogType ()
  getReportingInterval ()
  getReportObj ()
  getSessionObj ()
  getSNMPCommunity ()
  getSNMPEnable ()
  getSNMPSentTrapsToAllManagers ()
  listListeners ()
  listSNMPTrapDestinations ()
  removeListener ($address)
  removeSNMPTrapDestination ($address)
  reset ()
  save ()
  setDomainEnable ($value)
  setDomainObjectEnable ($value)
  setLogHost ($value)
  setLogLevel ($value)
  setLogType ($value)
  setReportingInterval ($value)
  setSNMPCommunity ($value)
  setSNMPEnable ($value)
  setSNMPSentTrapsToAllManagers ($value)
  start ()
  stop ()
  updateListener ($address)

Member Function Documentation

Report::__get ( name  ) 

Get member.

member

description

DomainEnable

Enabled/Disabled Domain Collecting

DomainObjectEnable

Enabled/Disabled Domain Objects Collecting

reportingInterval

Collect samples every (values: 0-5844 days)

logLevel

the log level for the Reporting service

logHost

the address of the host that offers log services

logType

the log type for the Reporting service

SNMPEnable

the SNMP service as enabled

SNMPSentTrapsToAllManagers

SNMPCommunity

Report::__set ( name,
value  
)

Set member.

member

description

DomainEnable

Enabled/Disabled Domain Collecting

DomainObjectEnable

Enabled/Disabled Domain Objects Collecting

reportingInterval

Collect samples every (values: 0-5844 days)

logLevel

the log level for the Reporting service

logHost

the address of the host that offers log services

logType

the log type for the Reporting service

SNMPEnable

the SNMP service as enabled

SNMPSentTrapsToAllManagers

SNMPCommunity

Report::addListener ( address  ) 

This function adds a listener to this service

Returns:
bool
Parameters:
$address  string the listener address (ex: 127.0.0.1:25)
Report::addSNMPTrapDestination ( address  ) 

adds a SNMP trap destination to the service

Returns:
bool
Parameters:
$address  string SNMP Trap Destination Address
Report::listListeners (  ) 

This function lists the listeners for this service

Returns:
array
Report::listSNMPTrapDestinations (  ) 

lists available SNMP trap destinations

Returns:
array
Report::removeListener ( address  ) 

This function removes a listener from this service

Returns:
bool
Parameters:
$address  string the listener address (ex: 127.0.0.1:25)
Report::removeSNMPTrapDestination ( address  ) 

removes a SNMP trap destination from the service

Returns:
bool
Parameters:
$address  string SNMP Trap Destination Address
Report::start (  ) 

This function starts the Reporting service

Returns:
bool
Report::stop (  ) 

This function stops the Reporting service

Returns:
bool
Report::updateListener ( address  ) 

This function updates a listener from this service

Returns:
object Listener
Parameters:
$address  string the listener address (ex: 127.0.0.1:25)