What can you do in the Agents module in Moveworks Setup?

From the Agents module in Moveworks Setup will be able to:

1. Able to monitor your deployed agents - Check the status of various agents deployed
2. Generate secret for deploying a new agent
3. Create new agents in servers where agents are previously deployed
4. Stop or upgrade deployed agents
5. Logs for create, update or stop operation done on deployed agents via the new UI

Prerequisites

1. Ensure that you have an on-premise system
2. Please see the Moveworks Agent and Moveworks Agent Installation Guide to learn more about agents, how they work and how to install the Moveworks Agent

To enable new functionalities such as create agent, upgrade agent & stop agent:

In order to utilize the new functionalities you will need to manually upgrade your agents through the following steps:

1. Fetch the latest version of the installation script - Change the directory in your server to where the agents are already installed

   1. Download the agent installation script using curl or wget 💡 These links redirect to GitHub

      curl -fsSL https://get-agent.moveworks.com > setup_agent.sh

   2. Set the script's permissions to allow execution

      chmod +x setup_agent.sh

2. Run the installation script with a additional flag

   ./setup_agent.sh --setup_agent_manager

In case, if you are doing the Moveworks agent setup for first time run these commands in sequence

1. ./setup_agent.sh --docker (You can choose between either docker or podman as your runtime container)
2. ./setup_agent.sh --setup_agent_manager

Configuring Moveworks Agent

🚧

IMPORTANT: Secure Your Org Access Secret

Please be advised that the API token for the Org Access Secret is displayed only once. It is imperative that you save it immediately for future use. Please handle the secret securely.

1. First you must generate the org secret, this will be used to deploy the Moveworks Agent in your network:
   1. Navigate to the Agents module in the left navigation bar under Core Platform
   2. Click on the Generate Secret button in the bottom right of the Agents module. A pop-up window will appear showing the Org Access Secret
   3. Copy the Org Access Secret and save it. You will need this value as referenced in the Installation Guide reference in the next step.
2. Deploy Moveworks Agent in your networks
   1. See the Moveworks Agent Installation Guide to learn how to install the Moveworks Agent
   2. See the Moveworks Agent guide to learn more about the agent

Checking the Status and Health of the Agents Deployed

1. Navigate to the Agents module in the left navigation bar under Core Platform

2. In the Agents module you will see a table with a view of all the agents that are deployed and reachable

   Field name	Description
   Agent name	This is the name or the ID of the docker/podman container where the agent is installed Once you have installed the agent via a script or the UI - You will see a entry for it in this table
   Server UUID	Unique identifier for the server where the agent is deployed. This is picked from the script deployed in your server This will only be populated once you have enabled the new create/update/stop functionalities via ./setup_agent.sh --setup_agent_manager
   Agent version	This reflect the current version of the Agent that is deployed in your server
   Agent health	The Agent Health refers to the agents ability to serve requests from the Moveworks platform Healthy - the agent is able to successfully serve requests > 90% of the time Unhealthy - if out of 100 calls that Moveworks makes to the agent, 10 or more times a connection could not be established Not in Use (previously Unknown) - Typically unknown implies that the agent is not in use yet i.e: 0 calls have been made to the AD Agent, so the health check does not know if it is healthy or not The agent health refers to the ability of deployed agent to serve request from the Moveworks platform. It doesn’t reflect the health of server or the deployed container on your end
   Agent status	The Agent Status refers to whether the agent is Active or Inactive Active - agent container is running and connected to upstream Moveworks platform Inactive - Any agent that fails to connect to Moveworks or has stopped running is set to inactive, it will stay in this list for around 30 minutes before disappearing If you stop the agent via the UI it will marked as Inactive

   

How to Create a New Agent?

• Click on the “Create New” agent button on the On-Premise Agents page
• This will allow you to deploy new agent containers to eligible servers—where the setup_agent_manager flag is enabled
• Selection of Server and Agent Version are available. Admins can optionally enable host network access for new agents. If an agent is already set up with host network on the selected server, this option will remain disabled
• If no Servers are eligible (i.e., the setup_agent_manager is not enabled in any of your servers), the “Create New” button will be disabled

How to Upgrade the Version of Agents?

Agents on servers where the setup_agent_manager is enabled can be upgraded from the UI via the “...” actions menu beside each Agent item on the table.

Clicking on “Upgrade Agent” will open a form where you can select the Agent Version you want to upgrade to.

⚠️

Important Note

It’s not possible to downgrade to a version lower than the current Agent version.

How to Stop Agents?

Agents on servers where the setup_agent_manager is enabled can also be stopped from the UI via the “...” actions menu beside each Agent item on the table.

Clicking on “Stop Agent” will ask you for further confirmation before triggering the removal of the Agent container.

❗️

Important Note

It is not possible to recover an Agent once it has been stopped.

👉

The above operations are not instantaneous. They are triggered and run asynchronously on the server; they may take several minutes to complete.

Monitor Operations Logs

The operation logs contains records of the Create/Upgrade/Stop actions triggered via the UI. If the you have run the upgrade and stop commands via the script directly - These will not be captured here.