# benashby/opnsense-sdk Source: https://glimind.com/server/glama%2Fbenashby%2Fopnsense-sdk Registry id: `glama/benashby/opnsense-sdk` Status: unknown ## Tools (80) - `auth_create_group`: Create a new user group. Args: name: Group name description: Group description (optional) members: List of usernames to include (optional) Returns: Created grou - `auth_create_user`: Create a new user account. Args: username: The username for the new account password: The user's password full_name: User's full name (optional) email: User's e - `auth_delete_api_key`: Delete/revoke an API key. Args: key_id: The ID of the API key to delete Returns: Deletion result - `auth_delete_group`: Delete a user group. Args: uuid: The UUID of the group to delete Returns: Deletion result - `auth_delete_user`: Delete a user account. Args: uuid: The UUID of the user to delete Returns: Deletion result - `auth_generate_api_key`: Generate a new API key for a user. Args: username: The username to generate a key for Returns: New API key and secret (save these - secret is shown only once!) - `auth_get_group`: Get detailed information about a specific group. Args: uuid: The UUID of the group Returns: Complete group configuration including members - `auth_get_privilege`: Get details about a specific privilege. Args: privilege_id: The privilege identifier Returns: Privilege details - `auth_get_user`: Get detailed information about a specific user. Args: uuid: The UUID of the user Returns: Complete user configuration including groups and privileges - `auth_list_api_keys`: List all API keys in the system. Returns: List of API keys with owner and creation info - `auth_list_groups`: List all user groups. Args: search_phrase: Optional text to search for limit: Maximum number of groups to return Returns: List of groups with name and member co - `auth_list_privileges`: List all available system privileges. Returns: List of privileges that can be assigned to groups - `auth_list_users`: List all users on the OPNsense system. Args: search_phrase: Optional text to search for in usernames limit: Maximum number of users to return Returns: List of u - `auth_update_group`: Update an existing group. Args: uuid: The UUID of the group to update name: New group name (optional) description: New description (optional) members: New membe - `auth_update_user`: Update an existing user account. Args: uuid: The UUID of the user to update password: New password (optional) full_name: New full name (optional) email: New ema - `diag_activity`: Get system activity and process information. Returns: Active processes and system load - `diag_arp_table`: Get the ARP table. Returns: ARP entries with IP, MAC address, and interface - `diag_dns_lookup`: Perform DNS lookup from the OPNsense firewall. Args: hostname: Hostname to resolve Returns: DNS resolution results - `diag_firewall_log`: View firewall log entries. Args: limit: Maximum number of entries to return action: Filter by action ('block', 'pass', 'reject') Returns: Firewall log entries - `diag_firewall_states`: Query active firewall connection states. Args: search_phrase: Optional filter text (IP, port, protocol) limit: Maximum number of states to return Returns: Activ - `diag_firewall_stats`: Get firewall statistics. Returns: Packet filter statistics including packet/byte counts - `diag_flush_arp`: Flush ARP table entries. Args: ip_address: Specific IP to flush. If omitted, flushes all. Returns: Flush result - `diag_interface_config`: Get interface configuration details. Args: identifier: Optional interface name (e.g., 'wan', 'lan') Returns: Interface configuration including IP, subnet, gatew - `diag_interface_names`: Get list of interface names and identifiers. Returns: Mapping of interface identifiers to names - `diag_ndp_table`: Get the NDP (IPv6 Neighbor Discovery) table. Returns: NDP entries with IPv6 address, MAC, and interface - `diag_packet_capture_jobs`: List packet capture jobs. Returns: List of configured packet capture jobs - `diag_ping`: Ping a host from the OPNsense firewall. Args: host: Hostname or IP address to ping count: Number of ping requests (default: 4) source: Source IP address to use - `diag_routing_table`: View the system routing table. Args: filter_type: Optional filter - 'inet' for IPv4, 'inet6' for IPv6 Returns: Routing table entries - `diag_system_info`: Get system information. Returns: System details including hostname, version, uptime, and hardware info - `diag_system_resources`: Get system resource usage. Returns: CPU, memory, disk usage statistics - `diag_traceroute`: Trace route to a host from the OPNsense firewall. Args: host: Hostname or IP address to trace source: Source IP address to use (optional) Returns: Traceroute re - `diag_traffic`: Get real-time traffic statistics. Args: interface: Interface to get stats for (default: 'wan') Returns: Traffic statistics with bytes/packets in/out - `firewall_add_alias`: Create a new firewall alias. Args: name: Alias name (alphanumeric, must start with letter) alias_type: Type - 'host', 'network', 'port', 'url', 'geoip' content: - `firewall_add_rule` - `firewall_alias_export` - `firewall_alias_get_geoip`: Get GeoIP database information. Returns details about the GeoIP database used for geographic-based aliases. Returns: GeoIP database version, update time, and st - `firewall_alias_get_settings`: Get global alias configuration settings. Returns system-wide alias settings such as default behaviors, table sizes, and other global options. Returns: Global al - `firewall_alias_get_table_size`: Get firewall alias table size statistics. Shows memory usage and entry counts for firewall alias tables, useful for performance monitoring and capacity planning - `firewall_alias_import` - `firewall_alias_list_countries` - `firewall_alias_list_network_aliases`: List only network-type aliases. Returns aliases of type 'network' or 'host', excluding ports, URLs, and GeoIP. Useful for populating network selection fields. R - `firewall_alias_list_user_groups`: List user groups available for use in aliases. User groups can be referenced in firewall rules for user-based policies. Returns: List of user groups Example: `` - `firewall_alias_toggle`: Toggle an alias enabled/disabled. Args: uuid: The UUID of the alias enabled: Set to True to enable, False to disable. Omit to toggle current state. Returns: Tog - `firewall_alias_util_add` - `firewall_alias_util_delete`: Remove an entry from a running alias table. This removes an IP address or network from an alias's runtime table without modifying the alias configuration. Chang - `firewall_alias_util_find_references` - `firewall_alias_util_flush` - `firewall_alias_util_list_all`: List all runtime aliases. Returns all aliases currently loaded in the firewall's runtime tables, showing the actual active aliases regardless of configuration s - `firewall_alias_util_update_bogons`: Update the bogon address database. Bogons are IP addresses that should not appear on the public internet (private ranges, reserved addresses, etc.). This update - `firewall_apply`: Apply pending firewall changes. This must be called after adding, updating, or deleting rules for changes to take effect. Returns: Apply result - `firewall_delete_alias`: Delete a firewall alias. Args: uuid: The UUID of the alias to delete Returns: Deletion result - `firewall_delete_rule`: Delete a firewall rule. Args: uuid: The UUID of the rule to delete Returns: Deletion result - `firewall_delete_rules_bulk` - `firewall_filter_cancel_rollback` - `firewall_filter_download_rules` - `firewall_filter_flush_inspect_cache`: Flush the firewall inspection cache. Clears the state table inspection cache. Useful when troubleshooting connection issues or after significant rule changes. R - `firewall_filter_get_settings`: Get global filter configuration settings. Returns system-wide firewall filter settings such as default policies, optimization options, and other global configur - `firewall_filter_list_network_options`: Get network selection options for filter rules. Returns available network options (aliases, interfaces, special networks) that can be used in filter rule source - `firewall_filter_list_port_options`: Get port selection options for filter rules. Returns available port options (aliases, well-known ports) that can be used in filter rule port fields. Useful for - `firewall_filter_toggle_log`: Toggle logging for a specific filter rule. Args: uuid: The UUID of the filter rule log: True to enable logging, False to disable Returns: Toggle result. Call fi - `firewall_filter_upload_rules` - `firewall_get_alias`: Get detailed information about a specific alias. Args: uuid: The UUID of the alias Returns: Complete alias configuration - `firewall_get_alias_uuid`: Get the UUID of an alias by its name. Args: name: The alias name Returns: Alias UUID - `firewall_get_rule`: Get detailed information about a specific firewall rule. Args: uuid: The UUID of the firewall rule Returns: Complete rule configuration including action, source - `firewall_get_rule_stats`: Get traffic statistics for all firewall rules. Returns: Rule statistics including packet and byte counts - `firewall_list_alias_content`: List the runtime content of an alias. This shows the resolved IP addresses/ports currently in the alias table. Args: alias_name: The alias name Returns: List of - `firewall_list_aliases`: List firewall aliases (IP/port groups). Args: search_phrase: Optional text to search for limit: Maximum number of aliases to return Returns: List of aliases wit - `firewall_list_categories`: List firewall rule categories. Returns: List of available categories - `firewall_list_interfaces`: Get list of interfaces available for firewall rules. Returns: List of interface names and identifiers - `firewall_list_rules` - `firewall_migration_download_rules`: Download legacy firewall rules for migration. Exports rules in legacy format for migration purposes. Used when migrating from older OPNsense versions or pfSense - `firewall_migration_flush`: Flush/clear legacy migration rules. Removes legacy rules from the migration queue. Use after completing a migration to clean up temporary migration data. Return - `firewall_move_rule`: Move a firewall rule before another rule. Args: rule_uuid: UUID of the rule to move before_uuid: UUID of the rule to move before Returns: Move result - `firewall_quick_block_ip`: Quickly block an IP address on all interfaces. This is a composite operation that: 1. Creates a block rule for the IP on WAN 2. Applies the firewall changes Arg - `firewall_reconfigure_aliases`: Reconfigure/reload all aliases. Call this after modifying aliases for changes to take effect. Returns: Reconfigure result - `firewall_revert`: Revert to the previous firewall configuration. This undoes changes made since the last apply. Returns: Revert result - `firewall_savepoint`: Create a firewall configuration savepoint. Use this before making changes to enable rollback if needed. Returns: Savepoint identifier - `firewall_toggle_rule`: Toggle a firewall rule enabled/disabled. Args: uuid: The UUID of the rule enabled: Set to True to enable, False to disable. Omit to toggle. Returns: Toggle resu - `firewall_update_alias`: Update an existing alias. Args: uuid: The UUID of the alias to update name: New alias name alias_type: New type content: New content description: New descriptio - `firewall_update_rule` Measured by Glimind (https://glimind.com): MCP handshake + tool list only, no tool is ever called. CC BY 4.0.