Skip to content

Commit

Permalink
Imporved consistency across the page and mentioned [To be supplied]
Browse files Browse the repository at this point in the history
… for some descriptions
  • Loading branch information
siddardh committed Jun 7, 2023
1 parent b09209c commit 49cf3b1
Showing 1 changed file with 65 additions and 57 deletions.
122 changes: 65 additions & 57 deletions docs/Agent/user-guide/man_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

#### Pbench Server 1.0

- [pbench-results-move](pbench-results-move)
- [pbench-results-move](#pbench-results-move)

## Commands

Expand All @@ -45,7 +45,7 @@
This command clears the results directory from `/var/lib/pbench-agent` directory.

**OPTIONS**
`-C`, `--config` PATH
`-C`, `--config PATH`
Path to the Pbench Agent configuration file.
This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable.

Expand All @@ -68,17 +68,17 @@ Show this message and exit.
Clear all tools which are registered and can filter by name of the group.

**OPTIONS**
`-C`, `--config` PATH
`-C`, `--config PATH`
Path to the Pbench Agent configuration file.
This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable.

`-n`, `--name`, `--names` STR
Clear only the <`STR`> tool.
`-n`, `--name`, `--names <name>`
Clear only the `<name>` tool.

`-g`, `--group`, `--groups` STR
Clear the tools in the <`STR`> group. If no group is specified, the `default` group is assumed.
`-g`, `--group`, `--groups <group>`
Clear the tools in the `<group>`. If no group is specified, the `default` group is assumed.

`-r`, `--remote`, `--remotes` STR[,STR...]
`-r`, `--remote`, `--remotes STR[,STR...]`
Clear the tool(s) only on the specified remote(s). Multiple remotes may be specified as a comma-separated list. If no remote is specified, all remotes are cleared.

`--help`
Expand All @@ -94,25 +94,25 @@ Show this message and exit.
`pbench-copy-results` - copy result tarball to the 0.69 Pbench Server

**SYNOPSIS**
`pbench-copy-results [OPTIONS]`
`pbench-copy-results --user=<user> [OPTIONS]`

**DESCRIPTION**
Push the benchmark result to the Pbench Server without removing it from the local host. This command requires `/opt/pbench-agent/id_rsa` file with the private SSH key, when pushing to a 0.69 Pbench Server.

**OPTIONS**
`--user`
`--user <user>`
This option value is required if not provided by the
`PBENCH_USER` environment variable; otherwise, a value provided
on the command line will override any value provided by the
environment.

`--controller`
`--controller <controller>`
This option may be used to override the value
provided by the `PBENCH_CONTROLLER` environment variable; if
neither value is available, the result of `hostname -f` is used.
(If no value is available, the command will exit with an error.)

`--prefix`
`--prefix <prefix>`
This option allows the user to specify an optional
directory-path hierarchy to be used when displaying the result
files on the 0.69 Pbench Server.
Expand Down Expand Up @@ -144,15 +144,15 @@ Show this message and exit.
List tool registrations, optionally filtered by tool name or tool group.

**OPTIONS**
`-C`, `--config` PATH
`-C`, `--config PATH`
Path to the Pbench Agent configuration file.
This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable.

`-n`, `--name` STR
List the tool groups in which tool <`STR`> is registered.
`-n`, `--name <name>`
List the tool groups in which tool `<name>` is registered.

`-g`, `--group` STR
List all the tools registered in the <`STR`> group.
`-g`, `--group <group>`
List all the tools registered in the `<group>`.

`-o`, `--with-option`
List the options with each tool.
Expand All @@ -176,12 +176,12 @@ Show this message and exit.
This command will list all the registered triggers by `group-name`.

**OPTIONS**
`-C`, `--config` PATH
`-C`, `--config PATH`
Path to the Pbench Agent configuration file.
This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable.

`-g`, `--group`, `--groups` STR
List all the triggers registered in the <`STR`> group.
`-g`, `--group`, `--groups <group>`
List all the triggers registered in the `<group>`.

`--help`
Show this message and exit.
Expand All @@ -202,19 +202,19 @@ Show this message and exit.
Push the benchmark result to the 0.69 Pbench Server. Requires a `/opt/pbench-agent/id_rsa` file with the private SSH key of the server's pbench account. On a successful push, this command removes the results from the local host.

**OPTIONS**
`--user`
`--user <user>`
This option value is required if not provided by the
`PBENCH_USER` environment variable; otherwise, a value provided
on the command line will override any value provided by the
environment.

`--controller`
`--controller <controller>`
This option may be used to override the value
provided by the `PBENCH_CONTROLLER` environment variable; if
neither value is available, the result of `hostname -f` is used.
(If no value is available, the command will exit with an error.)

`--prefix`
`--prefix <prefix>`
This option allows the user to specify an optional
directory-path hierarchy to be used when displaying the result
tar balls on the pbench server.
Expand All @@ -240,7 +240,7 @@ Show this message and exit.
`pbench-register-tool` - registers the specified tool

**SYNOPSIS**
`pbench-register-tool [OPTIONS]`
`pbench-register-tool --name=<tool-name> [OPTIONS] [-- <tool-specific-options>]`

**DESCRIPTION**
Register the specified tool.
Expand Down Expand Up @@ -299,16 +299,22 @@ For a list of tool-specific options, run:
> `/opt/pbench-agent/tool-scripts/<tool-name> --help`
**OPTIONS**
`--name` STR
<`STR`> specifies the name of the tool to be registered.
`--name <tool-name>`
`<tool-name>` specifies the name of the tool to be registered.

`-g`, `--group`, `--groups` STR
Register the tool in <`STR`> group. If no group is specified, the `default` group is assumed.
`-g`, `--group`, `--groups <group>`
Register the tool in `<group>`. If no group is specified, the `default` group is assumed.

`[--persistent | --transient]`
For tools which can be run as either "transient" (where they are started and stopped on each iteration) or as "persistent" (where they are started before the first iteration and run continuously over all iterations), these options determine how the tool will be run. (Most tools are configured to run as either or the other, so these options are not necessary in those cases, and specifying the wrong one will produce an error.)
For tools which can be run as either "transient" (where they are started and stopped on each iteration) or as "persistent" (where they are started before the first iteration and run continuously over all iterations), these options determine how the tool will be run. (Most tools are configured to run as either one the other, so these options are not necessary in those cases, and specifying the wrong one will produce an error.)

`--remotes`
`--no-install`
[To be supplied]

`--labels=<label>[,<label>]]`
Where the list of labels must match the list of remotes.

`-remotes STR[,STR]...`
Single remote host, a list of remote hosts (comma-separated, no spaces) or an "at" sign (`@`) followed by a filename. In this last case, the file should contain a list of hosts and their (optional) labels. Each line of the file should contain a hostname, optionally followed by a label separated by a comma (`,`); empty lines are ignored, and comments are denoted by a leading hash (`#`), character.

`--help`
Expand All @@ -324,32 +330,34 @@ Show this message and exit.
`pbench-register-tool-set` - register the specified toolset

**SYNOPSIS**
`pbench-register-tool-set [OPTIONS]`
`pbench-register-tool-set [OPTIONS] <tool-set>`

**DESCRIPTION**
Register all the tools in the specified toolset.

Available <`tool-set`> from /opt/pbench-agent/config/pbench-agent.cfg:
Available `<tool-set>` from /opt/pbench-agent/config/pbench-agent.cfg:

- heavy
- legacy
- light
- medium

**OPTIONS**

`<tool-set>`
A named tool set argument from one of: `heavy`, `legacy`, `light`, `medium`.

`--remotes`
**OPTIONS**
`-remotes STR[,STR]...`
Single remote host, a list of remote hosts (comma-separated, no spaces) or an "at" sign (`@`) followed by a filename. In this last case, the file should contain a list of hosts and their (optional) labels. Each line of the file should contain a hostname, optionally followed by a label separated by a comma (`,`); empty lines are ignored, and comments are denoted by a leading hash (`#`), character.

`-g`, `--group` STR
Register the toolset in <`STR`> group. If no group is specified, the `default` group is assumed.
`-g`, `--group <group>`
Register the toolset in `<group>`. If no group is specified, the `default` group is assumed.

`--labels`
`--labels=<label>[,<label>]]`
Where the list of labels must match the list of remotes.

`--interval=<INT>`
[To be supplied]

`--no-install`
[To be supplied]

`--help`
Show this message and exit.

Expand All @@ -369,18 +377,18 @@ Show this message and exit.
Register triggers which start and stop data collection for the given tool group.

**OPTIONS**
`-C`, `--config` PATH
`-C`, `--config PATH`
Path to the Pbench Agent configuration file.
This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable.

`-g`, `--group`, `--groups` STR
Registers the trigger in the <`STR`> group. If no group is specified, the `default` group is assumed.
`-g`, `--group`, `--groups <group>`
Registers the trigger in the `<group>`. If no group is specified, the `default` group is assumed.

`--start-trigger` STR
[required]
`--start-trigger STR`
[To be supplied]

`--stop-trigger` STR
[required]
`--stop-trigger STR`
[To be supplied]

`--help`
Show this message and exit.
Expand All @@ -401,14 +409,14 @@ Show this message and exit.
This command uploads one or more result directories to the configured v1.0 Pbench Server. The specified API Key is used to authenticate the user and to establish ownership of the data on the server. Once the upload is complete, the result directories are, by default, removed from the local system.

**OPTIONS**
`-C`, `--config` PATH
`-C`, `--config PATH`
Path to the Pbench Agent configuration file.
This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable.

`--controller` STR
`--controller <controller>`
Override the default controller name.

`--token` STR
`--token <token>`
Pbench Server API key [required].

`--delete` | `--no-delete`
Expand Down Expand Up @@ -450,27 +458,27 @@ options, like
> `pbench-user-benchmark --config string -- fio --bs 16k`
**OPTIONS**
`-C`, `--config` PATH
`-C`, `--config PATH`
Path to the Pbench Agent configuration file.
This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable.

`--tool-group` STR
`--tool-group STR`
The tool group to use for data collection.

`--iteration-list` STR
`--iteration-list STR`
A file containing a list of iterations to run for the provided script;
the file should contain one iteration per line. With a leading hash (`#`) character used for comments and blank lines are ignored.
Each iteration line should use alpha-numeric characters before the first space to name the iteration, with the rest of the line provided as arguments to the script.
_NOTE: --iteration-list is not compatible with --use-tool-triggers_

`--sysinfo` STR[,STR...]
`--sysinfo STR[,STR...]`
Comma-separated values of system information to be collected; available: `default`, `none`, `all`, `ara`, `block`, `insights`, `kernel_config`, `libvirt`, `security_mitigations`, `sos`, `stockpile`, `topology`

`--pbench-pre` STR
`--pbench-pre STR`
Path to the script which will be executed before tools are started.
_NOTE: --pbench-pre is not compatible with --use-tool-triggers_

`--pbench-post` STR
`--pbench-post STR`
Path to the script which will be executed after tools are stopped and postprocessing is complete.
_NOTE: --pbench-post is not compatible with --use-tool-triggers_

Expand Down

0 comments on commit 49cf3b1

Please sign in to comment.