Skip to content

Commit a9d3d6b

Browse files
authored
(DOCSP-14127): Added a page and the nav for the mongocli atlas privateendpoint regionalmode describe command. (#482)
* (DOCSP-14127): Added a page and the nav for the mongocli atlas privateendpoint regionalmode describe command. * (DOCSP-14127): Incorporated Julia's feedback. * (DOCSP-14127): Incorporated Andrea's feedback.
1 parent 2e1729d commit a9d3d6b

File tree

2 files changed

+131
-0
lines changed

2 files changed

+131
-0
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,5 @@ Atlas ``privateEndpoint`` Commands
1414
Create One Private Endpoint Service for One Provider </reference/atlas/private-endpoint-provider-create>
1515

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

0 commit comments

Comments
 (0)