mongocli atlas networking containers list¶
The networking containers list
command retrieves the list of Atlas
network peering containers on the specified Atlas cluster. You can
also retrieve a list of network peering containers through the Atlas
API.
Syntax¶
mongocli atlas networking containers list [ --output|-o <output-format> ] [ --profile|-P <profile-name> ] [ --projectId <project-ID> ] [ --provider <AWS|GCP|AZURE> ]
Use -h
or --help
to view the command-line help for
this command.
Options¶
Option | Type | Description | Required? |
---|---|---|---|
--output , -o | string | Command output format. Valid values are:
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 |
--projectId | string | Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable. | no |
--provider | string | Name of the cloud service provider. Valid values are:
If omitted, this option defaults to all providers. | no |
Output¶
If the command is successful, it returns the following information:
Field | Description |
---|---|
ID | Unique identifier of the container. |
PROVIDER | Cloud provider of the container. Valid values are:
|
ATLAS CIDR | CIDR block of the container. |
PROVISIONED | Boolean that indicates if the project has clusters deployed in the
network peering container or Azure VNet. |
Example¶
The following example uses the mongocli atlas networking containers
list
command to retrieve the list of network containers for the
specified project. The command uses the default profile, which
contains the Programmatic API Key