-
Notifications
You must be signed in to change notification settings - Fork 88
CLOUDP-112245: [Milestone] Atlascli/Mongocli Doc changes #975
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| .. _atlas-accessLists-create: | ||
|
|
||
| ======================== | ||
| atlas accessLists create | ||
| ======================== | ||
|
|
||
| .. default-domain:: mongodb | ||
|
|
||
| .. contents:: On this page | ||
| :local: | ||
| :backlinks: none | ||
| :depth: 1 | ||
| :class: singlecol | ||
|
|
||
| Create an IP access list for your project. | ||
|
|
||
| Syntax | ||
| ------ | ||
|
|
||
| .. code-block:: | ||
|
|
||
| atlas accessLists create [entry] [options] | ||
|
|
||
| Arguments | ||
| --------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - entry | ||
| - string | ||
| - false | ||
| - The IP address, CIDR address, or AWS security group ID of the access list entry to create. | ||
|
|
||
| Options | ||
| ------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - --comment | ||
| - string | ||
| - false | ||
| - Optional description or comment for the entry. | ||
| * - --currentIp | ||
| - | ||
| - false | ||
| - Flag that indicates whether to use the IP Address from the host that is currently executing the command. Only applicable for type ipAddress entries. To learn more, see: https://docs.mongodb.com/mongocli/master/command/mongocli-atlas-accessLists-create/. | ||
| * - --deleteAfter | ||
| - string | ||
| - false | ||
| - ISO-8601-formatted UTC date after which Atlas removes the value from the entry. | ||
| * - -h, --help | ||
| - | ||
| - false | ||
| - help for create | ||
| * - -o, --output | ||
| - string | ||
| - false | ||
| - Output format. Valid values are json, json-path, go-template, or go-template-file. | ||
| * - --projectId | ||
| - string | ||
| - false | ||
| - Project ID to use. Overrides the settings in the configuration file or environment variable. | ||
| * - --type | ||
| - string | ||
| - false | ||
| - Type of access list entry. Valid values are cidrBlock, ipAddress, or awsSecurityGroup. This value defaults to "ipAddress". | ||
|
|
||
| Inherited Options | ||
| ----------------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -P, --profile | ||
| - string | ||
| - false | ||
| - Profile to use from your configuration file. | ||
|
|
||
| Examples | ||
| -------- | ||
|
|
||
| .. code-block:: | ||
|
|
||
| Create IP address access list with the current IP address. Entry is not needed in this case. | ||
| $ mongocli atlas accessList create --currentIP | ||
|
|
||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| .. _atlas-accessLists-delete: | ||
|
|
||
| ======================== | ||
| atlas accessLists delete | ||
| ======================== | ||
|
|
||
| .. default-domain:: mongodb | ||
|
|
||
| .. contents:: On this page | ||
| :local: | ||
| :backlinks: none | ||
| :depth: 1 | ||
| :class: singlecol | ||
|
|
||
| Delete an IP access list from your project. | ||
|
|
||
| Syntax | ||
| ------ | ||
|
|
||
| .. code-block:: | ||
|
|
||
| atlas accessLists delete <entry> [options] | ||
|
|
||
| Arguments | ||
| --------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - entry | ||
| - string | ||
| - false | ||
| - The IP address, CIDR address, or AWS security group ID of the access list entry to delete. | ||
|
|
||
| Options | ||
| ------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - --force | ||
| - | ||
| - false | ||
| - If specified, skips asking for confirmation before proceeding with a requsted action. | ||
| * - -h, --help | ||
| - | ||
| - false | ||
| - help for delete | ||
| * - --projectId | ||
| - string | ||
| - false | ||
| - Project ID to use. Overrides the settings in the configuration file or environment variable. | ||
|
|
||
| Inherited Options | ||
| ----------------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -P, --profile | ||
| - string | ||
| - false | ||
| - Profile to use from your configuration file. | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| .. _atlas-accessLists-describe: | ||
|
|
||
| ========================== | ||
| atlas accessLists describe | ||
| ========================== | ||
|
|
||
| .. default-domain:: mongodb | ||
|
|
||
| .. contents:: On this page | ||
| :local: | ||
| :backlinks: none | ||
| :depth: 1 | ||
| :class: singlecol | ||
|
|
||
| Describe an IP access list entry. | ||
|
|
||
| Syntax | ||
| ------ | ||
|
|
||
| .. code-block:: | ||
|
|
||
| atlas accessLists describe <name> [options] | ||
|
|
||
| Arguments | ||
| --------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - entry | ||
| - string | ||
| - false | ||
| - The IP address, CIDR address, or AWS security group ID of the access list entry to retrieve. | ||
|
|
||
| Options | ||
| ------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -h, --help | ||
| - | ||
| - false | ||
| - help for describe | ||
| * - -o, --output | ||
| - string | ||
| - false | ||
| - Output format. Valid values are json, json-path, go-template, or go-template-file. | ||
| * - --projectId | ||
| - string | ||
| - false | ||
| - Project ID to use. Overrides the settings in the configuration file or environment variable. | ||
|
|
||
| Inherited Options | ||
| ----------------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -P, --profile | ||
| - string | ||
| - false | ||
| - Profile to use from your configuration file. | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| .. _atlas-accessLists-list: | ||
|
|
||
| ====================== | ||
| atlas accessLists list | ||
| ====================== | ||
|
|
||
| .. default-domain:: mongodb | ||
|
|
||
| .. contents:: On this page | ||
| :local: | ||
| :backlinks: none | ||
| :depth: 1 | ||
| :class: singlecol | ||
|
|
||
| List Atlas IP access list entries for your project. | ||
|
|
||
| Syntax | ||
| ------ | ||
|
|
||
| .. code-block:: | ||
|
|
||
| atlas accessLists list [options] | ||
|
|
||
| Options | ||
| ------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -h, --help | ||
| - | ||
| - false | ||
| - help for list | ||
| * - --limit | ||
| - int | ||
| - false | ||
| - Number of items per page. This value defaults to 100. | ||
| * - -o, --output | ||
| - string | ||
| - false | ||
| - Output format. Valid values are json, json-path, go-template, or go-template-file. | ||
| * - --page | ||
| - int | ||
| - false | ||
| - Page number. This value defaults to 1. | ||
| * - --projectId | ||
| - string | ||
| - false | ||
| - Project ID to use. Overrides the settings in the configuration file or environment variable. | ||
|
|
||
| Inherited Options | ||
| ----------------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -P, --profile | ||
| - string | ||
| - false | ||
| - Profile to use from your configuration file. | ||
|
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is one change