In this section, you will learn how a PUT request can be used to trigger actions in an OTbase Discovery node. We'll cover how to initiate a probe as well as different ways to export asset data to OTbase Inventory.
Initiating A Probe
A PUT request using the endpoint /doProbe triggers a probe of all networks that are checked for export.
You can specify if you want to wait for the result using the parameterwait, where the default value is True. You can also specify if you not only want to probe for new devices but also want to refresh the information of the devices already known using the parameter refresh, where the default value is True.
The following command will only probe for new devices and will not wait for the completion.
Request:
PUT https://192.168.0.1/doProbe?wait=false&refresh=false
Note: You can specify which networks to probe by adding network parameters. Just ensure that those networks have the export flag set.
| Parameter | Description |
|---|---|
| wait | Adding the wait parameter to your request instructs OTbase Discovery to either wait or not wait for completion. |
| refresh | Adding the refresh parameter to your request tells OTbase Discovery to update existing device information and probe for new devices within designated networks. |
Exporting Asset Data to OTbase Inventory
Via doSync
A PUT request using the endpoint /doSync exports asset data to OTbase Inventory and is configured in the global configuration.
You can specify whether you want to wait for the result. The default value for the wait parameter is True. Additionally, you can choose if you want to probe all exported networks and devices before sending the result. The default value for the refresh parameter is set to False.
The request below probes all networks configured for export, exports the results to OTbase Inventory, and will not wait for the completion of the probing or the transfer.
Request:
PUT https://192.168.0.1/doSync?wait=false&refresh=true
Via doReduceMultipleExportedNetworks
A PUT request using the endpoint /doReduceMultipleExportedNetworks will try to detect duplicate exported networks and will reduce them by unsetting the export flag for the other duplicates.
You have the option to specify whether you want to wait for the result as the default value for the wait is set to True
Request:
PUT https://192.168.0.1/doReduceMultipleExportedNetworks
This request reduces multiple exported networks and will return a description of what have been detected.
Comments
0 comments
Please sign in to leave a comment.