mongocli atlas clusters onlineArchives watch
On this page
mongocli atlas commands are now deprecated because there's a new, dedicated CLI available for Atlas users. Migrate to the Atlas CLI to enjoy the same capabilities and the latest features. You can use mongocli atlas commands until April 30, 2023.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.
Syntax
mongocli atlas clusters onlineArchives watch <archiveId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
archiveId | string | false | Unique identifier of the online archive to watch. |
Options
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. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Profile to use from your configuration file. |
Examples
$ mongocli atlas cluster onlineArchive watch archiveIdSample --clusterName clusterNameSample