DOCSP-11361 Add a global output flag (#179)

* DOCSP-11361 Add a global output flag

* DOCSP-11361 indentation fix

DOCSP-11361 minor fix

DOCSP-11361 changes

* DOCSP-11361 doc updates for feedback

Author: kanchana-mongodb

source/includes/alert-describe-options.rst

@@ -12,6 +12,11 @@
      - Unique identifier of the alert you want to describe.
      - yes
 
+   * - ``--output``, ``-o``
+     - string 
+     - .. include:: /includes/extracts/fact-basic-options-output.rst
+     - no
+
    * - ``--profile``, ``-P``
      - string
      - Name of the profile where the public and private 

source/includes/alert-list-options.rst

@@ -13,6 +13,11 @@
        ``100`` if not specified.
      - no
 
+   * - ``--output``, ``-o``
+     - string 
+     - .. include:: /includes/extracts/fact-basic-options-output.rst
+     - no
+
    * - ``--page``
      - integer
      - Page number (1-based). Defaults to ``1`` if not specified.

source/includes/alerts-ack-options.rst

@@ -12,27 +12,23 @@
      - ID of the alert you want to acknowledge or un-acknowledge.
      - yes
 
-   * - ``--forever``
+   * - ``--comment``
      - string
-     - Prevent the alert from resuming at any point in the future.
-
-       You can't set both ``--forever`` and ``--until`` in the same
-       command.
+     - Comment describing the alert acknowledgement. If included, wrap
+       the comment in double quotes.
      - no
 
-   * - ``--until``
+   * - ``--forever``
      - string
-     - |iso8601-time| through which you acknowledge this alert. After
-       this time passes, the alert becomes un-acknowledged.
+     - Prevent the alert from resuming at any point in the future.
 
-       You can't set both ``--until`` and ``--forever`` in the same
+       You can't set both ``--forever`` and ``--until`` in the same
        command.
      - no
 
-   * - ``--comment``
-     - string
-     - Comment describing the alert acknowledgement. If included, wrap
-       the comment in double quotes.
+   * - ``--output``, ``-o``
+     - string 
+     - .. include:: /includes/extracts/fact-basic-options-output.rst
      - no
 
    * - ``--profile``, ``-P``
@@ -53,3 +49,12 @@
        omitted, uses the project ID in the profile or
        :ref:`environment variable <mcli-env-var>`.
      - no
+
+   * - ``--until``
+     - string
+     - |iso8601-time| through which you acknowledge this alert. After
+       this time passes, the alert becomes un-acknowledged.
+
+       You can't set both ``--until`` and ``--forever`` in the same
+       command.
+     - no

source/includes/alerts-unack-options.rst

@@ -12,21 +12,17 @@
      - ID of the alert you want to unacknowledge.
      - yes
 
-   * - ``--until``
-     - string
-     - |iso8601-time| through which you unacknowledge this alert. After
-       this time passes, the alert becomes acknowledged.
-
-       You can't set both ``--until`` and ``--forever`` in the same
-       command.
-     - no
-
    * - ``--comment``
      - string
      - Comment describing the alert unacknowledgement. If included,
        wrap the comment in double quotes.
      - no
 
+   * - ``--output``, ``-o``
+     - string 
+     - .. include:: /includes/extracts/fact-basic-options-output.rst
+     - no
+
    * - ``--profile``, ``-P``
      - string
      - Name of the profile where the project ID and the |svc-api-key|\s
@@ -45,3 +41,12 @@
        omitted, uses the project ID in the profile or
        :ref:`environment variable <mcli-env-var>`.
      - no
+
+   * - ``--until``
+     - string
+     - |iso8601-time| through which you unacknowledge this alert. After
+       this time passes, the alert becomes acknowledged.
+
+       You can't set both ``--until`` and ``--forever`` in the same
+       command.
+     - no

source/includes/backup-checkpoints-options.rst

@@ -12,6 +12,11 @@
      - ID of the cluster. 
      - yes 
 
+   * - ``--output``, ``-o``
+     - string 
+     - .. include:: /includes/extracts/fact-basic-options-output.rst
+     - no
+
    * - ``--profile``, ``-P``
      - string
      - Name of the profile where the project ID and the |svc-api-key|\s 

source/includes/basic-options.rst

@@ -12,6 +12,11 @@
        ``admin``.
      - no
 
+   * - ``--output``, ``-o``
+     - string 
+     - .. include:: /includes/extracts/fact-basic-options-output.rst
+     - no
+
    * - ``--profile``, ``-P``
      - string
      - Name of the profile where the public and private 

source/includes/extracts-basic-options.yaml

@@ -0,0 +1,11 @@
+ref: fact-basic-options-output
+content: | 
+  Command output format. Value must be ``json``. If omitted, defaults to 
+  ``json``.
+---
+ref: fact-basic-options-profile
+content: | 
+  Name of the profile where the public and private keys for the project are 
+  set. If omitted, uses the {+default-profile+}. To learn more about creating a 
+  profile, see :ref:`mcli-configure`.
+...

source/includes/list-table-events-list-options.rst

@@ -7,23 +7,6 @@
      - Description 
      - Required? 
 
-   * - ``--profile``, ``-P``
-     - string
-     - Name of the profile where the project ID and the |svc-api-key|\s 
-       for the project are saved. If omitted, uses the {+default-profile+}. 
-       To learn more about creating a profile, see :ref:`mcli-configure`.
-     - no
-
-   * - ``--projectId``
-     - string
-     - Unique identifier of the project for which to retrieve events.
-     - yes
-
-   * - ``--orgId``
-     - string
-     - Unique identifier of the organization for which to retrieve events.
-     - yes
-
    * - ``--limit``
      - integer
      - Number of items per page.
@@ -39,11 +22,33 @@
      - Return events whose created date is greater than or equal to it.
      - no
 
+   * - ``--orgId``
+     - string
+     - Unique identifier of the organization for which to retrieve events.
+     - yes
+
+   * - ``--output``, ``-o``
+     - string 
+     - .. include:: /includes/extracts/fact-basic-options-output.rst
+     - no
+
    * - ``--page``
      - integer
      - Page number.
      - no
 
+   * - ``--profile``, ``-P``
+     - string
+     - Name of the profile where the project ID and the |svc-api-key|\s 
+       for the project are saved. If omitted, uses the {+default-profile+}. 
+       To learn more about creating a profile, see :ref:`mcli-configure`.
+     - no
+
+   * - ``--projectId``
+     - string
+     - Unique identifier of the project for which to retrieve events.
+     - yes
+
 .. note::
 
    The ``--orgId`` and ``--projectId`` flags are exclusive. You must use one or

source/includes/metrics-disks-describe-options.rst

@@ -7,16 +7,18 @@
      - Description
      - Required?
 
-   * - ``<hostID>``
-     - String
-     - The host ID of the server running the MongoDB process.
-     - yes
-
    * - ``<partition-name>``
      - string
      - The name of the disk or partition for which to get available metrics.
      - yes
 
+   * - ``end``
+     - String
+     - The time at which to stop retrieving metrics, as specified by an
+       ISO-8601 timestamp string. If you specify ``end``, you must also
+       specify ``start``. Mutually exclusive with ``period``.
+     - yes
+
    * - ``granularity``
      - String
      - An ISO-8601-formatted time period that specifies the interval
@@ -32,13 +34,46 @@
        - ``P1D``
 
      - yes
-   
+
+   * - ``<hostID>``
+     - String
+     - The host ID of the server running the MongoDB process.
+     - yes
+
+   * - ``--limit``
+     - number
+     - Number of items per page.
+     - no
+
+   * - ``--output``, ``-o``
+     - string 
+     - .. include:: /includes/extracts/fact-basic-options-output.rst
+     - no
+
+   * - ``--page``
+     - number
+     - Page number
+     - no
+
    * - ``period``
      - String
      - An ISO-8601-formatted time period that specifies the length of time in
        the past to query. For example, to request the last 36 hours, specify:
        ``period=P1DT12H``. Mutually exclusive with ``start`` and ``end``.
      - yes
+
+   * - ``--profile``, ``-P``
+     - string
+     - Name of the profile where the project ID and the |svc-api-key|\s 
+       for the project are saved. If omitted, uses the {+default-profile+}. 
+       To learn more about creating a profile, see :ref:`mcli-configure`.
+     - no
+
+   * - ``--projectId``
+     - string
+     - Unique identifier of the project for which to retrieve events. If
+       omitted, uses the project ID listed in the profile.
+     - no
 
    * - ``start``
      - String
@@ -47,13 +82,6 @@
        specify ``end``. Mutually exclusive with ``period``.
      - yes
 
-   * - ``end``
-     - String
-     - The time at which to stop retrieving metrics, as specified by an
-       ISO-8601 timestamp string. If you specify ``end``, you must also
-       specify ``start``. Mutually exclusive with ``period``.
-     - yes
-   
    * - ``type``
      - String
      - Specifies which metric to return. If ``type`` is not specified, all
@@ -93,26 +121,3 @@
             - Measures the free disk space and used disk space on the disk partition
               used by MongoDB.
      - no
-
-   * - ``--limit``
-     - number
-     - Number of items per page.
-     - no
-
-   * - ``--page``
-     - number
-     - Page number
-     - no
-
-   * - ``--profile``, ``-P``
-     - string
-     - Name of the profile where the project ID and the |svc-api-key|\s 
-       for the project are saved. If omitted, uses the {+default-profile+}. 
-       To learn more about creating a profile, see :ref:`mcli-configure`.
-     - no
-
-   * - ``--projectId``
-     - string
-     - Unique identifier of the project for which to retrieve events. If
-       omitted, uses the project ID listed in the profile.
-     - no

source/includes/metrics-process-options.rst

@@ -32,6 +32,11 @@
        *or* ``start`` and ``end``.
      - yes
 
+   * - ``--output``, ``-o``
+     - string 
+     - .. include:: /includes/extracts/fact-basic-options-output.rst
+     - no
+
    * - ``period``
      - String
      - An ISO-8601-formatted time period that specifies the length of time in

source/includes/mms-backup-restore-start-options.rst

@@ -66,6 +66,11 @@
           - Cannot set ``checkpointId`` or ``pointInTimeUTCMillis``.
      - no
 
+   * - ``--output``, ``-o``
+     - string 
+     - .. include:: /includes/extracts/fact-basic-options-output.rst
+     - no
+
    * - ``--pointInTimeUTCMillis``
      - integer
      - *Only available for AUTOMATED RESTORE of replica sets.* 

source/reference/atlas/alerts-describe.txt

@@ -25,9 +25,12 @@ Syntax
 .. code-block:: text 
 
    mongocli atlas alert|alerts describe <alertID>
+        [ --output|-o json ]
         [ --profile|-P <profile-name> ]
         [ --projectId <id-of-project> ]
 
+.. include:: /includes/fact-command-line-help.rst
+
 .. _atlas-alerts-describe-options:
 
 Options 

source/reference/atlas/alerts-list.txt

@@ -26,11 +26,14 @@ Syntax
 
    mongocli atlas alert|alerts list|ls
         [ --limit <number-of-items-per-page> ]
+        [ --output|-o json ]
         [ --page <page-number> ]
         [ --profile|-P <profile-name> ]
         [ --projectId <id-of-project> ]
         [ --status <alert-status> ]
 
+.. include:: /includes/fact-command-line-help.rst
+
 .. _atlas-alerts-list-options:
 
 Options 

source/reference/atlas/alerts-settings-create.txt

@@ -32,9 +32,12 @@ Syntax
         [ --matcherOperator <operator> ]
         [ --matcherValue <value> ]
         [ --notification* (notification flags) ]
+        [ --output|-o json ]
         [ --projectId <id-of-project> ]
         [ --profile|-P <profile-name> ]
 
+.. include:: /includes/fact-command-line-help.rst
+
 .. _atlas-crete-alerts-settings-options:
 
 Options 
@@ -256,6 +259,11 @@ Options
      - VictorOps routing key
      - Only if ``notificationType`` is ``VICTOR_OPS``.
 
+   * - ``--output``, ``-o``
+     - string 
+     - .. include:: /includes/extracts/fact-basic-options-output.rst
+     - no
+
    * - ``--profile``, ``-P``
      - string
      - Name of the profile where the public and private