AI Assistant Reference

Features marked with EE badge require Enterprise Edition.

This page provides configuration reference for the NetXMS AI assistant.

For setup instructions, see Getting Started with the AI Assistant. For task-oriented guides, see AI Assistant How-to Guides. For architecture and concepts, see AI Assistant Concepts.

Server Configuration

Provider and global AI settings are placed in netxmsd.conf. Runtime limits are set through server configuration variables (see Server Configuration Variables).

Global Settings

The [AI] section supports the following parameters:

Parameter Default Description

Parameter	Default	Description
`DefaultProvider`	(auto)	Name of the default provider. If not set, the first provider with the `default` slot is used automatically.
`PromptInjectionGuard`	`true`	Enable or disable the prompt injection guard.

DefaultProvider

(auto)

Name of the default provider. If not set, the first provider with the default slot is used automatically.

PromptInjectionGuard

true

Enable or disable the prompt injection guard.

Provider Settings

Each provider is configured in a [AI/Provider/<name>] section.

Parameter Type Default Description

Parameter	Type	Default	Description
`Type`	String	`openai`	Provider type: `openai`, `anthropic`, `mistral`, or `ollama`. Any unrecognized value is treated as `ollama`.
`URL`	String	(varies)	API endpoint URL. Defaults: `https://api.openai.com/v1/chat/completions` (OpenAI), `http://127.0.0.1:11434/api/chat` (Ollama), `https://api.anthropic.com/v1/messages` (Anthropic), `https://api.mistral.ai/v1/chat/completions` (Mistral).
`Model`	String	(varies)	Model name. Defaults: `gpt-6-luna` (OpenAI), `llama3.2` (Ollama), `claude-sonnet-5-5` (Anthropic), `mistral-large-latest` (Mistral).
`Token`	String	(empty)	API authentication token. Sent as a `Bearer` token in the `Authorization` header for `openai`, `mistral`, and `ollama` providers. Anthropic providers send it in the `x-api-key` header together with an `anthropic-version` header.
`Temperature`	Number	-1	Sampling temperature. Set to -1 to use the provider default.
`TopP`	Number	-1	Nucleus sampling parameter. Set to -1 to use the provider default. Values above 1 are clamped to 1.0.
`VerifySSL`	Boolean	`true`	Verify the provider’s TLS certificate.
`ContextSize`	Integer	32768	Provider-specific token limit. For `ollama` providers, sets the context window size (`num_ctx`). For `anthropic` providers, used as the `max_tokens` output limit (8192 when not set). Not used by `openai` and `mistral` providers.
`Timeout`	Integer	180	HTTP request timeout in seconds.
`Slots`	String	`default`	Comma-separated list of slots this provider serves (e.g., `default,interactive,analytical`).

Type

String

openai

Provider type: openai, anthropic, mistral, or ollama. Any unrecognized value is treated as ollama.

URL

String

(varies)

API endpoint URL. Defaults: https://api.openai.com/v1/chat/completions (OpenAI), http://127.0.0.1:11434/api/chat (Ollama), https://api.anthropic.com/v1/messages (Anthropic), https://api.mistral.ai/v1/chat/completions (Mistral).

Model

String

(varies)

Model name. Defaults: gpt-6-luna (OpenAI), llama3.2 (Ollama), claude-sonnet-5-5 (Anthropic), mistral-large-latest (Mistral).

Token

String

(empty)

API authentication token. Sent as a Bearer token in the Authorization header for openai, mistral, and ollama providers. Anthropic providers send it in the x-api-key header together with an anthropic-version header.

Temperature

Number

-1

Sampling temperature. Set to -1 to use the provider default.

TopP

Number

-1

Nucleus sampling parameter. Set to -1 to use the provider default. Values above 1 are clamped to 1.0.

VerifySSL

Boolean

true

Verify the provider’s TLS certificate.

ContextSize

Integer

32768

Provider-specific token limit. For ollama providers, sets the context window size (num_ctx). For anthropic providers, used as the max_tokens output limit (8192 when not set). Not used by openai and mistral providers.

Timeout

Integer

180

HTTP request timeout in seconds.

