Edit

Manage viam-agent

viam-agent is installed as a systemd service named viam-agent on Linux, and as a launchd daemon named system/com.viam.agent on MacOS.

To restart viam-agent:

Alert

When you restart viam-agent, the agent will restart viam-server as well.

Web UI
Shell

Navigate to your machine in Viam.
Click on the machine status indicator next to the machine name.
Click on the restart arrow symbol. This will restart viam-server and viam-agent.

sudo systemctl restart viam-agent

To start viam-agent:
```
sudo systemctl start viam-agent
```
To stop viam-agent:

Alert

When you stop viam-agent, the agent will stop viam-server as well.

sudo systemctl stop viam-agent

To completely uninstall viam-agent and viam-server, run the following command:
```
sudo /bin/sh -c "$(curl -fsSL https://storage.googleapis.com/packages.viam.com/apps/viam-agent/uninstall.sh)"
```
This command uninstalls viam-agent, viam-server, the machine cloud credentials file (/etc/viam.json), and the provisioning configuration file (/etc/viam-provisioning.json).

Caution

If you remove the machine cloud credentials file you will not be able to connect to your machine. You can only restore this file if you have access to the machine configuration.

To restart viam-agent:

Alert

When you restart viam-agent, the agent will restart viam-server as well.

Web UI
Shell

Navigate to your machine in Viam.
Click on the machine status indicator next to the machine name.
Click on the restart arrow symbol. This will restart viam-server and viam-agent.

sudo launchctl kickstart -k system/com.viam.agent

To start viam-agent:
```
sudo launchctl kickstart system/com.viam.agent
```
If the service fails to start, make sure it is bootstrapped. The following command will print an error message if the service is NOT bootstrapped.
```
sudo launchctl print system/com.viam.agent
```
The following command will bootstrap the service.
```
sudo launchctl bootstrap system /Library/LaunchDaemons/com.viam.agent.plist
```
If the service STILL fails to start, ensure that it is enabled. The following command will enable the service.
```
sudo launchctl enable system/com.viam.agent
```
To stop viam-agent:

Alert

When you stop viam-agent, the agent will stop viam-server as well.

sudo launchctl kill and sudo launchctl stop will NOT fully stop viam-agent, as launchd will automatically resurrect it. You can use the following to “boot out” the service and fully stop it.

sudo launchctl bootout system/com.viam.agent

If you would like to start viam-agent again after this command, you will need to bootstrap it again.

sudo launchctl bootstrap system /Library/LaunchDaemons/com.viam.agent.plist

To completely uninstall viam-agent and viam-server, run the following command:
```
sudo /bin/sh -c "$(curl -fsSL https://storage.googleapis.com/packages.viam.com/apps/viam-agent/uninstall.sh)"
```
This command uninstalls viam-agent, viam-server, and the machine cloud credentials file (/etc/viam.json).

Caution

If you remove the machine cloud credentials file you will not be able to connect to your machine. You can only restore this file if you have access to the machine configuration.

On Windows, you can manage viam-agent using the Services GUI or the command line. You can also use the Viam web UI to restart viam-agent.

Open the Services management console from your computer’s start menu.
Find viam-agent in the list of services.
Use the Restart Service, Stop Service, and Start Service buttons to manage viam-agent.
To change the startup type of viam-agent, right-click on viam-agent and select Properties. Select your desired startup type from the Startup type dropdown menu.

Open a PowerShell prompt, selecting Run as administrator.

Use the following commands to manage viam-agent:

To start viam-agent:
```
Start-Service viam-agent
```
To stop viam-agent:
```
Stop-Service viam-agent
```
To restart viam-agent:
```
Restart-Service viam-agent
```

To change the startup type of viam-agent, use one of the following commands:

Set-Service -Name "viam-agent" -StartupType Manual
Set-Service -Name "viam-agent" -StartupType Automatic

Navigate to your machine in Viam.
Click on the machine status indicator next to the machine name.
Click on the restart arrow symbol. This will restart viam-server and viam-agent.

To uninstall viam-agent, run the following command in an administrator prompt:

sc stop viam-agent
sc delete viam-agent
Remove-Item \opt\viam -Recurse
Remove-Item C:\Windows\system32\config\systemprofile\.viam -Recurse

Troubleshooting

You can find assistance in the Troubleshooting section.

Was this page helpful?

Glad to hear it! If you have any other feedback please let us know:

We're sorry about that. To help us improve, please tell us what we can do better:

Thank you!