docs: Update meta content - CLI (#5343)

* docs: Update meta content - CLI

* docs: Edits for consistency

* docs: More edits for consistency

* Apply batch of suggestions from code review

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

* Apply batch suggestions from code review

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

* docs: Remove given id references

* Update read.mdx

* Update read.mdx

---------

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
This commit is contained in:
Dan HeathandRobin Beck authored and GitHub committed 2024-12-17 14:13:18 -05:00
1 parent a4f2a704fd
commit b442c1fa60
191 files changed
+378 -378

No files matched your search

@@ -1,8 +1,8 @@
---
layout: docs
page_title: accounts change-password - Command
description: |-
The "accounts change-password" command lets Boundary admin change the password for an account.
description: >-
The "accounts change-password" command resets the password on account resources.
---
# accounts change-password
@@ -1,8 +1,8 @@
---
layout: docs
page_title: accounts create - Command
description: |-
The "accounts create" command lets Boundary admin create a new account resource.
description: >-
The "accounts create" command creates a new account resource and associates it with an auth method.
---
# accounts create
@@ -1,8 +1,8 @@
---
layout: docs
page_title: accounts delete - Command
description: |-
The "accounts delete" command lets Boundary admin delete an account resource.
description: >-
The "accounts delete" command deletes an existing account resource.
---
# accounts delete
@@ -1,8 +1,8 @@
---
layout: docs
page_title: accounts - Command
description: |-
The "accounts" command lets Boundary admin create and manage account resources.
description: >-
The "accounts" command performs operations on account resources. You can associate users with accounts using auth methods.
---
# accounts
@@ -1,8 +1,8 @@
---
layout: docs
page_title: accounts list - Command
description: |-
The "accounts list" command lets Boundary admin list an account resource.
description: >-
The "accounts list" command lists the available accounts that were created for an auth method.
---
# accounts list
@@ -1,8 +1,8 @@
---
layout: docs
page_title: accounts read - Command
description: |-
The "accounts read" command lets Boundary admin read an account resource.
description: >-
The "accounts read" command retrieves the account details for an account.
---
# accounts read
@@ -67,4 +67,4 @@ $ boundary accounts read [options] [args]
- `-id` `(string: "")` - The ID of the account to read.
@include 'cmd-option-note.mdx'
@include 'cmd-option-note.mdx'
@@ -1,8 +1,8 @@
---
layout: docs
page_title: accounts set-password - Command
description: |-
The "accounts set-password" command lets Boundary admin set the password for an account.
description: >-
The "accounts set-password" command sets the password for account resources.
---
# accounts set-password
@@ -1,7 +1,7 @@
---
layout: docs
page_title: accounts update - Command
description: |-
description: >-
The "accounts update" command updates an existing account resource's LDAP, OIDC, or password authentication information.
---
@@ -1,8 +1,8 @@
---
layout: docs
page_title: aliases create - Command
description: |-
The "aliases create" command lets you create a new alias.
description: >-
The "aliases create" command creates a new alias resource for a target.
---
# aliases create
@@ -1,15 +1,15 @@
---
layout: docs
page_title: aliases delete - Command
description: |-
The "aliases delete" command lets you delete an alias.
description: >-
The "aliases delete" command deletes an existing alias resource.
---
# aliases delete
Command: `aliases delete`
The `aliases delete` command lets you delete a target.
The `aliases delete` command lets you delete an alias.
## Example
@@ -1,8 +1,8 @@
---
layout: docs
page_title: aliases - Command
description: |-
The "aliases" command lets Boundary admin create and manage alias resources.
description: >-
The "aliases" command performs operations on alias resources. An alias is a globally unique, DNS-like string that is associated with a destination resource.
---
# aliases
@@ -1,8 +1,8 @@
---
layout: docs
page_title: aliases list - Command
description: |-
The "aliases list" command lists the aliases within a given scope or resource.
description: >-
The "aliases list" command lists the available alias resources within a scope or resource.
---
# aliases list
@@ -1,8 +1,8 @@
---
layout: docs
page_title: aliases read - Command
description: |-
The "aliases read" command reads an alias with a given ID.
description: >-
The "aliases read" command retrieves the details of an alias resource.
---
# aliases read
@@ -1,8 +1,8 @@
---
layout: docs
page_title: aliases update - Command
description: |-
The "aliases update" command lets you update an alias.
description: >-
The "aliases update" command updates an existing alias resource with new information.
---
# aliases update
@@ -1,8 +1,8 @@
---
layout: docs
page_title: auth-methods change-state - Command
description: |-
The "auth-methods change-state" command lets Boundary admin change the state of an auth method.
description: >-
The "auth-methods change-state" command changes the active and visibility state of an OIDC-type auth method resource.
---
# auth-methods change-state
@@ -1,8 +1,8 @@
---
layout: docs
page_title: auth-methods create - Command
description: |-
The "auth-methods create" command creates auth method resources in Boundary. You can create LDAP, OIDC, and password auth method types.
description: >-
The "auth-methods create" command creates new auth method resources. You can create LDAP, OIDC, and password auth method types.
---
# auth-methods create
@@ -1,8 +1,8 @@
---
layout: docs
page_title: auth-methods delete - Command
description: |-
The "auth-methods delete" command lets Boundary admin delete an auth method.
description: >-
The "auth-methods delete" command deletes an existing auth method resource.
---
# auth-methods delete
@@ -1,8 +1,8 @@
---
layout: docs
page_title: auth-methods - Command
description: |-
The "auth-methods" command lets you create and manage Boundary authentication method configuration.
description: >-
The "auth-methods" command performs operations on Boundary authentication method resources. Auth methods let users authenticate to Boundary.
---
# auth-methods
@@ -1,8 +1,8 @@
---
layout: docs
page_title: auth-methods list - Command
description: |-
The "auth-methods list" command lets Boundary admin list available auth methods.
description: >-
The "auth-methods list" command lists the available auth method resources within a scope or resource.
---
# auth-methods list
@@ -1,8 +1,8 @@
---
layout: docs
page_title: auth-methods read - Command
description: |-
The "auth-methods read" command lets Boundary admin read an auth method.
description: >-
The "auth-methods read" command retrieves the details for an auth method resource.
---
# auth-methods read
@@ -1,8 +1,8 @@
---
layout: docs
page_title: auth-methods update - Command
description: |-
The "auth-methods update" command updates existing auth method resources in Boundary. You can update LDAP, OIDC, and password auth method types.
description: >-
The "auth-methods update" command updates existing auth method resources. You can update LDAP, OIDC, and password auth method types.
---
# auth-methods update
@@ -1,8 +1,8 @@
---
layout: docs
page_title: auth-tokens delete - Command
description: |-
The "auth-tokens delete" command allows Boundary admin to delete an auth token.
description: >-
The "auth-tokens delete" command deletes an existing auth token resource.
---
# auth-tokens delete
@@ -1,8 +1,8 @@
---
layout: docs
page_title: auth-tokens - Command
description: |-
The "auth-tokens" command allows operations on Boundary auth token resources.
description: >-
The "auth-tokens" command peforms operations on auth token resources.
---
# auth-tokens
@@ -1,8 +1,8 @@
---
layout: docs
page_title: auth-tokens list - Command
description: |-
The "auth-tokens list" command allows Boundary admin to list available auth tokens.
description: >-
The "auth-tokens list" command lists the available auth token resources within an enclosing scope or resource.
---
# auth-tokens list
@@ -1,8 +1,8 @@
---
layout: docs
page_title: auth-tokens read - Command
description: |-
The "auth-tokens read" command allows Boundary admin to read an auth token.
description: >-
The "auth-tokens read" command retrieves the details for an auth token resource.
---
# auth-tokens read
@@ -1,8 +1,8 @@
---
layout: docs
page_title: authenticate - Command
description: |-
The "authenticate" command authenticates the Boundary command line client using a specified auth method.
description: >-
The "authenticate" command authenticates the CLI client using the specified auth method.
---
# authenticate
@@ -1,8 +1,8 @@
---
layout: docs
page_title: authenticate ldap - Command
description: |-
The "authenticate ldap" command invokes the ldap auth method to authenticate the Boundary CLI.
description: >-
The "authenticate ldap" command invokes the LDAP auth method to authenticate the CLI client.
---
# authenticate ldap
@@ -1,8 +1,8 @@
---
layout: docs
page_title: authenticate oidc - Command
description: |-
The "authenticate oidc" command invokes the OIDC auth method to authenticate the Boundary CLI.
description: >-
The "authenticate oidc" command invokes the OIDC auth method to authenticate the CLI client.
---
# authenticate oidc
@@ -1,8 +1,8 @@
---
layout: docs
page_title: authenticate password - Command
description: |-
The "authenticate password" command invokes the password auth method to authenticate the Boundary CLI.
description: >-
The "authenticate password" command invokes the password auth method to authenticate the CLI client.
---
# authenticate password
@@ -1,7 +1,7 @@
---
layout: docs
page_title: billing - Command
description: |-
description: >-
The "billing" command retrieves the number of active users to help you predict user-based pricing.
---
@@ -1,8 +1,8 @@
---
layout: docs
page_title: billing monthly-active-users - Command
description: |-
The "billing monthly-active-users" command retrieves the number of monthly active users during a specified time to help you predict user-based pricing.
description: >-
The "billing monthly-active-users" command retrieves the number of monthly active users during a specified time period to help you predict user-based pricing.
---
# billing monthly-active-users
+2 -2
View File
@@ -1,8 +1,8 @@
---
layout: docs
page_title: cache add-token - Command
description: |-
The "cache add-token" command lets you add an auth token to a Boundary cache that is running.
description: >-
The "cache add-token" command adds an auth token resource to the Boundary cache.
---
# cache add-token
+2 -2
View File
@@ -1,8 +1,8 @@
---
layout: docs
page_title: cache - Command
description: |-
Boundary's "cache" command lets you manage a local cache of information to facilitate searches and protect your system resources from being overwhelmed.
description: >-
The "cache" command performs operations on a local cache that facilitates searches and protects your system resources from being overwhelmed.
---
# cache
+2 -2
View File
@@ -1,8 +1,8 @@
---
layout: docs
page_title: cache start - Command
description: |-
The "cache start" command lets you manually start the Boundary cache and customize the behavior of the local cache.
description: >-
The "cache start" command starts the Boundary cache and determines the behavior of the local cache. You can customize log, search, and refresh settings.
---
# cache start
+2 -2
View File
@@ -1,8 +1,8 @@
---
layout: docs
page_title: cache status - Command
description: |-
The "cache status" command lets you manually check the status of the Boundary cache.
description: >-
The "cache status" command checks the status of the Boundary cache and reports on configuration, user, and resource information.
---
# cache status
+2 -2
View File
@@ -1,8 +1,8 @@
---
layout: docs
page_title: cache stop - Command
description: |-
The "cache stop" command lets you manually stop the Boundary cache.
description: >-
The "cache stop" command stops the Boundary cache.
---
# cache stop
@@ -1,7 +1,7 @@
---
layout: docs
page_title: config autocomplete - Command
description: |-
description: >-
The "config autocomplete" command installs or uninstalls autocompletion support for Boundary's CLI.
---
@@ -1,8 +1,8 @@
---
layout: docs
page_title: config decrypt - Command
description: |-
The "config decrypt" command decrypts sensitive values in a Boundary's configuration file. These values must be marked with {{decrypt()}} as appropriate.
description: >-
The "config decrypt" command decrypts sensitive values in configuration files. You must mark sensitive values with {{decrypt()}} as appropriate.
---
# config decrypt
@@ -1,8 +1,8 @@
---
layout: docs
page_title: config encrypt - Command
description: |-
The "config encrypt" command encrypts sensitive values in a Boundary's configuration file. These values must be marked with {{encrypt()}} as appropriate.
description: >-
The "config encrypt" command encrypts sensitive values in configuration files. You must mark sensitive values with {{encrypt()}} as appropriate.
---
# config encrypt
@@ -1,7 +1,7 @@
---
layout: docs
page_title: config get-token - Command
description: |-
description: >-
The "config get-token" command fetches a token stored by the Boundary CLI.
---
@@ -1,8 +1,8 @@
---
layout: docs
page_title: config - Command
description: |-
The "config" command groups subcommands for operators to interact with Boundary's configuration files.
description: >-
The "config" command groups subcommands that interact with Boundary's configuration files.
---
# config
@@ -1,8 +1,8 @@
---
layout: docs
page_title: connect http - Command
description: |-
The "connect http" command command performs a target authorization or consumes an existing authorization token, and launches a proxied http connection.
description: >-
The "connect http" command command performs a target authorization or consumes an existing authorization token, and then launches a proxied http connection.
---
# connect http
@@ -1,8 +1,8 @@
---
layout: docs
page_title: connect - Command
description: |-
The "connect" command allows Boundary admin to authorize a target and launch a proxied connection.
description: >-
The "connect" command authorizes a target resource and launches a proxied connection.
---
# connect
@@ -1,8 +1,8 @@
---
layout: docs
page_title: connect kube - Command
description: |-
The "connect kube" command command performs a target authorization or consumes an existing authorization token, and launches a proxied kube connection.
description: >-
The "connect kube" command command performs a target authorization or consumes an existing authorization token, and then launches a proxied kube connection.
---
# connect kube
@@ -1,8 +1,8 @@
---
layout: docs
page_title: connect postgres - Command
description: |-
The "connect postgres" command performs a target authorization or consumes an existing authorization token, and launches a proxied postgres connection.
description: >-
The "connect postgres" command performs a target authorization or consumes an existing authorization token, and then launches a proxied PostgreSQL connection.
---
# connect postgres
@@ -1,8 +1,8 @@
---
layout: docs
page_title: connect rdp - Command
description: |-
The "connect rdp" command command performs a target authorization or consumes an existing authorization token, and launches a proxied rdp connection.
description: >-
The "connect rdp" command command performs a target authorization or consumes an existing authorization token, and then launches a proxied RDP connection.
---
# connect rdp
@@ -1,8 +1,8 @@
---
layout: docs
page_title: connect ssh - Command
description: |-
The "connect ssh" command command performs a target authorization or consumes an existing authorization token, and launches a proxied SSH connection.
description: >-
The "connect ssh" command command performs a target authorization or consumes an existing authorization token, and then launches a proxied SSH connection.
---
# connect ssh
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credential-libraries create - Command
description: |-
The "credential-libraries create" command lets you create Boundary credential library resources.
description: >-
The "credential-libraries create" command creates new credential library resources. You can create a generic Vault or Vault SSH certificate credential library.
---
# credential-libraries create
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credential-libraries delete - Command
description: |-
The "credential-libraries delete" command lets Boundary admin delete a credential library resource.
description: >-
The "credential-libraries delete" command deletes an existing credential library resource.
---
# credential-libraries delete
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credential-libraries - Command
description: |-
The "credential-libraries" command lets Boundary admin create and manage credential libraries.
description: >-
The "credential-libraries" command performs operations on credential library resources. Credential libraries provide credentials of the same type and access level.
---
# credential-libraries
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credential-libraries list - Command
description: |-
The "credential-libraries list" command lists credential libraries within an enclosing scope or resource.
description: >-
The "credential-libraries list" command lists the available credential library resources within an enclosing scope or resource.
---
# credential-libraries list
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credential-libraries read - Command
description: |-
The "credential-libraries read" command lets Boundary admin read credential library information.
description: >-
The "credential-libraries read" command retrieves the details of a credential library.
---
# credential-libraries read
@@ -68,4 +68,4 @@ $ boundary credential-libraries read [options] [args]
- `-id` `(string: "")` - The ID of the credential library from which to read information.
@include 'cmd-option-note.mdx'
@include 'cmd-option-note.mdx'
@@ -1,8 +1,8 @@
---
layout: doc
page_title: credential-libraries update - Command
description: |-
The "credential-libraries update" command lets Boundary admin update a credential library resource.
description: >-
The "credential-libraries update" command updates an existing credential library resource with new information.
---
# credential-libraries update
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credential-stores create - Command
description: |-
The "credential-stores create" command lets you create Boundary credential store resources.
description: >-
The "credential-stores create" command creates new credential store resources. You can create static or Vault credential stores to manage credentials.
---
# credential-stores create
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credential-stores delete - Command
description: |-
The "credential-stores delete" command lets Boundary admin delete a credential store resource.
description: >-
The "credential-stores delete" command deletes an existing credential store resource.
---
# credential-stores delete
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credential-stores - Command
description: |-
The "credential-stores" command lets Boundary admin create and manage credential stores.
description: >-
The "credential-stores" command performs operations on credential store resources. Credential stores can manage credentials of differing types and access levels.
---
# credential-stores
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credential-stores list - Command
description: |-
The "credential-stores list" command lists credential stores within an enclosing scope or resource.
description: >-
The "credential-stores list" command lists the available credential store resources within an enclosing scope or resource.
---
# credential-stores list
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credential-stores read - Command
description: |-
The "credential-stores read" command lets Boundary admin read credential store information.
description: >-
The "credential-stores read" command retrieves the details of a credential store resource.
---
# credential-stores read
@@ -1,8 +1,8 @@
---
layout: doc
page_title: credential-stores update - Command
description: |-
The "credential-stores update" command lets Boundary admin update a credential store resource.
description: >-
The "credential-stores update" command updates an existing credential store resource.
---
# credential-stores update
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credentials create - Command
description: |-
The "credentials create" command lets you create Boundary credential resources.
description: >-
The "credentials create" command creates new credential resources. You can create JSON, SSH private key, and username-password credentials.
---
# credentials create
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credentials delete - Command
description: |-
The "credentials delete" command lets Boundary admin delete a credential resource.
description: >-
The "credentials delete" command deletes an existing credential resource.
---
# credentials delete
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credentials - Command
description: |-
The "credentials" command lets you create and manage Boundary credential resources.
description: >-
The "credentials" command performs operations on Boundary credential resources. Credentials contain secrets that bind an identity to a set of permissions.
---
# credentials
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credentials list - Command
description: |-
The "credentials list" command lists credentials within an enclosing scope or resource.
description: >-
The "credentials list" command lists the available credential resources within an enclosing scope or resource.
---
# credentials list
@@ -1,8 +1,8 @@
---
layout: docs
page_title: credentials read - Command
description: |-
The "credentials read" command reads information for a credential given its ID.
description: >-
The "credentials read" command retrieves the details of an existing credential resource.
---
# credentials read
@@ -1,8 +1,8 @@
---
layout: doc
page_title: credentials update - Command
description: |-
The "credentials update" command lets Boundary admin update a credential resource.
description: >-
The "credentials update" command updates an existing credential resource.
---
# credentials update
@@ -1,8 +1,8 @@
---
layout: docs
page_title: database - Command
description: |-
The "database" command allows operations on Boundary's database.
description: >-
The "database" command performs operations on Boundary's database. You can initialize or migrate the database.
---
# database
@@ -1,7 +1,7 @@
---
layout: docs
page_title: database init - Command
description: |-
description: >-
The "database init" command initializes Boundary's database.
---
@@ -1,8 +1,8 @@
---
layout: docs
page_title: database migrate - Command
description: |-
The "database migrate" command migrates database within an enclosing scope or resource.
description: >-
The "database migrate" command migrates Boundary's database within an enclosing scope or resource.
---
# database migrate
+2 -2
View File
@@ -1,8 +1,8 @@
---
layout: docs
page_title: delete - Command
description: |-
The "delete" command lets you delete Boundary resources.
description: >-
The "delete" command deletes existing resources.
---
# delete
+1 -1
View File
@@ -1,7 +1,7 @@
---
layout: docs
page_title: dev - Command
description: |-
description: >-
The `dev` command starts a Boundary instance in a dev mode. Dev mode provides admin credentials for password authentication.
---
@@ -1,8 +1,8 @@
---
layout: docs
page_title: groups add-members - Command
description: |-
The "groups add-members" command lets Boundary admin add members (users) to a group.
description: >-
The "groups add-members" command adds users as members of a group resource.
---
# groups add-members
@@ -1,8 +1,8 @@
---
layout: docs
page_title: groups create - Command
description: |-
The "groups create" command lets Boundary admin create a group.
description: >-
The "groups create" command creates a new group resource.
---
# groups create
@@ -1,8 +1,8 @@
---
layout: docs
page_title: groups delete - Command
description: |-
The "groups delete" command lets Boundary admin delete a group resource.
description: >-
The "groups delete" command deletes an existing group resource.
---
# groups delete
@@ -1,8 +1,8 @@
---
layout: docs
page_title: groups - Command
description: |-
The "groups" command lets Boundary admin create and manage group resources.
description: >-
The "groups" command performs operations on group resources. A group represents a collection of users with the same access control.
---
# groups
@@ -1,8 +1,8 @@
---
layout: docs
page_title: groups list - Command
description: |-
The "groups list" command lets Boundary admin list groups within an enclosing scope or resource.
description: >-
The "groups list" command lists the available group resources within an enclosing scope or resource.
---
# groups list
@@ -1,8 +1,8 @@
---
layout: docs
page_title: groups read - Command
description: |-
The "groups read" command lets Boundary admin read a group resource.
description: >-
The "groups read" command retrieves the details of an existing group resource.
---
# groups read
@@ -1,8 +1,8 @@
---
layout: docs
page_title: groups remove-members - Command
description: |-
The "groups remove-members" command lets Boundary admin remove members (users) from a group given its ID.
description: >-
The "groups remove-members" command removes members from a group resource.
---
# groups remove-members
@@ -1,8 +1,8 @@
---
layout: docs
page_title: groups set-members - Command
description: |-
The "groups set-members" command lets Boundary admin configure a complete set of members (users) on a group given its ID.
description: >-
The "groups set-members" command configures a complete set of users as members in a group resource.
---
# groups set-members
@@ -1,8 +1,8 @@
---
layout: docs
page_title: groups update - Command
description: |-
The "groups update" command lets Boundary admin update a group resource.
description: >-
The "groups update" command updates an existing group resource.
---
# groups update
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-catalogs create - Command
description: |-
The "host-catalogs create" command lets you create a new host catalog.
description: >-
The "host-catalogs create" command creates a new host catalog resource. You can create plugin or static host catalog types.
---
# host-catalogs create
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-catalogs delete - Command
description: |-
The "host-catalogs delete" command lets you delete a host catalog.
description: >-
The "host-catalogs delete" command deletes a existing host catalog resource.
---
# host-catalogs delete
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-catalogs - Command
description: |-
The "host-catalogs" command lets you perform operations on Boundary host catalog resources.
description: >-
The "host-catalogs" command performs operations on Boundary host catalog resources. Host catalogs contain hosts and host sets.
---
# host-catalogs
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-catalogs list - Command
description: |-
The "host-catalogs list" command lists the host catalogs within a given scope or resource.
description: >-
The "host-catalogs list" command lists the available host catalog resourcess within a scope or resource.
---
# host-catalogs list
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-catalogs read - Command
description: |-
The "host-catalogs read" command lets you read host catalog information with a given host catalog ID.
description: >-
The "host-catalogs read" command retrieves host catalog information for a host catalog resource.
---
# host-catalogs read
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-catalogs update - Command
description: |-
The "host-catalogs update" command lets you update an existing host catalog.
description: >-
The "host-catalogs update" command updates an existing host catalog resource.
---
# host-catalogs update
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-sets add-hosts - Command
description: |-
The "host-sets add-hosts" command lets you add hosts to host set resources, if the types match and the operation is allowed by the host set type.
description: >-
The "host-sets add-hosts" command adds new hosts to host set resources.
---
# host-sets add-hosts
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-sets create - Command
description: |-
The "host-sets create" command lets you create a new host set.
description: >-
The "host-sets create" command creates a new host set resource. You can create plugin or static type host sets.
---
# host-sets create
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-sets delete - Command
description: |-
The "host-sets delete" command lets you delete a host set.
description: >-
The "host-sets delete" command deletes a existing host set resource.
---
# host-sets delete
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-sets - Command
description: |-
The "host-sets" command lets you perform operations on Boundary host set resources.
description: >-
The "host-sets" command performs operations on Boundary host set resources. A host set represents a collection of hosts with the same access control.
---
# host-sets
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-sets list - Command
description: |-
The "host-sets list" command lists the host sets within a given scope or resource.
description: >-
The "host-sets list" command lists the available host set resources within a scope or resource.
---
# host-sets list
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-sets read - Command
description: |-
The "host-sets read" command lets you read the details of a host set resource using its given ID.
description: >-
The "host-sets read" command retrieves the details of an existing host set resource.
---
# host-sets read
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-sets remove-hosts - Command
description: |-
The "host-sets remove-hosts" command lets you remove hosts from host set resources, if the types match and the operation is allowed by the host set type.
description: >-
The "host-sets remove-hosts" command removes hosts from host set resources.
---
# host-sets remove-hosts
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-sets set-hosts - Command
description: |-
The "host-sets set-hosts" command lets you configure the complete set of hosts on host source resources, if the types match and the operation is allowed by the host set type.
description: >-
The "host-sets set-hosts" command configures a complete set of hosts on host set resources.
---
# host-sets set-hosts
@@ -1,8 +1,8 @@
---
layout: docs
page_title: host-sets update - Command
description: |-
The "host-sets update" command lets you update an existing host set.
description: >-
The "host-sets update" command updates an existing host set resource.
---
# host-sets update
@@ -1,8 +1,8 @@
---
layout: docs
page_title: hosts create - Command
description: |-
The "hosts create" command lets you create a new host.
description: >-
The "hosts create" command creates a new host resource.
---
# hosts create
@@ -1,8 +1,8 @@
---
layout: docs
page_title: hosts delete - Command
description: |-
The "hosts delete" command lets you delete a host.
description: >-
The "hosts delete" command deletes an existing host resource.
---
# hosts delete
@@ -1,8 +1,8 @@
---
layout: docs
page_title: hosts - Command
description: |-
The "hosts" command lets you perform operations on Boundary host resources.
description: >-
The "hosts" command performs operations on Boundary host resources. A host represents a computing element with a network address that Boundary can reach.
---
# hosts
+2 -2
View File
@@ -1,8 +1,8 @@
---
layout: docs
page_title: hosts list - Command
description: |-
The "hosts list" command lists the hosts within a given scope or resource.
description: >-
The "hosts list" command lists the available host resources within a scope or resource.
---
# hosts list
+2 -2
View File
@@ -1,8 +1,8 @@
---
layout: docs
page_title: hosts read - Command
description: |-
The "hosts read" command lets you read information about a host with a given ID.
description: >-
The "hosts read" command retrieves details about a host resource.
---
# hosts read
@@ -1,8 +1,8 @@
---
layout: docs
page_title: hosts update - Command
description: |-
The "hosts update" command lets you update a host.
description: >-
The "hosts update" command updates an existing host resource.
---
# hosts update
Loaded 100 of 191 files, more files were not shown because too many files have changed in this diff. Show more