- Agents >
- Automation Agent >
- Install or Update the Automation Agent >
- Install or Upgrade the Automation Agent from an Archive
Install or Upgrade the Automation Agent from an Archive¶
On this page
Ops Manager Automation relies on an Automation Agent, which must be installed on every server that runs a monitored MongoDB deployment. The Automation Agents periodically poll Ops Manager to determine the goal configuration, deploy changes as needed, and report deployment status back to Ops Manager.
This procedure installs the Automation Agent on a Linux server using an
tar.gz
archive file.
Automation Agents can run only on 64-bit architectures.
Prerequisites¶
Server Networking Access¶
The hosts that serve the MongoDB deployments must:
Have full networking access to each other through their fully qualified domain names (FQDNs). Each host must be able to reach every other host through the FQDN. To find the FQDN for each host, run the following command in the shell:
Resolve each FQDN to a unique IP address. Run the following command in the shell to resolve the FQDN:
Set the Common Name or Subject Alternative Name value of any SSL certificates to the MongoDB host’s FQDN.
The network configuration must allow each Automation Agent to make a direct connection to every MongoDB deployment listed on the Deployment page. Ops Manager does not support port forwarding.
Installing to a Server that Already Runs MongoDB¶
If you install the Automation Agent to a server that is already running a MongoDB process, the agent must have:
- Permission to stop the MongoDB process. The Automation Agent will restart the process using the agent’s own set of MongoDB binaries. If you had installed MongoDB with a package manager, use the same package manager to install the Automation Agent. This gives the agent the same owner as MongoDB.
Read
andWrite
permissions on the MongoDB data directory and log directory.- Permission to stop, start, and update any existing Monitoring and Backup Agents.
Installing to a Server Before Installing MongoDB¶
If you deploy the Automation Agent to a server that does not have
MongoDB installed, ensure the user that owns the Automation Agent has
Read
and Write
permissions on the MongoDB data and log
directories you plan to use.
Acquire an Agent API Key¶
Ops Manager Agents require one Agent API Key per project to communicate with the Ops Manager Application.
If you do not have an existing Agent API Key for your Ops Manager project, you need to create one:
Navigate to Agents, then Agent API Keys
Click plus icon Generate.
Note
The button appears only if the current user is the project owner and the project either has no Agent API keys or just the Original Group API key. An Original Group API key exists only in projects created prior to the new Agent API Key model. The new model allows a project to have more than one key and permits any of the project’s agents to use any of the keys. For more information, see Manage Agent API Keys. If you do not see the + Generate Key button and do not remember your existing agent api key, you can generate a key on the Agent API Keys tab. To navigate to the tab, select Deployment view, then click the Agents tab and then the Agent API Keys tab.
Enter your password and click Verify.
Click plus icon Generate again.
Important
When you generate an Agent API key, Ops Manager displays it one time only. You must copy it and store it in a secure place. Ops Manager will never display the full key again.
Install the Automation Agent from an Archive¶
Installation Tip for Binding the Agent to a Project
You can also access install instructions in Ops Manager, including commands you can copy and paste: click Deployment, then Agents, then Downloads & Settings.
- RHEL/CentOS/SUSE (x86_64)
- RHEL/CentOS (ppc64le)
- Ubuntu (ppc64le)
- Other Linux
For RHEL / CentOS (7.x) and SUSE 12 on x64 architecture:
Log in to the Ops Manager Application.¶
Begin or Manage a Deployment.¶
- Click Build New or Manage Existing to begin the deployment wizard. When you reach the Install an Automation Agent on each server page, all hosts are listed.
- Click on the Install Agent menu of the first MongoDB host.
- Click RHEL/CentOS 7.X, SUSE12 - TAR.
- Click RHEL/CentOS 7.X Power (ppc64le) - TAR.
- Click Ubuntu 16.X Power (ppc64le) - TAR.
- Click Other Linux - TAR.
Download the latest version of the Automation Agent archive.¶
From a system shell on the host that will run the
Automation Agent, issue a curl
command to download the
archive for your platform:
Note
Replace <OpsManagerHost>:<Port>
with the hostname and port of
your Ops Manager Application.
Extract the Automation Agent.¶
You can install the Automation Agent in any directory. If you want to move the archive to another directory before extracting, you may do so.
To install the agent, extract the archive:
When the command completes, the Automation Agent is installed.
Change to the extracted binary directory.¶
Change into the directory that was created after extracting the Automation Agent binary:
Edit the local.config
file.¶
In the directory where you installed the Automation Agent, open the
local.config
file in your preferred text editor.
The changes you make depend whether or not you are using server pools.
- Projects
- Server Pools
Update the following configuration keys:
Key | Change |
---|---|
mmsGroupId |
Set to your ProjectID . |
mmsApiKey |
Set to the project’s agent API key. |
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
The resulting changes to the local.config
file should
look like the following:
Important
Do not configure the Server Pool settings:
Server Pools deprecated as of Ops Manager 4.0
As of Ops Manager 4.0, server pools are deprecated and disabled by default.
Update the following configuration keys:
Key | Change |
---|---|
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
serverPoolKey |
Set to the Server Pool Key. To find the server pool key, in the Admin menu, go to Server Pool view and click on the Agent Configuration tab. |
serverPoolPropertiesFile |
Set to the full filepath of a file that contains server properties. Ensure the Automation Agent can read the file. The properties file contains key/value pairs of the form
Note Ensure that the properties file contains the desired property names and values before starting the Automation Agent on the server. Once the server is registered with the pool, changes to the properties file do not take effect until the server is first removed and the Automation Agent restarted. |
serverPoolStateFile |
Set to the full filepath of the file to be used by the Automation Agent. Ensure that the directory path to the file exists and the agent has read and write access to the directory. The file itself need not exist; however, if it does exist, the agent must have read and write access to the file. |
The resulting changes to the local.config
file should
look like the following:
Optional: Configure the Automation Agent to use a proxy server.¶
To configure the agent to connect to Ops Manager via a proxy server, you must
specify the server in the httpProxy
environment variable. In the
<install-directory>/local.config
file, set the httpProxy
value to the URL of to
your proxy server:
Create the automation and data directories.¶
Create the following directories to store files that the Automation Agent needs:
Component | Default Directory | Description |
---|---|---|
Binaries | /var/lib/mongodb-mms-automation |
These are the binaries that the Automation Agent manages. They include the Backup Agent, Monitoring Agent, BI Connector, and MongoDB binaries. |
Automation Agent logs | /var/log/mongodb-mms-automation |
These are the log files that the Automation Agent creates. |
MongoDB databases | /data |
These are the databases that the Automation Agent creates and manages. |
Run these commands to create the directories:
Using a Different Path than /var/lib
By default, the Agent binaries and Ops Manager
configuration backup file are located in
/var/lib/mongodb-mms-automation
.
If you want to store these files in a different
directory, follow these procedures:
To change the location of the Agent Binaries:
Click Deployment, then Agents, and then Downloads & Settings.
Below the Download Directory heading, click the pencil icon to the right of the path shown in Download Directory (Linux/MacOS).
Change the path to the new path you want.
Click Save.
Create the new directory you specified on each host that runs an Agent.
To change the location of the Agent configuration backup:
Open the Agent configuration file in your preferred text editor.
Change the
mmsConfigBackup
setting to the new path for the configuration backup file.Save the Agent configuration file.
Move the configuration backup file to the new directory.
Start the Automation Agent.¶
From the directory in which you installed the Automation Agent and as the system user you created in the last step, issue the following command:
Verify that the Automation Agent can connect to Ops Manager.¶
Click Verify Agent on the Automation Agent Installation Instructions modal.
For RHEL / CentOS (7.x) on PowerPC architecture (managing MongoDB 3.4 or later deployments only):
Log in to the Ops Manager Application.¶
Begin or Manage a Deployment.¶
- Click Build New or Manage Existing to begin the deployment wizard. When you reach the Install an Automation Agent on each server page, all hosts are listed.
- Click on the Install Agent menu of the first MongoDB host.
- Click RHEL/CentOS 7.X, SUSE12 - TAR.
- Click RHEL/CentOS 7.X Power (ppc64le) - TAR.
- Click Ubuntu 16.X Power (ppc64le) - TAR.
- Click Other Linux - TAR.
Download the latest version of the Automation Agent archive.¶
From a system shell on the host that will run the
Automation Agent, issue a curl
command to download the
archive for your platform:
Note
Replace <OpsManagerHost>:<Port>
with the hostname and port of
your Ops Manager Application.
Extract the Automation Agent.¶
You can install the Automation Agent in any directory. If you want to move the archive to another directory before extracting, you may do so.
To install the agent, extract the archive:
When the command completes, the Automation Agent is installed.
Change to the extracted binary directory.¶
Change into the directory that was created after extracting the Automation Agent binary:
Edit the local.config
file.¶
In the directory where you installed the Automation Agent, open the
local.config
file in your preferred text editor.
The changes you make depend whether or not you are using server pools.
- Projects
- Server Pools
Update the following configuration keys:
Key | Change |
---|---|
mmsGroupId |
Set to your ProjectID . |
mmsApiKey |
Set to the project’s agent API key. |
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
The resulting changes to the local.config
file should
look like the following:
Important
Do not configure the Server Pool settings:
Server Pools deprecated as of Ops Manager 4.0
As of Ops Manager 4.0, server pools are deprecated and disabled by default.
Update the following configuration keys:
Key | Change |
---|---|
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
serverPoolKey |
Set to the Server Pool Key. To find the server pool key, in the Admin menu, go to Server Pool view and click on the Agent Configuration tab. |
serverPoolPropertiesFile |
Set to the full filepath of a file that contains server properties. Ensure the Automation Agent can read the file. The properties file contains key/value pairs of the form
Note Ensure that the properties file contains the desired property names and values before starting the Automation Agent on the server. Once the server is registered with the pool, changes to the properties file do not take effect until the server is first removed and the Automation Agent restarted. |
serverPoolStateFile |
Set to the full filepath of the file to be used by the Automation Agent. Ensure that the directory path to the file exists and the agent has read and write access to the directory. The file itself need not exist; however, if it does exist, the agent must have read and write access to the file. |
The resulting changes to the local.config
file should
look like the following:
Optional: Configure the Automation Agent to use a proxy server.¶
To configure the agent to connect to Ops Manager via a proxy server, you must
specify the server in the httpProxy
environment variable. In the
<install-directory>/local.config
file, set the httpProxy
value to the URL of to
your proxy server:
Create the automation and data directories.¶
Create the following directories to store files that the Automation Agent needs:
Component | Default Directory | Description |
---|---|---|
Binaries | /var/lib/mongodb-mms-automation |
These are the binaries that the Automation Agent manages. They include the Backup Agent, Monitoring Agent, BI Connector, and MongoDB binaries. |
Automation Agent logs | /var/log/mongodb-mms-automation |
These are the log files that the Automation Agent creates. |
MongoDB databases | /data |
These are the databases that the Automation Agent creates and manages. |
Run these commands to create the directories:
Using a Different Path than /var/lib
By default, the Agent binaries and Ops Manager
configuration backup file are located in
/var/lib/mongodb-mms-automation
.
If you want to store these files in a different
directory, follow these procedures:
To change the location of the Agent Binaries:
Click Deployment, then Agents, and then Downloads & Settings.
Below the Download Directory heading, click the pencil icon to the right of the path shown in Download Directory (Linux/MacOS).
Change the path to the new path you want.
Click Save.
Create the new directory you specified on each host that runs an Agent.
To change the location of the Agent configuration backup:
Open the Agent configuration file in your preferred text editor.
Change the
mmsConfigBackup
setting to the new path for the configuration backup file.Save the Agent configuration file.
Move the configuration backup file to the new directory.
Start the Automation Agent.¶
From the directory in which you installed the Automation Agent and as the system user you created in the last step, issue the following command:
Verify that the Automation Agent can connect to Ops Manager.¶
Click Verify Agent on the Automation Agent Installation Instructions modal.
For Ubuntu (16.04) on PowerPC architecture (managing MongoDB 3.4 or later deployments only):
Log in to the Ops Manager Application.¶
Begin or Manage a Deployment.¶
- Click Build New or Manage Existing to begin the deployment wizard. When you reach the Install an Automation Agent on each server page, all hosts are listed.
- Click on the Install Agent menu of the first MongoDB host.
- Click RHEL/CentOS 7.X, SUSE12 - TAR.
- Click RHEL/CentOS 7.X Power (ppc64le) - TAR.
- Click Ubuntu 16.X Power (ppc64le) - TAR.
- Click Other Linux - TAR.
Download the latest version of the Automation Agent archive.¶
From a system shell on the host that will run the
Automation Agent, issue a curl
command to download the
archive for your platform:
Note
Replace <OpsManagerHost>:<Port>
with the hostname and port of
your Ops Manager Application.
Extract the Automation Agent.¶
You can install the Automation Agent in any directory. If you want to move the archive to another directory before extracting, you may do so.
To install the agent, extract the archive:
When the command completes, the Automation Agent is installed.
Change to the extracted binary directory.¶
Change into the directory that was created after extracting the Automation Agent binary:
Edit the local.config
file.¶
In the directory where you installed the Automation Agent, open the
local.config
file in your preferred text editor.
The changes you make depend whether or not you are using server pools.
- Projects
- Server Pools
Update the following configuration keys:
Key | Change |
---|---|
mmsGroupId |
Set to your ProjectID . |
mmsApiKey |
Set to the project’s agent API key. |
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
The resulting changes to the local.config
file should
look like the following:
Important
Do not configure the Server Pool settings:
Server Pools deprecated as of Ops Manager 4.0
As of Ops Manager 4.0, server pools are deprecated and disabled by default.
Update the following configuration keys:
Key | Change |
---|---|
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
serverPoolKey |
Set to the Server Pool Key. To find the server pool key, in the Admin menu, go to Server Pool view and click on the Agent Configuration tab. |
serverPoolPropertiesFile |
Set to the full filepath of a file that contains server properties. Ensure the Automation Agent can read the file. The properties file contains key/value pairs of the form
Note Ensure that the properties file contains the desired property names and values before starting the Automation Agent on the server. Once the server is registered with the pool, changes to the properties file do not take effect until the server is first removed and the Automation Agent restarted. |
serverPoolStateFile |
Set to the full filepath of the file to be used by the Automation Agent. Ensure that the directory path to the file exists and the agent has read and write access to the directory. The file itself need not exist; however, if it does exist, the agent must have read and write access to the file. |
The resulting changes to the local.config
file should
look like the following:
Optional: Configure the Automation Agent to use a proxy server.¶
To configure the agent to connect to Ops Manager via a proxy server, you must
specify the server in the httpProxy
environment variable. In the
<install-directory>/local.config
file, set the httpProxy
value to the URL of to
your proxy server:
Create the automation and data directories.¶
Create the following directories to store files that the Automation Agent needs:
Component | Default Directory | Description |
---|---|---|
Binaries | /var/lib/mongodb-mms-automation |
These are the binaries that the Automation Agent manages. They include the Backup Agent, Monitoring Agent, BI Connector, and MongoDB binaries. |
Automation Agent logs | /var/log/mongodb-mms-automation |
These are the log files that the Automation Agent creates. |
MongoDB databases | /data |
These are the databases that the Automation Agent creates and manages. |
Run these commands to create the directories:
Using a Different Path than /var/lib
By default, the Agent binaries and Ops Manager
configuration backup file are located in
/var/lib/mongodb-mms-automation
.
If you want to store these files in a different
directory, follow these procedures:
To change the location of the Agent Binaries:
Click Deployment, then Agents, and then Downloads & Settings.
Below the Download Directory heading, click the pencil icon to the right of the path shown in Download Directory (Linux/MacOS).
Change the path to the new path you want.
Click Save.
Create the new directory you specified on each host that runs an Agent.
To change the location of the Agent configuration backup:
Open the Agent configuration file in your preferred text editor.
Change the
mmsConfigBackup
setting to the new path for the configuration backup file.Save the Agent configuration file.
Move the configuration backup file to the new directory.
Start the Automation Agent.¶
From the directory in which you installed the Automation Agent and as the system user you created in the last step, issue the following command:
Verify that the Automation Agent can connect to Ops Manager.¶
Click Verify Agent on the Automation Agent Installation Instructions modal.
For all other Linux distributions:
Log in to the Ops Manager Application.¶
Begin or Manage a Deployment.¶
- Click Build New or Manage Existing to begin the deployment wizard. When you reach the Install an Automation Agent on each server page, all hosts are listed.
- Click on the Install Agent menu of the first MongoDB host.
- Click RHEL/CentOS 7.X, SUSE12 - TAR.
- Click RHEL/CentOS 7.X Power (ppc64le) - TAR.
- Click Ubuntu 16.X Power (ppc64le) - TAR.
- Click Other Linux - TAR.
Download the latest version of the Automation Agent archive.¶
From a system shell on the host that will run the
Automation Agent, issue a curl
command to download the
archive for your platform:
Note
Replace <OpsManagerHost>:<Port>
with the hostname and port of
your Ops Manager Application.
Extract the Automation Agent.¶
You can install the Automation Agent in any directory. If you want to move the archive to another directory before extracting, you may do so.
To install the agent, extract the archive:
When the command completes, the Automation Agent is installed.
Change to the extracted binary directory.¶
Change into the directory that was created after extracting the Automation Agent binary:
Edit the local.config
file.¶
In the directory where you installed the Automation Agent, open the
local.config
file in your preferred text editor.
The changes you make depend whether or not you are using server pools.
- Projects
- Server Pools
Update the following configuration keys:
Key | Change |
---|---|
mmsGroupId |
Set to your ProjectID . |
mmsApiKey |
Set to the project’s agent API key. |
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
The resulting changes to the local.config
file should
look like the following:
Important
Do not configure the Server Pool settings:
Server Pools deprecated as of Ops Manager 4.0
As of Ops Manager 4.0, server pools are deprecated and disabled by default.
Update the following configuration keys:
Key | Change |
---|---|
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
serverPoolKey |
Set to the Server Pool Key. To find the server pool key, in the Admin menu, go to Server Pool view and click on the Agent Configuration tab. |
serverPoolPropertiesFile |
Set to the full filepath of a file that contains server properties. Ensure the Automation Agent can read the file. The properties file contains key/value pairs of the form
Note Ensure that the properties file contains the desired property names and values before starting the Automation Agent on the server. Once the server is registered with the pool, changes to the properties file do not take effect until the server is first removed and the Automation Agent restarted. |
serverPoolStateFile |
Set to the full filepath of the file to be used by the Automation Agent. Ensure that the directory path to the file exists and the agent has read and write access to the directory. The file itself need not exist; however, if it does exist, the agent must have read and write access to the file. |
The resulting changes to the local.config
file should
look like the following:
Optional: Configure the Automation Agent to use a proxy server.¶
To configure the agent to connect to Ops Manager via a proxy server, you must
specify the server in the httpProxy
environment variable. In the
<install-directory>/local.config
file, set the httpProxy
value to the URL of to
your proxy server:
Create the automation and data directories.¶
Create the following directories to store files that the Automation Agent needs:
Component | Default Directory | Description |
---|---|---|
Binaries | /var/lib/mongodb-mms-automation |
These are the binaries that the Automation Agent manages. They include the Backup Agent, Monitoring Agent, BI Connector, and MongoDB binaries. |
Automation Agent logs | /var/log/mongodb-mms-automation |
These are the log files that the Automation Agent creates. |
MongoDB databases | /data |
These are the databases that the Automation Agent creates and manages. |
Run these commands to create the directories:
Using a Different Path than /var/lib
By default, the Agent binaries and Ops Manager
configuration backup file are located in
/var/lib/mongodb-mms-automation
.
If you want to store these files in a different
directory, follow these procedures:
To change the location of the Agent Binaries:
Click Deployment, then Agents, and then Downloads & Settings.
Below the Download Directory heading, click the pencil icon to the right of the path shown in Download Directory (Linux/MacOS).
Change the path to the new path you want.
Click Save.
Create the new directory you specified on each host that runs an Agent.
To change the location of the Agent configuration backup:
Open the Agent configuration file in your preferred text editor.
Change the
mmsConfigBackup
setting to the new path for the configuration backup file.Save the Agent configuration file.
Move the configuration backup file to the new directory.
Start the Automation Agent.¶
From the directory in which you installed the Automation Agent and as the system user you created in the last step, issue the following command:
Verify that the Automation Agent can connect to Ops Manager.¶
Click Verify Agent on the Automation Agent Installation Instructions modal.
Update the Automation Agent from an Archive¶
Important
If any Automation Agent for any deployment is out of date, Ops Manager displays a warning on the Deployment page.
- RHEL/CentOS/SUSE (x86_64)
- RHEL/CentOS (ppc64le)
- Ubuntu (ppc64le)
- Other Linux
For RHEL / CentOS (7.x) and SUSE 12 on x64 architecture:
Log in the host where the Automation Agent is installed.¶
Stop any currently running Automation Agents.¶
Issue the following command on the MongoDB host:
Log in to the Ops Manager Application.¶
Click Deployment, then Agents, and then Downloads & Settings.¶
Select the Linux distribution for your Agent host.¶
Click RHEL/CentOS 7.X, SUSE12 - TAR
Click RHEL/CentOS 7.X Power (ppc64le) - TAR
Click Ubuntu 16.X Power (ppc64le) - TAR
Click Other Linux - TAR
Download the latest version of the Automation Agent archive.¶
From a system shell on the host that will run the
Automation Agent, issue a curl
command to download the
archive for your platform:
Note
Replace <OpsManagerHost>:<Port>
with the hostname and port of
your Ops Manager Application.
Extract the Automation Agent.¶
You can install the Automation Agent in any directory. If you want to move the archive to another directory before extracting, you may do so.
To install the agent, extract the archive:
When the command completes, the Automation Agent is installed.
Change to the extracted binary directory.¶
Change into the directory that was created after extracting the Automation Agent binary:
Edit the local.config
file.¶
In the directory where you installed the Automation Agent, open the
local.config
file in your preferred text editor.
The changes you make depend whether or not you are using server pools.
- Projects
- Server Pools
Update the following configuration keys:
Key | Change |
---|---|
mmsGroupId |
Set to your ProjectID . |
mmsApiKey |
Set to the project’s agent API key. |
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
The resulting changes to the local.config
file should
look like the following:
Important
Do not configure the Server Pool settings:
Server Pools deprecated as of Ops Manager 4.0
As of Ops Manager 4.0, server pools are deprecated and disabled by default.
Update the following configuration keys:
Key | Change |
---|---|
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
serverPoolKey |
Set to the Server Pool Key. To find the server pool key, in the Admin menu, go to Server Pool view and click on the Agent Configuration tab. |
serverPoolPropertiesFile |
Set to the full filepath of a file that contains server properties. Ensure the Automation Agent can read the file. The properties file contains key/value pairs of the form
Note Ensure that the properties file contains the desired property names and values before starting the Automation Agent on the server. Once the server is registered with the pool, changes to the properties file do not take effect until the server is first removed and the Automation Agent restarted. |
serverPoolStateFile |
Set to the full filepath of the file to be used by the Automation Agent. Ensure that the directory path to the file exists and the agent has read and write access to the directory. The file itself need not exist; however, if it does exist, the agent must have read and write access to the file. |
The resulting changes to the local.config
file should
look like the following:
Optional: Configure the Automation Agent to use a proxy server.¶
To configure the agent to connect to Ops Manager via a proxy server, you must
specify the server in the httpProxy
environment variable. In the
<install-directory>/local.config
file, set the httpProxy
value to the URL of to
your proxy server:
Create the automation and data directories.¶
Create the following directories to store files that the Automation Agent needs:
Component | Default Directory | Description |
---|---|---|
Binaries | /var/lib/mongodb-mms-automation |
These are the binaries that the Automation Agent manages. They include the Backup Agent, Monitoring Agent, BI Connector, and MongoDB binaries. |
Automation Agent logs | /var/log/mongodb-mms-automation |
These are the log files that the Automation Agent creates. |
MongoDB databases | /data |
These are the databases that the Automation Agent creates and manages. |
Run these commands to create the directories:
Using a Different Path than /var/lib
By default, the Agent binaries and Ops Manager
configuration backup file are located in
/var/lib/mongodb-mms-automation
.
If you want to store these files in a different
directory, follow these procedures:
To change the location of the Agent Binaries:
Click Deployment, then Agents, and then Downloads & Settings.
Below the Download Directory heading, click the pencil icon to the right of the path shown in Download Directory (Linux/MacOS).
Change the path to the new path you want.
Click Save.
Create the new directory you specified on each host that runs an Agent.
To change the location of the Agent configuration backup:
Open the Agent configuration file in your preferred text editor.
Change the
mmsConfigBackup
setting to the new path for the configuration backup file.Save the Agent configuration file.
Move the configuration backup file to the new directory.
Start the Automation Agent.¶
From the directory in which you installed the Automation Agent and as the system user you created in the last step, issue the following command:
Upgrade the Automation Agent in Ops Manager.¶
After you have updated the Automation Agent, Ops Manager recognizes that the updated Agent does not match the version specified in the Automation Configuration. Ops Manager displays a banner informing you that one or more agents are out of date. Click Update All Agents to make Ops Manager update the Automation Configuration and complete the upgrade.
Click Review & Deploy to review your changes.¶
Ops Manager displays your proposed changes.
- If you are satisfied, click Confirm & Deploy.
- If you want to make further configuration changes, click Cancel. Click Modify for the cluster to make additional changes.
For RHEL / CentOS (7.x) on PowerPC architecture (managing MongoDB 3.4 or later deployments only):
Log in the host where the Automation Agent is installed.¶
Stop any currently running Automation Agents.¶
Issue the following command on the MongoDB host:
Log in to the Ops Manager Application.¶
Click Deployment, then Agents, and then Downloads & Settings.¶
Select the Linux distribution for your Agent host.¶
Click RHEL/CentOS 7.X, SUSE12 - TAR
Click RHEL/CentOS 7.X Power (ppc64le) - TAR
Click Ubuntu 16.X Power (ppc64le) - TAR
Click Other Linux - TAR
Download the latest version of the Automation Agent archive.¶
From a system shell on the host that will run the
Automation Agent, issue a curl
command to download the
archive for your platform:
Note
Replace <OpsManagerHost>:<Port>
with the hostname and port of
your Ops Manager Application.
Extract the Automation Agent.¶
You can install the Automation Agent in any directory. If you want to move the archive to another directory before extracting, you may do so.
To install the agent, extract the archive:
When the command completes, the Automation Agent is installed.
Change to the extracted binary directory.¶
Change into the directory that was created after extracting the Automation Agent binary:
Edit the local.config
file.¶
In the directory where you installed the Automation Agent, open the
local.config
file in your preferred text editor.
The changes you make depend whether or not you are using server pools.
- Projects
- Server Pools
Update the following configuration keys:
Key | Change |
---|---|
mmsGroupId |
Set to your ProjectID . |
mmsApiKey |
Set to the project’s agent API key. |
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
The resulting changes to the local.config
file should
look like the following:
Important
Do not configure the Server Pool settings:
Server Pools deprecated as of Ops Manager 4.0
As of Ops Manager 4.0, server pools are deprecated and disabled by default.
Update the following configuration keys:
Key | Change |
---|---|
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
serverPoolKey |
Set to the Server Pool Key. To find the server pool key, in the Admin menu, go to Server Pool view and click on the Agent Configuration tab. |
serverPoolPropertiesFile |
Set to the full filepath of a file that contains server properties. Ensure the Automation Agent can read the file. The properties file contains key/value pairs of the form
Note Ensure that the properties file contains the desired property names and values before starting the Automation Agent on the server. Once the server is registered with the pool, changes to the properties file do not take effect until the server is first removed and the Automation Agent restarted. |
serverPoolStateFile |
Set to the full filepath of the file to be used by the Automation Agent. Ensure that the directory path to the file exists and the agent has read and write access to the directory. The file itself need not exist; however, if it does exist, the agent must have read and write access to the file. |
The resulting changes to the local.config
file should
look like the following:
Optional: Configure the Automation Agent to use a proxy server.¶
To configure the agent to connect to Ops Manager via a proxy server, you must
specify the server in the httpProxy
environment variable. In the
<install-directory>/local.config
file, set the httpProxy
value to the URL of to
your proxy server:
Create the automation and data directories.¶
Create the following directories to store files that the Automation Agent needs:
Component | Default Directory | Description |
---|---|---|
Binaries | /var/lib/mongodb-mms-automation |
These are the binaries that the Automation Agent manages. They include the Backup Agent, Monitoring Agent, BI Connector, and MongoDB binaries. |
Automation Agent logs | /var/log/mongodb-mms-automation |
These are the log files that the Automation Agent creates. |
MongoDB databases | /data |
These are the databases that the Automation Agent creates and manages. |
Run these commands to create the directories:
Using a Different Path than /var/lib
By default, the Agent binaries and Ops Manager
configuration backup file are located in
/var/lib/mongodb-mms-automation
.
If you want to store these files in a different
directory, follow these procedures:
To change the location of the Agent Binaries:
Click Deployment, then Agents, and then Downloads & Settings.
Below the Download Directory heading, click the pencil icon to the right of the path shown in Download Directory (Linux/MacOS).
Change the path to the new path you want.
Click Save.
Create the new directory you specified on each host that runs an Agent.
To change the location of the Agent configuration backup:
Open the Agent configuration file in your preferred text editor.
Change the
mmsConfigBackup
setting to the new path for the configuration backup file.Save the Agent configuration file.
Move the configuration backup file to the new directory.
Start the Automation Agent.¶
From the directory in which you installed the Automation Agent and as the system user you created in the last step, issue the following command:
Upgrade the Automation Agent in Ops Manager.¶
After you have updated the Automation Agent, Ops Manager recognizes that the updated Agent does not match the version specified in the Automation Configuration. Ops Manager displays a banner informing you that one or more agents are out of date. Click Update All Agents to make Ops Manager update the Automation Configuration and complete the upgrade.
Click Review & Deploy to review your changes.¶
Ops Manager displays your proposed changes.
- If you are satisfied, click Confirm & Deploy.
- If you want to make further configuration changes, click Cancel. Click Modify for the cluster to make additional changes.
For Ubuntu (16.04) on PowerPC architecture (managing MongoDB 3.4 or later deployments only):
Log in the host where the Automation Agent is installed.¶
Stop any currently running Automation Agents.¶
Issue the following command on the MongoDB host:
Log in to the Ops Manager Application.¶
Click Deployment, then Agents, and then Downloads & Settings.¶
Select the Linux distribution for your Agent host.¶
Click RHEL/CentOS 7.X, SUSE12 - TAR
Click RHEL/CentOS 7.X Power (ppc64le) - TAR
Click Ubuntu 16.X Power (ppc64le) - TAR
Click Other Linux - TAR
Download the latest version of the Automation Agent archive.¶
From a system shell on the host that will run the
Automation Agent, issue a curl
command to download the
archive for your platform:
Note
Replace <OpsManagerHost>:<Port>
with the hostname and port of
your Ops Manager Application.
Extract the Automation Agent.¶
You can install the Automation Agent in any directory. If you want to move the archive to another directory before extracting, you may do so.
To install the agent, extract the archive:
When the command completes, the Automation Agent is installed.
Change to the extracted binary directory.¶
Change into the directory that was created after extracting the Automation Agent binary:
Edit the local.config
file.¶
In the directory where you installed the Automation Agent, open the
local.config
file in your preferred text editor.
The changes you make depend whether or not you are using server pools.
- Projects
- Server Pools
Update the following configuration keys:
Key | Change |
---|---|
mmsGroupId |
Set to your ProjectID . |
mmsApiKey |
Set to the project’s agent API key. |
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
The resulting changes to the local.config
file should
look like the following:
Important
Do not configure the Server Pool settings:
Server Pools deprecated as of Ops Manager 4.0
As of Ops Manager 4.0, server pools are deprecated and disabled by default.
Update the following configuration keys:
Key | Change |
---|---|
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
serverPoolKey |
Set to the Server Pool Key. To find the server pool key, in the Admin menu, go to Server Pool view and click on the Agent Configuration tab. |
serverPoolPropertiesFile |
Set to the full filepath of a file that contains server properties. Ensure the Automation Agent can read the file. The properties file contains key/value pairs of the form
Note Ensure that the properties file contains the desired property names and values before starting the Automation Agent on the server. Once the server is registered with the pool, changes to the properties file do not take effect until the server is first removed and the Automation Agent restarted. |
serverPoolStateFile |
Set to the full filepath of the file to be used by the Automation Agent. Ensure that the directory path to the file exists and the agent has read and write access to the directory. The file itself need not exist; however, if it does exist, the agent must have read and write access to the file. |
The resulting changes to the local.config
file should
look like the following:
Optional: Configure the Automation Agent to use a proxy server.¶
To configure the agent to connect to Ops Manager via a proxy server, you must
specify the server in the httpProxy
environment variable. In the
<install-directory>/local.config
file, set the httpProxy
value to the URL of to
your proxy server:
Create the automation and data directories.¶
Create the following directories to store files that the Automation Agent needs:
Component | Default Directory | Description |
---|---|---|
Binaries | /var/lib/mongodb-mms-automation |
These are the binaries that the Automation Agent manages. They include the Backup Agent, Monitoring Agent, BI Connector, and MongoDB binaries. |
Automation Agent logs | /var/log/mongodb-mms-automation |
These are the log files that the Automation Agent creates. |
MongoDB databases | /data |
These are the databases that the Automation Agent creates and manages. |
Run these commands to create the directories:
Using a Different Path than /var/lib
By default, the Agent binaries and Ops Manager
configuration backup file are located in
/var/lib/mongodb-mms-automation
.
If you want to store these files in a different
directory, follow these procedures:
To change the location of the Agent Binaries:
Click Deployment, then Agents, and then Downloads & Settings.
Below the Download Directory heading, click the pencil icon to the right of the path shown in Download Directory (Linux/MacOS).
Change the path to the new path you want.
Click Save.
Create the new directory you specified on each host that runs an Agent.
To change the location of the Agent configuration backup:
Open the Agent configuration file in your preferred text editor.
Change the
mmsConfigBackup
setting to the new path for the configuration backup file.Save the Agent configuration file.
Move the configuration backup file to the new directory.
Start the Automation Agent.¶
From the directory in which you installed the Automation Agent and as the system user you created in the last step, issue the following command:
Upgrade the Automation Agent in Ops Manager.¶
After you have updated the Automation Agent, Ops Manager recognizes that the updated Agent does not match the version specified in the Automation Configuration. Ops Manager displays a banner informing you that one or more agents are out of date. Click Update All Agents to make Ops Manager update the Automation Configuration and complete the upgrade.
Click Review & Deploy to review your changes.¶
Ops Manager displays your proposed changes.
- If you are satisfied, click Confirm & Deploy.
- If you want to make further configuration changes, click Cancel. Click Modify for the cluster to make additional changes.
For all other Linux distributions:
Log in the host where the Automation Agent is installed.¶
Stop any currently running Automation Agents.¶
Issue the following command on the MongoDB host:
Log in to the Ops Manager Application.¶
Click Deployment, then Agents, and then Downloads & Settings.¶
Select the Linux distribution for your Agent host.¶
Click RHEL/CentOS 7.X, SUSE12 - TAR
Click RHEL/CentOS 7.X Power (ppc64le) - TAR
Click Ubuntu 16.X Power (ppc64le) - TAR
Click Other Linux - TAR
Download the latest version of the Automation Agent archive.¶
From a system shell on the host that will run the
Automation Agent, issue a curl
command to download the
archive for your platform:
Note
Replace <OpsManagerHost>:<Port>
with the hostname and port of
your Ops Manager Application.
Extract the Automation Agent.¶
You can install the Automation Agent in any directory. If you want to move the archive to another directory before extracting, you may do so.
To install the agent, extract the archive:
When the command completes, the Automation Agent is installed.
Change to the extracted binary directory.¶
Change into the directory that was created after extracting the Automation Agent binary:
Edit the local.config
file.¶
In the directory where you installed the Automation Agent, open the
local.config
file in your preferred text editor.
The changes you make depend whether or not you are using server pools.
- Projects
- Server Pools
Update the following configuration keys:
Key | Change |
---|---|
mmsGroupId |
Set to your ProjectID . |
mmsApiKey |
Set to the project’s agent API key. |
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
The resulting changes to the local.config
file should
look like the following:
Important
Do not configure the Server Pool settings:
Server Pools deprecated as of Ops Manager 4.0
As of Ops Manager 4.0, server pools are deprecated and disabled by default.
Update the following configuration keys:
Key | Change |
---|---|
mmsBaseUrl |
Set to the URL of the Ops Manager Application. Include the port number. |
serverPoolKey |
Set to the Server Pool Key. To find the server pool key, in the Admin menu, go to Server Pool view and click on the Agent Configuration tab. |
serverPoolPropertiesFile |
Set to the full filepath of a file that contains server properties. Ensure the Automation Agent can read the file. The properties file contains key/value pairs of the form
Note Ensure that the properties file contains the desired property names and values before starting the Automation Agent on the server. Once the server is registered with the pool, changes to the properties file do not take effect until the server is first removed and the Automation Agent restarted. |
serverPoolStateFile |
Set to the full filepath of the file to be used by the Automation Agent. Ensure that the directory path to the file exists and the agent has read and write access to the directory. The file itself need not exist; however, if it does exist, the agent must have read and write access to the file. |
The resulting changes to the local.config
file should
look like the following:
Optional: Configure the Automation Agent to use a proxy server.¶
To configure the agent to connect to Ops Manager via a proxy server, you must
specify the server in the httpProxy
environment variable. In the
<install-directory>/local.config
file, set the httpProxy
value to the URL of to
your proxy server:
Create the automation and data directories.¶
Create the following directories to store files that the Automation Agent needs:
Component | Default Directory | Description |
---|---|---|
Binaries | /var/lib/mongodb-mms-automation |
These are the binaries that the Automation Agent manages. They include the Backup Agent, Monitoring Agent, BI Connector, and MongoDB binaries. |
Automation Agent logs | /var/log/mongodb-mms-automation |
These are the log files that the Automation Agent creates. |
MongoDB databases | /data |
These are the databases that the Automation Agent creates and manages. |
Run these commands to create the directories:
Using a Different Path than /var/lib
By default, the Agent binaries and Ops Manager
configuration backup file are located in
/var/lib/mongodb-mms-automation
.
If you want to store these files in a different
directory, follow these procedures:
To change the location of the Agent Binaries:
Click Deployment, then Agents, and then Downloads & Settings.
Below the Download Directory heading, click the pencil icon to the right of the path shown in Download Directory (Linux/MacOS).
Change the path to the new path you want.
Click Save.
Create the new directory you specified on each host that runs an Agent.
To change the location of the Agent configuration backup:
Open the Agent configuration file in your preferred text editor.
Change the
mmsConfigBackup
setting to the new path for the configuration backup file.Save the Agent configuration file.
Move the configuration backup file to the new directory.
Start the Automation Agent.¶
From the directory in which you installed the Automation Agent and as the system user you created in the last step, issue the following command:
Upgrade the Automation Agent in Ops Manager.¶
After you have updated the Automation Agent, Ops Manager recognizes that the updated Agent does not match the version specified in the Automation Configuration. Ops Manager displays a banner informing you that one or more agents are out of date. Click Update All Agents to make Ops Manager update the Automation Configuration and complete the upgrade.
Click Review & Deploy to review your changes.¶
Ops Manager displays your proposed changes.
- If you are satisfied, click Confirm & Deploy.
- If you want to make further configuration changes, click Cancel. Click Modify for the cluster to make additional changes.