The new docs.trellix.com features a modernized UI and AI-powered conversational search. Content is currently available in English, with additional languages launching in early November 2026. We hope you enjoy the updated experience.

Download the Cluster Virtual Probe Agent

Prev Next

This URL download the cluster virtual probe agent.

Resource URL

GET /cloud/cluster/<id>/downloadagent

Request Parameters

URL Parameters

Field Name Description Data Type Mandatory
id Cluster id Number Yes

Query Parameter

Field Name Description Data Type Mandatory
ostype Operating system type. Values can be:
  • Windows (default)
  • Linux
String No

Payload Request Parameters

None

Response Parameters

Cluster virtual probe file data is returned if the request parameters are correct, otherwise error details are returned.

Example

Request

PUT https://<NSM_IP>/sdkapi/cloud/cluster/101/downloadagent?ostype=linux

Response

<probe software file data>

Error Information

Following error codes are returned by this URL:

No HTTP Error Code SDK API errorId SDK API errorMessage
1 500 1001 Internal error message: internal server error
2 400 11001 Please provide valid OS, one of [windows, linux]
3 400 11001 Get failed for id <id> : <error>