This section describes web service methods.
Purpose: Lets you create a network definition.
In the Administration page, each submitted, new entry in the Network Properties would be equivalent to one method call.
Input parameters:
Return: XML document with root node InsertNetworkDefinition and ClientId element containing the newly created ClientId for the inserted network. If unsuccessful, ClientId will be zero.
Errors returned: Standard error reporting is provided.
Purpose: Lets you modify a network definition identified by the passed client ID, including the subnet description, IP address, and mask.
In the Administration page, each network definition edit is equivalent to one method call.
Input parameters:
Return: True or false indicating success or failure of the update.
Errors returned: Standard error reporting is provided.
Purpose: Lets you delete a network definition identified by the passed client ID. Internally, the client network is marked inactive. Deleting already deleted networks will result in a false return code.
In the Administration page, deleting a network from the Network List is equivalent to one method call.
Input parameter: ClientId (required)
Return: XML document with root node DeleteNetworkDefinition and ClientId element containing the deleted ClientId.
Errors returned: Standard error reporting is provided.
Purpose: Lets you retrieve network definitions by client ID.
In the Administration page, the Network List includes each network definition from the Default Network Set.
Input parameter: None.
Return: XML document with one entry per network definition. Each entry contains the following parameters:
Errors returned: Standard error reporting is provided.
Purpose: Triggers a reset of all monitoring devices to pick up the configuration data and then restart.
In the Show Me menu of the Administration page, click Data Monitoring and Monitoring Devices. In the ADA Monitoring Device List, click the blue gear menu (
) and select Synchronize Monitor Devices.
Input parameter: None
Return: XML document with root node ReloadCollectors and Collector element for status report for each monitoring device. The Status/Message attribute indicates the success of the reload process. Check each monitoring device individually to find the results of the synchronization.
Errors returned: Standard error reporting is provided.
Purpose: Shows the string/numerical version number of this API. This method is applicable only to this web services API.
Input parameter: None.
Return: Version number as a string.
Errors returned: Standard error reporting is provided.
|
Copyright © 2015 CA Technologies.
All rights reserved.
|
|