Docs Menu

atlas clusters onlineArchives watch

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Examples

Watch for an archive to be available.

This command checks the archive's status periodically until it reaches a state different from PENDING or PAUSING. Once the archive reaches the expected status, the command prints "Online archive available." If you run the command in the terminal, it blocks the terminal session until the resource status changes to the expected status. You can interrupt the command's polling at any time with CTRL-C.

atlas clusters onlineArchives watch <archiveId> [options]
Name
Type
Required
Description
archiveId
string
false
Unique identifier of the online archive to watch.
Name
Type
Required
Description
--clusterName
string
false
Name of the cluster.
-h, --help
false
help for watch
--projectId
string
false
Project ID to use. Overrides the settings in the configuration file or environment variable.
Name
Type
Required
Description
-P, --profile
string
false
Profile to use from your configuration file.
$ mongocli atlas cluster onlineArchive watch archiveIdSample --clusterName clusterNameSample
Give Feedback
MongoDB logo
© 2021 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.