Get Instance
get_instanceRetrieve, list, filter, or search OpenStack instances by ID, name, status, host, flavor, or image, with pagination and summary or detailed results.
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.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_instance"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Specific instance ID(s) to retrieve (comma-separated) | |
| limit | No | Maximum instances to return (default: 50; capped by the server LIST_MAX_LIMIT setting, default 100) | |
| names | No | Specific instance name(s) to retrieve (comma-separated: "vm1,vm2,vm3") | |
| offset | No | Number of instances to skip for pagination | |
| status | No | Filter by instance status (e.g., "ACTIVE", "SHUTOFF", "ERROR") | |
| detailed | No | If True, return detailed information; if False, return summary only | |
| search_in | No | Fields to search in ("name", "status", "host", "flavor", "image", "availability_zone", "all") | name |
| search_term | No | Search term for partial matching across fields | |
| all_instances | No | If True, retrieve all instances (ignores other filters) | |
| case_sensitive | No | Case-sensitive search (default: False) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |