Skip to content

Commit

Permalink
docs: clarify behavior of launchctl stop and unload for client agent
Browse files Browse the repository at this point in the history
  • Loading branch information
Mohit0233 committed Nov 20, 2024
1 parent 69fc3a4 commit 99ca183
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions website/content/docs/api-clients/client-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,14 @@ If you want to disable the Boundary Client Agent, you can stop it with the follo
$ sudo launchctl stop com.hashicorp.boundary.boundary-client-agent
```

<Note>

Stopping the Boundary client agent using `launchctl stop` only halts it temporarily, as the `StartInterval` setting causes it to restart automatically after 60 seconds.

**To disable it permanently**, you must unload the service using `launchctl unload`. Unloading not only stops the agent but also removes its configuration from `launchd`. To restart the agent after unloading, you must reload it using `launchctl load`, as the `start` command will not work in this case.

</Note>

</Tab>
<Tab heading="Windows" group="windows">

Expand Down

0 comments on commit 99ca183

Please sign in to comment.