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/commands/client-agent/pause.mdx

44 lines
1.4 KiB

---
layout: docs
page_title: client-agent pause - Command
description: >-
The "client-agent pause" command pauses the Client Agent so that it does not intercept DNS requests.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!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.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
# client-agent pause
Command: `boundary client-agent pause`
The `boundary client-agent pause` command lets you temporarily stop the Client Agent.
When the Client Agent is paused, it does not intercept DNS requests and you cannot use transparent sessions.
## Example
The following command pauses the Client Agent:
```shell-session
$ boundary client-agent pause
```
## Usage
<CodeBlockConfig hideClipboard>
```shell-session
$ boundary client-agent pause [options] [args]
```
</CodeBlockConfig>
### Command options
- `client-agent-port=<uint>` - Specifies the port on which the Client Agent listens.
You can also specify the port using the **BOUNDARY_CLIENT_AGENT_LISTENING_PORT** environment variable.
@include 'cmd-option-note.mdx'