GetXMLRPCEntityData

Edit online

The GetXMLRPCEntityData method issues an XML-RPC call, through the XML-RPC Helper, on the specified method. The Collector contacted will be that referenced in the supplied standard entity record (that is, the .despatch record).

Method Synopsis

GetXMLRPCEntityData($ne, $method, $methodArgArray)

Parameters

$ne: Specifies a reference to the network entity record as received in the .despatch table of the Collector supporting Agents. The target device’s host address and port will be extracted from the data m_CollectorInfo within this record.
$method: Specifies the XML-RPC method to call on the target device.
$methodArgArray: Holds the relevant arguments to the selected XML-RPC method call specified in the $method parameter.

Description

The GetXMLRPCEntityData method uses the XML-RPC Helper to perform the XML-RPC call specified in the $method parameter on the target device specified in the $ne parameter. The call can be a custom call or one of the calls defined in the published Network Manager Collector XML Schema.

Notes®

The GetXMLRPCEntityData method issues the request to the Helper Server, which performs the actual work. Thus, the Helper Server (and ncp_ctrl) must be running so that this method can make the appropriate XML-RPC request.

Returns

Upon completion, the GetXMLRPCEntityData method returns the XML data with which the target device responded. It is the responsibility of the caller to interpret this XML data.