Skip to main content

Install Cyware Agent

After creating an agent group, you must install the agent on your on-premise server by executing the command generated in Orchestrate.

Before you Start  

Ensure that you meet the prerequisites and system requirements to install the agent on your server. For more information, see System Requirements and Prerequisites.

Steps 

To install a Cyware Agent, follow these steps:

  1. Go to Admin Panel > Cyware Agent.

  2. Select an Agent group and click View Installation Instructions to view the command. You can view the steps to set up the agent. The installation command follows this format:

    mkdir -p /apps/cyware/cyware_agent/<AGENT_GROUP>-<AGENT_ID>; \
cd /apps/cyware/cyware_agent/<AGENT_GROUP>-<AGENT_ID>; \
wget -O keeper.sh "https://<cyware-domain>/soarapi/agent/keeper/export/<AGENT_TOKEN>/?dtoken=<DOWNLOAD_TOKEN>&tenantid=<TENANT_ID>" \
&& bash keeper.sh PUID=1000 PGID=1000

    Note

    Starting from Orchestrate Next Gen v3.12.11, you can modify the values of Process User ID (PUID) and Process Group ID (PGID) as required to match your system’s configured user and group IDs. If not specified, default values may apply depending on your environment. PUID and PGID are system IDs that define which user and user group a process runs as on your system.

  3. Click Copy to copy the command from the installation form. 

  4. Sign in to your on-premise server as an administrator.

  5. Run the copied command.

After successful installation in Orchestrate, you must activate the agent by clicking Activate to start polling tasks.

Agent Status 

You can view the following statuses depending on the agent’s connection status.

  • Disconnected: Displayed when the agent is unable to establish or maintain a connection with the Orchestrate platform. When an agent is disconnected, it will not receive new tasks until the connection is restored.

  • Connected: Displayed when the agent is successfully installed, configured, and actively polling the Orchestrate platform for tasks.

  • Pending Installation: Displayed when the Cyware Agent is configured but not yet installed on the on-premise server.

  • Pending Update: Displayed when the Cyware Agent is yet to poll and apply the latest configuration updates pushed from the Orchestrate Platform.

System Requirements