Docs Menu

shutdown

On this page

  • Behavior
  • Access Control
  • Examples
shutdown

The shutdown command cleans up all database resources and then terminates the process. You must issue the shutdown command against the admin database.

The command has the following syntax:

db.adminCommand({
shutdown: 1,
force: <boolean>
timeoutSecs: <int>,
comment: <any>
})

The command takes the following optional field:

Field
Description

Specify 1.

Optional. Specify true to force the mongod to shut down. Force shutdown interrupts any ongoing operations on the mongod and may result in unexpected behavior.

Optional. The number of seconds the primary should wait for a secondary to catch up. Defaults to 10.

If no secondaries catch up within the specified time, the command fails.

comment

Optional. A user-provided comment to attach to this command. Once set, this comment appears alongside records of this command in the following locations:

A comment can be any valid BSON type (string, integer, object, array, etc).

New in version 4.4.

Tip
See also:

For a mongod started with Authentication, you must run shutdown over an authenticated connection. See Access Control for more information.

For a mongod started without Authentication, you must run shutdown from a client connected to the localhost interface. For example, run a mongo with the --host "127.0.0.1" option on the same host machine as the mongod.

shutdown fails if the replica set member is running certain operations such as index builds. You can specify force: true to force the member to interrupt those operations and shut down.

If running shutdown against the replica set primary, the operation implicitly uses replSetStepDown to step down the primary before shutting down the mongod. If no secondary in the replica set can catch up to the primary within 10 seconds, the shutdown operation fails. You can issue shutdown with force: true to shut down the primary even if the step down fails.

Warning

Force shutdown of the primary can result in the rollback of any writes not yet replicated to a secondary.

To run shutdown on a mongod enforcing Authentication, the authenticated user must have the shutdown privilege. For example, a user with the built-in role hostManager has the appropriate permissions.

db.adminCommand({ "shutdown" : 1 })
db.adminCommand({ "shutdown" : 1, "force" : true })
db.adminCommand({ "shutdown" : 1, timeoutSecs: 60 })
Give Feedback
© 2021 MongoDB, Inc.

About

  • Careers
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.