Skip to content

Commit

Permalink
Update dds-agent-cmd docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AnarManafov committed Sep 29, 2023
1 parent 94fd346 commit 189a639
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions dds-agent-cmd/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# dds-agent-cmd

Send commands to agent. **UNIX/Linux/OSX**

## Synopsis

```shell
dds-agent-cmd [[-h, --help] | [-v, --version] | [command, --command arg] | [-s, --session arg]] {[getlog arg] {[-a, --all]} | [update-key arg] {[--key arg] | [--value arg]}}
```

## Description

This utility allows to send commands to DDS agents.
For the currently available commands see [Options](#options)

## Options

* **getlog** *arg*
Download all log files from active agents. All files from agents' working directories with the extension `.log` will be tar/zip'ed into a single file and downloaded on DDS commander server machine into the directory specified by `server.log_dir` DDS configuration option and placed in the subdirectory "agents" (default:`~/.DDS/log/agents`)
Usage example:

```shell
dds-agent-cmd getlog -a
```

* **update-key** *arg*
It forces an update of a given task's property in the topology. Name of the property and a new value should be provided additionally (see `--key` and `--value`)
Usage example:
```shell
dds-agent-cmd update-key --key mykey --value new_value
```
* **--key**
Defines the key to update
* **--value**
Defines a new value of the given key.
* **-a, --all**
Send command to all active agents.
* **--s, --session** *arg*
DDS Session ID.

0 comments on commit 189a639

Please sign in to comment.