Slots

String

default

Comma-separated list of slots this provider serves (e.g., default,interactive,analytical).

Provider Slots

Slots route different types of AI requests to appropriate providers. Assign one or more slots to each provider using the Slots parameter.

Slot Description

Slot	Description
`default`	General-purpose slot used when no specific slot is requested. A provider becomes the default when its name matches `DefaultProvider` in the `[AI]` section or when its slot list contains `default`. The AI subsystem fails to initialize only when no default provider can be resolved.
`interactive`	Used for interactive chat sessions with users.
`background`	Used for background AI task execution.
`analytical`	Used for deep analysis tasks such as incident investigation.
`delegation`	Used when the AI assistant delegates work to a skill (the `delegate-to-skill` function).
`fast`	Used for quick operations where low latency is preferred over capability (e.g., prompt injection guard fallback).
`guard`	Used by the prompt injection guard. If not defined, the `fast` slot is used as fallback.

default

General-purpose slot used when no specific slot is requested. A provider becomes the default when its name matches DefaultProvider in the [AI] section or when its slot list contains default. The AI subsystem fails to initialize only when no default provider can be resolved.

interactive

Used for interactive chat sessions with users.

background

Used for background AI task execution.

analytical

Used for deep analysis tasks such as incident investigation.

delegation

Used when the AI assistant delegates work to a skill (the delegate-to-skill function).

fast

Used for quick operations where low latency is preferred over capability (e.g., prompt injection guard fallback).

guard

Used by the prompt injection guard. If not defined, the fast slot is used as fallback.

A request to a slot with no assigned provider falls back to the default provider (except the prompt injection guard, which falls back to the fast slot as noted above).

Configuration Examples

Single cloud provider:

[AI/Provider/openai]
Type = openai
URL = https://api.openai.com/v1/chat/completions
Model = gpt-4o
Token = sk-your-api-key
Slots = default

Multi-provider setup with slots:

[AI/Provider/claude]
Type = anthropic
Model = claude-sonnet-4-20250514
Token = sk-ant-your-key
Slots = default,analytical

[AI/Provider/ollama-fast]
Type = ollama
Model = mistral
Slots = fast

[AI]
DefaultProvider = claude

Local-only deployment with Ollama:

[AI/Provider/local]
Type = ollama
URL = http://127.0.0.1:11434/api/chat
Model = llama3.2
ContextSize = 32768
Slots = default

Server Configuration Variables

The following server configuration variables (stored in the database, changed at runtime from the management client) control the AI subsystem:

Variable Default Description

Variable	Default	Description
`AI.MaxInteractiveIterations`	30	Number of LLM iterations in an interactive chat request after which the user is asked whether to continue. Continuing grants a fresh iteration budget, so this is not a hard cap. Changes take effect without server restart.
`AI.MaxBackgroundIterations`	64	Maximum number of LLM iterations per background task execution. Changes take effect without server restart.
`AI.Memory.EnvironmentMaxSize`	16384	Maximum total size (bytes) of environment memory entries placed into AI assistant prompts. Entries beyond this size are available to the model only on request.
`AI.Memory.UserMaxSize`	8192	Maximum total size (bytes) of per-user memory entries placed into AI assistant prompts.
`AI.Memory.ObjectMaxSize`	8192	Maximum total size (bytes) of per-object memory entries placed into AI assistant prompts.
`AIOperator.Enabled`	1	Enable the AI operator subsystem (global switch for all operator instances).
`AIOperator.MaxConsecutiveFailures`	3	Number of consecutive execution failures after which an AI operator instance is disabled automatically.
`AIOperator.InterruptCooldown`	60	Minimum time (seconds) between an AI operator iteration and the next iteration started by a standing check with the wake action. Interrupts arriving sooner are queued until it elapses.
`AIOperator.Checks.ExecutionTimeLimit`	10	Maximum execution time (seconds) of a single run of an AI operator standing check script.
`AIOperator.Checks.MaxConsecutiveErrors`	5	Number of consecutive script errors after which a standing check is disabled automatically.
`AIOperator.Checks.MaxPerInstance`	32	Maximum number of standing checks per AI operator instance.
`AIOperator.Instructions.HistoryDepth`	20	Number of standing instruction history records kept per AI operator instance.
`AIOperator.Instructions.MaxSize`	8192	Maximum size (bytes of UTF-8 text) of AI operator standing instructions; longer text returned by the model is truncated at a character boundary.

