You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
boundary/website/content/docs/client-agent/manage.mdx

80 lines
2.8 KiB

---
layout: docs
page_title: Manage the Client Agent
description: >-
Learn how to manage the Boundary Client Agent to intercept DNS requests, allowing Boundary to proxy connections transparently.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
# Manage the Client Agent
Refer to the following sections for more information about managing the Client Agent.
You can monitor the Client Agent's status and retrieve information about any transparent sessions.
If you want to temporarily defer DNS resolution to any previously configured DNS resolvers, you can pause the Client Agent.
You can also disable the Client Agent, if you no longer want to use it for DNS resolution.
## Monitor status and sessions
You can check the status of the Client Agent to ensure it is running.
Use the following command to check the Client Agent's status:
```shell-session
$ boundary client-agent status
```
You can retrieve information about the sessions that the Client Agent is managing.
Use the following command to list any sessions currently being managed by the Client Agent, as well as any brokered credentials for those sessions:
```shell-session
$ boundary client-agent sessions
```
Note that this command does not list sessions that are not managed by the Client Agent. Use `boundary sessions list -recursive` to see all sessions.
## Pause the Client Agent
You can temporarily disable the Boundary Client Agent by pausing it with the following command:
```shell-session
$ boundary client-agent pause
```
When the Client Agent is paused, it does not intercept any DNS requests, and you are unable to use transparent sessions.
To resume the Client Agent, use the following command:
```shell-session
$ boundary client-agent resume
```
## Disable the Client Agent
If you want to disable the Boundary Client Agent, you can stop it with the following commands:
<Tabs>
<Tab heading="MacOS" group="macos">
```shell-session
$ sudo launchctl bootout system /Library/LaunchDaemons/com.hashicorp.boundary.boundary-client-agent.plist
```
Unloading the Boundary Client Agent removes its launch daemon configuration. To restart the Client Agent, use:
```shell-session
$ sudo launchctl bootstrap system /Library/LaunchDaemons/com.hashicorp.boundary.boundary-client-agent.plist
```
</Tab>
<Tab heading="Windows" group="windows">
```shell-session
net stop BoundaryClientAgent
```
</Tab>
</Tabs>