|
| 1 | +.. _mcli-atlas-cluster-onlinearchive-delete-command: |
| 2 | + |
| 3 | +======================================= |
| 4 | +mongocli atlas cluster onlinearchive rm |
| 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 | +.. include:: /includes/fact-online-archive-beta.rst |
| 16 | + |
| 17 | +The ``onlinearchive rm`` command deletes one :atlas:`online archive |
| 18 | +</online-archive/manage-online-archive/>` for the specified cluster. You can |
| 19 | +also delete an online archive through the |service| :atlas:`UI |
| 20 | +</online-archive/delete-online-archive/>` or :atlas:`API |
| 21 | +</reference/api/online-archive-delete-one/>`. |
| 22 | + |
| 23 | +.. _mcli-atlas-cluster-online-archive-delete-syntax: |
| 24 | + |
| 25 | +Syntax |
| 26 | +------ |
| 27 | + |
| 28 | +.. code-block:: text |
| 29 | + |
| 30 | + mongocli atlas cluster onlinearchive rm <online-archive-id> |
| 31 | + --clusterName <cluster-name> |
| 32 | + [ --force ] |
| 33 | + [ --profile|-P <profile-name> ] |
| 34 | + [ --projectId <project-ID> ] |
| 35 | + |
| 36 | +.. _mcli-atlas-cluster-onlinearchive-delete-options: |
| 37 | + |
| 38 | +Options |
| 39 | +------- |
| 40 | + |
| 41 | +.. list-table:: |
| 42 | + :header-rows: 1 |
| 43 | + :widths: 20 10 60 10 |
| 44 | + |
| 45 | + * - Option |
| 46 | + - Type |
| 47 | + - Description |
| 48 | + - Required? |
| 49 | + |
| 50 | + * - ``<online-archive-id>`` |
| 51 | + - string |
| 52 | + - Unique identifier of the online archive to delete. |
| 53 | + - yes |
| 54 | + |
| 55 | + * - ``--clusterName`` |
| 56 | + - string |
| 57 | + - Name of the cluster. |
| 58 | + - yes |
| 59 | + |
| 60 | + * - ``--force`` |
| 61 | + - |
| 62 | + - Flag indicating that the archive can be deleted without requiring |
| 63 | + confirmation. |
| 64 | + - no |
| 65 | + |
| 66 | + * - ``--profile``, ``-P`` |
| 67 | + - string |
| 68 | + - Name of the profile where the public and private |
| 69 | + keys for the project are saved. If omitted, uses the |
| 70 | + {+default-profile+}. To learn more about creating a |
| 71 | + profile, see :ref:`mcli-configure`. |
| 72 | + - no |
| 73 | + |
| 74 | + * - ``--projectId`` |
| 75 | + - string |
| 76 | + - Unique identifier of the project that contains the |
| 77 | + cluster. If omitted, uses the project ID in the profile or |
| 78 | + :ref:`environment variable <mcli-env-var>`. |
| 79 | + - no |
| 80 | + |
| 81 | +Behavior |
| 82 | +-------- |
| 83 | + |
| 84 | +You must respond affirmatively to a confirmation request before {+mcli+} |
| 85 | +completes a request to delete an online archive. |
| 86 | + |
| 87 | +.. _mcli-atlas-cluster-onlinearchive-delete-output: |
| 88 | + |
| 89 | +Output |
| 90 | +------ |
| 91 | + |
| 92 | +If successful, the command returns the following message: |
| 93 | + |
| 94 | +.. code-block:: none |
| 95 | + |
| 96 | + Archive '<online-archive-id>' deleted |
| 97 | + |
| 98 | +Example |
| 99 | +------- |
| 100 | + |
| 101 | +The following example uses the ``mongocli atlas cluster onlinearchive rm`` |
| 102 | +command to delete an archive configured for the cluster named |
| 103 | +``myTestCluster``. The command uses the {+default-profile+} to access the |
| 104 | +project. |
| 105 | + |
| 106 | +.. code-block:: sh |
| 107 | + |
| 108 | + mongocli atlas cluster onlinearchive rm 5f189832e26ec075e10c32d3 --clusterName myTestCluster |
0 commit comments