Skip to content

Commit 2915a5c

Browse files
DOCSP-11043 doc for mongocli config delete command (#131)
1 parent 78e093c commit 2915a5c

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
.. _mcli-config-delete-command:
2+
3+
======================
4+
mongocli config 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+
The ``config delete`` command removes the specified
16+
profile from the :ref:`mcli-config-file`. The command prompts
17+
you to confirm the operation.
18+
19+
.. _mcli-config-delete-syntax:
20+
21+
Syntax
22+
------
23+
24+
.. code-block:: sh
25+
26+
mongocli config delete|rm <profile-name>
27+
28+
.. _mcli-config-delete-args:
29+
30+
Arguments
31+
---------
32+
33+
.. list-table::
34+
:header-rows: 1
35+
:widths: 20 10 60 10
36+
37+
* - Argument
38+
- Type
39+
- Description
40+
- Required?
41+
42+
* - ``<profile-name>``
43+
- string
44+
- Name of the profile to delete. Specify ``default` to delete
45+
the ``default`` profile.
46+
- yes
47+
48+
.. _mcli-config-delete-output:
49+
50+
Output
51+
------
52+
53+
None. You can verify by running the :ref:`mcli-config-describe-command`
54+
command.
55+
56+
If the command prints an error, see :ref:`Troubleshooting
57+
<troubleshooting>` for recommended solutions.
58+
59+
.. _mcli-config-delete-egs:
60+
61+
Example
62+
-------
63+
64+
The following example uses the ``mongocli config delete``
65+
command to delete a profile named ``egProfile``.
66+
67+
.. code-block:: text
68+
:copyable: false
69+
70+
mongocli config delete egProfile
71+
Are you sure you want to delete: egProfile Yes
72+
73+
The preceding command removes the profile from the configuration
74+
file.

source/reference/configuration.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ including |service-fullname|, |cloud|, and |mms-full|.
2121
- :ref:`Create a configuration file <mcli-config-command>`
2222
- :ref:`Update a configuration file <mcli-config-set-command>`
2323
- :ref:`Retrieve a profile from the configuration file <mcli-config-describe-command>`
24+
- :ref:`Delete a profile <mcli-config-delete-command>`
2425

2526
.. class:: hidden
2627

@@ -30,3 +31,4 @@ including |service-fullname|, |cloud|, and |mms-full|.
3031
Create a Configuration File </reference/config>
3132
Update a Configuration File </reference/mcli-config-set>
3233
Retrieve a Profile </reference/config/config-describe>
34+
Delete a Profile </reference/config/config-delete>

0 commit comments

Comments
 (0)