Skip to content

Commit 0122d4c

Browse files
corryrootcorryroot
authored
(DOCSP-14125): Added a page and the nav for the mongocli atlas privateendpoint regionalmode enable command. (#480)
* (DOCSP-14125): Added a page and the nav for the mongocli atlas privateendpoint regionalmode enable command. * (DOCSP-14125): Fixed formatting. * (DOCSP-14125): Fixed TOC. * (DOCSP-14125): Fixed commands. * (DOCSP-14125): Fixed typo. * (DOCSP-14125): Fixed anchor. * (DOCSP-14125): Incorporated Andrea's feedback.
1 parent 0f5902f commit 0122d4c

File tree

4 files changed

+130
-2
lines changed

4 files changed

+130
-2
lines changed

‎source/reference/atlas/private-endpoint-commands-new.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,5 @@ Atlas ``privateEndpoint`` Commands
1818
Get the Regionalized Private Endpoint Setting </reference/atlas/private-endpoint-regionalmode-describe>
1919

2020
Disable the Regionalized Private Endpoint Setting </reference/atlas/private-endpoint-regionalmode-disable>
21+
22+
Enable the Regionalized Private Endpoint Setting </reference/atlas/private-endpoint-regionalmode-enable>

‎source/reference/atlas/private-endpoint-regionalmode-describe.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Syntax
2525

2626
.. code-block:: text
2727

28-
mongocli atlas privateendpoint regionalMode(s)|regional-mode(s)|regionalmode(s) describe|get
28+
mongocli atlas privateEndpoint(s)|private-endpoint(s)|privateendpoint(s) regionalMode(s)|regional-mode(s)|regionalmode(s) describe|get
2929
[ --output|-o <output-format> ]
3030
[ --profile|-P <profile-name> ]
3131
[ --projectId <project-ID> ]

‎source/reference/atlas/private-endpoint-regionalmode-disable.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Syntax
2323

2424
.. code-block:: text
2525

26-
mongocli atlas privateendpoint regionalMode(s)|regional-mode(s)|regionalmode(s) disable
26+
mongocli atlas privateEndpoint(s)|private-endpoint(s)|privateendpoint(s) regionalMode(s)|regional-mode(s)|regionalmode(s) disable
2727
[ --output|-o <output-format> ]
2828
[ --profile|-P <profile-name> ]
2929
[ --projectId <project-ID> ]

‎source/reference/atlas/private-endpoint-regionalmode-enable.txt

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
.. _mcli-atlas-private-endpoint-regionalmode-enable-cmd:
2+
3+
==================================================
4+
mongocli atlas privateendpoint regionalmode enable
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+
The ``privateendpoint regionalmode enable`` command enables the
16+
regionalized private endpoint setting for an |service| project. This
17+
setting lets you use regionalized private endpoints for multi-region
18+
sharded clusters. You can also enable the regionalized private endpoint
19+
setting through the |service| :atlas:`UI </security-private-endpoint/#regionalized-private-endpoints-for-multi-region-sharded-clusters>` or
20+
:atlas:`API </reference/api/private-endpoints-update-regional-mode/>`.
21+
22+
Syntax
23+
------
24+
25+
.. code-block:: text
26+
27+
mongocli atlas privateEndpoint(s)|private-endpoint(s)|privateendpoint(s) regionalMode(s)|regional-mode(s)|regionalmode(s) enable
28+
[ --output|-o <output-format> ]
29+
[ --profile|-P <profile-name> ]
30+
[ --projectId <project-ID> ]
31+
32+
.. include:: /includes/fact-command-line-help.rst
33+
34+
.. _atlas-private-endpoint-regionalmode-enable-options:
35+
36+
Options
37+
-------
38+
39+
.. list-table::
40+
:widths: 20 10 60 10
41+
:header-rows: 1
42+
43+
* - Option
44+
- Type
45+
- Description
46+
- Required?
47+
48+
* - ``--output``, ``-o``
49+
- string
50+
- .. include:: /includes/extracts/fact-basic-options-output.rst
51+
- no
52+
53+
* - ``--profile``, ``-P``
54+
- string
55+
- Name of the profile where the public and private
56+
keys for the project are saved. If omitted, uses the
57+
{+default-profile+}. To learn more about creating a
58+
profile, see :ref:`mcli-configure`.
59+
- no
60+
61+
* - ``--projectId``
62+
- string
63+
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
64+
- no
65+
66+
.. _atlas-private-endpoint-regionalmode-enable-output:
67+
68+
Output
69+
------
70+
71+
If the command succeeds, it returns the following output in the default
72+
format. If the command returns errors, see
73+
:ref:`Troubleshooting <troubleshooting>` for recommended solutions.
74+
75+
.. code-block:: sh
76+
:copyable: false
77+
78+
Regionalized private endpoint setting enabled.
79+
80+
Example
81+
-------
82+
83+
.. tabs::
84+
85+
.. tab:: Default Output
86+
:tabid: default-output
87+
88+
The following command enables the regionalized
89+
private endpoint setting in a project using the
90+
{+default-profile+}, which contains credentials for accessing the
91+
project and the project ID. The output is returned in the default
92+
format.
93+
94+
.. code-block:: sh
95+
96+
mongocli atlas privateendpoint regionalmode enable
97+
98+
The previous command prints the following to the terminal.
99+
100+
.. code-block:: sh
101+
:copyable: false
102+
103+
Regionalized private endpoint setting enabled.
104+
105+
.. tab:: JSON Output
106+
:tabid: json-output
107+
108+
The following command enables the regionalized
109+
private endpoint setting in a project using the
110+
{+default-profile+}, which contains credentials for accessing the
111+
project and the project ID. The output is returned
112+
in |json| format.
113+
114+
.. code-block:: sh
115+
116+
mongocli atlas privateendpoint regionalmode enable --output json
117+
118+
The previous command prints the following to the terminal in
119+
|json| format.
120+
121+
.. code-block:: json
122+
:copyable: false
123+
124+
{
125+
"enabled": true
126+
}

0 commit comments

Comments
 (0)