Navigation

mongocli ops-manager maintenanceWindow describe

The maintenanceWindow describe command retrieves the configuration of one Ops Manager maintenance window for the specified project. You can also retrieve the configuration of a maintenance window through the API.

mongocli ops-manager|om maintenanceWindow describe <maintenance-window-id>
[ --output|-o <output-format> ]
[ --profile|-P <profile-name> ]
[ --projectId <project-ID> ]
Argument
Type
Description
Required?
<maintenance-window-id>
string
Unique identifier of the maintenance window that you want to describe.
yes
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 the 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

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.

The following example uses the mongocli om maintenanceWindow describe command to retrieve the configuration of the maintenance window with ID 5f7cb0eec902201990cb1506. It uses a profile called myOm and specifies JSON output.

mongocli om maintenanceWindow describe 5f7cb0eec902201990cb1506 \
-P myOm -o json

The above command produces the following output. For more information about these fields, see Output.

{
"id": "5f7cb0eec902201990cb1506",
"groupId": "5f1f39ffc902201990f53873",
"created": "2020-10-06T18:01:18Z",
"startDate": "2020-10-23T22:00:00Z",
"endDate": "2020-10-24T22:00:00Z",
"updated": "2020-10-06T18:05:29Z",
"alertTypeNames": [
"BACKUP",
"HOST"
],
"description": "One-day maintenance window"
}
Give Feedback

On this page

  • Syntax
  • Arguments
  • Options
  • Output
  • Example