get_instance
Query OpenStack instances by name, ID, status, or custom search. Supports bulk retrieval and pagination for efficient management.
Instructions
Unified instance query tool supporting all instance retrieval patterns. Consolidates functionality from get_instance_details, get_instance_by_name, get_instances_by_status, and search_instances.
Functions:
Get specific instances by names or IDs
Filter instances by status (ACTIVE, SHUTOFF, ERROR, etc.)
Search instances across multiple fields (name, flavor, image, host, etc.)
List all instances with pagination
Support both summary and detailed information modes
Use when user requests instance information, status checks, or instance searches.
Args: names: Specific instance name(s) to retrieve (comma-separated: "vm1,vm2,vm3") ids: Specific instance ID(s) to retrieve (comma-separated) status: Filter by instance status (e.g., "ACTIVE", "SHUTOFF", "ERROR") search_term: Search term for partial matching across fields search_in: Fields to search in ("name", "status", "host", "flavor", "image", "availability_zone", "all") all_instances: If True, retrieve all instances (ignores other filters) detailed: If True, return detailed information; if False, return summary only limit: Maximum instances to return (default: 50, max: 200) offset: Number of instances to skip for pagination case_sensitive: Case-sensitive search (default: False)
Returns: Instance information in JSON format with metadata and pagination info.
Examples: get_instance(names="vm1,vm2") # Get specific instances get_instance(status="SHUTOFF") # Get all stopped instances get_instance(search_term="web", search_in="name") # Search by name get_instance(all_instances=True, detailed=False) # List all (summary)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| names | No | ||
| ids | No | ||
| status | No | ||
| search_term | No | ||
| search_in | No | name | |
| all_instances | No | ||
| detailed | No | ||
| limit | No | ||
| offset | No | ||
| case_sensitive | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |