-
Notifications
You must be signed in to change notification settings - Fork 68
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Generate mongocli atlas command docs page (#1101)
- Loading branch information
1 parent
51c6df3
commit ec8fedc
Showing
229 changed files
with
17,252 additions
and
10 deletions.
There are no files selected for viewing
104 changes: 104 additions & 0 deletions
104
docs/mongocli/command/mongocli-atlas-accessLists-create.txt
This file contains 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 @@ | ||
| .. _mongocli-atlas-accessLists-create: | ||
|
|
||
| ================================= | ||
| mongocli 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:: | ||
|
|
||
| mongocli 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 | ||
|
|
||
|
|
79 changes: 79 additions & 0 deletions
79
docs/mongocli/command/mongocli-atlas-accessLists-delete.txt
This file contains 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 @@ | ||
| .. _mongocli-atlas-accessLists-delete: | ||
|
|
||
| ================================= | ||
| mongocli 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:: | ||
|
|
||
| mongocli 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. | ||
|
|
79 changes: 79 additions & 0 deletions
79
docs/mongocli/command/mongocli-atlas-accessLists-describe.txt
This file contains 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 @@ | ||
| .. _mongocli-atlas-accessLists-describe: | ||
|
|
||
| =================================== | ||
| mongocli 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:: | ||
|
|
||
| mongocli 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 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 @@ | ||
| .. _mongocli-atlas-accessLists-list: | ||
|
|
||
| =============================== | ||
| mongocli 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:: | ||
|
|
||
| mongocli 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.