mongocli ops-manager maintenanceWindow describe

On this page

Syntax

Arguments
Options
Output
Example

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 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.

Syntax

mongocli ops-manager|om maintenanceWindow describe <maintenance-window-id>
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]
     [ --projectId <project-ID> ]

Arguments

Argument	Type	Description	Required?
`<maintenance-window-id>`	string	Unique identifier of the maintenance window that you want to describe.	yes

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.

ID              PROJECT ID       START DATE       END DATE
<window-id>     <project-id>     <start-date>     <end-date>

Name	Type	Description
`id`	string	Unique identifier of the maintenance window.
`groupId`	string	Unique identifier of the project to which this maintenance window applies.
`created`	string	Timestamp in ISO 8601 date and time format in UTC when the maintenance window was created.
`updated`	string	Timestamp in ISO 8601 date and time format in UTC when the maintenance window was last updated.
`startDate`	string	Timestamp in ISO 8601 date and time format in UTC when the maintenance window starts.
`endDate`	string	Timestamp in ISO 8601 date and time format in UTC when the maintenance window ends.
`alertTypeNames`	array of strings	Alert types to silence during maintenance window. For example: `HOST`, `REPLICA_SET`, `CLUSTER`, `AGENT`, `BACKUP`
`description`	string	Description of the maintenance window. This field is returned only if you provided a description of the maintenance window.

Example

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"
}

Back

List Maintenance Windows

Update a Maintenance Window