mongocli ops-manager admin backup blockstore delete

On this page

Syntax

Arguments
Options
Output
Example

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoCLI.

Note

You must be a Global Owner to run admin commands.

The admin backup blockstore delete command deletes one backup blockstore configuration. You can also delete the one blockstore configuration using the API.

Syntax

mongocli ops-manager|om admin backup blockstore delete|rm <blockstore-ID>
     [ --force ]
     [ --output|-o <output-format> ]
     [ --profile|-p <profile-name> ]

Arguments

Option	Type	Description	Required?
`<blockstore-ID>`	string	Unique name of the blockstore configuration to delete.	yes

Options

Option	Type	Description	Required?
`--force`		Flag that indicates that the alert configuration can be deleted without requiring confirmation.	no
`--output`, `-o`	string	Command output format. Valid values are: `json` for output in JSON format `go-template` for custom output using the Go template `go-template-file` for custom output specified using Go template file If omitted, the command returns output in the default format.	no
`--profile`, `-p`	string	Name of the profile where the public and private keys for the project are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.	no

Output

If successful, the command returns the following message:

Blockstore configuration '<blockstore-ID>' deleted

Example

The following example uses the mongocli om admin backup blockstore delete command to delete the blockstore configuration egblockstore. The command uses the --force option to bypass the confirmation prompt and the default profile to access Ops Manager.

mongocli om admin backup blockstore delete egblockstore --force

The previous command returns the following:

Blockstore configuration 'test' deleted

Back

Update One Backup Blockstore Configuration

S3 Blockstore Configurations