---
title: "Agent Overview and Management"
canonical: "https://docs.vaultspeed.com/space/VPD/3011412068/Agent%20Overview%20and%20Management"
format: markdown
---
The VaultSpeed Agent securely connects local systems to the cloud application, ensuring that tasks are executed efficiently. Every 20 seconds (or more, based on your configuration), the Agent polls the cloud application for new tasks and executes them. Communication is always initiated by the Agent, maintaining a secure, one-way flow of information.

For setup and installation instructions, refer to the [VaultSpeed Agent guide.](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/3012821038)  

### Managing the Agent

You can manage your running agents directly from the **Agent page** in VaultSpeed using the following features:

- **Ping Agents**: Verify which agents are running and retrieve their hostnames.
- **Stop All Agents**: Terminate all or specific agents based on your selection.

These tools provide visibility into the Agent’s current status and allow you to manage them efficiently.

### Ping Agents

The **Ping Agents** button allows you to verify which agents are currently running and retrieve their hostnames.

#### **Steps to Use Ping Agents**

1. **Start the Task**:  
Click the **Ping Agents** button to begin the process of identifying running agents and their hostnames.  
The following graphic shows the **Ping Agents** button and task interface:

![screen3.png](media://66a4406d-b29a-45fd-bf36-fa6c8a9ee7e2)

2. **Monitor Progress**:  
While the task is running, a progress bar will display the status of the process. This gives real-time feedback as the agents respond to the ping request.  
The following graphic shows the task in progress, including the "Waiting for execution" status:

#### **Ping Results**

After refreshing, you will see a list of pings that includes:

- **When the ping was received (timestamp).**
- **The hostname of the machine where the agent is running.**
- **The software version of the agent.**
- **The PID (Process ID) of the agent process.**

The following graphic displays the completed ping results, including timestamps, hostnames, versions, PIDs, and the Stop button functionality for individual agents:

![image-20250214-125306.png](media://8fff5c6d-8a5f-497e-88b0-f642c5504135)

### How Hostnames Are Determined

The hostname is identified in the following order:

1. Retrieve the `"COMPUTERNAME"` environment variable.
2. Retrieve the `"HOSTNAME"` environment variable.
3. Execute the `hostname` command.
4. Get the network name of localhost.
5. Return `"Unknown Computer"` if none of the above succeed.

> 📝 **Notes**
> 📝 
> 📝 - The task will remain active indefinitely if no agents are running.
> 📝 - Ensure agents are running and updated to the latest supported version to avoid ping issues.
> 📝 - Hostname details will appear alongside the **software version** and **PID** in the results table after the ping task completes.

### Stop All Agents

The **Stop All Agents** feature allows you to terminate active agents globally or individually.

#### **Steps to Use Stop All Agents**

1. **Complete a Ping Agents Task**: Run this task to populate the list of running agents, including their hostnames, versions, and PIDs.
2. **Choose an Option**:
  - **Stop All Agents**: Sends a stop task to terminate all running agents.
  - **Stop (per hostname)**: Click the **Stop** button next to a specific hostname to terminate only the agent(s) running on that hostname.

> 📝 **Notes**
> 📝 
> 📝 - Clicking **Stop All Agents** will cause all agents to exit with code 0.
> 📝 - The **Stop Agent** button is only enabled when the agent version is supported. If the agent is unsupported (and cannot connect to the environment), the button will be greyed out.
> 📝 - Termination actions are only available for:
> 📝   - Agents running the latest version.
> 📝   - Agents running a previous version during the grace period.
> 📝 - Depending on how the customer manages agent processes, terminated agents may restart automatically.

### Agent Overview – Color Coding

Agents are now color-coded in the **Agent Overview** to indicate their status and required actions:

- **Grey**: The Agent is running and on the latest supported version.
- **Yellow**: The Agent is running within a grace period. These agents will need to be updated soon.
- **Red**: The Agent is running an unsupported version. All connections for this Agent are blocked.

> 📝 #### **Notes:**
> 📝 
> 📝 - Termination actions (**Stop buttons**) are only available for:
> 📝   - Agents running the latest version.
> 📝   - Agents running a previous version within the grace period.
> 📝 - The color coding helps users quickly identify which agents require attention and take appropriate actions.


### **Agent Support for Amazon Redshift (New in Version 5.7.4)**

VaultSpeed Agent now supports connectivity to **Amazon Redshift** for metadata harvesting and code deployment.

To enable Redshift support:

- Update the Agent to version **5.7.4** or higher
- Place the **Redshift JDBC driver** in the Agent’s `/lib/` directory
- Configure the connection in `connections.properties` or via the VaultSpeed UI

Refer to: [Amazon Redshift Integration](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4498194630) for setup instructions.