truenas-mcp

Manage your TrueNAS SCALE system. 278 actions organized in categories. Usage: - No args or category="help" → list all categories - category only → list available actions in that category with parameters - category + action → execute (pass action-specific params in 'params') Categories: syste…

List all active alerts on the TrueNAS system. Shows alert level, message, source, and dismissal status.

Dismiss an alert by its UUID. Dismissed alerts no longer appear as active but can be restored.

Restore a previously dismissed alert by its UUID, making it active again.

List all available alert categories. Useful for understanding the types of alerts the system can generate.

List all available alert policies. Policies define how alerts are escalated and delivered.

List all configured alert notification services (e.g. email, Slack, PagerDuty). Shows their type, enabled status, and alert level.

Create a new alert notification service. Configures how and where alerts are delivered.

Update an existing alert notification service by its ID. All fields are optional — only provide the ones to change.

Delete an alert notification service by its ID. Use alertservice_list to find the ID.

Send a test notification through an alert service to verify it is configured correctly.

List all certificates on the system, including self-signed, imported, CSR, and ACME certificates.

Get a specific certificate by its numeric ID. Returns full certificate details including the PEM content.

Create a new certificate. Supports internal (self-signed), CSR, imported, and ACME certificate types. Only name and create_type are required; other fields depend on the create_type.

Delete a certificate by its ID. This is a DESTRUCTIVE operation — the 'confirm' parameter must be true to proceed. Optionally force deletion even if the certificate is in use.

