Skip to content

Commit 2854c25

Browse files
authored
Adds missing agent settings (#5190) (#5193)
1 parent ce35c0f commit 2854c25

File tree

1 file changed

+25
-33
lines changed

1 file changed

+25
-33
lines changed

source/reference/mongodb-agent-settings.txt

Lines changed: 25 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ You can configure additional
6868
these values can be copied directly from this box by clicking
6969
:icon-fa5:`copy`.
7070

71+
This setting is usually set when the {+mdbagent+} is
72+
installed and is required to bind the server to a
73+
project.
74+
7175
.. code-block:: ini
7276

7377
mmsGroupId=8zvbo2s2asigxvmpnkq5yexf
@@ -82,6 +86,10 @@ You can configure additional
8286

8387
.. include:: /includes/extracts/agent-api-key-specify.rst
8488

89+
This setting is usually set when the {+mdbagent+} is
90+
installed and is required to bind the server to a
91+
project.
92+
8593
.. note::
8694

8795
To enable the MongoDB Agent to request the Agent API Key from
@@ -93,62 +101,46 @@ You can configure additional
93101

94102
mmsApiKey=8zvbo2s2asigxvmpnkq5yexf
95103

104+
.. cond:: onprem
105+
96106
.. setting:: mmsGroupId
97107

98108
*Type*: string
99109

100-
*Required*.
101-
102-
Specifies the ID of your |mms| project. In |mms|, click
103-
:guilabel:`Deployments`, then :guilabel:`Agents` and
104-
then select the appropriate operating system under
105-
:guilabel:`Downloads & Settings`.
110+
Specifies the ID of your |mms| project. Find the project ID on the
111+
:guilabel:`Project Settings` page (:guilabel:`Settings` >
112+
:guilabel:`Project Settings`).
106113

107-
When the :guilabel:`Install Agent Instructions` box
108-
appears, these values can be copied directly from this
109-
box by clicking :icon-fa5:`copy`.
110-
111-
This setting is usually set when the {+mdbagent+} is
112-
installed and is required to bind the server to a
113-
project.
114+
|mms| configures this setting when you install the {+mdbagent+}. If
115+
you need to configure {+magent+} separately, include this setting to
116+
bind the server to a project.
114117

115118
.. code-block:: ini
116119

117-
mmsGroupId=8zvbo2s2asigxvmpnkq5yexf
120+
mmsGroupId=8zvbo2s2asigxvmpnkq5yexf
118121

119122
.. setting:: mmsApiKey
120123

121124
*Type*: string
122125

123-
*Required*.
124-
125-
Specifies the |mms| agent |api| key of your |mms|
126-
project.
126+
Specifies the {+mdbagent+} |api| key of your |mms| project.
127127

128128
.. include:: /includes/extracts/agent-api-key-specify.rst
129129

130-
This setting is usually set when the {+mdbagent+} is
131-
installed and is required to bind the server to a
132-
project.
133-
134-
.. note::
135-
136-
You can specify the password from a shell
137-
command by using the
138-
:setting:`mmsApiKeyExec` option instead of
139-
:setting:`mmsApiKey`.
130+
|mms| configures this setting when you install the {+mdbagent+}. If
131+
you need to configure {+magent+} separately, include this setting.
140132

141133
.. code-block:: ini
142134

143-
mmsApiKey=8zvbo2s2asigxvmpnkq5yexf
135+
mmsApiKey=rgdte4w7wwbnds9nceuodx9mcte2zqem
144136

145-
.. _mmsBaseUrl:
137+
.. _mmsBaseUrl:
146138

147-
.. setting:: mmsBaseUrl
139+
.. setting:: mmsBaseUrl
148140

149-
*Type*: string
141+
*Type*: string
150142

151-
.. include:: /includes/extracts/automation-agent-configuration-mmsbaseurl.rst
143+
.. include:: /includes/extracts/automation-agent-configuration-mmsbaseurl.rst
152144

153145
.. _mongodb-agent-logging-settings:
154146

0 commit comments

Comments
 (0)