IBM DataPower Operations Dashboard v1.0.13.0
A newer version of this product documentation is available.
You are viewing an older version. View latest at IBM DPOD Documentation.
Devices REST API
- Assaf Cohen (Deactivated)
- Sara Weisz
- Amit Munwes
User will need an admin or operator access for this API, Unauthorized users will get "401 Unauthorized"
Add and setup a device:
Omitted Boolean parameters are presumed to be false, it's not allowed to setup wsm without setting up log targets
Omit the autoSetupAgentNameand autoSetupPattern parameters if you do not wish to use the automatic domain setup feature.
POSTÂ /op/api/v1/devices?name=wdp6&host=10.0.0.13&somaPort=5550&somaUser=admin&somaPassword=password&logTargetAddress=10.0.0.13&monitorResources=false&monitorServices=true&syslogAgentName=MonTier-SyslogAgent-1&setupSyslogForDomains=true&wsmAgentName=MonTier-WsmAgent-1&setupWsmForDomains=true&setupCertificateMonitor=true&autoSetupPattern=APIMgmt*&autoSetupAgentName=MonTier-SyslogAgent-1
{
"resultCode": "SUCCESS",
"resultMessage": ""
}
Error messages are issued for input validation errors , errors while inserting the device into derby/es and errors that happened during the device-level syslog setup, when an error happens during those steps - the transaction is rolled-back and the device is removed from DPOD, so the command can be issued again without failing on a duplicate device error.
Warning messages are issued for errors that happened while setting up log targets for all domains, setting up wsm for all domains or setting up certificate monitoring, the operation stops, but the transaction will not roll-back from DPOD, so manual steps will be needed in order to complete the setup.
{
"resultCode": "ERROR",
"resultMessage": "A device with this name already exists, name=wdp6"
}
Warning - the operation started but stopped, we did not roll back the device or any setup done to this point, so the user will need to manually check what was setup and complete it manually.
{
"resultCode": "WARNING",
"resultMessage": "Error setting up WS-M agent for the following domains: Domain: APIMgmt_963162B289, Message: +DPOD WSM agent cannot be reached from the device. Error is: Cannot ping both host and IP address: TCP connection to \"10.0.0.38 port 60020\" failed (connection refused)"
}
Setup all devices' host aliases (for DR)
For all devices - disable all log targets, setup DPOD's host aliases again and re-enable all log targets.
If the device cannot be reached - it will be skipped.
Errors or exceptions will not stop the operation.
POST /op/api/v1/devices/refreshAgents
{
"resultCode": "SUCCESS"
}
Warning - not all the operations were completed for one or more devices, the operation completed successfully for devices that are not mentioned.
{
"resultCode": "WARNING",
"resultMessage": "Device=adp: Could not connect to device, skipping device, Exception=Could not connect to host. "
}
The operation does not return an "ERROR" status.