AI.MaxInteractiveIterations

Number of LLM iterations in an interactive chat request after which the user is asked whether to continue. Continuing grants a fresh iteration budget, so this is not a hard cap. Changes take effect without server restart.

AI.MaxBackgroundIterations

Maximum number of LLM iterations per background task execution. Changes take effect without server restart.

AI.Memory.EnvironmentMaxSize

16384

Maximum total size (bytes) of environment memory entries placed into AI assistant prompts. Entries beyond this size are available to the model only on request.

AI.Memory.UserMaxSize

8192

Maximum total size (bytes) of per-user memory entries placed into AI assistant prompts.

AI.Memory.ObjectMaxSize

8192

Maximum total size (bytes) of per-object memory entries placed into AI assistant prompts.

AIOperator.Enabled

Enable the AI operator subsystem (global switch for all operator instances).

AIOperator.MaxConsecutiveFailures

Number of consecutive execution failures after which an AI operator instance is disabled automatically.

AIOperator.InterruptCooldown

Minimum time (seconds) between an AI operator iteration and the next iteration started by a standing check with the wake action. Interrupts arriving sooner are queued until it elapses.

AIOperator.Checks.ExecutionTimeLimit

Maximum execution time (seconds) of a single run of an AI operator standing check script.

AIOperator.Checks.MaxConsecutiveErrors

Number of consecutive script errors after which a standing check is disabled automatically.

AIOperator.Checks.MaxPerInstance

Maximum number of standing checks per AI operator instance.

AIOperator.Instructions.HistoryDepth

Number of standing instruction history records kept per AI operator instance.

AIOperator.Instructions.MaxSize

8192

Maximum size (bytes of UTF-8 text) of AI operator standing instructions; longer text returned by the model is truncated at a character boundary.

Expired AI messages are cleaned up at the interval given by AI.MessageCleanupInterval (default: 60 minutes). This variable is read directly at runtime and is not visible in the Server Configuration view.

Background AI tasks run in the AITasks thread pool, sized by the ThreadPool.AITasks.BaseSize (default: 4) and ThreadPool.AITasks.MaxSize (default: 16) server configuration variables. AI operators run in the dedicated AIOperator thread pool, sized by ThreadPool.AIOperator.BaseSize (default: 4) and ThreadPool.AIOperator.MaxSize (default: 16).

nxai Command-Line Reference

nxai [options] [message]

nxai is nxshell started under another name and accepts the same options, except -c.

Connection options:

Option Description

Option	Description
`-s`, `--server HOST`	Server hostname or URL (e.g., `netxms.local` or `https://netxms.local:8443`). Include a non-default port in the URL.
`-u`, `--user USER`	Username for authentication.
`-p`, `--password PASS`	Password. Prefer using the `NETXMS_PASSWORD` environment variable.
`--no-verify-ssl`	Disable SSL certificate verification.
`--no-save-session`	Do not save the session token for reuse.
`--clear-session`	Clear saved session token and exit.

-s, --server HOST

