Skip to content

Commit ddd927d

Browse files
kanchana-mongodbkanchana-mongodb
authored
bringing in new files for v1.20 (#631)
1 parent 601f741 commit ddd927d

File tree

54 files changed

+3791
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+3791
-0
lines changed

‎source/command/mongocli-atlas-accessLogs-list.txt

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
.. _mongocli-atlas-accessLogs-list:
2+
3+
==============================
4+
mongocli atlas accessLogs list
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+
Retrieve the access logs of a cluster identified by the cluster's name or hostname.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
22+
mongocli atlas accessLogs list [options]
23+
24+
Options
25+
-------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - --authResult
36+
- string
37+
- false
38+
- Flag that indicates whether to return either successful or failed authentication attempts. When set to success, Atlas filters the log to return only successful authentication attempts. When set to fail, Atlas filters the log to return only failed authentication attempts.
39+
* - --clusterName
40+
- string
41+
- false
42+
- Name of the cluster.
43+
* - --end
44+
- string
45+
- false
46+
- Timestamp in the number of milliseconds that have elapsed since the UNIX epoch for the first entry that Atlas returns from the database access logs.
47+
* - -h, --help
48+
-
49+
- false
50+
- help for list
51+
* - --hostname
52+
- string
53+
- false
54+
- The fully qualified domain name of the target node that received the authentication attempt.
55+
* - --ip
56+
- string
57+
- false
58+
- Single IP address that attempted to authenticate with the database. Atlas filters the returned logs to include documents with only this IP address.
59+
* - --nLog
60+
- int
61+
- false
62+
- Maximum number of log lines to return.
63+
* - -o, --output
64+
- string
65+
- false
66+
- Output format.
67+
Valid values: json|json-path|go-template|go-template-file
68+
* - --projectId
69+
- string
70+
- false
71+
- Project ID to use. Overrides configuration file or environment variable settings.
72+
* - --start
73+
- string
74+
- false
75+
- Timestamp in the number of milliseconds that have elapsed since the UNIX epoch for the first entry that Atlas returns from the database access logs.
76+
77+
Inherited Options
78+
-----------------
79+
80+
.. list-table::
81+
:header-rows: 1
82+
:widths: 20 10 10 60
83+
84+
* - Name
85+
- Type
86+
- Required
87+
- Description
88+
* - -P, --profile
89+
- string
90+
- false
91+
- Profile to use from your configuration file.
92+

‎source/command/mongocli-atlas-accessLogs.txt

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
.. _mongocli-atlas-accessLogs:
2+
3+
=========================
4+
mongocli atlas accessLogs
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+
Manage the access logs of a cluster.
16+
17+
Options
18+
-------
19+
20+
.. list-table::
21+
:header-rows: 1
22+
:widths: 20 10 10 60
23+
24+
* - Name
25+
- Type
26+
- Required
27+
- Description
28+
* - -h, --help
29+
-
30+
- false
31+
- help for accessLogs
32+
33+
Inherited Options
34+
-----------------
35+
36+
.. list-table::
37+
:header-rows: 1
38+
:widths: 20 10 10 60
39+
40+
* - Name
41+
- Type
42+
- Required
43+
- Description
44+
* - -P, --profile
45+
- string
46+
- false
47+
- Profile to use from your configuration file.
48+
49+
Related Commands
50+
----------------
51+
52+
* :ref:`mongocli-atlas-accessLogs-list` - Retrieve the access logs of a cluster identified by the cluster's name or hostname.
53+
54+
55+
.. toctree::
56+
:titlesonly:
57+
58+
list </command/mongocli-atlas-accessLogs-list>
59+

‎source/command/mongocli-atlas-events-organizations-list.txt

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
.. _mongocli-atlas-events-organizations-list:
2+
3+
========================================
4+
mongocli atlas events organizations list
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+
Return all events for an organization.
16+
17+
Your API Key must have the Org Member role to successfully call this resource.
18+
19+
Syntax
20+
------
21+
22+
.. code-block::
23+
24+
mongocli atlas events organizations list [options]
25+
26+
Options
27+
-------
28+
29+
.. list-table::
30+
:header-rows: 1
31+
:widths: 20 10 10 60
32+
33+
* - Name
34+
- Type
35+
- Required
36+
- Description
37+
* - -h, --help
38+
-
39+
- false
40+
- help for list
41+
* - --limit
42+
- int
43+
- false
44+
- Number of items per page.
45+
* - --maxDate
46+
- string
47+
- false
48+
- Returns events whose created date is less than or equal to it.
49+
* - --minDate
50+
- string
51+
- false
52+
- Returns events whose created date is greater than or equal to it.
53+
* - --orgId
54+
- string
55+
- false
56+
- Organization ID to use. Overrides configuration file or environment variable settings.
57+
* - -o, --output
58+
- string
59+
- false
60+
- Output format.
61+
Valid values: json|json-path|go-template|go-template-file
62+
* - --page
63+
- int
64+
- false
65+
- Page number.
66+
* - --type
67+
- strings
68+
- false
69+
- Type of event that will trigger an alert.
70+
71+
Inherited Options
72+
-----------------
73+
74+
.. list-table::
75+
:header-rows: 1
76+
:widths: 20 10 10 60
77+
78+
* - Name
79+
- Type
80+
- Required
81+
- Description
82+
* - -P, --profile
83+
- string
84+
- false
85+
- Profile to use from your configuration file.
86+

‎source/command/mongocli-atlas-events-organizations.txt

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
.. _mongocli-atlas-events-organizations:
2+
3+
===================================
4+
mongocli atlas events organizations
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+
Organization operations.
16+
17+
List organization events.
18+
19+
Options
20+
-------
21+
22+
.. list-table::
23+
:header-rows: 1
24+
:widths: 20 10 10 60
25+
26+
* - Name
27+
- Type
28+
- Required
29+
- Description
30+
* - -h, --help
31+
-
32+
- false
33+
- help for organizations
34+
35+
Inherited Options
36+
-----------------
37+
38+
.. list-table::
39+
:header-rows: 1
40+
:widths: 20 10 10 60
41+
42+
* - Name
43+
- Type
44+
- Required
45+
- Description
46+
* - -P, --profile
47+
- string
48+
- false
49+
- Profile to use from your configuration file.
50+
51+
Related Commands
52+
----------------
53+
54+
* :ref:`mongocli-atlas-events-organizations-list` - Return all events for an organization.
55+
56+
57+
.. toctree::
58+
:titlesonly:
59+
60+
list </command/mongocli-atlas-events-organizations-list>
61+

‎source/command/mongocli-atlas-events-projects-list.txt

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
.. _mongocli-atlas-events-projects-list:
2+
3+
===================================
4+
mongocli atlas events projects list
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+
Return all events for a project.
16+
17+
Your API Key must have the Project Read Only role to successfully call this resource.
18+
19+
Syntax
20+
------
21+
22+
.. code-block::
23+
24+
mongocli atlas events projects list [options]
25+
26+
Options
27+
-------
28+
29+
.. list-table::
30+
:header-rows: 1
31+
:widths: 20 10 10 60
32+
33+
* - Name
34+
- Type
35+
- Required
36+
- Description
37+
* - -h, --help
38+
-
39+
- false
40+
- help for list
41+
* - --limit
42+
- int
43+
- false
44+
- Number of items per page.
45+
* - --maxDate
46+
- string
47+
- false
48+
- Returns events whose created date is less than or equal to it.
49+
* - --minDate
50+
- string
51+
- false
52+
- Returns events whose created date is greater than or equal to it.
53+
* - -o, --output
54+
- string
55+
- false
56+
- Output format.
57+
Valid values: json|json-path|go-template|go-template-file
58+
* - --page
59+
- int
60+
- false
61+
- Page number.
62+
* - --projectId
63+
- string
64+
- false
65+
- Project ID to use. Overrides configuration file or environment variable settings.
66+
* - --type
67+
- strings
68+
- false
69+
- Type of event that will trigger an alert.
70+
71+
Inherited Options
72+
-----------------
73+
74+
.. list-table::
75+
:header-rows: 1
76+
:widths: 20 10 10 60
77+
78+
* - Name
79+
- Type
80+
- Required
81+
- Description
82+
* - -P, --profile
83+
- string
84+
- false
85+
- Profile to use from your configuration file.
86+

0 commit comments

Comments
 (0)