get_ip_addresses
Retrieve IP addresses from Nautobot using filters like address, prefix, status, role, tenant, or VRF. Supports pagination with limit and offset settings for precise results.
Instructions
Retrieve IP addresses from Nautobot with filtering options
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| address | No | Specific IP address to search for | |
| limit | No | Maximum number of results to return (default: 100, max: 1000) | |
| offset | No | Number of results to skip for pagination (default: 0) | |
| prefix | No | Network prefix to filter by (e.g., 10.0.0.0/24) | |
| role | No | Role to filter by (e.g., loopback, secondary, anycast) | |
| status | No | Status to filter by (e.g., active, reserved, deprecated) | |
| tenant | No | Tenant to filter by | |
| vrf | No | VRF to filter by |
Implementation Reference
- MCP @server.call_tool handler block for executing the 'get_ip_addresses' tool. Parses input arguments, calls NautobotClient.get_ip_addresses, formats results as JSON.if name == "get_ip_addresses": # Extract and validate arguments address = args.get("address") prefix = args.get("prefix") status = args.get("status") role = args.get("role") tenant = args.get("tenant") vrf = args.get("vrf") limit = min(args.get("limit", 100), 1000) # Cap at 1000 offset = args.get("offset", 0) logger.info(f"Retrieving IP addresses with filters: {args}") # Get IP addresses from Nautobot ip_addresses = await client.get_ip_addresses( address=address, prefix=prefix, status=status, role=role, tenant=tenant, vrf=vrf, limit=limit, offset=offset ) # Format results result = { "count": len(ip_addresses), "filters_applied": {k: v for k, v in args.items() if v is not None}, "results": [ip.model_dump() for ip in ip_addresses] } return [ types.TextContent( type="text", text=f"Retrieved {len(ip_addresses)} IP addresses from Nautobot:\n\n" f"```json\n{result}\n```" ) ]
- src/mcp_nautobot_server/server.py:387-433 (registration)Registration of the 'get_ip_addresses' tool in @server.list_tools(), defining the tool name, description, and detailed input schema.types.Tool( name="get_ip_addresses", description="Retrieve IP addresses from Nautobot with filtering options", inputSchema={ "type": "object", "properties": { "address": { "type": "string", "description": "Specific IP address to search for" }, "prefix": { "type": "string", "description": "Network prefix to filter by (e.g., 10.0.0.0/24)" }, "status": { "type": "string", "description": "Status to filter by (e.g., active, reserved, deprecated)" }, "role": { "type": "string", "description": "Role to filter by (e.g., loopback, secondary, anycast)" }, "tenant": { "type": "string", "description": "Tenant to filter by" }, "vrf": { "type": "string", "description": "VRF to filter by" }, "limit": { "type": "integer", "description": "Maximum number of results to return (default: 100, max: 1000)", "default": 100, "minimum": 1, "maximum": 1000 }, "offset": { "type": "integer", "description": "Number of results to skip for pagination (default: 0)", "default": 0, "minimum": 0 } }, "additionalProperties": False }, ),
- Core helper function in NautobotClient that implements the API call to retrieve IP addresses from Nautobot, applies filters, parses responses into IPAddress models.async def get_ip_addresses( self, address: Optional[str] = None, prefix: Optional[str] = None, status: Optional[str] = None, role: Optional[str] = None, tenant: Optional[str] = None, vrf: Optional[str] = None, limit: int = 100, offset: int = 0 ) -> List[IPAddress]: """ Retrieve IP addresses from Nautobot. Args: address: Filter by specific IP address prefix: Filter by network prefix status: Filter by status slug role: Filter by role slug tenant: Filter by tenant slug vrf: Filter by VRF name limit: Maximum number of results to return offset: Number of results to skip Returns: List of IPAddress objects Raises: NautobotError: For API or connection errors """ params: Dict[str, Any] = { "limit": limit, "offset": offset, } # Add optional filters if address: params["address"] = address if prefix: params["parent"] = prefix if status: params["status"] = status if role: params["role"] = role if tenant: params["tenant"] = tenant if vrf: params["vrf"] = vrf try: response = await self._make_request("GET", "/ipam/ip-addresses/", params) # Parse results ip_addresses = [] for item in response.get("results", []): try: ip_addresses.append(IPAddress(**item)) except Exception as e: logger.warning(f"Failed to parse IP address data: {e}") continue logger.info(f"Retrieved {len(ip_addresses)} IP addresses") return ip_addresses except Exception as e: logger.error(f"Failed to retrieve IP addresses: {e}") raise
- Pydantic schema/model for IPAddress data returned by the get_ip_addresses tool.class IPAddress(BaseModel): """Pydantic model for Nautobot IP address data.""" id: str url: HttpUrl address: str status: Dict[str, Any] role: Optional[Dict[str, Any]] = None tenant: Optional[Dict[str, Any]] = None vrf: Optional[Dict[str, Any]] = None nat_inside: Optional[Dict[str, Any]] = None nat_outside: Optional[Dict[str, Any]] = None dns_name: Optional[str] = None description: Optional[str] = None comments: Optional[str] = None tags: List[Dict[str, Any]] = Field(default_factory=list) custom_fields: Dict[str, Any] = Field(default_factory=dict) created: str last_updated: str