find_object_usage
Find every policy, group, and object that references a given ADOM object to assess where-used dependencies before modification.
Instructions
Find everywhere an ADOM object is referenced (where-used).
Runs FortiManager's cache-daemon where-used search: policies, groups, and other objects that reference the given object. This is a usage-graph lookup, distinct from object_tools.search_objects (which matches objects BY NAME, not by reference).
Args: adom: ADOM name (use "global" to search a Global ADOM object) object_name: Name of the object to trace usage for object_type: One of "address", "address_group", "service", "service_group" (default: "address") timeout: Maximum seconds to wait for the search to complete (default: 60, capped at 300) poll_interval: Seconds between progress checks (default: 2, clamped to 1-30)
Returns: dict: Usage result with keys: - status: "success" or "error" - object_name: The object searched for - object_type: The object type searched - total_matches: Number of referencing locations - used_in: List of where-used entries, each with the referencing object's root ADOM/package and the matching attr/mapping_name/mkey detail FortiManager returned - message: Error message if failed
Example: >>> result = await find_object_usage("root", "WebServer") >>> for entry in result["used_in"]: ... print(entry["root"], entry["data"])
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| adom | Yes | ||
| timeout | No | ||
| object_name | Yes | ||
| object_type | No | address | |
| poll_interval | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||