Skip to content

Commit be2e0ce

Browse files
sarahsimperssarahsimpers
authored
v1.21: Removes submodule and adds in files (#517)
* Removes submodule (#464) * Adds back the command dir, test file (#465) * Adds command files
1 parent fc7045d commit be2e0ce

File tree

445 files changed

+40582
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

445 files changed

+40582
-5
lines changed

‎.gitmodules

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +0,0 @@
1-
[submodule "submodules/mongodb-atlas-cli"]
2-
path = submodules/mongodb-atlas-cli
3-
url = https://github.com/mongodb/mongodb-atlas-cli.git

‎source/command

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎source/command/atlas-accessLists-create.txt

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
.. _atlas-accessLists-create:
2+
3+
========================
4+
atlas accessLists create
5+
========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Create an IP access list entry for your project.
16+
17+
The access list can contain trusted IP addresses, AWS security group IDs, and entries in Classless Inter-Domain Routing (CIDR) notation. You can add only one access list entry at a time. You can create one access list per project.
18+
19+
The command doesn't overwrite existing entries in the access list. Instead, it adds the new entries to the list of entries.
20+
21+
To use this command, you must authenticate with a user account or an API key with the Read Write role.
22+
23+
Syntax
24+
------
25+
26+
.. code-block::
27+
:caption: Command Syntax
28+
29+
atlas accessLists create [entry] [options]
30+
31+
.. Code end marker, please don't delete this comment
32+
33+
Arguments
34+
---------
35+
36+
.. list-table::
37+
:header-rows: 1
38+
:widths: 20 10 10 60
39+
40+
* - Name
41+
- Type
42+
- Required
43+
- Description
44+
* - entry
45+
- string
46+
- false
47+
- IP address, CIDR address, or AWS security group ID that you want to add to the access list.
48+
49+
Options
50+
-------
51+
52+
.. list-table::
53+
:header-rows: 1
54+
:widths: 20 10 10 60
55+
56+
* - Name
57+
- Type
58+
- Required
59+
- Description
60+
* - --comment
61+
- string
62+
- false
63+
- Optional description or comment for the entry.
64+
* - --currentIp
65+
-
66+
- false
67+
- Flag that adds the IP address from the host that is currently executing the command to the access list. Only applicable for type ipAddress entries. You don't need the entry argument when you use the currentIp option.
68+
* - --deleteAfter
69+
- string
70+
- false
71+
- ISO-8601-formatted UTC date after which Atlas removes the entry from the access list.
72+
* - -h, --help
73+
-
74+
- false
75+
- help for create
76+
* - -o, --output
77+
- string
78+
- false
79+
- Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
80+
* - --projectId
81+
- string
82+
- false
83+
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
84+
* - --type
85+
- string
86+
- false
87+
- Type of access list entry. Valid values are cidrBlock, ipAddress, or awsSecurityGroup. This value defaults to "ipAddress".
88+
89+
Inherited Options
90+
-----------------
91+
92+
.. list-table::
93+
:header-rows: 1
94+
:widths: 20 10 10 60
95+
96+
* - Name
97+
- Type
98+
- Required
99+
- Description
100+
* - -P, --profile
101+
- string
102+
- false
103+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
104+
105+
Output
106+
------
107+
108+
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
109+
110+
.. code-block::
111+
112+
Created a new IP access list.
113+
114+
115+
Examples
116+
--------
117+
118+
.. code-block::
119+
120+
# Create an IP access list entry using the current IP address:
121+
atlas accessList create --currentIp
122+
123+
124+
.. code-block::
125+
126+
# Create an access list entry for the IP address 192.0.2.15 in the project with ID 5e2211c17a3e5a48f5497de3:
127+
atlas accessList create 192.0.2.15 --type ipAddress --projectId 5e2211c17a3e5a48f5497de3 --comment "IP address for app server 2" --output json
128+
129+
130+
.. code-block::
131+
132+
# Create an access list entry in CIDR notation for 73.231.201.205/24 in the project with ID 5e2211c17a3e5a48f5497de3:
133+
atlas accessList create 73.231.201.205/24 --type cidrBlock --projectId 5e2211c17a3e5a48f5497de3 --output json --comment "CIDR block for servers C - F"
134+
135+
136+
.. code-block::
137+
138+
# Create an access list entry for the AWS security group sg-903004f8 in the project with ID 5e2211c17a3e5a48f5497de3:
139+
atlas accessList create sg-903004f8 --type awsSecurityGroup
140+
--projectId 5e2211c17a3e5a48f5497de3 --output json --comment "AWS Security Group"

‎source/command/atlas-accessLists-delete.txt

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
.. _atlas-accessLists-delete:
2+
3+
========================
4+
atlas accessLists delete
5+
========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Remove the specified IP access list entry from your project.
16+
17+
The command, when run without the force option, prompts you to confirm the operation.
18+
19+
To use this command, you must authenticate with a user account or an API key with the Read Write role.
20+
21+
Syntax
22+
------
23+
24+
.. code-block::
25+
:caption: Command Syntax
26+
27+
atlas accessLists delete <entry> [options]
28+
29+
.. Code end marker, please don't delete this comment
30+
31+
Arguments
32+
---------
33+
34+
.. list-table::
35+
:header-rows: 1
36+
:widths: 20 10 10 60
37+
38+
* - Name
39+
- Type
40+
- Required
41+
- Description
42+
* - entry
43+
- string
44+
- true
45+
- The IP address, CIDR address, or AWS security group ID that you want to remove from the access list.
46+
47+
Options
48+
-------
49+
50+
.. list-table::
51+
:header-rows: 1
52+
:widths: 20 10 10 60
53+
54+
* - Name
55+
- Type
56+
- Required
57+
- Description
58+
* - --force
59+
-
60+
- false
61+
- Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action.
62+
* - -h, --help
63+
-
64+
- false
65+
- help for delete
66+
* - --projectId
67+
- string
68+
- false
69+
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
70+
71+
Inherited Options
72+
-----------------
73+
74+
.. list-table::
75+
:header-rows: 1
76+
:widths: 20 10 10 60
77+
78+
* - Name
79+
- Type
80+
- Required
81+
- Description
82+
* - -P, --profile
83+
- string
84+
- false
85+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
86+
87+
Output
88+
------
89+
90+
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
91+
92+
.. code-block::
93+
94+
Project access list entry '<Name>' deleted
95+
96+
97+
Examples
98+
--------
99+
100+
.. code-block::
101+
102+
# Remove the IP address 192.0.2.0 from the access list for the project with the ID 5e2211c17a3e5a48f5497de3 after prompting for a confirmation:
103+
atlas accessLists delete 192.0.2.0 --projectId 5e2211c17a3e5a48f5497de3
104+
105+
.. code-block::
106+
107+
# Remove the IP address 192.0.2.0 from the access list for the project with the ID 5e2211c17a3e5a48f5497de3 without requiring confirmation:
108+
atlas accessLists delete 192.0.2.0 --projectId 5e2211c17a3e5a48f5497de3 --force

‎source/command/atlas-accessLists-describe.txt

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
.. _atlas-accessLists-describe:
2+
3+
==========================
4+
atlas accessLists describe
5+
==========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Return the details for the specified IP access list entry.
16+
17+
To use this command, you must authenticate with a user account or an API key with the Organization Member role.
18+
19+
Syntax
20+
------
21+
22+
.. code-block::
23+
:caption: Command Syntax
24+
25+
atlas accessLists describe <entry> [options]
26+
27+
.. Code end marker, please don't delete this comment
28+
29+
Arguments
30+
---------
31+
32+
.. list-table::
33+
:header-rows: 1
34+
:widths: 20 10 10 60
35+
36+
* - Name
37+
- Type
38+
- Required
39+
- Description
40+
* - entry
41+
- string
42+
- true
43+
- The IP address, CIDR address, or AWS security group ID of the access list entry to return.
44+
45+
Options
46+
-------
47+
48+
.. list-table::
49+
:header-rows: 1
50+
:widths: 20 10 10 60
51+
52+
* - Name
53+
- Type
54+
- Required
55+
- Description
56+
* - -h, --help
57+
-
58+
- false
59+
- help for describe
60+
* - -o, --output
61+
- string
62+
- false
63+
- Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
64+
* - --projectId
65+
- string
66+
- false
67+
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
68+
69+
Inherited Options
70+
-----------------
71+
72+
.. list-table::
73+
:header-rows: 1
74+
:widths: 20 10 10 60
75+
76+
* - Name
77+
- Type
78+
- Required
79+
- Description
80+
* - -P, --profile
81+
- string
82+
- false
83+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
84+
85+
Examples
86+
--------
87+
88+
.. code-block::
89+
90+
# Return the JSON-formatted details for the access list entry 192.0.2.0/24 in the project with ID 5e2211c17a3e5a48f5497de3:
91+
atlas accessLists describe 192.0.2.0/24 --output json --projectId 5e1234c17a3e5a48f5497de3

0 commit comments

Comments
 (0)