summaryrefslogtreecommitdiff
path: root/src/mongo/db/server_options_general.idl
blob: 53e303f3aa90921726f70cc1db28d7393edd6513 (plain)
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
# Copyright (C) 2019-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#

global:
    cpp_namespace: "mongo"
    cpp_includes:
        - "mongo/db/server_options.h"
        - "mongo/db/server_options_base.h"
    configs:
        section: 'General options'
        source: [ cli, ini, yaml ]
        initializer:
            register: addGeneralServerOptionDefinitions

configs:
    help:
        description: 'Show this usage information'
        single_name: h
        arg_vartype: Switch
        source: [ cli, ini ]
    version:
        description: 'Show version information'
        arg_vartype: Switch
        source: [ cli, ini ]
    config:
        description: 'Configuration file specifying additional options'
        single_name: f
        arg_vartype: String
        source: [ cli, ini ]
    outputConfig:
        description: 'Display the resolved configuration and exit'
        arg_vartype: Switch
        source: cli
        hidden: true
    configExpand:
        description: 'Process expansion directives in config file (none, exec, rest)'
        arg_vartype: String
        source: cli
    configExpandTimeoutSecs:
        description: >-
            Maximum number of seconds to wait for a single configuration expansion to resolve
        arg_vartype: Int
        source: cli
        hidden: true
        default: 30

    'net.port':
        description:
            expr: 'ServerGlobalParams::getPortSettingHelpText()'
            is_constexpr: false
        short_name: port
        arg_vartype: Int
    'net.ipv6':
        description: 'Enable IPv6 support (disabled by default)'
        short_name: ipv6
        arg_vartype: Switch
    'net.listenBacklog':
        description: 'Set socket listen backlog size'
        short_name: listenBacklog
        arg_vartype: Int
        default: { expr: 'SOMAXCONN' }
    'net.maxIncomingConnections':
        description: 'Max number of simultaneous connections'
        short_name: maxConns
        arg_vartype: Int
        default: { expr: 'static_cast<int>(DEFAULT_MAX_CONN)' }
    'net.maxIncomingConnectionsOverride':
        description: 'CIDR ranges that are exempt from the maxIncomingConnections limit'
        arg_vartype: StringVector
        source: yaml
        hidden: true
    'net.reservedAdminThreads':
        description: 'Number of worker threads to reserve for admin and internal connections'
        arg_vartype: Int
        source: yaml
        hidden: true
    'net.transportLayer':
        description: 'Sets the ingress transport layer implementation'
        short_name: transportLayer
        arg_vartype: String
        default: asio
        hidden: true
    'processManagement.pidFilePath':
        description: 'Full path to pidfile (if not set, no pidfile is created)'
        short_name: pidfilepath
        arg_vartype: String
    'processManagement.timeZoneInfo':
        description: 'Full path to time zone info directory, e.g. /usr/share/zoneinfo'
        short_name: timeZoneInfo
        arg_vartype: String

    nounixsocket:
        description: 'Disable listening on unix sockets'
        arg_vartype: Switch
        source: [ cli, ini ]
        condition:
            preprocessor: '!defined(_WIN32)'
    'net.unixDomainSocket.enabled':
        description: 'Disable listening on unix sockets'
        arg_vartype: Bool
        source: yaml
        condition:
            preprocessor: '!defined(_WIN32)'
    'net.unixDomainSocket.pathPrefix':
        short_name: unixSocketPrefix
        description: 'Alternative directory for UNIX domain sockets (defaults to /tmp)'
        arg_vartype: String
        condition:
            preprocessor: '!defined(_WIN32)'
    'net.unixDomainSocket.filePermissions':
        description:
            expr: 'getUnixDomainSocketFilePermissionsHelpText()'
            is_constexpr: false
        short_name: filePermissions
        arg_vartype: Int
        condition:
            preprocessor: '!defined(_WIN32)'
    'processManagement.fork':
        description: 'Fork server process'
        short_name: fork
        arg_vartype: Switch
        condition:
            preprocessor: '!defined(_WIN32)'

    objcheck:
        description: 'Inspect client data for validity on receipt (DEFAULT)'
        arg_vartype: Switch
        source: [ cli, ini ]
        conflicts: noobjcheck
        hidden: true
    noobjcheck:
        description: 'Do NOT inspect client data for validity on receipt'
        arg_vartype: Switch
        source: [ cli, ini ]
        conflicts: objcheck
        hidden: true
    'net.wireObjectCheck':
        description: 'Inspect client data for validity on receipt (DEFAULT)'
        arg_vartype: Bool
        source: yaml
        hidden: true
    crashOnInvalidBSONError:
        description: "Crashes the shell if invalid BSON is returned from a call to the server. Must be paired with objcheck to provoke a BSON validation check."
        arg_vartype: Switch
        source: [ cli, ini ]
        hidden: true
    enableExperimentalStorageDetailsCmd:
        description: 'EXPERIMENTAL (UNSUPPORTED). Enable command computing aggregate statistics on storage.'
        arg_vartype: Switch
        source: [ cli, ini ]
        hidden: true