Hortonworks Docs » Cloudbreak 2.9.1 » Cloudbreak CLI Reference

Cloudbreak CLI Reference

Also available as:

PDF

loading table of contents...

Cloudbreak CLI reference
Command structure
Command output
Commands
Debugging
Checking CLI Version

Commands

The following commands are available via Cloudbreak CLI.

audit describe
Displays details of a specific audit event.
audit list
Lists all audit events for a specific resource.
blueprint create
Adds a new blueprint from a file or from a URL.
blueprint delete
Deletes an existing blueprint.
blueprint describe
Describes an existing blueprint.
blueprint list
Lists available blueprints.
cloud availability-zones
Lists all availability zones available in the specified cloud provider region.
cloud regions
Lists the available cloud provider regions.
cloud volumes
Lists the available cloud provider volume types.
cloud instances
Lists the available cloud provider instance types.
cluster change-ambari-password
Changes Ambari password.
cluster change-image
Changes default image used for newly added cluster nodes.
cluster create
Creates a new cluster based on a JSON template.
cluster delete
Deletes an existing cluster.
cluster describe
Describes an existing cluster.
cluster generate-attached-cluster-template
Generates a template for a cluster that can be attached to a data lake.
cluster generate-template
Generates a provider-specific cluster template in JSON format.
cluster generate-reinstall-template
Generates a cluster template that you can use to reinstall the cluster if installation went fail.
cluster list
Lists all clusters which are currently associated with the Cloudbreak instance.
cluster maintenance-mode
Enables/disables maintenance mode and changes stack repository configurations.
cluster reinstall
Reinstalls a cluster based on the JSON template generated by the cb cluster reinstall command.
cluster repair
Repairs a cluster if cluster installation failed by removing, or removing and replacing failed nodes. You must specify the cluster name and the host group with the failed nodes.
cluster retry
Retries the process if cluster or stack provisioning failed.
cluster scale
Scales a cluster by adding or removing nodes.
cluster start
Starts a cluster which has previously been stopped.
cluster stop
Stops a cluster.
cluster sync
Synchronizes a cluster with the cloud provider.
completion
Prints the bash completion function and the commands that allow you to configure CLI autocomplete.
configure
Configures the Cloudbreak server address and credentials used to communicate with this server.
credential create
Creates a new credential.
credential delete
Deletes an existing credential.
credential describe
Describes an existing credential.
credential list
Lists existing credentials.
credential modify
Modifies an existing credential.
database create
Registers an existing external database with Cloudbreak.
database delete
Unregisters a previously registered database with Cloudbreak. It does not delete the database instance.
database list
Lists all available database registrations.
database test
Test database connection.
imagecatalog create
Registers a new custom image catalog based on the URL provided.
imagecatalog delete
Deletes a previously registered custom image catalog. It does not delete any cloud provider resources that you created as a prerequisite for creating a credential.
imagecatalog describe
Displays details of a specific image catalog.
imagecatalog images
Lists images from the specified image catalog available for the specified cloud provider.
imagecatalog list
Lists default and custom image catalogs registered with the Cloudbreak instance.
imagecatalog set-default
Sets the specified image catalog as default.
ldap create
Registers an existing LDAP with Cloudbreak.
ldap delete
Deletes selected LDAP registration from Cloudbreak. It does not delete the LDAP.
ldap list
Lists all available LDAPs.
mpack create
Registers an existing management pack with Cloudbreak.
mpack delete
Deletes selected management registration from Cloudbreak. It does not delete the management pack.
mpack list
Lists all available management packs.
proxy create
Registers an existing proxy with Cloudbreak.
proxy delete
Unregisters a previously registered proxy with Cloudbreak. It does not delete the proxy.
proxy list
Lists all proxies that were previously registered with Cloudbreak.
recipe create
Adds a new recipe from a file or from a URL.
recipe delete
Deletes an existing recipe.
recipe describe
Describes an existing recipe.
recipe list
Lists all available recipes.
user list
Lists all LDAP/AD users.
workspace add-user
Adds user to a workspace and assigns access permissions.
workspace create
Creates a new workspace.
workspace delete
Deletes an existing workspace.
workspace describe
Provides detailed information about an existing workspace.
workspace list
Lists all workspaces that the user running the command is a member of.
workspace remove-user
Removes a user from a workspace.

© 2012–2019, Hortonworks, Inc.

Document licensed under the Creative Commons Attribution ShareAlike 4.0 License.

Hortonworks.com | Documentation | Support | Community