mongocli atlas maintenanceWindow clear
This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoCLI.
The maintenanceWindow clear command removes the
maintenance window
for the specified Atlas project. You can also remove 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 clear|rm|delete [ --force ] [ --profile|-P <profile-name> ] [ --projectId <project-ID> ]
Options
Option | Type | Description | Required? |
|---|---|---|---|
--force | Flag that indicates that the maintenance window can be removed without
requiring confirmation. | 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
Maintenance window removed.
Example
The following example uses the mongocli atlas maintenanceWindow
clear command to remove the maintenance window configured for the
project specified in the default profile.
mongocli atlas maintenanceWindow clear