mongocli atlas networking peering watch¶
The networking peering watch command monitors one network peering
connection in the specified project until it becomes available, at which
time it displays a confirmation message.
Syntax¶
mongocli atlas networking peering watch <peering-connection-id> [ --profile|-P <profile-name> ] [ --projectId <project-ID> ]
Use -h or --help to view the command-line help for
this command.
Arguments¶
Argument | Type | Description | Required? |
|---|---|---|---|
<peering-connection-id> | string | Unique identifier of the network peering connection that you
want to watch. | yes |
Options¶
Option | Type | Description | Required? |
|---|---|---|---|
--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 |
--projectId | string | Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable. | no |
Output¶
The networking peering watch command continuously polls Atlas
for the status of the network peering connection until it reaches an
available status.
The MongoDB CLI considers WAITING_FOR_USER and FAILED to be
available statuses.
For more information on network peering connection statuses, see the Atlas documentation.
If the command succeeds, it returns the following output in the default format. If the command returns errors, see Troubleshooting for recommended solutions.
Network peering changes completed.
Example¶
The following command watches one network peering connection for a project using the default profile, which contains credentials and the project ID. The output is returned in the default format.
mongocli atlas networking peering watch 5f621dc701240c5b7c3a888e
The previous command prints the following to the terminal.
Network peering changes completed.