Docs Menu
Docs Home
/
MongoDB Atlas
/
MongoDB Command Line Interface
/
Reference
/
Atlas
/
Maintenance Window

mongocli atlas maintenanceWindow defer

On this page

  • Syntax
  • Options
  • Output
  • Example

The maintenanceWindow defer command defers scheduled maintenance on an Atlas project for one week. You can also defer a maintenance window through the Atlas UI or API.

Important

Maintenance Window Considerations

Urgent Maintenance Activities
Urgent maintenance activities such as security patches cannot wait for your chosen window. Atlas will start those maintenance activities when needed.
Ongoing Maintenance Operations
Once maintenance is scheduled for your cluster, you cannot change your maintenance window until the current maintenance efforts have completed.
Maintenance Requires Replica Set Elections
Atlas performs maintenance the same way as the maintenance procedure described in the MongoDB Manual. This procedure requires at least one replica set election during the maintenance window per replica set.
Maintenance Starts As Close to the Hour As Possible
Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time.

Syntax

mongocli atlas maintenanceWindow defer
     [ --profile|-P <profile-name> ]
     [ --projectId <project-ID> ]

Note

If the specified project has no upcoming scheduled maintenance, this command returns an error.

Options

Option
Type
Description
Required?
--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

Maintenance window deferred.

Example

The following example uses the mongocli atlas maintenanceWindow defer command to defer scheduled maintenance for one week for the project specified in the default profile.

mongocli atlas maintenanceWindow defer

Back

Clear a Maintenance Window

Next

Metrics