mongos(1) General Commands Manual mongos(1) MONGOS SYNOPSIS For a sharded cluster, the mongos instances provide the interface between the client applications and the sharded cluster. The mongos instances route queries and write operations to the shards. From the perspective of the ap- plication, a mongos instance behaves identically to any other MongoDB in- stance. CONSIDERATIONS * Never change the name of the mongos binary. * MongoDB disables support for TLS 1.0 encryption on systems where TLS 1.1+ is available. * The mongos binary cannot connect to mongod instances whose feature compatibility version (fCV) is greater than that of the mongos. For example, you cannot connect a MongoDB 5.0 version mongos to a 7.0 sharded cluster with fCV set to 7.0. You can, however, connect a MongoDB 5.0 version mongos to a 7.0 sharded cluster with fCV set to 5.0. * mongod includes a Full Time Diagnostic Data Capture mechanism to assist MongoDB engineers with troubleshooting deployments. If this thread fails, it terminates the originating process. To avoid the most common failures, confirm that the user running the process has permissions to create the FTDC diagnostic.data directory. For mongod the directory is within storage.dbPath. For mongos it is parallel to systemLog.path. OPTIONS Configuration File Settings and Command-Line Options Mapping * MongoDB deprecates the SSL options and instead adds new corre- sponding TLS options. * MongoDB adds --tlsClusterCAFile/net.tls.clusterCAFile. * MongoDB 5.0 removes the --serviceExecutor command-line option and the corresponding net.serviceExecutor configuration option. CORE OPTIONS mongos --help, mongos -h Returns information on the options and use of mongos. mongos --version Returns the mongos release number. mongos --config, mongos -f Specifies a configuration file for runtime configuration options. The configuration file is the preferred method for runtime configu- ration of mongos. The options are equivalent to the command-line configuration options. See Configuration File Options for more in- formation. Ensure the configuration file uses ASCII encoding. The mongos in- stance does not support configuration files with non-ASCII encoding, including UTF-8. mongos --configExpand Default: none Enables using Expansion Directives in configuration files. Expansion directives allow you to set externally sourced values for configura- tion file options. --configExpand supports the following expansion directives: * * Value * Description * * none * Default. mongos does not expand expansion directives. mongos fails to start if any configuration file set- tings use expansion directives. * * rest * mongos expands __rest expansion directives when parsing the configuration file. * * exec * mongos expands __exec expansion directives when parsing the configuration file. You can specify multiple expansion directives as a comma-separated list, for example: rest, exec. If the configuration file contains expansion directives not specified to --configExpand, the mongos re- turns an error and terminates. See Externally Sourced Configuration File Values for configuration files for more information on expansion directives. mongos --verbose, mongos -v Increases the amount of internal reporting returned on standard out- put or in log files. Increase the verbosity with the -v form by in- cluding the option multiple times, for example: -vvvvv. mongos --quiet Runs mongos in a quiet mode that attempts to limit the amount of output. This option suppresses: * output from database commands * replication activity * connection accepted events * connection closed events mongos --port Default: 27017 The TCP port on which the mongos instance listens for client connec- tions. The --port option accepts a range of values between 0 and 65535. Setting the port to 0 configures mongos to use an arbitrary port as- signed by the operating system. mongos --bind_ip Default: localhost The hostnames and/or IP addresses and/or full Unix domain socket paths on which mongos should listen for client connections. You may attach mongos to any interface. To bind to multiple addresses, enter a list of comma-separated values. You can specify both IPv4 and IPv6 addresses, or hostnames that re- solve to an IPv4 or IPv6 address. If specifying an IPv6 address or a hostname that resolves to an IPv6 address to --bind_ip, you must start mongos with --ipv6 to enable IPv6 support. Specifying an IPv6 address to --bind_ip does not en- able IPv6 support. If specifying a link-local IPv6 address (https://en.wikipedia.org/wiki/Link-local_address#IPv6) (fe80::/10), you must append the zone index (https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_ad- dresses_(with_zone_index)) to that address (i.e. fe80::<ad- dress>%<adapter-name>). To avoid configuration updates due to IP address changes, use DNS hostnames instead of IP addresses. It is particularly important to use a DNS hostname instead of an IP address when configuring replica set members or sharded cluster members. Use hostnames instead of IP addresses to configure clusters across a split network horizon. Starting in MongoDB 5.0, nodes that are only configured with an IP address fail startup validation and do not start. Before you bind your instance to a publicly-accessible IP address, you must secure your cluster from unauthorized access. For a com- plete list of security recommendations, see Security Checklist. At minimum, consider enabling authentication and hardening network in- frastructure. For more information about IP Binding, refer to the IP Binding docu- mentation. To bind to all IPv4 addresses, enter 0.0.0.0. To bind to all IPv4 and IPv6 addresses, enter ::,0.0.0.0 or an as- terisk "*" (enclose the asterisk in quotes to avoid filename pattern expansion). Alternatively, use the net.bindIpAll setting. * --bind_ip and --bind_ip_all are mutually exclusive. Speci- fying both options causes mongos to throw an error and ter- minate. * The command-line option --bind overrides the configuration file setting net.bindIp. mongos --bind_ip_all If specified, the mongos instance binds to all IPv4 addresses (i.e. 0.0.0.0). If mongos starts with --ipv6, --bind_ip_all also binds to all IPv6 addresses (i.e. ::). mongos only supports IPv6 if started with --ipv6. Specifying --bind_ip_all alone does not enable IPv6 support. Before you bind your instance to a publicly-accessible IP address, you must secure your cluster from unauthorized access. For a com- plete list of security recommendations, see Security Checklist. At minimum, consider enabling authentication and hardening network in- frastructure. For more information about IP Binding, refer to the IP Binding docu- mentation. Alternatively, you can set the --bind_ip option to ::,0.0.0.0 or to an asterisk "*" (enclose the asterisk in quotes to avoid filename pattern expansion). --bind_ip and --bind_ip_all are mutually exclusive. That is, you can specify one or the other, but not both. mongos --listenBacklog Default: Target system SOMAXCONN constant The maximum number of connections that can exist in the listen queue. Consult your local system's documentation to understand the limita- tions and configuration requirements before using this parameter. To prevent undefined behavior, specify a value for this parameter between 1 and the local system SOMAXCONN constant. The default value for the listenBacklog parameter is set at compile time to the target system SOMAXCONN constant. SOMAXCONN is the max- imum valid value that is documented for the backlog parameter to the listen system call. Some systems may interpret SOMAXCONN symbolically, and others numer- ically. The actual listen backlog applied in practice may differ from any numeric interpretation of the SOMAXCONN constant or argu- ment to --listenBacklog, and may also be constrained by system set- tings like net.core.somaxconn on Linux. Passing a value for the listenBacklog parameter that exceeds the SO- MAXCONN constant for the local system is, by the letter of the stan- dards, undefined behavior. Higher values may be silently integer truncated, may be ignored, may cause unexpected resource consump- tion, or have other adverse consequences. On systems with workloads that exhibit connection spikes, for which it is empirically known that the local system can honor higher val- ues for the backlog parameter than the SOMAXCONN constant, setting the listenBacklog parameter to a higher value may reduce operation latency as observed by the client by reducing the number of connec- tions which are forced into a backoff state. mongos --maxConns The maximum number of simultaneous connections that mongos accepts. This setting has no effect if it is higher than your operating sys- tem's configured maximum connection tracking threshold. Do not assign too low of a value to this option, or you will en- counter errors during normal application operation. This is particularly useful for a mongos if you have a client that creates multiple connections and allows them to timeout rather than closing them. In this case, set maxIncomingConnections to a value slightly higher than the maximum number of connections that the client creates, or the maximum size of the connection pool. This setting prevents the mongos from causing connection spikes on the individual shards. Spikes like these may disrupt the operation and memory allocation of the sharded cluster. mongos --logpath Sends all diagnostic logging information to a log file instead of to standard output or to the host's syslog system. MongoDB creates the log file at the path you specify. By default, MongoDB will move any existing log file rather than overwrite it. To instead append to the log file, set the --logappend option. mongos --syslog Sends all logging output to the host's syslog system rather than to standard output or to a log file (--logpath). The --syslog option is not supported on Windows. The syslog daemon generates timestamps when it logs a message, not when MongoDB issues the message. This can lead to misleading time- stamps for log entries, especially when the system is under heavy load. We recommend using the --logpath option for production systems to ensure accurate timestamps. MongoDB includes the component in its log messages to syslog. ... ACCESS [repl writer worker 5] Unsupported modification to roles collection ... mongos --syslogFacility Default: user Specifies the facility level used when logging messages to syslog. The value you specify must be supported by your operating system's implementation of syslog. To use this option, you must enable the --syslog option. mongos --logappend Appends new entries to the end of the existing log file when the mongos instance restarts. Without this option, mongod will back up the existing log and create a new file. mongos --logRotate Default: rename Determines the behavior for the logRotate command when rotating the server log and/or the audit log. Specify either rename or reopen: * rename renames the log file. * reopen closes and reopens the log file following the typi- cal Linux/Unix log rotate behavior. Use reopen when using the Linux/Unix logrotate utility to avoid log loss. If you specify reopen, you must also use --logappend. mongos --redactClientLogData Available in MongoDB Enterprise only. A mongos running with --redactClientLogData redacts any message ac- companying a given log event before logging. This prevents the mon- gos from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs. Use --redactClientLogData in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. For example, a MongoDB deployment might store Personally Identifi- able Information (PII) in one or more collections. The mongos logs events such as those related to CRUD operations, sharding metadata, etc. It is possible that the mongos may expose PII as a part of these logging operations. A mongos running with --redactClientLog- Data removes any message accompanying these events before being out- put to the log, effectively removing the PII. Diagnostics on a mongos running with --redactClientLogData may be more difficult due to the lack of data related to a log event. See the process logging manual page for an example of the effect of --redactClientLogData on log output. On a running mongos, use setParameter with the redactClientLogData parameter to configure this setting. mongos --timeStampFormat Default: iso8601-local The time format for timestamps in log messages. Specify one of the following values: * * Value * Description * * iso8601-utc * Displays timestamps in Coordinated Universal Time (UTC) in the ISO-8601 format. For example, for New York at the start of the Epoch: 1970-01-01T00:00:00.000Z * * iso8601-local * Displays timestamps in local time in the ISO-8601 for- mat. For example, for New York at the start of the Epoch: 1969-12-31T19:00:00.000-05:00 --timeStampFormat no longer supports ctime. An example of ctime for- matted date is: Wed Dec 31 18:17:54.811. mongos --pidfilepath Specifies a file location to store the process ID (PID) of the mon- gos process. The user running the mongod or mongos process must be able to write to this path. If the --pidfilepath option is not spec- ified, the process does not create a PID file. This option is gener- ally only useful in combination with the --fork option. On Linux, PID file management is generally the responsibility of your distro's init system: usually a service file in the /etc/init.d directory, or a systemd unit file registered with systemctl. Only use the --pidfilepath option if you are not using one of these init systems. For more information, please see the respective Installa- tion Guide for your operating system. On macOS, PID file management is generally handled by brew. Only use the --pidfilepath option if you are not using brew on your macOS system. For more information, please see the respective Installa- tion Guide for your operating system. mongos --keyFile Specifies the path to a key file that stores the shared secret that MongoDB instances use to authenticate to each other in a sharded cluster or replica set. --keyFile implies client authorization. See Internal/Membership Authentication for more information. Keyfiles for internal membership authentication use YAML format to allow for multiple keys in a keyfile. The YAML format accepts ei- ther: * A single key string (same as in earlier versions) * A sequence of key strings The YAML format is compatible with the existing single-key keyfiles that use the text file format. mongos --setParameter Specifies one of the MongoDB parameters described in MongoDB Server Parameters. You can specify multiple setParameter fields. mongos --noscripting Disables the scripting engine. When disabled, you cannot use opera- tions that perform server-side execution of JavaScript code, such as the $where query operator, mapReduce command, $accumulator, and $function. If you do not use these operations, disable server-side scripting. mongos --nounixsocket Disables listening on the UNIX domain socket. --nounixsocket applies only to Unix-based systems. The mongos process always listens on the UNIX socket unless one of the following is true: * --nounixsocket is set * net.bindIp is not set * net.bindIp does not specify localhost or its associated IP address mongos installed from official .deb and .rpm packages have the bind_ip configuration set to 127.0.0.1 by default. mongos --unixSocketPrefix Default: /tmp The path for the UNIX socket. --unixSocketPrefix applies only to Unix-based systems. If this option has no value, the mongos process creates a socket with /tmp as a prefix. MongoDB creates and listens on a UNIX socket unless one of the following is true: * net.unixDomainSocket.enabled is false * --nounixsocket is set * net.bindIp is not set * net.bindIp does not specify localhost or its associated IP address mongos --filePermissions Default: 0700 Sets the permission for the UNIX domain socket file. --filePermissions applies only to Unix-based systems. mongos --fork Enables a daemon mode that runs the mongos process in the back- ground. The --fork option is not supported on Windows. By default mongos does not run as a daemon. You run mongos as a dae- mon by using either --fork or a controlling process that handles daemonization, such as upstart or systemd. Using the --fork option requires that you configure log output for the mongos with one of the following: * --logpath * --syslog mongos --transitionToAuth Allows the mongos to accept and create authenticated and non-authen- ticated connections to and from other mongod and mongos instances in the deployment. Used for performing rolling transition of replica sets or sharded clusters from a no-auth configuration to internal authentication. Requires specifying a internal authentication mecha- nism such as --keyFile. For example, if using keyfiles for internal authentication, the mon- gos creates an authenticated connection with any mongod or mongos in the deployment using a matching keyfile. If the security mechanisms do not match, the mongos utilizes a non-authenticated connection in- stead. A mongos running with --transitionToAuth does not enforce user ac- cess controls. Users may connect to your deployment without any ac- cess control checks and perform read, write, and administrative op- erations. A mongos running with internal authentication and without --transi- tionToAuth requires clients to connect using user access controls. Update clients to connect to the mongos using the appropriate user prior to restarting mongos without --transitionToAuth. mongos --networkMessageCompressors Default: snappy,zstd,zlib Specifies the default compressor(s) to use for communication between this mongos instance and: * other members of the sharded cluster * mongosh * drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors: * snappy * zlib * zstd Both mongod and mongos instances default to snappy,zstd,zlib com- pressors, in that order. To disable network compression, set the value to disabled. Messages are compressed when both parties enable network compres- sion. Otherwise, messages between the parties are uncompressed. If you specify multiple compressors, then the order in which you list the compressors matter as well as the communication initiator. For example, if mongosh specifies the following network compressors zlib,snappy and the mongod specifies snappy,zlib, messages between mongosh and mongod uses zlib. If the parties do not share at least one common compressor, messages between the parties are uncompressed. For example, if mongosh speci- fies the network compressor zlib and mongod specifies snappy, mes- sages between mongosh and mongod are not compressed. mongos --timeZoneInfo The full path from which to load the time zone database. If this op- tion is not provided, then MongoDB uses its built-in time zone data- base. The configuration file included with Linux and macOS packages sets the time zone database path to /usr/share/zoneinfo by default. The built-in time zone database is a copy of the Olson/IANA time zone database (https://www.iana.org/time-zones). It is updated along with MongoDB releases, but the time zone database release cycle dif- fers from the MongoDB release cycle. The most recent release of the time zone database is available on our download site (https://down- loads.mongodb.org/olson_tz_db/timezonedb-latest.zip). wget https://downloads.mongodb.org/olson_tz_db/timezonedb-latest.zip unzip timezonedb-latest.zip mongos --timeZoneInfo timezonedb-2017b/ MongoDB uses the third party timelib (https://github.com/der- ickr/timelib) library to provide accurate conversions between time- zones. Due to a recent update, timelib could create inaccurate time zone conversions in older versions of MongoDB. To explicitly link to the time zone database in versions of MongoDB prior to 5.0, download the time zone database (https://down- loads.mongodb.org/olson_tz_db/timezonedb-latest.zip). and use the timeZoneInfo parameter. mongos --outputConfig Outputs the mongos instance's configuration options, formatted in YAML, to stdout and exits the mongos instance. For configuration op- tions that uses Externally Sourced Configuration File Values, --out- putConfig returns the resolved value for those options. This may include any configured passwords or secrets previously ob- fuscated through the external source. For usage examples, see: * Output the Configuration File with Resolved Expansion Di- rective Values * Convert Command-Line Options to YAML SHARDED CLUSTER OPTIONS mongos --configdb Specifies the configuration servers for the sharded cluster. Config servers for sharded clusters are deployed as a replica set. The replica set config servers must run the WiredTiger storage en- gine. Specify the config server replica set name and the hostname and port of at least one of the members of the config server replica set. sharding: configDB: <configReplSetName>/cfg1.example.net:27019, cfg2.example.net:27019,... The mongos instances for the sharded cluster must specify the same config server replica set name but can specify hostname and port of different members of the replica set. mongos --localThreshold Default: 15 Specifies the ping time, in milliseconds, that mongos uses to deter- mine which secondary replica set members to pass read operations from clients. The default value of 15 corresponds to the default value in all of the client drivers (https://www.mon- godb.com/docs/drivers/). When mongos receives a request that permits reads to secondary mem- bers, it: * Finds the member of the set with the lowest ping time. * Constructs a list of replica set members that is within a ping time of 15 milliseconds of the nearest suitable member of the set. If you specify a value for the --localThreshold option, mongos constructs the list of replica members that are within the latency allowed by this value. * Selects a member to read from at random from this list. The ping time used for a member compared by the --localThreshold 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 mongos recalculates the average. See the Read Preference for Replica Sets section of the read prefer- ence documentation for more information. TLS OPTIONS Configure mongod and mongos for TLS/SSL for full documentation of MongoDB's support. mongos --tlsMode Enables TLS used for all network connections. The argument to the --tlsMode option can be one of the following: * * Value * Description * * disabled * The server does not use TLS. * * allowTLS * Connections between servers do not use TLS. For incom- ing connections, the server accepts both TLS and non-TLS. * * preferTLS * Connections between servers use TLS. For incoming con- nections, the server accepts both TLS and non-TLS. * * requireTLS * The server uses and accepts only TLS encrypted connec- tions. If --tlsCAFile or tls.CAFile is not specified and you are not using x.509 authentication, you must set the tlsUseSystemCA parameter to true. This makes MongoDB use the system-wide CA certificate store when connecting to a TLS-enabled server. If using x.509 authentication, --tlsCAFile or tls.CAFile must be specified unless using --tlsCertificateSelector. For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients . mongos --tlsCertificateKeyFile On macOS or Windows, you can use a certificate from the operating system's secure store instead of specifying a PEM file. See --tlsCertificateSelector. Specifies the .pem file that contains both the TLS certificate and key. * On Linux/BSD, you must specify --tlsCertificateKeyFile when TLS is enabled. * On Windows or macOS, you must specify either --tlsCertifi- cateKeyFile or --tlsCertificateSelector when TLS is en- abled. For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients . mongos --tlsCertificateKeyFilePassword Specifies the password to decrypt the certificate-key file (i.e. --tlsCertificateKeyFile). Use the --tlsCertificateKeyFilePassword option only if the certificate-key file is encrypted. In all cases, the mongos redacts the password from all logging and reporting out- put. * On Linux/BSD, if the private key in the PEM file is en- crypted and you do not specify the --tlsCertificateKey- FilePassword option, MongoDB prompts for a passphrase. See TLS/SSL Certificate Passphrase. * On macOS or Windows, if the private key in the PEM file is encrypted, you must explicitly specify the --tlsCertifi- cateKeyFilePassword option. Alternatively, you can use a certificate from the secure system store (see --tlsCertifi- cateSelector) instead of a PEM file or use an unencrypted PEM file. For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients . mongos --clusterAuthMode Default: keyFile The authentication mode used for cluster authentication. If you use internal x.509 authentication, specify so here. This option can have one of the following values: * * Value * Description * * keyFile * Use a keyfile for authentication. Accept only key- files. * * sendKeyFile * For rolling upgrade purposes. Send a keyfile for au- thentication but can accept both keyfiles and x.509 certificates. * * sendX509 * For rolling upgrade purposes. Send the x.509 certifi- cate for authentication but can accept both keyfiles and x.509 certificates. * * x509 * Recommended. Send the x.509 certificate for authentica- tion and accept only x.509 certificates. If --tlsCAFile or tls.CAFile is not specified and you are not using x.509 authentication, you must set the tlsUseSystemCA parameter to true. This makes MongoDB use the system-wide CA certificate store when connecting to a TLS-enabled server. If using x.509 authentication, --tlsCAFile or tls.CAFile must be specified unless using --tlsCertificateSelector. For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients . mongos --tlsClusterFile On macOS or Windows, you can use a certificate from the operating system's secure store instead of a PEM file. See --tlsClusterCer- tificateSelector. Specifies the .pem file that contains the x.509 certificate-key file for membership authentication for the cluster or replica set. If --tlsClusterFile does not specify the .pem file for internal cluster authentication or the alternative --tlsClusterCertificateSe- lector, the cluster uses the .pem file specified in the --tlsCer- tificateKeyFile option or the certificate returned by the --tlsCer- tificateSelector. If using x.509 authentication, --tlsCAFile or tls.CAFile must be specified unless using --tlsCertificateSelector. mongod / mongos logs a warning on connection if the presented x.509 certificate expires within 30 days of the mongod/mongos host system time. See x.509 Certificates Nearing Expiry Trigger Warnings for more information. For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients . mongos --tlsClusterPassword Specifies the password to decrypt the x.509 certificate-key file specified with --tlsClusterFile. Use the --tlsClusterPassword option only if the certificate-key file is encrypted. In all cases, the mongos redacts the password from all logging and reporting output. * On Linux/BSD, if the private key in the x.509 file is en- crypted and you do not specify the --tlsClusterPassword op- tion, MongoDB prompts for a passphrase. See TLS/SSL Cer- tificate Passphrase. * On macOS or Windows, if the private key in the x.509 file is encrypted, you must explicitly specify the --tlsCluster- Password option. Alternatively, you can either use a cer- tificate from the secure system store (see --tlsClusterCer- tificateSelector) instead of a cluster PEM file or use an unencrypted PEM file. For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients . mongos --tlsCAFile Specifies the .pem file that contains the root certificate chain from the Certificate Authority. Specify the file name of the .pem file using relative or absolute paths. On macOS or Windows, you can use a certificate from the operating system's secure store instead of a PEM key file. See --tlsCertifi- cateSelector. When using the secure store, you do not need to, but can, also specify the --tlsCAFile. For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients . mongos --tlsClusterCAFile Specifies the .pem file that contains the root certificate chain from the Certificate Authority used to validate the certificate pre- sented by a client establishing a connection. Specify the file name of the .pem file using relative or absolute paths. If --tlsClusterCAFile does not specify the .pem file for validating the certificate from a client establishing a connection, the cluster uses the .pem file specified in the --tlsCAFile option. --tlsClusterCAFile lets you use separate Certificate Authorities to verify the client to server and server to client portions of the TLS handshake. On macOS or Windows, you can use a certificate from the operating system's secure store instead of a PEM key file. See --tlsCluster- CertificateSelector. When using the secure store, you do not need to, but can, also specify the --tlsClusterCAFile. Requires that --tlsCAFile is set. For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients . mongos --tlsCertificateSelector Available on Windows and macOS as an alternative to --tlsCertifi- cateKeyFile. The --tlsCertificateKeyFile and --tlsCertificateSelector options are mutually exclusive. You can only specify one. Specifies a certificate property in order to select a matching cer- tificate from the operating system's certificate store. --tlsCertificateSelector accepts an argument of the format <prop- erty>=<value> where the property can be one of the following: * * Property * Value type * Description * * subject * ASCII string * Subject name or common name on certificate * * thumbprint * hex string * A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA-1 digest. The thumbprint is sometimes referred to as a finger- print. When using the system SSL certificate store, OCSP (Online Certifi- cate Status Protocol) is used to validate the revocation status of certificates. You cannot use the rotateCertificates command or the db.rotateCer- tificates() shell method when using net.tls.certificateSelector or --tlsCertificateSelector set to thumbprint mongos --tlsClusterCertificateSelector Available on Windows and macOS as an alternative to --tlsCluster- File. --tlsClusterFile and --tlsClusterCertificateSelector options are mu- tually exclusive. You can only specify one. Specifies a certificate property in order to select a matching cer- tificate from the operating system's certificate store to use for internal authentication. --tlsClusterCertificateSelector accepts an argument of the format <property>=<value> where the property can be one of the following: * * Property * Value type * Description * * subject * ASCII string * Subject name or common name on certificate * * thumbprint * hex string * A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA-1 digest. The thumbprint is sometimes referred to as a finger- print. mongod / mongos logs a warning on connection if the presented x.509 certificate expires within 30 days of the mongod/mongos host system time. See x.509 Certificates Nearing Expiry Trigger Warnings for more information. mongos --tlsCRLFile Specifies the .pem file that contains the Certificate Revocation List. Specify the file name of the .pem file using relative or ab- solute paths. * You cannot specify a CRL file on macOS. Instead, you can use the system SSL certificate store, which uses OCSP (On- line Certificate Status Protocol) to validate the revoca- tion status of certificates. To use the system SSL certifi- cate store, see --tlsCertificateSelector. * To check for certificate revocation, MongoDB enables the use of OCSP (Online Certificate Status Protocol) by default as an alternative to specifying a CRL file or using the system SSL certificate store. For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients . mongos --tlsAllowConnectionsWithoutCertificates By default, the server bypasses client certificate validation unless the server is configured to use a CA file. If a CA file is provided, the following rules apply: * For clients that don't provide certificates, mongod or mon- gos encrypts the TLS/SSL connection, assuming the connec- tion is successfully made. * For clients that present a certificate, mongos performs certificate validation using the root certificate chain specified by --tlsCAFile and reject clients with invalid certificates. Use the --tlsAllowConnectionsWithoutCertificates option if you have a mixed deployment that includes clients that do not or cannot present certificates to the mongos. For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients . mongos --tlsAllowInvalidCertificates Bypasses the validation checks for TLS certificates on other servers in the cluster and allows the use of invalid certificates to con- nect. If you specify --tlsAllowInvalidCertificates or tls.allowInvalidCer- tificates: true when using x.509 authentication, an invalid certifi- cate is only sufficient to establish a TLS connection but is insuf- ficient for authentication. When using the --tlsAllowInvalidCertificates setting, MongoDB logs a warning regarding the use of the invalid certificate. For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients . mongos --tlsAllowInvalidHostnames Disables the validation of the hostnames in TLS certificates, when connecting to other members of the replica set or sharded cluster for inter-process authentication. This allows mongos to connect to other members if the hostnames in their certificates do not match their configured hostname. For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients . mongos --tlsDisabledProtocols Prevents a MongoDB server running with TLS from accepting incoming connections that use a specific protocol or protocols. To specify multiple protocols, use a comma separated list of protocols. --tlsDisabledProtocols recognizes the following protocols: TLS1_0, TLS1_1, TLS1_2, and TLS1_3. * On macOS, you cannot disable TLS1_1 and leave both TLS1_0 and TLS1_2 enabled. You must disable at least one of the other two, for example, TLS1_0,TLS1_1. * To list multiple protocols, specify as a comma separated list of protocols. For example TLS1_0,TLS1_1. * Specifying an unrecognized protocol prevents the server from starting. * The specified disabled protocols overrides any default dis- abled protocols. MongoDB disables the use of TLS 1.0 if TLS 1.1+ is available on the system. To enable the disabled TLS 1.0, specify none to --tlsDis- abledProtocols. Members of replica sets and sharded clusters must speak at least one protocol in common. Disallow Protocols mongos --tlsFIPSMode Directs the mongos to use the FIPS mode of the TLS library. Your system must have a FIPS compliant library to use the --tlsFIPSMode option. FIPS-compatible TLS/SSL is available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb-enterprise-ad- vanced?tck=docs_server). See Configure MongoDB for FIPS for more in- formation. AUDIT OPTIONS mongos --auditCompressionMode Specifies the compression mode for audit log encryption. You must also enable audit log encryption using either --auditEncryption- KeyUID or --auditLocalKeyFile. --auditCompressionMode can be set to one of these values: * * Value * Description * * zstd * Use the zstd algorithm to compress the audit log. * * none (default) * Do not compress the audit log. Available only in MongoDB Enterprise (http://www.mongodb.com/prod- ucts/mongodb-enterprise-advanced?tck=docs_server). MongoDB Enter- prise and Atlas have different configuration requirements. mongos --auditDestination Enables auditing and specifies where mongos sends all audit events. --auditDestination can have one of the following values: * * Value * Description * * syslog * Output the audit events to syslog in JSON format. Not available on Windows. Audit messages have a syslog severity level of info and a facility level of user. The syslog message limit can result in the truncation of audit messages. The auditing system neither detects the truncation nor errors upon its occurrence. * * console * Output the audit events to stdout in JSON format. * * file * Output the audit events to the file specified in --au- ditPath in the format specified in --auditFormat. Available only in MongoDB Enterprise (http://www.mongodb.com/prod- ucts/mongodb-enterprise-advanced?tck=docs_server) and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login). mongos --auditEncryptionKeyUID Specifies the unique identifier of the Key Management Interoperabil- ity Protocol (KMIP) key for audit log encryption. You cannot use --auditEncryptionKeyUID and --auditLocalKeyFile to- gether. Available only in MongoDB Enterprise (http://www.mongodb.com/prod- ucts/mongodb-enterprise-advanced?tck=docs_server). MongoDB Enter- prise and Atlas have different configuration requirements. mongos --auditFormat Specifies the format of the output file for auditing if --auditDes- tination is file. The --auditFormat option can have one of the fol- lowing values: * * Value * Description * * JSON * Output the audit events in JSON format to the file specified in --auditPath. * * BSON * Output the audit events in BSON binary format to the file specified in --auditPath. Printing audit events to a file in JSON format degrades server per- formance more than printing to a file in BSON format. Available only in MongoDB Enterprise (http://www.mongodb.com/prod- ucts/mongodb-enterprise-advanced?tck=docs_server) and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login). mongos --auditLocalKeyFile Specifies the path and file name for a local audit key file for au- dit log encryption. Only use --auditLocalKeyFile for testing because the key is not se- cured. To secure the key, use --auditEncryptionKeyUID and an exter- nal Key Management Interoperability Protocol (KMIP) server. You cannot use --auditLocalKeyFile and --auditEncryptionKeyUID to- gether. Available only in MongoDB Enterprise (http://www.mongodb.com/prod- ucts/mongodb-enterprise-advanced?tck=docs_server). MongoDB Enter- prise and Atlas have different configuration requirements. mongos --auditPath Specifies the output file for auditing if --auditDestination has value of file. The --auditPath option can take either a full path name or a relative path name. Available only in MongoDB Enterprise (http://www.mongodb.com/prod- ucts/mongodb-enterprise-advanced?tck=docs_server) and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login). mongos --auditFilter Specifies the filter to limit the types of operations the audit sys- tem records. The option takes a string representation of a query document of the form: { <field1>: <expression1>, ... } The <field> can be any field in the audit message, including fields returned in the param document. The <expression> is a query condi- tion expression. To specify an audit filter, enclose the filter document in single quotes to pass the document as a string. To specify the audit filter in a configuration file, you must use the YAML format of the configuration file. Available only in MongoDB Enterprise (http://www.mongodb.com/prod- ucts/mongodb-enterprise-advanced?tck=docs_server) and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login). mongos --auditSchema Type: string Default: mongo Specifies the format used for audit logs. You can specify one of the following values for --auditSchema: * * Value * Description * * mongo * Logs are written in a format designed by MongoDB. For example log messages, see mongo Schema Audit Mes- sages. * * OCSF * Logs are written in OCSF (Open Cybersecurity Schema Framework) format. This option provides logs in a stan- dardized format compatible with log processors. For example log messages, see OCSF Schema Audit Mes- sages. PROFILER OPTIONS mongos --slowms Default: 100 The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow. When logLevel is set to 0, MongoDB records slow operations to the diagnostic log at a rate determined by slowOpSampleRate. At higher logLevel settings, all operations appear in the diagnostic log regardless of their latency. For mongos instances, affects the diagnostic log only and not the profiler since profiling is not available on mongos. mongos --slowOpSampleRate Default: 1.0 The fraction of slow operations that should be logged. --slowOpSam- pleRate accepts values between 0 and 1, inclusive. For mongos instances, --slowOpSampleRate affects the diagnostic log only and not the profiler since profiling is not available on mon- gos. LDAP AUTHENTICATION AND AUTHORIZATION OPTIONS mongos --ldapServers Available in MongoDB Enterprise only. The LDAP server against which the mongos authenticates users or de- termines what actions a user is authorized to perform on a given database. If the LDAP server specified has any replicated instances, you may specify the host and port of each replicated server in a comma-delimited list. If your LDAP infrastructure partitions the LDAP directory over mul- tiple LDAP servers, specify one LDAP server or any of its replicated instances to --ldapServers. MongoDB supports following LDAP refer- rals as defined in RFC 4511 4.1.10 (https://www.rfc-edi- tor.org/rfc/rfc4511.txt). Do not use --ldapServers for listing every LDAP server in your infrastructure. This setting can be configured on a running mongos using setParame- ter. If unset, mongos cannot use LDAP authentication or authorization. mongos --ldapValidateLDAPServerConfig Available in MongoDB Enterprise A flag that determines if the mongos instance checks the availabil- ity of the LDAP server(s) as part of its startup: * If true, the mongos instance performs the availability check and only continues to start up if the LDAP server is available. * If false, the mongos instance skips the availability check; i.e. the instance starts up even if the LDAP server is un- available. mongos --ldapQueryUser Available in MongoDB Enterprise only. The identity with which mongos binds as, when connecting to or per- forming queries on an LDAP server. Only required if any of the following are true: * Using LDAP authorization. * Using an LDAP query for username transformation. * The LDAP server disallows anonymous binds You must use --ldapQueryUser with --ldapQueryPassword. If unset, mongos doesn't attempt to bind to the LDAP server. This setting can be configured on a running mongos using setParame- ter. Windows MongoDB deployments can use --ldapBindWithOSDefaults instead of --ldapQueryUser and --ldapQueryPassword. You cannot specify both --ldapQueryUser and --ldapBindWithOSDefaults at the same time. mongos --ldapQueryPassword Available in MongoDB Enterprise only. The password used to bind to an LDAP server when using --ldap- QueryUser. You must use --ldapQueryPassword with --ldapQueryUser. If unset, mongos doesn't attempt to bind to the LDAP server. This setting can be configured on a running mongos using setParame- ter. Windows MongoDB deployments can use --ldapBindWithOSDefaults instead of --ldapQueryPassword and --ldapQueryPassword. You cannot specify both --ldapQueryPassword and --ldapBindWithOSDefaults at the same time. mongos --ldapBindWithOSDefaults Default: false Available in MongoDB Enterprise for the Windows platform only. Allows mongos to authenticate, or bind, using your Windows login credentials when connecting to the LDAP server. Only required if: * Using LDAP authorization. * Using an LDAP query for username transformation. * The LDAP server disallows anonymous binds Use --ldapBindWithOSDefaults to replace --ldapQueryUser and --ldap- QueryPassword. mongos --ldapBindMethod Default: simple Available in MongoDB Enterprise only. The method mongos uses to authenticate to an LDAP server. Use with --ldapQueryUser and --ldapQueryPassword to connect to the LDAP server. --ldapBindMethod supports the following values: * simple - mongos uses simple authentication. * sasl - mongos uses SASL protocol for authentication If you specify sasl, you can configure the available SASL mechanisms using --ldapBindSaslMechanisms. mongos defaults to using DIGEST-MD5 mechanism. mongos --ldapBindSaslMechanisms Default: DIGEST-MD5 Available in MongoDB Enterprise only. A comma-separated list of SASL mechanisms mongos can use when au- thenticating to the LDAP server. The mongos and the LDAP server must agree on at least one mechanism. The mongos dynamically loads any SASL mechanism libraries installed on the host machine at runtime. Install and configure the appropriate libraries for the selected SASL mechanism(s) on both the mongos host and the remote LDAP server host. Your operating system may include certain SASL libraries by default. Defer to the documentation associated with each SASL mecha- nism for guidance on installation and configuration. If using the GSSAPI SASL mechanism for use with Kerberos Authentica- tion, verify the following for the mongos host machine: Linux * The KRB5_CLIENT_KTNAME environment variable resolves to the name of the client Linux Keytab Files for the host machine. For more on Kerberos environment vari- ables, please defer to the Kerberos documentation (https://web.mit.edu/kerberos/krb5-1.13/doc/ad- min/env_variables.html). * The client keytab includes a User Principal for the mongos to use when connecting to the LDAP server and execute LDAP queries. Windows If connecting to an Active Directory server, the Windows Ker- beros configuration automatically generates a Ticket-Grant- ing-Ticket (https://msdn.microsoft.com/en-us/library/win- dows/desktop/aa380510(v=vs.85).aspx) when the user logs onto the system. Set --ldapBindWithOSDefaults to true to allow mongos to use the generated credentials when connecting to the Active Directory server and execute queries. Set --ldapBindMethod to sasl to use this option. For a complete list of SASL mechanisms see the IANA listing (http://www.iana.org/assignments/sasl-mechanisms/sasl-mecha- nisms.xhtml). Defer to the documentation for your LDAP or Active Directory service for identifying the SASL mechanisms compatible with the service. MongoDB is not a source of SASL mechanism libraries, nor is the Mon- goDB documentation a definitive source for installing or configuring any given SASL mechanism. For documentation and support, defer to the SASL mechanism library vendor or owner. For more information on SASL, defer to the following resources: * For Linux, please see the Cyrus SASL documentation (https://www.cyrusimap.org/sasl/). * For Windows, please see the Windows SASL documentation (https://msdn.microsoft.com/en-us/library/cc223500.aspx). mongos --ldapTransportSecurity Default: tls Available in MongoDB Enterprise only. By default, mongos creates a TLS/SSL secured connection to the LDAP server. For Linux deployments, you must configure the appropriate TLS Op- tions in /etc/openldap/ldap.conf file. Your operating system's pack- age manager creates this file as part of the MongoDB Enterprise in- stallation, via the libldap dependency. See the documentation for TLS Options in the ldap.conf OpenLDAP documentation (http://www.openldap.org/software/man.cgi?query=ldap.conf&man- path=OpenLDAP+2.4-Release) for more complete instructions. For Windows deployment, you must add the LDAP server CA certificates to the Windows certificate management tool. The exact name and func- tionality of the tool may vary depending on operating system ver- sion. Please see the documentation for your version of Windows for more information on certificate management. Set --ldapTransportSecurity to none to disable TLS/SSL between mon- gos and the LDAP server. Setting --ldapTransportSecurity to none transmits plaintext informa- tion and possibly credentials between mongos and the LDAP server. mongos --ldapTimeoutMS Default: 10000 Available in MongoDB Enterprise only. The amount of time in milliseconds mongos should wait for an LDAP server to respond to a request. Increasing the value of --ldapTimeoutMS may prevent connection fail- ure between the MongoDB server and the LDAP server, if the source of the failure is a connection timeout. Decreasing the value of --ldap- TimeoutMS reduces the time MongoDB waits for a response from the LDAP server. This setting can be configured on a running mongos using setParame- ter. mongos --ldapRetryCount Default: 0 Available in MongoDB Enterprise only. Number of operation retries by the server LDAP manager after a net- work error. mongos --ldapUserToDNMapping Available in MongoDB Enterprise only. Maps the username provided to mongos for authentication to a LDAP Distinguished Name (DN). You may need to use --ldapUserToDNMapping to transform a username into an LDAP DN in the following scenarios: * Performing LDAP authentication with simple LDAP binding, where users authenticate to MongoDB with usernames that are not full LDAP DNs. * Using an LDAP authorization query template that requires a DN. * Transforming the usernames of clients authenticating to Mongo DB using different authentication mechanisms, such as x.509 or kerberos, to a full LDAP DN for authorization. --ldapUserToDNMapping expects a quote-enclosed JSON-string repre- senting an ordered array of documents. Each document contains a reg- ular expression match and either a substitution or ldapQuery tem- plate used for transforming the incoming username. Each document in the array has the following form: { match: "<regex>" substitution: "<LDAP DN>" | ldapQuery: "<LDAP Query>" } * * Field * Description * Example * * match * An ECMAScript-formatted regular expression (regex) to match against a provided username. Each parenthesis-en- closed section represents a regex capture group used by substitution or ldapQuery. * "(.+)ENGINEERING" "(.+)DBA" * * substitution * An LDAP distinguished name (DN) formatting template that converts the authentication name matched by the match regex into a LDAP DN. Each curly bracket-en- closed numeric value is replaced by the corresponding regex capture group (http://www.regular-expres- sions.info/refcapture.html) extracted from the authen- tication username via the match regex. The result of the substitution must be an RFC4514 (https://www.ietf.org/rfc/rfc4514.txt) escaped string. * "cn={0},ou=engineering, dc=example,dc=com" * * ldapQuery * A LDAP query formatting template that inserts the au- thentication name matched by the match regex into an LDAP query URI encoded respecting RFC4515 and RFC4516. Each curly bracket-enclosed numeric value is replaced by the corresponding regex capture group (http://www.regular-expressions.info/refcapture.html) extracted from the authentication username via the match expression. mongos executes the query against the LDAP server to retrieve the LDAP DN for the authen- ticated user. mongos requires exactly one returned re- sult for the transformation to be successful, or mongos skips this transformation. * "ou=engineering,dc=example, dc=com??one?(user={0})" An explanation of RFC4514 (https://www.ietf.org/rfc/rfc4514.txt), RFC4515 (https://tools.ietf.org/html/rfc4515), RFC4516 (https://tools.ietf.org/html/rfc4516), or LDAP queries is out of scope for the MongoDB Documentation. Please review the RFC directly or use your preferred LDAP resource. For each document in the array, you must use either substitution or ldapQuery. You cannot specify both in the same document. When performing authentication or authorization, mongos steps through each document in the array in the given order, checking the authentication username against the match filter. If a match is found, mongos applies the transformation and uses the output for au- thenticating the user. mongos does not check the remaining documents in the array. If the given document does not match the provided authentication name, mongos continues through the list of documents to find addi- tional matches. If no matches are found in any document, or the transformation the document describes fails, mongos returns an er- ror. mongos also returns an error if one of the transformations cannot be evaluated due to networking or authentication failures to the LDAP server. mongos rejects the connection request and does not check the remaining documents in the array. Starting in MongoDB 5.0, --ldapUserToDNMapping accepts an empty string "" or empty array [ ] in place of a mapping documnent. If providing an empty string or empty array to --ldapUserToDNMapping, MongoDB maps the authenticated username as the LDAP DN. Previously, providing an empty mapping document would cause mapping to fail. The following shows two transformation documents. The first document matches against any string ending in @ENGINEERING, placing anything preceeding the suffix into a regex capture group. The second docu- ment matches against any string ending in @DBA, placing anything preceeding the suffix into a regex capture group. "[ { match: "(.+)@ENGINEERING.EXAMPLE.COM", substitution: "cn={0},ou=engineering,dc=example,dc=com" }, { match: "(.+)@DBA.EXAMPLE.COM", ldapQuery: "ou=dba,dc=example,dc=com??one?(user={0})" } ]" A user with username alice@ENGINEERING.EXAMPLE.COM matches the first document. The regex capture group {0} corresponds to the string al- ice. The resulting output is the DN "cn=alice,ou=engineering,dc=ex- ample,dc=com". A user with username bob@DBA.EXAMPLE.COM matches the second docu- ment. The regex capture group {0} corresponds to the string bob. The resulting output is the LDAP query "ou=dba,dc=exam- ple,dc=com??one?(user=bob)". mongos executes this query against the LDAP server, returning the result "cn=bob,ou=dba,dc=example,dc=com". If --ldapUserToDNMapping is unset, mongos applies no transformations to the username when attempting to authenticate or authorize a user against the LDAP server. This setting can be configured on a running mongos using the setPa- rameter database command. ADDITIONAL OPTIONS mongos --ipv6 Enables IPv6 support. mongos disables IPv6 support by default. Setting --ipv6 does not direct the mongos to listen on any local IPv6 addresses or interfaces. To configure the mongos to listen on an IPv6 interface, you must either: * Configure --bind_ip with one or more IPv6 addresses or hostnames that resolve to IPv6 addresses, or * Set --bind_ip_all to true. mongos(1)
MONGOS | SYNOPSIS | CONSIDERATIONS | OPTIONS
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongos&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>