List available ACME server choices (e.g. Let's Encrypt production/staging). Use when configuring ACME certificates.

List all configured ACME DNS authenticators. These are used for DNS-01 challenge validation when issuing ACME certificates.

Create a new ACME DNS authenticator for DNS-01 challenge validation. The attributes depend on the authenticator type (e.g. Cloudflare, Route53).

Delete an ACME DNS authenticator by its ID.

Check for available system updates. Returns information about pending updates and the current train.

Get the current update configuration, including the active update train.

Set the update configuration. Currently supports changing the update train.

Download pending system updates. This starts the download process; the system is not updated until update_apply is called.

Apply previously downloaded system updates. This is a DESTRUCTIVE operation that may reboot the system. The 'confirm' parameter must be true to proceed.

List all boot environments. Shows name, active status, creation date, size, and keep flag.

Create a new boot environment by cloning an existing one. Useful for creating a restore point before updates.

Activate a boot environment so it will be used on next boot.

Delete a boot environment. This is a DESTRUCTIVE operation — the 'confirm' parameter must be true to proceed. Cannot delete the currently active boot environment.

Set or clear the 'keep' flag on a boot environment. Boot environments with keep=true are protected from automatic pruning.

Get the current state of the boot pool, including disk layout, health status, and capacity.

Attach a disk to the boot pool to create or extend a mirror. This is a DESTRUCTIVE operation that will erase the target disk. The 'confirm' parameter must be true to proceed.

Detach a disk from the boot pool mirror. This is a DESTRUCTIVE operation — the 'confirm' parameter must be true to proceed.

Start a scrub of the boot pool to check for and repair data integrity issues.

Get file or directory info including permissions, size, owner, and timestamps. Provide the full path on the TrueNAS system.

List contents of a directory. Returns files and subdirectories with metadata. Supports pagination via limit and offset.

Create a new directory at the specified path. Optionally set the UNIX mode (permissions).

Set UNIX permissions on a file or directory. Can optionally apply recursively and strip existing ACLs.

Get the Access Control List (ACL) for a file or directory path. Optionally return a simplified representation.

Set the Access Control List (ACL) for a file or directory. This is a powerful operation — the 'confirm' parameter must be true to proceed.

Change ownership of a file or directory. Can optionally apply recursively.

Get the current reporting/metrics configuration.

List all available reporting graphs (CPU, memory, disk, network, etc.). Use the graph names with reporting_get_data to fetch time-series data.

Get time-series reporting data for one or more graphs (CPU, memory, disk, network, etc.). Use reporting_graphs first to discover available graph names and identifiers.

Get directory services configuration (Active Directory / LDAP).

Update directory services configuration. Fields depend on whether Active Directory or LDAP is configured. Pass only the fields you want to change.

Get current directory services status including connection state and health.

Leave the current Active Directory or LDAP domain. This is a DESTRUCTIVE operation — 'confirm' must be true to proceed. Requires domain credentials.

Refresh the directory services cache. Forces re-read of users and groups from the directory server.

Get Kerberos configuration settings.

List all configured Kerberos realms.

List all configured Kerberos keytabs.

List all system tunables (sysctl, loader, and rc variables).

Create a new system tunable. Tunables allow setting sysctl, loader, or rc variables.

Update an existing tunable by its ID. Use tunable_list to find the ID. All fields are optional — only provide the ones to change.

Delete a tunable by its ID. Use tunable_list to find the ID.

Get the current SSH service configuration.

Update SSH service configuration. All fields are optional — only provide the ones you want to change. Restart the SSH service after changes.

Get the current FTP service configuration.

Update FTP service configuration. All fields are optional — only provide the ones you want to change. Restart the FTP service after changes.

Get the current SNMP service configuration.

Update SNMP service configuration. All fields are optional — only provide the ones you want to change.

Get the current UPS service configuration.

Update UPS service configuration. All fields are optional — only provide the ones you want to change.

List all privileges/roles configured on the system.

Create a new privilege/role with specific permissions and group bindings.

Update an existing privilege/role by its ID. Use privilege_list to find the ID. All fields are optional.

Delete a privilege/role by its ID. Use privilege_list to find the ID.

Query the TrueNAS audit log. Supports filtering by services and applying query filters and options.

Get the current audit configuration including retention and quota settings.

Update audit configuration. All fields are optional — only provide the ones you want to change.

Make a raw API call to any TrueNAS endpoint not covered by specific tools. This is an escape hatch for advanced or uncommon operations. The body parameter accepts a JSON string that will be parsed before sending.

List all network interfaces on the TrueNAS system, including physical NICs, VLANs, bridges, and bond/LAGG interfaces.

Get details of a specific network interface by its ID (e.g. 'em0', 'br0', 'bond0').

Create a new network interface (VLAN, bridge, or bond/LAGG). Network changes are staged until committed with network_commit_changes.

Update an existing network interface. All fields are optional — only provide the ones you want to change. Network changes are staged until committed with network_commit_changes.

Delete a network interface. This is a DESTRUCTIVE operation — the 'confirm' parameter must be set to true to proceed. Network changes are staged until committed.

Get the global network configuration including hostname, domain, gateways, nameservers, and proxy settings.

Update global network configuration. All fields are optional — only provide the ones you want to change.

Get a summary of the network configuration including all interfaces, IPs, default routes, and nameservers.

List all configured static routes.

Create a new static route.

Delete a static route by its numeric ID. Use network_static_route_list to find the ID.

Get IPMI chassis information if IPMI is available on this system. First checks whether IPMI hardware is present.

Commit pending network interface changes. Network changes are staged and must be committed to take effect. Use checkin_timeout to set a rollback timer — if you do not check in (network_checkin) within that time, changes are automatically rolled back.

Rollback all pending (uncommitted) network interface changes, restoring the previous network configuration.

Check in after committing network changes to confirm they are working. This prevents the automatic rollback that occurs if you don't check in within the checkin_timeout window.

List all users on the TrueNAS system, including system and local accounts.

Get details of a specific user by their numeric ID.

Create a new user account on the TrueNAS system.

Update an existing user account. All fields are optional — only provide the ones you want to change.

Delete a user account. This is a DESTRUCTIVE operation — the 'confirm' parameter must be set to true to proceed.

Get a list of available login shells on the system. Useful when creating or updating a user to know which shells are valid.

Set or change a user's password by their numeric ID.

List all groups on the TrueNAS system.

Get details of a specific group by its numeric ID.

Create a new group on the TrueNAS system.

Update an existing group. All fields are optional — only provide the ones you want to change.

Delete a group. This is a DESTRUCTIVE operation — the 'confirm' parameter must be set to true to proceed.

List all physical disks in the TrueNAS system with their details including serial numbers, sizes, and pool membership.

Get details of a specific disk by its device name (e.g. 'sda', 'nvme0n1').