/
mongos.exe.txt
114 lines (72 loc) · 3.19 KB
/
mongos.exe.txt
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
.. default-domain:: mongodb
.. binary:: mongos.exe
.. program:: mongos.exe
==============
``mongos.exe``
==============
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Synopsis
--------
:binary:`mongos.exe` is the build of the MongoDB Shard
(i.e. :binary:`~bin.mongos`) for the Windows
platform. :binary:`mongos.exe` has all of the features of
:binary:`~bin.mongos` on Unix-like platforms and is completely compatible
with the other builds of :binary:`~bin.mongos`. In addition,
:binary:`mongos.exe` provides several options for interacting with
the Windows platform itself.
This document only references options that are unique to
:binary:`mongos.exe`. All :binary:`~bin.mongos` options are
available. See the :doc:`/reference/program/mongos` and the
:doc:`/reference/configuration-options` documents for more
information regarding :binary:`mongos.exe`.
To install and use :binary:`mongos.exe`, read the
:doc:`/tutorial/install-mongodb-on-windows` document.
Options
-------
.. option:: --install
Installs :program:`mongos.exe` as a Windows Service and exits.
If needed, you can install services for multiple instances of
:program:`mongos.exe`. Install each service with a unique :option:`--serviceName`
and :option:`--serviceDisplayName`. Use multiple instances only when
sufficient system resources exist and your system design requires it.
.. option:: --remove
Removes the :program:`mongos.exe` Windows Service. If :program:`mongos.exe` is
running, this operation will stop and then remove the service.
:option:`--remove` requires the :option:`--serviceName` if you
configured a non-default :option:`--serviceName` during the
:option:`--install` operation.
.. option:: --reinstall
Removes :program:`mongos.exe` and reinstalls :program:`mongos.exe`
as a Windows Service.
.. option:: --serviceName name
*Default*: MongoS
Sets the service name of :program:`mongos.exe` when running as a
Windows Service. Use this name with the ``net start <name>`` and
``net stop <name>`` operations.
You must use :option:`--serviceName` in conjunction with either
the :option:`--install` or :option:`--remove` option.
.. option:: --serviceDisplayName <name>
*Default*: Mongo DB Router
Sets the name listed for MongoDB on the Services administrative
application.
.. option:: --serviceDescription <description>
*Default*: Mongo DB Sharding Router
Sets the :program:`mongos.exe` service description.
You must use :option:`--serviceDescription` in conjunction with the
:option:`--install` option.
For descriptions that contain spaces, you must enclose the
description in quotes.
.. option:: --serviceUser <user>
Runs the :program:`mongos.exe` service in the context of a certain user. This
user must have "Log on as a service" privileges.
You must use :option:`--serviceUser` in conjunction with the
:option:`--install` option.
.. option:: --servicePassword <password>
Sets the password for ``<user>`` for :program:`mongos.exe` when running with
the :option:`--serviceUser` option.
You must use :option:`--servicePassword` in conjunction with the
:option:`--install` option.