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

mongocli atlas maintenanceWindow describe

On this page

  • Syntax
  • Options
  • Output
  • Example

The maintenanceWindow describe command retrieves the configuration of one Atlas maintenance window for the specified project. You can also view the configuration of 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 describe|get
     [ --output| -o ]
     [ --profile|-P <profile-name> ]
     [ --projectId <project-ID> ]

Options

Option
Type
Description
Required?
--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 the following fields in the specified format to the terminal if the command succeeds. If the command prints an error, see Troubleshooting for recommended solutions.

DAY OF THE WEEK   HOUR OF DAY   START ASAP
<number>          <number>      <boolean>
Field
Type
Description
dayOfWeek
number

Day of the week that you want the maintenance window to start, as a 1-based integer.

Day of Week
Integer
Sunday
1
Monday
2
Tuesday
3
Wednesday
4
Thursday
5
Friday
6
Saturday
7
hourOfDay
number
Hour of the day that you want the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0 and noon is 12.
startASAP
boolean

Flag indicates that you want maintenance to start immediately upon receiving this request.

To use startASAP : true, you need to have scheduled maintenance and set your own maintenance window.

After you set startASAP : true, the project's maintenance starts immediately. startASAP resets to false after Atlas completes maintenance.

Example

The following example uses the mongocli atlas maintenanceWindow describe command to retrieve the maintenance window configured for the project specified in the default profile. It produces output in the default format.

mongocli atlas maintenanceWindow describe

The previous command prints the following fields in the specified format to the terminal. To learn more about these fields, see Output.

DAY OF THE WEEK   HOUR OF DAY   START ASAP
5                 15            false

Back

Maintenance Window

Next

Update a Maintenance Window