Dan HeathandRobin Beck
915be558d2
* docs: Add Client Agent commands to CLI docs * docs: Fix typos * docs: Update status description * Update website/content/docs/commands/client-agent/index.mdx Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * docs: Capitalize Client Agent * docs: Undo capitalization * Apply batch suggestions from code review Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> --------- Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
39 lines
925 B
Plaintext
39 lines
925 B
Plaintext
---
|
|
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.
|
|
---
|
|
|
|
# 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'
|