Docs Menu
Docs Home
/
MongoDB Atlas
/
MongoDB Command Line Interface
/
Reference
/
Ops Manager
/
Clusters

mongocli ops-manager cluster apply

On this page

  • Syntax
  • Options
  • Output
  • Examples

The cluster apply command creates the cluster in the specified Ops Manager project if the cluster does not already exist or updates the cluster in the specified Ops Manager project if the cluster already exists. You can also:

  • Create a cluster through the Ops Manager UI, CLI, and Automation Configuration API,

  • Update a cluster through the the Ops Manager UI, CLI, and Automation Configuration API.

Syntax

mongocli ops-manager|om cluster apply
     --file|-f <om-settings-file>
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]
     [ --projectId <project-ID> ]

Note

Use -h or --help to view the command-line help for this command.

Options

Option
Type
Description
Required?
--file, -f
string
Path to the file that contains the settings for creating the cluster. To learn more about the configuration properties to specify in the file, see Cluster Configuration File.
yes
--output, -o
string

Command output format. Valid values are:

  • json for output in JSON format

  • go-template for custom output using the Go template

  • go-template-file for custom output specified using Go template file

If omitted, the command returns output in the default format.

no
--profile, -P
string
Name of the profile where the public and private keys for the project are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.
no
--projectId
string

Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable.

no

Output

The command prints output similar to the following to the terminal if the command succeeds. If the command returns errors, see Troubleshooting for recommended solutions.

Changes are being applied, please check http://<hostname>:<port>/v2/<projectId>#deployment/topology for status

where:

  • <hostname>:<port> is the Ops Manager base URL

  • projectId is the unique identifier of the project

Examples

The following examples show two ways to run the command.

Example 1

The following mongocli om cluster apply command deploys the settings in the file named om-cluster.yaml to the specified project. The command uses the default profile for the API access keys and project ID.

mongocli ops-manager cluster apply --file om-cluster.yaml

Example 2

The following mongocli ops-manager cluster apply command deploys the settings in the file named om-cluster.json to the cluster named myCluster. It uses the profile OMprofile for the API access keys.

mongocli ops-manager cluster apply --file om-cluster.json --projectId 5e33a17031cd7c007883e20d --profile OMprofile

Output

The Example 1 and Example 2 commands print the following to the terminal:

Changes are being applied, please check http://localhost:30700/v2/5e33a17031cd7c007883e20d#deployment/topology for status

Back

Modify a Cluster

Next

Start mongod Processes for a Cluster