All apps/BOSH CLI

BOSH CLI

bosh

BOSH is a project that unifies release engineering, deployment, and lifecycle management of small and large-scale cloud software.

Runs as bosh|macOS, Linux, Windows|bosh.io

Open form in Otty otty.toml

Autocomplete

Fig spec, with what the manifest adds · 89 subcommands · 14 options

Published once and never changed; check the digest before caching

sha256

c6cdf6dc601151372152758a6e62886a803351b0f20b00a454a949f9d4b6c4df

Size

15983 bytes

Subcommands89 subcommands

bosh add-blob

Add blob

bosh unignore

Unignore an instance

bosh update-cloud-config

Update current cloud config

bosh update-config

Update config

bosh update-cpi-config

Update current CPI config

bosh update-resurrection

Enable/disable resurrection

bosh update-runtime-config

Update current runtime config

bosh upload-blobs

Upload blobs

bosh upload-release

Upload release

bosh upload-stemcell

Upload stemcell

bosh variables

List variables

bosh vendor-package

Vendor package

bosh vms

List all VMs in all deployments

bosh orphan-disk

Orphan disk

bosh networks

List networks

bosh manifest

Show deployment manifest

bosh tasks

List running or recent tasks

bosh task

Show task status and start tracking its output

bosh take-snapshot

Take snapshot

bosh sync-blobs

Sync blobs

bosh stop-env

Stop BOSH environment

bosh stop

Stop instance(s)

bosh stemcells

List stemcells

bosh start-env

Start BOSH environment

bosh start

Start instance(s)

bosh ssh

SSH into instance(s)

bosh snapshots

List snapshots

bosh sha2ify-release

Convert release tarball to use SHA256

bosh sha1ify-release

Convert release tarball to use SHA1

bosh runtime-config

Show current runtime config

bosh run-errand

Run errand

bosh restart

Restart instance(s)

bosh reset-release

Reset release

bosh repack-stemcell

Repack stemcell

bosh remove-blob

Remove blob

bosh releases

List releases

bosh recreate

Recreate instance(s)

bosh orphaned-vms

List all the orphaned VMs in all deployments

bosh scp

SCP to/from instance(s)

bosh help

Show this help message

bosh ignore

Ignore an instance

bosh init-release

Initialize release

bosh inspect-local-release

Display information from release metadata

bosh inspect-local-stemcell

Display information from stemcell metadata

bosh inspect-release

List release contents such as jobs

bosh instances

List all instances in a deployment

bosh interpolate

Interpolates variables into a manifest

bosh locks

List current locks

bosh log-in

Login

bosh log-out

Log out

bosh logs

Fetch logs from instance(s)

bosh deployment

Show deployment information

bosh deployments

List deployments

bosh diff-config

Diff two configs by ID or content

bosh disks

List disks

bosh environment

Show environment

bosh environments

List environments

bosh errands

List errands

bosh event

Show event details

bosh events

List events

bosh export-release

Export the compiled release to a tarball

bosh finalize-release

Create final release from dev release tarball

bosh generate-job

Generate job

bosh generate-package

Generate package

bosh create-release

Create release

bosh curl

Make an HTTP request to the Director

bosh delete-config

Delete config

bosh delete-deployment

Delete deployment

bosh delete-disk

Delete disk

bosh delete-env

Delete BOSH environment

bosh delete-network

Delete network

bosh delete-release

Delete release

bosh delete-snapshot

Delete snapshot

bosh delete-snapshots

Delete all snapshots in a deployment

bosh delete-stemcell

Delete stemcell

bosh delete-vm

Delete VM

bosh deploy

Update deployment

bosh alias-env

Alias environment to save URL and CA certificate

bosh attach-disk

Attach disk to an instance

bosh blobs

List blobs

bosh cancel-task

Cancel task at its next checkpoint

bosh cancel-tasks

Cancel tasks at their next checkpoints

bosh clean-up

Clean up old unused resources except orphaned disks

bosh cloud-check

Cloud consistency check and interactive repair

bosh cloud-config

Show current cloud config

bosh config

Show current config for either ID or both type and name

bosh configs

List configs

bosh cpi-config

Show current CPI config

bosh create-env

Create or update BOSH environment

OptionsOn bosh itself

--version

Show CLI version

--config

Config file path (default: ~/.bosh/config) <PATH>

-e--environment

Director environment name or URL <name>

--ca-cert

Director CA certificate path or value <PATH>

--sha2

Use SHA256 checksums

--parallel

The max number of parallel operations (default: 5) <amount>

--client

Override username or UAA client [$BOSH_CLIENT] <name>

--client-secret

Override password or UAA client secret [$BOSH_CLIENT_SECRET] <secret>

--deployment

Deployment name [$BOSH_DEPLOYMENT] <value>

--column

Filter to show only given column(s) <name>

--json

Output as JSON

--tty

Force TTY-like output

--no-color

Toggle colorized output

-n--non-interactive

Don't ask for user input [$BOSH_NON_INTERACTIVE]