.\" Man page generated from reStructuredText.

.

.TH "MONGOOPLOG" "1" "January 30, 2015" "3.0" "mongodb-manual"

.SH NAME

mongooplog \- MongoDB Oplog Utility

.

.nr rst2man-indent-level 0

.

.de1 rstReportMargin

\\$1 \\n[an-margin]

level \\n[rst2man-indent-level]

level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]

-

\\n[rst2man-indent0]

\\n[rst2man-indent1]

\\n[rst2man-indent2]

..

.de1 INDENT

.\" .rstReportMargin pre:

. RS \\$1

. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]

. nr rst2man-indent-level +1

.\" .rstReportMargin post:

..

.de UNINDENT

. RE

.\" indent \\n[an-margin]

.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]

.nr rst2man-indent-level -1

.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]

.in \\n[rst2man-indent\\n[rst2man-indent-level]]u

..

.sp

New in version 2.2.

.SH SYNOPSIS

.sp

\fBmongooplog\fP is a simple tool that polls operations from

the \fIreplication\fP \fIoplog\fP of a remote server, and applies

them to the local server. This capability supports certain classes of

real\-time migrations that require that the source server remain online

and in operation throughout the migration process.

.sp

Typically this command will take the following form:

.INDENT 0.0

.INDENT 3.5

.sp

.nf

.ft C

mongooplog  \-\-from mongodb0.example.net \-\-host mongodb1.example.net

.ft P

.fi

.UNINDENT

.UNINDENT

.sp

This command copies oplog entries from the \fBmongod\fP instance

running on the host \fBmongodb0.example.net\fP and duplicates

operations to the host \fBmongodb1.example.net\fP\&. If you do not need

to keep the \fI\-\-from\fP host running during

the migration, consider using \fBmongodump\fP and

\fBmongorestore\fP or another \fBbackup\fP operation, which may be better suited to

your operation.

.sp

\fBNOTE:\fP

.INDENT 0.0

.INDENT 3.5

If the \fBmongod\fP instance specified by the \fI\-\-from\fP

argument is running with \fBauthentication\fP, then

\fBmongooplog\fP will not be able to copy oplog entries.

.UNINDENT

.UNINDENT

.sp

\fBSEE ALSO:\fP

.INDENT 0.0

.INDENT 3.5

\fBmongodump\fP, \fBmongorestore\fP,

http://docs.mongodb.org/manual/core/backups, http://docs.mongodb.org/manual/core/replica\-set\-oplog\&.

.UNINDENT

.UNINDENT

.SH OPTIONS

.sp

Changed in version 3.0.0: \fBmongooplog\fP removed the \fB\-\-dbpath\fP as well as related

\fB\-\-directoryperdb\fP and \fB\-\-journal\fP options. You must use

\fBmongooplog\fP while connected to a \fBmongod\fP instance.

.INDENT 0.0

.TP

.B mongooplog

.UNINDENT

.INDENT 0.0

.TP

.B mongooplog

.UNINDENT

.INDENT 0.0

.TP

.B \-\-help

Returns information on the options and use of \fBmongooplog\fP\&.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-verbose, \-v

Increases the amount of internal reporting returned on standard output

or in log files. Increase the verbosity with the \fB\-v\fP form by

including the option multiple times, (e.g. \fB\-vvvvv\fP\&.)

.UNINDENT

.INDENT 0.0

.TP

.B \-\-quiet

Runs the \fBmongooplog\fP in a quiet mode that attempts to limit the amount

of output.

.sp

This option suppresses:

.INDENT 7.0

