diff --git a/source/includes/options-mongodump.yaml b/source/includes/options-mongodump.yaml index d8f528e9221..2f22f529f8e 100644 --- a/source/includes/options-mongodump.yaml +++ b/source/includes/options-mongodump.yaml @@ -128,6 +128,20 @@ inherit: file: options-shared.yaml --- program: mongodump +name: gssapiServiceName +inherit: + name: gssapiServiceName + program: _shared + file: options-shared.yaml +--- +program: mongodump +name: gssapiHostName +inherit: + name: gssapiHostName + program: _shared + file: options-shared.yaml +--- +program: mongodump name: dbpath inherit: name: dbpath diff --git a/source/includes/options-mongoexport.yaml b/source/includes/options-mongoexport.yaml index 6be0d95d13b..01d879a2dcd 100644 --- a/source/includes/options-mongoexport.yaml +++ b/source/includes/options-mongoexport.yaml @@ -128,6 +128,20 @@ inherit: file: options-shared.yaml --- program: mongoexport +name: gssapiServiceName +inherit: + name: gssapiServiceName + program: _shared + file: options-shared.yaml +--- +program: mongoexport +name: gssapiHostName +inherit: + name: gssapiHostName + program: _shared + file: options-shared.yaml +--- +program: mongoexport name: dbpath inherit: name: dbpath diff --git a/source/includes/options-mongofiles.yaml b/source/includes/options-mongofiles.yaml index 755fcc68785..b0202d690cb 100644 --- a/source/includes/options-mongofiles.yaml +++ b/source/includes/options-mongofiles.yaml @@ -135,6 +135,20 @@ inherit: file: options-shared.yaml --- program: mongofiles +name: gssapiServiceName +inherit: + name: gssapiServiceName + program: _shared + file: options-shared.yaml +--- +program: mongofiles +name: gssapiHostName +inherit: + name: gssapiHostName + program: _shared + file: options-shared.yaml +--- +program: mongofiles name: dbpath inherit: name: dbpath diff --git a/source/includes/options-mongoimport.yaml b/source/includes/options-mongoimport.yaml index 367eb492922..046262cc08a 100644 --- a/source/includes/options-mongoimport.yaml +++ b/source/includes/options-mongoimport.yaml @@ -128,6 +128,20 @@ inherit: file: options-shared.yaml --- program: mongoimport +name: gssapiServiceName +inherit: + name: gssapiServiceName + program: _shared + file: options-shared.yaml +--- +program: mongoimport +name: gssapiHostName +inherit: + name: gssapiHostName + program: _shared + file: options-shared.yaml +--- +program: mongoimport name: dbpath inherit: name: dbpath diff --git a/source/includes/options-mongooplog.yaml b/source/includes/options-mongooplog.yaml index c30ecc5da7c..07e8ae7e434 100644 --- a/source/includes/options-mongooplog.yaml +++ b/source/includes/options-mongooplog.yaml @@ -159,6 +159,20 @@ inherit: file: options-shared.yaml --- program: mongooplog +name: gssapiServiceName +inherit: + name: gssapiServiceName + program: _shared + file: options-shared.yaml +--- +program: mongooplog +name: gssapiHostName +inherit: + name: gssapiHostName + program: _shared + file: options-shared.yaml +--- +program: mongooplog name: dbpath directive: option args: diff --git a/source/includes/options-mongorestore.yaml b/source/includes/options-mongorestore.yaml index 2117127b35d..9f99e0d39b6 100644 --- a/source/includes/options-mongorestore.yaml +++ b/source/includes/options-mongorestore.yaml @@ -129,6 +129,20 @@ inherit: file: options-shared.yaml --- program: mongorestore +name: gssapiServiceName +inherit: + name: gssapiServiceName + program: _shared + file: options-shared.yaml +--- +program: mongorestore +name: gssapiHostName +inherit: + name: gssapiHostName + program: _shared + file: options-shared.yaml +--- +program: mongorestore name: dbpath inherit: name: dbpath diff --git a/source/includes/options-mongos.exe.yaml b/source/includes/options-mongos.exe.yaml index 0b158069b38..0b4ef7ae4cd 100644 --- a/source/includes/options-mongos.exe.yaml +++ b/source/includes/options-mongos.exe.yaml @@ -28,6 +28,14 @@ inherit: file: options-mongod.exe.yaml --- program: mongos.exe +default: "MongoS" +name: gssapiServiceName +inherit: + name: gssapiServiceName + program: mongod.exe + file: options-mongod.exe.yaml +--- +program: mongos.exe name: serviceDisplayName default: "Mongo DB Router" inherit: diff --git a/source/includes/options-mongostat.yaml b/source/includes/options-mongostat.yaml index 40d9df5835c..d7dabdd733e 100644 --- a/source/includes/options-mongostat.yaml +++ b/source/includes/options-mongostat.yaml @@ -121,6 +121,20 @@ inherit: file: options-shared.yaml --- program: mongostat +name: gssapiServiceName +inherit: + name: gssapiServiceName + program: _shared + file: options-shared.yaml +--- +program: mongostat +name: gssapiHostName +inherit: + name: gssapiHostName + program: _shared + file: options-shared.yaml +--- +program: mongostat name: noheaders directive: option args: null diff --git a/source/includes/options-mongotop.yaml b/source/includes/options-mongotop.yaml index b399ce0f25b..87d17e72a0e 100644 --- a/source/includes/options-mongotop.yaml +++ b/source/includes/options-mongotop.yaml @@ -129,6 +129,20 @@ inherit: file: options-shared.yaml --- program: mongotop +name: gssapiServiceName +inherit: + name: gssapiServiceName + program: _shared + file: options-shared.yaml +--- +program: mongotop +name: gssapiHostName +inherit: + name: gssapiHostName + program: _shared + file: options-shared.yaml +--- +program: mongotop name: locks directive: option args: null diff --git a/source/includes/options-shared.yaml b/source/includes/options-shared.yaml index 4320e6a5057..f981a0f3192 100644 --- a/source/includes/options-shared.yaml +++ b/source/includes/options-shared.yaml @@ -350,4 +350,56 @@ directive: option description: | Specifies the name of the database on which to run the {{program}}. optional: true +--- +program: _shared +name: gssapiServiceName +args: null +directive: option +description: | + Non-default name of the service using SASL. This option allows you to + override the default :doc:`Kerberos + ` + service name component of the :doc:`Kerberos + ` + principal name, on a per-instance basis. If unspecified, the default + value is ``mongodb``. + + If you use a non-default value, update the + :setting:`~security.gssapiServiceName` setting with the same value to + allow the mongo shell and any drivers to connect to the :program:`mongo` + shell. + + MongoDB permits setting this option only at startup. The + :dbcommand:`setParameter` can not change this setting. + + This option is available only in MongoDB Enterprise. + + .. important:: Ensure that your driver supports alternate service names. +optional: true +--- +program: _shared +name: gssapiHostName +args: null +directive: option +description: | + Non-default hostname of a service using SASL where the hostname of a + machine does not match the hostname resolved by DNS. Some clients and + drivers use the machine hostname as the fully qualified domain name for + :doc:`Kerberos + ` + authentication. + + This option allows you to override the default :doc:`Kerberos + ` + hostname component of the :doc:`Kerberos + ` + principal hostname, on a per-instance basis. + + This setting permits the mongo shell, drivers, and tools to connect to + the :program:`mongod`. + + This option is available only in MongoDB Enterprise. + + .. important:: Ensure that your driver supports alternate hostnames. +optional: true ... diff --git a/source/reference/configuration-options.txt b/source/reference/configuration-options.txt index 3f6dc3a8aea..d80401dd51e 100644 --- a/source/reference/configuration-options.txt +++ b/source/reference/configuration-options.txt @@ -166,6 +166,8 @@ Core Options .. include:: /includes/option/setting-conf-security.sasl.serviceName.rst +.. include:: /includes/option/setting-conf-security.gssapiServiceName.rst + .. include:: /includes/option/setting-conf-security.sasl.saslauthdSocketPath.rst .. include:: /includes/option/setting-conf-security.javascriptEnabled.rst @@ -250,6 +252,8 @@ Windows Service Options .. include:: /includes/option/setting-conf-processManagement.windowsService.serviceName.rst +.. include:: /includes/option/setting-conf-processManagement.windowsService.gssapiServiceName.rst + .. include:: /includes/option/setting-conf-processManagement.windowsService.displayName.rst .. include:: /includes/option/setting-conf-processManagement.windowsService.description.rst diff --git a/source/reference/program/mongo.txt b/source/reference/program/mongo.txt index 3c0d29d619a..d5e653b98ff 100644 --- a/source/reference/program/mongo.txt +++ b/source/reference/program/mongo.txt @@ -95,6 +95,8 @@ SSL Options .. include:: /includes/option/option-mongo-sslAllowInvalidCertificates.rst +.. include:: /includes/option/option-mongo-gssapiHostName.rst + Files ----- diff --git a/source/reference/program/mongodump.txt b/source/reference/program/mongodump.txt index 0b085455710..556424561dd 100644 --- a/source/reference/program/mongodump.txt +++ b/source/reference/program/mongodump.txt @@ -97,6 +97,10 @@ Options .. include:: /includes/option/option-mongodump-authenticationMechanism.rst +.. include:: /includes/option/option-mongodump-gssapiServiceName.rst + +.. include:: /includes/option/option-mongodump-gssapiHostName.rst + .. include:: /includes/option/option-mongodump-dbpath.rst .. include:: /includes/option/option-mongodump-directoryperdb.rst diff --git a/source/reference/program/mongoexport.txt b/source/reference/program/mongoexport.txt index f20e3bad7e1..574328831ac 100644 --- a/source/reference/program/mongoexport.txt +++ b/source/reference/program/mongoexport.txt @@ -69,6 +69,10 @@ Options .. include:: /includes/option/option-mongoexport-authenticationMechanism.rst +.. include:: /includes/option/option-mongoexport-gssapiServiceName.rst + +.. include:: /includes/option/option-mongoexport-gssapiHostName.rst + .. include:: /includes/option/option-mongoexport-dbpath.rst .. include:: /includes/option/option-mongoexport-directoryperdb.rst diff --git a/source/reference/program/mongofiles.txt b/source/reference/program/mongofiles.txt index 6d1c94dc7e4..1a8273b3fe5 100644 --- a/source/reference/program/mongofiles.txt +++ b/source/reference/program/mongofiles.txt @@ -87,6 +87,10 @@ Options .. include:: /includes/option/option-mongofiles-authenticationMechanism.rst +.. include:: /includes/option/option-mongofiles-gssapiServiceName.rst + +.. include:: /includes/option/option-mongofiles-gssapiHostName.rst + .. include:: /includes/option/option-mongofiles-dbpath.rst .. include:: /includes/option/option-mongofiles-directoryperdb.rst diff --git a/source/reference/program/mongoimport.txt b/source/reference/program/mongoimport.txt index 8b0e7a44c8b..95cd2161283 100644 --- a/source/reference/program/mongoimport.txt +++ b/source/reference/program/mongoimport.txt @@ -74,6 +74,10 @@ Options .. include:: /includes/option/option-mongoimport-authenticationMechanism.rst +.. include:: /includes/option/option-mongoimport-gssapiServiceName.rst + +.. include:: /includes/option/option-mongoimport-gssapiHostName.rst + .. include:: /includes/option/option-mongoimport-dbpath.rst .. include:: /includes/option/option-mongoimport-directoryperdb.rst diff --git a/source/reference/program/mongooplog.txt b/source/reference/program/mongooplog.txt index bef66dabd5f..5a7ad9ad461 100644 --- a/source/reference/program/mongooplog.txt +++ b/source/reference/program/mongooplog.txt @@ -85,6 +85,10 @@ Options .. include:: /includes/option/option-mongooplog-authenticationMechanism.rst +.. include:: /includes/option/option-mongooplog-gssapiServiceName.rst + +.. include:: /includes/option/option-mongooplog-gssapiHostName.rst + .. include:: /includes/option/option-mongooplog-dbpath.rst .. include:: /includes/option/option-mongooplog-directoryperdb.rst diff --git a/source/reference/program/mongorestore.txt b/source/reference/program/mongorestore.txt index da774cd65a9..a16ae35d442 100644 --- a/source/reference/program/mongorestore.txt +++ b/source/reference/program/mongorestore.txt @@ -93,6 +93,10 @@ Options .. include:: /includes/option/option-mongorestore-authenticationMechanism.rst +.. include:: /includes/option/option-mongorestore-gssapiServiceName.rst + +.. include:: /includes/option/option-mongorestore-gssapiHostName.rst + .. include:: /includes/option/option-mongorestore-dbpath.rst .. include:: /includes/option/option-mongorestore-directoryperdb.rst diff --git a/source/reference/program/mongos.txt b/source/reference/program/mongos.txt index 42b021ee049..b4b31dd0829 100644 --- a/source/reference/program/mongos.txt +++ b/source/reference/program/mongos.txt @@ -122,6 +122,8 @@ SSL Options .. include:: /includes/option/option-mongos-sslFIPSMode.rst +.. include:: /includes/option/option-mongo-gssapiServiceName.rst + Audit Options ~~~~~~~~~~~~~ diff --git a/source/reference/program/mongostat.txt b/source/reference/program/mongostat.txt index 8428fbfe303..0c3bf3fc742 100644 --- a/source/reference/program/mongostat.txt +++ b/source/reference/program/mongostat.txt @@ -86,6 +86,10 @@ Options .. include:: /includes/option/option-mongostat-authenticationMechanism.rst +.. include:: /includes/option/option-mongostat-gssapiServiceName.rst + +.. include:: /includes/option/option-mongostat-gssapiHostName.rst + .. include:: /includes/option/option-mongostat-noheaders.rst .. include:: /includes/option/option-mongostat-rowcount.rst diff --git a/source/reference/program/mongotop.txt b/source/reference/program/mongotop.txt index 97895dd9758..edd2a4ab2d3 100644 --- a/source/reference/program/mongotop.txt +++ b/source/reference/program/mongotop.txt @@ -87,6 +87,10 @@ Options .. include:: /includes/option/option-mongotop-authenticationMechanism.rst +.. include:: /includes/option/option-mongotop-gssapiServiceName.rst + +.. include:: /includes/option/option-mongotop-gssapiHostName.rst + .. include:: /includes/option/option-mongotop-locks.rst .. include:: /includes/option/option-mongotop-.rst