Search Instances
search_instancesSearch OpenStack instances by name, status, host, flavor, image, or availability zone using partial matching, case sensitivity, and pagination.
Instructions
Search for OpenStack instances based on various criteria with efficient pagination.
Functions:
Search instances by name, status, host, flavor, image, or availability zone
Support partial matching with configurable case sensitivity
Return detailed information for matching instances with pagination
Optimized for large-scale environments with intelligent filtering
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"search_term": "<search_term>"
},
"name": "search_instances"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of matching instances to return (default: 50; capped by the server LIST_MAX_LIMIT setting, default 100) | |
| offset | No | Number of matching instances to skip for pagination (default: 0) | |
| search_in | No | Field to search in ('name', 'status', 'host', 'flavor', 'image', 'availability_zone', 'all') | name |
| search_term | Yes | Term to search for (supports partial matching) | |
| all_projects | No | If True, include every project the credential's OpenStack policy allows (like 'openstack server list --all-projects'). Requires ALLOW_CROSS_PROJECT_READ=true on the server; a disabled or denied request is reported as an error, never as current-project results. | |
| case_sensitive | No | If True, performs case-sensitive search (default: False) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |