1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
|
.\" Man page generated from reStructuredText.
.
.TH "MONGOS" "1" "March 18, 2014" "2.6" "mongodb-manual"
.SH NAME
mongos \- MongoDB Sharded Cluster Query Router
.
.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
..
.SH SYNOPSIS
.sp
\fBmongos\fP for "MongoDB Shard," is a routing service for
MongoDB shard configurations that processes queries from the
application layer, and determines the location of this data in the
\fIsharded cluster\fP, in order to complete these operations.
From the perspective of the application, a
\fBmongos\fP instance behaves identically to any other MongoDB
instance.
.SH OPTIONS
.SS Core Options
.INDENT 0.0
.TP
.B mongos
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help, \-h
Returns information on \fBmongos\fP options and usage.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-version
Returns the \fBmongos\fP release number.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-config <filename>, \-f
Specifies a configuration file for runtime configuration options. The
configuration file is the preferred method for runtime configuration of
\fBmongos\fP\&. The options are equivalent to the command\-line
configuration options. See http://docs.mongodb.org/manual/reference/configuration\-options for
more information.
.sp
Ensure the configuration file uses ASCII encoding. \fBmongos\fP does not
support configuration files with non\-ASCII encoding, including UTF\-8.
.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 \fBmongos\fP in a quiet mode that attempts to limit the amount of
output. This option suppresses:
.INDENT 7.0
.IP \(bu 2
output from \fIdatabase commands\fP
.IP \(bu 2
replication activity
.IP \(bu 2
connection accepted events
.IP \(bu 2
connection closed events
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-port <port>
Specifies the port number when the MongoDB instance is not running on the
standard port of \fB27017\fP\&. You may also specify the port number
using the \fB\-\-host\fP option.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-bind_ip <ip address>
Specifies the IP address that the \fBmongos\fP process binds to and
listens for connections on. By default \fBmongos\fP listens for
connections for all interfaces. You may attach \fBmongos\fP to any
interface. When attaching \fBmongos\fP to a publicly accessible
interface, ensure that you have implemented proper authentication and
firewall restrictions to protect the integrity of your database.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-maxConns <number>
Specifies the maximum number of simultaneous connections that
\fBmongos\fP will accept. This setting will have no effect if the
value of this setting is higher than your operating system\(aqs configured
maximum connection tracking threshold.
.sp
This setting is particularly useful for \fBmongos\fP if you have a
client that creates a number of collections but allows them to timeout
rather than close the collections. When you set \fBmaxConns\fP,
ensure the value is slightly higher than the size of the connection pool
or the total number of connections to prevent erroneous connection
spikes from propagating to the members of a \fIsharded cluster\fP\&.
.sp
Changed in version 2.6: MongoDB removed the upward limit on the \fBmaxConns\fP setting.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-syslog
Sends all logging output to the host\(aqs \fIsyslog\fP system rather
than to standard output or a log file as with \fI\%\-\-logpath\fP\&.
.sp
\fI\%\-\-syslog\fP is not supported on Windows.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-syslogFacility <string>
Specifies the facility level used when logging messages to syslog. The
default is \fBuser\fP\&. The value you specify must be supported by your
operating system\(aqs implementation of syslog. To use this option, you
must enable the \fI\%\-\-syslog\fP option.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-logpath <path>
Specifies the path for the log file that holds all diagnostic
logging information.
.sp
Unless specified, \fBmongos\fP will output all log information
to the standard output. Additionally, unless you also specify
\fI\%\-\-logappend\fP, the logfile will be overwritten when the
process restarts.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The behavior of the logging system may change in the near
future in response to the \fI\%SERVER\-4499\fP case.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-logappend
Appends new entries to the end of the logfile when the \fBmongos\fP restarts
instead of overwriting the content of the log.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-timeStampFormat <string>
Specifies the time format for timestamps in log messages. Specify one of
the following values:
.TS
center;
|l|l|.
_
T{
Value
T} T{
Description
T}
_
T{
\fBctime\fP
T} T{
Displays timestamps as \fBWed Dec 31
18:17:54.811\fP\&.
T}
_
T{
\fBiso8601\-utc\fP
T} T{
Displays timestamps in Coordinated Universal Time (UTC) in the
ISO\-8601 format. For example, for New York at the start of the
Epoch: \fB1970\-01\-01T00:00:00.000Z\fP
T}
_
T{
\fBiso8601\-local\fP
T} T{
Default value. Displays timestamps in local time in the ISO\-8601
format. For example, for New York at the start of the Epoch:
\fB1969\-12\-31T19:00:00.000+0500\fP
T}
_
.TE
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pidfilepath <path>
Specifies a file location to hold the "\fIPID\fP" or process ID of the
\fBmongos\fP process. Useful for tracking the \fBmongos\fP process in
combination with the \fI\%\-\-fork\fP option.
.sp
Without a specified \fI\%\-\-pidfilepath\fP option, \fBmongos\fP
creates no PID file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-keyFile <file>
Specifies the path to a key file to store authentication
information. This option is used for interprocess authentication among
the \fBmongos\fP and \fBmongod\fP instances of a
\fIsharded cluster\fP or \fIreplica set\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-setParameter <options>
New in version 2.4.
.sp
Specifies an option to configure on startup. Specify multiple options
with multiple \fI\%\-\-setParameter\fP options. See
http://docs.mongodb.org/manual/reference/parameters for full documentation of these parameters.
The \fBsetParameter\fP database command provides access to many
of these parameters. \fI\%\-\-setParameter\fP supports the following
options:
.INDENT 7.0
.IP \(bu 2
\fBenableLocalhostAuthBypass\fP
.IP \(bu 2
\fBenableTestCommands\fP
.IP \(bu 2
\fBlogLevel\fP
.IP \(bu 2
\fBlogUserIds\fP
.IP \(bu 2
\fBnotablescan\fP
.IP \(bu 2
\fBquiet\fP
.IP \(bu 2
\fBsupportCompatibilityFormPrivilegeDocuments\fP
.IP \(bu 2
\fBsyncdelay\fP
.IP \(bu 2
\fBtextSearchEnabled\fP
.IP \(bu 2
\fBuserCacheInvalidationIntervalSecs\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-httpinterface
New in version 2.6.
.sp
Enables the HTTP interface. Enabling the interface can increase
network exposure.
.sp
Leave the HTTP interface \fIdisabled\fP for production deployments. If you
\fIdo\fP enable this interface, you should only allow trusted clients to
access this port. See \fIsecurity\-firewalls\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
In MongoDB Enterprise, the HTTP Console does not support Kerberos
Authentication.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-clusterAuthMode <option>
New in version 2.6.
.sp
Enables \fIinternal x.509 authentication\fP for membership to the cluster or replica
set. The \fI\%\-\-clusterAuthMode\fP option can have one of the
following values:
.TS
center;
|l|l|.
_
T{
Value
T} T{
Description
T}
_
T{
\fBkeyFile\fP
T} T{
Default value. Use keyfile for authentication.
T}
_
T{
\fBsendKeyFile\fP
T} T{
For rolling upgrade purposes. Send the keyfile for
authentication but can accept either keyfile or x.509
certificate.
T}
_
T{
\fBsendX509\fP
T} T{
For rolling upgrade purposes. Send the x.509 certificate for
authentication but can accept either keyfile or x.509
certificate.
T}
_
T{
\fBx509\fP
T} T{
Recommended. Send the x.509 certificate for authentication and
accept \fBonly\fP x.509 certificate.
T}
_
.TE
.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 \-\-nounixsocket
Disables listening on the UNIX socket. \fBmongos\fP always
listens on the UNIX socket, unless either: \fI\%\-\-nounixsocket\fP
is set, \fBbind_ip\fP is not set, or \fBbind_ip\fP
does not specify \fB127.0.0.1\fP\&.
.sp
New in version 2.6: \fBmongos\fP installed from official \fB\&.deb\fP and \fB\&.rpm\fP packages
have the \fBbind_ip\fP configuration set to \fB127.0.0.1\fP by
default.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-unixSocketPrefix <path>
Specifies a path for the UNIX socket. If this option has no
value, \fBmongos\fP creates a socket with \fB/tmp\fP as a prefix.
.sp
MongoDB will always create and listen on a UNIX socket, unless
\fI\%\-\-nounixsocket\fP is set, \fBbind_ip\fP is not set,
or \fBbind_ip\fP does not specify \fB127.0.0.1\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-fork
Enables a \fIdaemon\fP mode for \fBmongos\fP that runs the
process in the background. This is the normal mode of operation in
production and production\-like environments but may not be
desirable for testing.
.UNINDENT
.SS Sharded Cluster Options
.INDENT 0.0
.TP
.B \-\-configdb <config1>,<config2>,<config3>
Specifies the \fIconfiguration database\fP for the
\fIsharded cluster\fP\&. You must specify either 1 or 3 configuration
servers, in a comma separated list.
.sp
All \fBmongos\fP instances \fBmust\fP specify the hosts in the
\fI\%\-\-configdb\fP setting in the in the same order.
.sp
If your configuration databases reside in more that one data center,
order the hosts so that the config database that is closest to the
majority of your \fBmongos\fP instances is first servers in the
list.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Never remove a config server from this setting, even if the config
server is not available or offline.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-localThreshold
Affects the logic that \fBmongos\fP uses when selecting
\fIreplica set\fP members to pass read operations to from clients.
Specify a value in milliseconds. The default value is \fB15\fP, which
corresponds to the default value in all of the client \fBdrivers\fP\&.
.sp
When \fBmongos\fP receives a request that permits reads to
\fIsecondary\fP members, the \fBmongos\fP will:
.INDENT 7.0
.IP \(bu 2
Find the member of the set with the lowest ping time.
.IP \(bu 2
Construct a list of replica set members that is within a ping time of
15 milliseconds of the nearest suitable member of the set.
.sp
If you specify a value for \fI\%\-\-localThreshold\fP,
\fBmongos\fP will construct the list of replica members that are
within the latency allowed by this value.
.IP \(bu 2
Select a member to read from at random from this list.
.UNINDENT
.sp
The ping time used for a member compared by the
\fI\%\-\-localThreshold\fP setting is a moving average of recent ping
times, calculated at most every 10 seconds. As a result, some queries
may reach members above the threshold until the \fBmongos\fP
recalculates the average.
.sp
See the \fIreplica\-set\-read\-preference\-behavior\-member\-selection\fP
section of the \fBread preference\fP
documentation for more information.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-upgrade
Updates the meta data format used by the \fIconfig database\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-chunkSize <value>
Determines the size in megabytes of each \fIchunk\fP in the
\fIsharded cluster\fP\&. The default value is 64 megabytes, which is the
ideal size for chunks in most deployments: larger chunk size can lead to
uneven data distribution; smaller chunk size can lead to inefficient
movement of chunks between nodes. However, in some circumstances it may
be necessary to set a different chunk size.
.sp
This option \fIonly\fP affects chunk size when you initialize the cluster
for the first time. If you later modify the option, the new value has no
effect. See the http://docs.mongodb.org/manual/tutorial/modify\-chunk\-size\-in\-sharded\-cluster
procedure if you need to change the chunk size on an existing sharded
cluster.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-noAutoSplit
Prevents \fBmongos\fP from automatically inserting metadata splits
in a \fIsharded collection\fP\&. If set on all
\fBmongos\fP instances, this prevents MongoDB from creating new
chunks as the data in a collection grows.
.sp
Because any \fBmongos\fP in a cluster can create a split, to
totally disable splitting in a cluster you must set
\fI\%\-\-noAutoSplit\fP on all \fBmongos\fP\&.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
With \fI\%\-\-noAutoSplit\fP enabled, the data in your sharded
cluster may become imbalanced over time. Enable with caution.
.UNINDENT
.UNINDENT
.UNINDENT
.SS SSL Options
.INDENT 0.0
.INDENT 3.5
.SS See
.sp
http://docs.mongodb.org/manual/tutorial/configure\-ssl for full
documentation of MongoDB\(aqs support.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-sslOnNormalPorts
Deprecated since version 2.6.
.sp
New in version 2.2.
.sp
Enables SSL so that \fBmongos\fP requires SSL encryption for all
connections on the default MongoDB port or port specified by
\fI\-\-port\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 \-\-sslMode <mode>
New in version 2.6.
.sp
Enables SSL or mixed SSL on a port. The argument to the
\fI\%\-\-sslMode\fP option can be one of the following:
.TS
center;
|l|l|.
_
T{
Value
T} T{
Description
T}
_
T{
\fBdisabled\fP
T} T{
The server does not use SSL.
T}
_
T{
\fBallowSSL\fP
T} T{
Connections between servers do not use SSL. For incoming
connections, the server accepts both SSL and non\-SSL.
T}
_
T{
\fBpreferSSL\fP
T} T{
Connections between servers use SSL. For incoming
connections, the server accepts both SSL and non\-SSL.
T}
_
T{
\fBrequireSSL\fP
T} T{
The server uses and accepts only SSL encrypted connections.
T}
_
.TE
.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 \-\-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
\fBsslCAFile\fP enabled \fIwithout\fP
\fBsslWeakCertificateValidation\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 \fI\-\-sslPEMKeyPassword\fP only if
the certificate\-key file is encrypted. In all cases, \fBmongos\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
\fI\-\-sslPEMKeyPassword\fP, \fBmongos\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 \-\-sslClusterFile <filename>
New in version 2.6.
.sp
Specifies the \fB\&.pem\fP file that contains the x.509 certificate\-key
file for \fImembership authentication\fP
for the cluster or replica set.
.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 \-\-sslClusterPassword <value>
New in version 2.6.
.sp
Specifies the password to de\-crypt the x.509 certificate\-key file
specified with \fI\%\-\-sslClusterFile\fP\&. Use
\fI\%\-\-sslClusterPassword\fP only if the certificate\-key file is
encrypted. In all cases, \fBmongos\fP will redact the password from all
logging and reporting output.
.sp
Changed in version 2.6: If the x.509 key file is encrypted and you do
not specify \fI\%\-\-sslClusterPassword\fP, \fBmongos\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 \-\-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\&.
.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 \-\-sslWeakCertificateValidation
New in version 2.4.
.sp
Disables the requirement for SSL certificate validation that
\fI\-\-sslCAFile\fP enables. With
\fI\%\-\-sslWeakCertificateValidation\fP, \fBmongos\fP will accept
connections when the client does not present a certificate when
establishing the connection.
.sp
If the client presents a certificate and \fBmongos\fP has
\fI\%\-\-sslWeakCertificateValidation\fP enabled, \fBmongos\fP will
validate the certificate using the root certificate chain specified by
\fI\-\-sslCAFile\fP and reject clients with invalid certificates.
.sp
Use \fI\%\-\-sslWeakCertificateValidation\fP if you have a mixed
deployment that includes clients that do not or cannot present
certificates to \fBmongos\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 \-\-sslAllowInvalidCertificates
New in version 2.6.
.sp
Bypasses the validation checks for server certificates and allows
the use of invalid certificates. When using the
\fBsslAllowInvalidCertificates\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 \-\-sslFIPSMode
New in version 2.6.
.sp
Directs \fBmongos\fP to use the FIPS mode of the installed OpenSSL
library. Your system must
have a FIPS compliant OpenSSL library to use \fI\-\-sslFIPSMode\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
.SS Audit Options
.INDENT 0.0
.TP
.B \-\-auditDestination
Enables auditing. The \fI\%\-\-auditDestination\fP option can have one of
the following values:
.TS
center;
|l|l|.
_
T{
Value
T} T{
Description
T}
_
T{
\fBsyslog\fP
T} T{
Output the audit events to syslog in JSON format. Not available on
Windows. Audit messages have a syslog severity level of \fBinfo\fP
and a facility level of \fBuser\fP\&.
.sp
The syslog message limit can result in the truncation of the audit
messages. The auditing system will neither detect the truncation nor
error upon its occurrence.
T}
_
T{
\fBconsole\fP
T} T{
Output the audit events to \fBstdout\fP in JSON format.
T}
_
T{
\fBfile\fP
T} T{
Output the audit events to the file specified in
\fI\%\-\-auditPath\fP in the format specified in
\fI\%\-\-auditFormat\fP\&.
T}
_
.TE
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBaudit system\fP is
available only in \fI\%MongoDB Enterprise\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-auditFormat
Specifies the format of the output file if
\fI\%\-\-auditDestination\fP is \fBfile\fP\&. The
\fI\%\-\-auditFormat\fP can have one of the following values:
.TS
center;
|l|l|.
_
T{
Value
T} T{
Description
T}
_
T{
\fBJSON\fP
T} T{
Output the audit events in JSON format to the file specified
in \fI\%\-\-auditPath\fP\&.
T}
_
T{
\fBBSON\fP
T} T{
Output the audit events in BSON binary format to the file
specified in \fI\%\-\-auditPath\fP\&.
T}
_
.TE
.sp
Printing audit events to a file in JSON format degrades server
performance more than printing to a file in BSON format.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBaudit system\fP is
available only in \fI\%MongoDB Enterprise\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-auditPath
Specifies the output file for auditing if \fI\%\-\-auditDestination\fP
has value of \fBfile\fP\&. The \fI\%\-\-auditPath\fP option can take
either a full path name or a relative path name.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBaudit system\fP is
available only in \fI\%MongoDB Enterprise\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-auditFilter
Specifies the filter to limit the \fItypes of operations\fP the audit system records. The option
takes a document of the form:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{ atype: <expression> }
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For authentication operations, the option can also take a document of
the form:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
{ atype: <expression>, "param.db": <database> }
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fBaudit system\fP is
available only in \fI\%MongoDB Enterprise\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Additional Options
.INDENT 0.0
.TP
.B \-\-ipv6
Enables IPv6 support, which allows \fBmongos\fP to connect to the MongoDB
instance using an IPv6 network. All MongoDB programs and processes,
including \fBmongos\fP, disable IPv6 support by default.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-jsonp
Permits \fIJSONP\fP access via an HTTP interface. Consider the
security implications of allowing this activity before enabling this
option. If the HTTP interface is disabled, the \fI\%\-\-jsonp\fP also
enables the HTTP interface.
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
\fI\%\-\-httpinterface\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-noscripting
Disables the scripting engine.
.UNINDENT
.SH AUTHOR
MongoDB Documentation Project
.SH COPYRIGHT
2011-2014, MongoDB, Inc.
.\" Generated by docutils manpage writer.
.
|