Device Inventory API Details¶
The table lists the Device Inventory application programing interfaces
(APIs) written for the Enterprise Manager. These APIs provide the
ability to interact with a BIG-IP system using Enterprise Manager.
Details about the syntax, inputs, outputs, and exceptions for each API
are provided with the iControl API documentation. Click an API name to
see this information.
Important: The client user account used to authenticate these API
calls must have the role of Administrator on Enterprise Manager.
| Name | Description | Usage Scenario |
| delete_devices | Use the delete_devices
API to to remove one or more devices from Enterprise Manager’s managed devices list. |
With this API you can automate this Enterprise Manager task, and schedule it to run (unattended) at a time optimal to the health of your network. |
| discover_devices | Use the discover_devices
API to to discover devices to be managed by Enterprise Manager. |
With this API you can automate this Enterprise Manager task, and schedule it to run (unattended) at a time optimal to the health of your network. |
| get_devices | Use the get_devices
API to retrieve a list of devices previously discovered by Enterprise Manager. |
When Enterprise Manager through which you establish the iControl proxied connection manages multiple BIG-IP devices, use the get_devices
API to retrieve a list of the those BIG-IP devices. |
| get_task_status | Use the get_task_status
API to to get the status of a discovery task. |
With this API you can either query for the results of a device management task, or use a specific task status to trigger another job. |
Associated libraries¶
The iControl Proxy APIs use the iControl web interface, which is a
simple object application protocol (SOAP) web service.