Server hostname or URL (e.g., netxms.local or https://netxms.local:8443). Include a non-default port in the URL.

-u, --user USER

Username for authentication.

-p, --password PASS

Password. Prefer using the NETXMS_PASSWORD environment variable.

--no-verify-ssl

Disable SSL certificate verification.

--no-save-session

Do not save the session token for reuse.

--clear-session

Clear saved session token and exit.

Context options (mutually exclusive):

Option Description

Option	Description
`-n`, `--node NAME`	Bind the chat session to an object by name.
`-o`, `--object ID`	Bind the chat session to an object by ID.
`-i`, `--incident ID`	Bind the chat session to an incident.

-n, --node NAME

Bind the chat session to an object by name.

-o, --object ID

Bind the chat session to an object by ID.

-i, --incident ID

Bind the chat session to an incident.

Display options:

Option Description

Option	Description
`--plain`	Force plain text output (no colors or formatting).

--plain

Force plain text output (no colors or formatting).

General options:

Option Description

Option	Description
`-h`, `--help`	Show usage information and exit.
`-V`, `--version`	Show version information and exit.

-h, --help

Show usage information and exit.

-V, --version

Show version information and exit.

Environment variables:

Variable Description

Variable	Description
`NETXMS_SERVER`	Default server hostname.
`NETXMS_USER`	Default username.
`NETXMS_PASSWORD`	Password (avoids passing on command line).

NETXMS_SERVER

Default server hostname.

NETXMS_USER

Default username.

NETXMS_PASSWORD

Password (avoids passing on command line).

Session tokens are saved to sessions.json in the nxshell configuration directory for automatic reconnection: $XDG_CONFIG_HOME/nxshell if XDG_CONFIG_HOME is set, otherwise ~/.config/nxshell (%APPDATA%\nxshell on Windows). Saved sessions expire after 4 hours. Command history is stored in the history file in the same directory. Use --clear-session to remove saved tokens.

Debug Tags

The following debug tags can be used for troubleshooting the AI subsystem:

Tag Description

Tag	Description
`ai.assistant`	General AI assistant operations (chat, function calls, incident analysis).
`ai.chat`	Low-level message assembly traces (debug level 8), for both interactive and background chats.
`ai.provider`	LLM provider base class (HTTP requests, response parsing).
`ai.prov.openai`	OpenAI-compatible provider operations.
`ai.prov.anthropic`	Anthropic provider operations.
`ai.prov.ollama`	Ollama provider operations.
`ai.prov.mistral`	Mistral provider operations.
`ai.memory`	AI memory store (environment, per-user, and per-object entries).
`ai.operator`	AI operator management and execution.
`ai.skills`	Skill loading and management.
`ai.tasks`	Background task scheduling and execution.
`ai.messages`	AI message lifecycle and cleanup.
`ai.anomaly`	Anomaly detection profile generation.
`ai.tools`	AI assistant function handlers (data collection, logs, objects).
`webapi.ai`	Web API endpoints for AI chat sessions, memory, and operators.
`ai.extensions` EE	Operations of the `aiext` module.
`ai.extensions.filemgr` EE	File management skill operations.
`ai.ssh` EE	SSH command execution skill operations.

ai.assistant

General AI assistant operations (chat, function calls, incident analysis).

ai.chat

Low-level message assembly traces (debug level 8), for both interactive and background chats.

ai.provider

LLM provider base class (HTTP requests, response parsing).

ai.prov.openai

OpenAI-compatible provider operations.

ai.prov.anthropic

Anthropic provider operations.

ai.prov.ollama

Ollama provider operations.

ai.prov.mistral

Mistral provider operations.

ai.memory

AI memory store (environment, per-user, and per-object entries).

ai.operator

AI operator management and execution.

ai.skills

Skill loading and management.

ai.tasks

Background task scheduling and execution.

ai.messages

AI message lifecycle and cleanup.

ai.anomaly

Anomaly detection profile generation.

ai.tools

AI assistant function handlers (data collection, logs, objects).

webapi.ai

Web API endpoints for AI chat sessions, memory, and operators.

ai.extensions EE

Operations of the aiext module.

ai.extensions.filemgr EE

File management skill operations.

ai.ssh EE

SSH command execution skill operations.

On the agent side, the ai.tools debug tag in nxagentd covers AI tools provided by agent subagents, which the AI assistant discovers and calls with the get-node-ai-tools and execute-agent-tool functions. The aifileops subagent, which provides file search and editing tools, logs under the aifileops tag; it does not start without at least one RootFolder entry in its [aifileops] configuration section (same path[;ro][;nofollow] format as the filemgr subagent), and its file-modifying tools are available only to master servers. The file management skill of the aiext module does not use aifileops: its requests are served by the agent’s filemgr subagent.

Enable debug output by adding the DebugTags parameter to the global section of netxmsd.conf (before any named section):

DebugTags = ai.*:6