.IP \(bu 2

connection accepted events

.IP \(bu 2

connection closed events

.UNINDENT

.UNINDENT

.INDENT 0.0

.TP

.B \-\-version

Returns the \fBmongooplog\fP release number.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-host <hostname><:port>, \-h <hostname><:port>

Specifies a resolvable hostname for the \fBmongod\fP instance to

which \fBmongooplog\fP will apply \fIoplog\fP operations

retrieved from the server specified by the \fI\-\-from\fP option.

.sp

By default \fBmongooplog\fP attempts to connect to a MongoDB instance running

on the localhost on port number \fB27017\fP\&.

.sp

To connect to a replica set, specify the \fBreplica set name\fP and a seed list of set members. Use the

following form:

.INDENT 7.0

.INDENT 3.5

.sp

.nf

.ft C

<replSetName>/<hostname1><:port>,<hostname2><:port>,<...>

.ft P

.fi

.UNINDENT

.UNINDENT

.sp

You can always connect directly to a single MongoDB instance by

specifying the host and port number directly.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-port

Specifies the port number of the \fBmongod\fP instance where

\fBmongooplog\fP will apply \fIoplog\fP entries. Specify

this option only if the MongoDB instance to connect to is not

running on the standard port of \fB27017\fP\&. You may also specify a

port number using the \fI\-\-host\fP command.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-ipv6

Enables IPv6 support and allows the \fBmongooplog\fP to connect to the

MongoDB instance using an IPv6 network. All MongoDB programs and

processes disable IPv6 support by default.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-ssl

New in version 2.6.

.sp

Enables connection to a \fBmongod\fP or \fBmongos\fP that has

SSL support enabled.

.sp

The default distribution of MongoDB does not contain support for SSL.

For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-sslCAFile <filename>

New in version 2.6.

.sp

Specifies the \fB\&.pem\fP file that contains the root certificate chain

from the Certificate Authority. Specify the file name of the

\fB\&.pem\fP file using relative or absolute paths.

.sp

The default distribution of MongoDB does not contain support for SSL.

For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&.

.sp

\fBWARNING:\fP

.INDENT 7.0

.INDENT 3.5

If the \fBmongo\fP shell or any other tool that connects to

\fBmongos\fP or \fBmongod\fP is run without

\fI\-\-sslCAFile\fP, it will not attempt to validate

server certificates. This results in vulnerability to expired

\fBmongod\fP and \fBmongos\fP certificates as well as to foreign

processes posing as valid \fBmongod\fP or \fBmongos\fP

instances. Ensure that you \fIalways\fP specify the CA file against which

server certificates should be validated in cases where intrusion is a

possibility.

.UNINDENT

.UNINDENT

.UNINDENT

.INDENT 0.0

.TP

.B \-\-sslPEMKeyFile <filename>

New in version 2.6.

.sp

Specifies the \fB\&.pem\fP file that contains both the SSL certificate

and key. Specify the file name of the \fB\&.pem\fP file using relative

or absolute paths.

.sp

This option is required when using the \fI\-\-ssl\fP option to connect

to a \fBmongod\fP or \fBmongos\fP that has

\fBCAFile\fP enabled \fIwithout\fP

\fBallowConnectionsWithoutCertificates\fP\&.

.sp

The default distribution of MongoDB does not contain support for SSL.

For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-sslPEMKeyPassword <value>

New in version 2.6.

.sp

Specifies the password to de\-crypt the certificate\-key file (i.e.

\fI\-\-sslPEMKeyFile\fP). Use the \fI\-\-sslPEMKeyPassword\fP option only if the

certificate\-key file is encrypted. In all cases, the \fBmongooplog\fP will

redact the password from all logging and reporting output.

.sp

If the private key in the PEM file is encrypted and you do not specify

the \fI\-\-sslPEMKeyPassword\fP option, the \fBmongooplog\fP will prompt for a passphrase. See

\fIssl\-certificate\-password\fP\&.

.sp

The default distribution of MongoDB does not contain support for SSL.

For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-sslCRLFile <filename>

New in version 2.6.

.sp

Specifies the \fB\&.pem\fP file that contains the Certificate Revocation

List. Specify the file name of the \fB\&.pem\fP file using relative or

absolute paths.

.sp

The default distribution of MongoDB does not contain support for SSL.

For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-sslAllowInvalidCertificates

New in version 2.6.

.sp

Bypasses the validation checks for server certificates and allows

the use of invalid certificates. When using the

\fBallowInvalidCertificates\fP setting, MongoDB logs as a

warning the use of the invalid certificate.

.sp

The default distribution of MongoDB does not contain support for SSL.

For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-sslAllowInvalidHostnames

New in version 3.0.

.sp

Disables the validation of the hostnames in SSL certificates. Allows

\fBmongooplog\fP to connect to MongoDB instances if the hostname their

certificates do not match the specified hostname.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-sslFIPSMode

New in version 2.6.

.sp

Directs the \fBmongooplog\fP to use the FIPS mode of the installed OpenSSL

library. Your system must have a FIPS compliant OpenSSL library to use

the \fI\-\-sslFIPSMode\fP option.

.sp

\fBNOTE:\fP

.INDENT 7.0

.INDENT 3.5

FIPS Compatible SSL is

available only in \fI\%MongoDB Enterprise\fP\&. See

http://docs.mongodb.org/manual/tutorial/configure\-fips for more information.

.UNINDENT

.UNINDENT

.UNINDENT

.INDENT 0.0

.TP

.B \-\-username <username>, \-u <username>

Specifies a username with which to authenticate to a MongoDB database

that uses authentication. Use in conjunction with the \fB\-\-password\fP and

\fB\-\-authenticationDatabase\fP options.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-password <password>, \-p <password>

Specifies a password with which to authenticate to a MongoDB database

that uses authentication. Use in conjunction with the \fB\-\-username\fP and

\fB\-\-authenticationDatabase\fP options.

.sp

If you do not specify an argument for \fI\-\-password\fP, \fBmongooplog\fP will

prompt interactively for a password on the console.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-authenticationDatabase <dbname>

New in version 2.4.

.sp

Specifies the database that holds the user\(aqs credentials.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-authenticationMechanism <name>

\fIDefault\fP: MONGODB\-CR

.sp

New in version 2.4.

.sp

Changed in version 2.6: Added support for the \fBPLAIN\fP and \fBMONGODB\-X509\fP authentication

mechanisms.

.sp

Specifies the authentication mechanism the \fBmongooplog\fP instance uses to

authenticate to the \fBmongod\fP or \fBmongos\fP\&.

.TS

center;

|l|l|.

_

T{

Value

T}	T{

Description

T}

_

T{

MONGODB\-CR

T}	T{

MongoDB challenge/response authentication.

T}

_

T{

MONGODB\-X509

T}	T{

MongoDB SSL certificate authentication.

T}

_

T{

PLAIN

T}	T{

External authentication using LDAP. You can also use \fBPLAIN\fP

for authenticating in\-database users. \fBPLAIN\fP transmits

passwords in plain text. This mechanism is available only in

\fI\%MongoDB Enterprise\fP\&.

T}

_

T{

GSSAPI

T}	T{

External authentication using Kerberos. This mechanism is

available only in \fI\%MongoDB Enterprise\fP\&.

T}

_

.TE

.UNINDENT

.INDENT 0.0

.TP

.B \-\-gssapiServiceName

New in version 2.6.

.sp

Specify the name of the service using \fBGSSAPI/Kerberos\fP\&. Only required if the service does not use the

default name of \fBmongodb\fP\&.

.sp

This option is available only in MongoDB Enterprise.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-gssapiHostName

New in version 2.6.

.sp

Specify the hostname of a service using \fBGSSAPI/Kerberos\fP\&. \fIOnly\fP required if the hostname of a machine does

not match the hostname resolved by DNS.

.sp

This option is available only in MongoDB Enterprise.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-db <database>, \-d <database>

Specifies the name of the database on which to run the \fBmongooplog\fP\&.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-collection <collection>, \-c <collection>

Specifies the collection to export.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-seconds <number>, \-s <number>

Specify a number of seconds of operations for \fBmongooplog\fP to

pull from the \fIremote host\fP\&. Unless

specified the default value is \fB86400\fP seconds, or 24 hours.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-from <host[:port]>

Specify the host for \fBmongooplog\fP to retrieve \fIoplog\fP

operations from. \fBmongooplog\fP \fIrequires\fP this option.

.sp

Unless you specify the \fI\-\-host\fP option,

\fBmongooplog\fP will apply the operations collected with this

option to the oplog of the \fBmongod\fP instance running on the

localhost interface connected to port \fB27017\fP\&.

.UNINDENT

.INDENT 0.0

.TP

.B \-\-oplogns <namespace>

Specify a namespace in the \fI\-\-from\fP host

where the oplog resides. The default value is \fBlocal.oplog.rs\fP, which

is the where \fIreplica set\fP members store their operation log.

However, if you\(aqve copied \fIoplog\fP entries into another

database or collection or are pulling oplog entries from a

\fBmaster\-slave\fP deployment, use \fI\%\-\-oplogns\fP to

apply oplog entries stored in another location. Namespaces take the

form of \fB[database].[collection]\fP\&.

.UNINDENT

.SH USE

.sp

Consider the following prototype \fBmongooplog\fP command:

.INDENT 0.0

.INDENT 3.5

.sp

.nf

.ft C

mongooplog  \-\-from mongodb0.example.net \-\-host mongodb1.example.net

.ft P

.fi

.UNINDENT

.UNINDENT

.sp

Here, entries from the \fIoplog\fP of the \fBmongod\fP running

on port \fB27017\fP\&. This only pull entries from the last 24 hours.

.sp

Use the \fI\-\-seconds\fP argument to capture

a greater or smaller amount of time. Consider the following example:

.INDENT 0.0

.INDENT 3.5

.sp

.nf

.ft C

mongooplog  \-\-from mongodb0.example.net \-\-seconds 172800

.ft P

.fi

.UNINDENT

.UNINDENT

.sp

In this operation, \fBmongooplog\fP captures 2 full days of

operations. To migrate 12 hours of \fIoplog\fP entries, use the

following form:

.INDENT 0.0

.INDENT 3.5

.sp

.nf

.ft C

mongooplog  \-\-from mongodb0.example.net \-\-seconds 43200

.ft P

.fi

.UNINDENT

.UNINDENT

.SH AUTHOR

MongoDB Documentation Project

.SH COPYRIGHT

2011-2015

.\" Generated by docutils manpage writer.

.