* 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>
152 lines
5.8 KiB
Plaintext
152 lines
5.8 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: host-catalogs create - Command
|
|
description: |-
|
|
The "host-catalogs create" command lets you create a new host catalog.
|
|
---
|
|
|
|
# host-catalogs create
|
|
|
|
Command: `host-catalogs create`
|
|
|
|
The `host-catalogs create` command lets you create a new host catalog.
|
|
|
|
## Example
|
|
|
|
This example creates a static host catalog with the name `prodops` and the description `For ProdOps usage`:
|
|
|
|
```shell-session
|
|
$ boundary host-catalogs create static -name prodops -description "For ProdOps usage"
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary host-catalogs create [type] <subcommand> [options] [args]
|
|
|
|
Please see the typed subcommand help for detailed usage information.
|
|
|
|
Subcommands:
|
|
plugin Create a plugin-type host catalog
|
|
static Create a static-type host catalog
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Usages by type
|
|
|
|
You can create plugin or static host catalog types.
|
|
|
|
<Tabs>
|
|
<Tab heading="Plugin">
|
|
|
|
The `boundary host-catalogs create plugin` command lets you create a plugin type host catalog.
|
|
|
|
#### Example
|
|
|
|
This example creates a plugin type host catalog with the name `prodops` and the description `Plugin host-catalog for ProdOps`, and adds it to a scope with the ID `p_1234567890`.
|
|
|
|
```shell-session
|
|
$ boundary host-catalogs create plugin -scope-id p_1234567890 -name prodops -description "Plugin host-catalog for ProdOps"
|
|
```
|
|
|
|
#### Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary host-catalogs create plugin [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
#### Command options
|
|
|
|
- `-description=<string>` - The description to set on the plugin host catalog.
|
|
- `-name=<string>` - The name to set on the plugin host catalog.
|
|
- `-plugin-id=<string>` - The ID of the plugin associated with the host catalog you want to create.
|
|
- `-plugin-name=<string>` - The name of the plugin associated with the host catalog you want to create.
|
|
- `-scope-id=<string>` - The scope in which you want to create the host catalog.
|
|
The default scope is `global`.
|
|
You can also specify the scope using the **BOUNDARY_SCOPE_ID** environment variable.
|
|
|
|
#### Attribute options
|
|
|
|
- `-attr` - A key=value pair to add to the request's attribute map.
|
|
This option can also be a key value only, which sets a JSON null as the value.
|
|
If you provide a value, Boundary automatically infers the type.
|
|
You can override the type using `-string-attr`, `-bool-attr`, or `-num-attr`.
|
|
You can specify this value multiple times.
|
|
This option supports referencing values from files using `file://` and environment variables using `env://`.
|
|
- `-attributes=<string>` - A JSON map value that you can use as the entirety of the request's attributes map.
|
|
Usually this value is sourced from a file using the `file://` syntax.
|
|
This option is exclusive with other `attr` flags.
|
|
- `-bool-attr` - A key=value Boolean value that you can add to the request's attributes map.
|
|
You can specify this value multiple times.
|
|
This option supports referencing values from files using `file://` and environment variables using `env://`.
|
|
- `-num-attr` - A key=value numeric value that you can add to the request's attributes map.
|
|
You can specify this value multiple times.
|
|
This attribute supports referencing values from files using `file://` and environment variables using `env://`.
|
|
- `-string-attr` - A key=value string value that you can add to the request's attributes map.
|
|
You can specify this value multiple times.
|
|
This option supports referencing values from files using `file://` and environment variables using `env://`.
|
|
|
|
#### Secrets options
|
|
|
|
- `-bool-secret` - A key=value Boolean value that you can add to the request's secrets map.
|
|
You can specify this value multiple times.
|
|
This option supports referencing values from files using `file://` and environment variables using `env://`.
|
|
- `-num-secret` - A key=value numeric value that you can add to the request's secrets map.
|
|
You can specify this value multiple times.
|
|
This option supports referencing values from files using `file://` and environment variables using `env://`.
|
|
- `-secret` - A key=value pair that you can add to the request's secrets map.
|
|
This option can also be a key value only, which sets a JSON null as the value.
|
|
If you provide a value, Boundary automatically infers the type.
|
|
You can override the type using `-string-secret`, `-bool-secret`, or `-num-secret`.
|
|
You can specify this value multiple times.
|
|
This option supports referencing values from files using `file://` and environment variables using `env://`.
|
|
- `-secrets=<string>` - A JSON map value that you can use as the entirety of the request's secrets map.
|
|
Usually this value is sourced from file using `file://` syntax.
|
|
This option is exclusive with other secret flags.
|
|
- `-string-secret` - A key=value string value that you can add to the request's attributes map.
|
|
You can specify this value multiple times.
|
|
This option supports referencing values from files using `file://` and environment variables using `env://`.
|
|
|
|
</Tab>
|
|
|
|
<Tab heading="Static">
|
|
|
|
The `boundary host-catalogs create static` command lets you create a static type host catalog.
|
|
|
|
#### Example
|
|
|
|
This example creates a static type host catalog with the name `prodops` and the description `Static host-catalog for ProdOps` and adds it to the scope `p_1234567890`:
|
|
|
|
```shell-session
|
|
$ boundary host-catalogs create static -scope-id p_1234567890 -name prodops -description "Static host-catalog for ProdOps"
|
|
```
|
|
|
|
#### Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary host-catalogs create static [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
#### Command options
|
|
|
|
- `-description=<string>` - The description to set on the static host catalog.
|
|
- `-name=<string>` - The name to set on the static host catalog.
|
|
- `-scope-id=<string>` - The scope in which to create the static host catalog.
|
|
The default scope is `global`.
|
|
You can also specify the scope using the **BOUNDARY_SCOPE_ID** environment variable,
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
@include 'cmd-option-note.mdx' |