mongocli ops-manager admin backup s3 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 s3 delete command deletes the specified backup S3 blockstore configuration. You can also delete an S3 configuration using the UI and the API.

Syntax

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

Arguments

Option	Type	Description	Required?
`<s3-name>`	string	Unique identifier of the S3 blockstore configuration that you want to delete. You can retrieve a list of S3 names for a deployment with the List Backup S3 Configurations command.	yes

Options

Option	Type	Description	Required?
`--force`		Flag indicating 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 accessing Ops Manager 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:

s3 configuration '<s3-name>' deleted.

Example

The following example uses the mongocli om admin backup s3 delete command to delete the S3 blockstore configuration s3BackupExample. The command uses the --force option to bypass the confirmation prompt and the default profile, which contains Global Owner Ops Manager credentials.

mongocli om admin backup s3 delete s3BackupExample --force

The previous command returns the following:

s3 configuration 's3BackupExample' deleted.

Back

Update One Backup S3 Blockstore Configuration

File System Store Configurations