agents

Sensor agents and agent groups.

• Toolset name: agents

• Enabled by default: yes

• Tools: 14 (6 read-only)

Tools

openvas_clone_agent_group

Clone agent group · mutating

Clone an agent group. Returns the UUID of the copy.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_create_agent_group

Create agent group · mutating

Create an agent group. Not idempotent.

Parameter	Type	Required	Description
agent_ids	array	no	UUIDs of member agents
comment	string	no
name	string	yes	Group name
scheduler_cron_time	string	yes	Scheduler cron expression for the group

openvas_delete_agent

Delete agent · destructive

Delete an agent (no trashcan).

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_delete_agent_group

Delete agent group · destructive

Delete an agent group (to the trashcan by default; ultimate deletes permanently).

Parameter	Type	Required	Description
id	string	yes	Resource UUID
ultimate	boolean	no	Permanently delete instead of moving to the trashcan (default false)

openvas_get_agent

Get agent · read-only

Get one agent by UUID, including its configuration.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_get_agent_group

Get agent group · read-only

Get one agent group by UUID.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_get_agent_installer_instruction

Get agent installer instruction · read-only

Get the installer instructions for enrolling an agent with a scanner.

Parameter	Type	Required	Description
language	string	no	Instruction language: en or de
origin_url	string	yes	Absolute origin URL used in the generated instructions
scanner_id	string	yes	Scanner UUID the agent will report to

openvas_get_agent_support_bundle

Get agent support bundle · read-only

Download an agent’s support bundle (returned base64-encoded, up to 3 MB).

Parameter	Type	Required	Description
days	integer	no	Limit the bundle to the most recent number of days (min 0)
encryption	boolean	no	Request backend encryption of the bundle (omit for the default)
id	string	yes	Agent UUID

openvas_list_agent_groups

List agent groups · read-only

List agent groups. trash lists trashed ones.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)
trash	boolean	no	List trashed resources instead of active ones

openvas_list_agents

List agents · read-only

List sensor agents with status, version and authorization.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_sync_agents

Sync agents · mutating

Trigger a synchronization of agents with the agent controller.

This tool takes no parameters.

openvas_update_agent

Update agent · destructive

Authorize, update or reconfigure an agent. Idempotent (PUT).

Parameter	Type	Required	Description
authorized	boolean	no	Authorize (true) or revoke (false) the agent
comment	string	no
config	any	no	Agent configuration update object (agentControl.retry, agentScriptExecutor, heartbeat), as in the gateway’s AgentConfigUpdate
id	string	yes	Agent UUID
update_to_latest	boolean	no	Request an update to the latest agent version

openvas_update_agent_control_scan_config

Update agent-control scan config · destructive

Change the default agent configuration of an agent-control scan config. Idempotent (PUT).

Parameter	Type	Required	Description
agent_defaults	any	no	Default agent configuration (AgentConfigUpdate object)
id	string	yes	Agent-control scan config UUID
update_to_latest	boolean	no	Update agents to the latest version by default

openvas_update_agent_group

Update agent group · destructive

Update an agent group. Idempotent (PUT); the scheduler cron time is always required by the gateway.

Parameter	Type	Required	Description
agent_ids	array	no	Replacement member agent UUIDs
comment	string	no
id	string	yes	Group UUID
name	string	no
scheduler_cron_time	string	yes	Scheduler cron expression (required by the gateway on every update)