ad5ad69d54
* Add 'Commands (CLI)' docs * Update index.mdx Added Environment variables section * Add 'connect' sub-folder structure * Adding listen address and port environment variables * add connect to the docs navigation * docs: Add Florin's update to index * docs: Fix links and typo * Add front-matter to resolve the PR check issue * Update postgres.mdx Boundary helper for POSTGRES * Completed 'boundary accounts' command docs * Draft connection option documentatino for kube, http, and rdp (#3455) * Style updates for consistency * Clean up using partials * Add 'ssh' doc & updated style for consistency * Fix paste error * Fix the format issue on 'connect ssh' doc * Add 'auth-methods' command doc (#3520) * Add the docs for 'logout', 'server', and 'dev' commands (#3524) * Add the docs for 'logout', 'server', and 'dev' commands * Update the front matter * Add auth-tokens and authenticate command docs (#3575) * Add config command docs (#3576) * updates to the ssh helper command docs (#3523) * updates to the ssh helper command docs * docs: Fix code block * docs: Add minor copy edits --------- Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> * docs: Add worker commands * docs: Update workers subcommands (#3598) * docs: Update worker subcommands * docs: Update certificate-authority subcommand * doc: Fix syntax for code refererences * docs: Add `users` commands (#3599) * docs: Add `users` commands * docs: Add more subcommands * docs: Add `target` commands (#3608) * Add command docs for 'credential-libraries' (#3610) * Add 'credential-stores' command docs (#3611) * Add 'credential-stores' command docs * Add the output message * Fix a typo * Fix a typo * Update the dummy token value * docs: Add `storage-bucket` commands - update (#3615) * docs: Add `sessions` commands (#3616) * docs: Add `session-recordings` commands (#3617) * Add 'credentials' command docs (#3619) * Add 'credentials' command docs * Fix typos * docs: Add `scopes` commands (#3620) * docs: Add `scopes` commands * docs: Fix typos * docs: Add `roles` commands (#3621) * docs: Add `roles` commands * docs: Add remaining subcommands * Add 'database' command docs (#3628) * Add 'database' command docs * Update the format inconsistency * docs: Add `managed-groups` commands (#3626) * docs: Add `managed-groups` commands * docs: Clarify description * docs: Add `hosts` commands (#3629) * docs: Add `host-sets` commands (#3630) * docs: Add `host-sets` commands * docs: Copy edits * docs: Add `host-catalogs` commands (#3632) * Add 'boundary groups' command docs (#3636) --------- Co-authored-by: kevin-loehfelm <37027455+kevin-loehfelm@users.noreply.github.com> Co-authored-by: kevin-loehfelm <kevin.loehfelm@hashicorp.com> Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Co-authored-by: Florin Cătălin Țiucra-Popa <106736683+FlorinTP@users.noreply.github.com> Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com>
32 lines
1.9 KiB
Plaintext
32 lines
1.9 KiB
Plaintext
### Connect command options:
|
|
|
|
- `-authz-token` `(string: "")` - The authorization string returned from the Boundary controller via an `authorize-session` action against a target.
|
|
This option is only required if you don't set a `-target-id`.
|
|
If you set the value to `-`, the command attempts to read in the authorization string from standard input.
|
|
You can also specify the authorization string using the **BOUNDARY_CONNECT_AUTHZ_TOKEN** environment variable.
|
|
|
|
- `-exec` `(string: "")` - If set, specifies that the given binary should be executed after connecting to the worker, if set.
|
|
This value should be a binary on your path or an absolute path.
|
|
If all command flags are followed by ` -- ` (space, two hyphens, space), then any arguments after that are sent directly to the binary.
|
|
You can also specify a binary using the **BOUNDARY_CONNECT_EXEC** environment variable.
|
|
|
|
- `-host-id` `(string: "")` - The ID of a specific host to connect to out of
|
|
the target's host sets.
|
|
If you do not indicate a specific host, Boundary chooses one at random.
|
|
|
|
- `-target-id` `(string: "")` - The ID of the target to authorize against.
|
|
You cannot use this option with `-authz-token`.
|
|
|
|
- `-target-name` `(string: "")` - The target name, if you authorize the session using
|
|
scope parameters and target name.
|
|
|
|
- `-target-scope-id` `(string: "")` - The target scope ID, if you authorize the
|
|
session using scope parameters and target name.
|
|
This value is mutually exclusive with `-scope-name`.
|
|
You can also specify the target scope ID using the **BOUNDARY_CONNECT_TARGET_SCOPE_ID** environment variable.
|
|
|
|
- `-target-scope-name` `(string: "")` - The target scope name, if you authorize the
|
|
session using scope parameters and target name.
|
|
This value is mutually exclusive with `-scope-id`.
|
|
You can also specify the target scope name using the **BOUNDARY_CONNECT_TARGET_SCOPE_NAME** environment variable.
|