Skip to main content

Get

Returns the specified MongoDB Cluster resource.

To get the list of available MongoDB Cluster resources, make a List request.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const GetClusterRequest = cloudApi.dataproc.cluster_service.GetClusterRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.ClusterServiceClient);

  const result = await client.get(
    GetClusterRequest.fromPartial({
      clusterId: "clusterId",
    })
  );
  console.log(result);
})();

GetClusterRequest​

clusterId : string​

ID of the MongoDB Cluster resource to return. To get the cluster ID, use a ClusterService.List request.

Cluster​

A managed MongoDB cluster. For more information, see the documentation.

Environment​

  • ENVIRONMENT_UNSPECIFIED

  • PRODUCTION

    Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.

  • PRESTABLE

    Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.

Health​

  • HEALTH_UNKNOWN

    State of the cluster is unknown ([Host.health][3] for every host in the cluster is UNKNOWN).

  • ALIVE

    Cluster is alive and well ([Host.health][4] for every host in the cluster is ALIVE).

  • DEAD

    Cluster is inoperable ([Host.health][5] for every host in the cluster is DEAD).

  • DEGRADED

    Cluster is working below capacity ([Host.health][6] for at least one host in the cluster is not ALIVE).

Status​

  • STATUS_UNKNOWN

    Cluster state is unknown.

  • CREATING

    Cluster is being created.

  • RUNNING

    Cluster is running normally.

  • ERROR

    Cluster encountered a problem and cannot operate.

  • UPDATING

    Cluster is being updated.

  • STOPPING

    Cluster is stopping.

  • STOPPED

    Cluster stopped.

  • STARTING

    Cluster is starting.

id : string​

ID of the MongoDB cluster. This ID is assigned by MDB at creation time.

folderId : string​

ID of the folder that the MongoDB cluster belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp in RFC3339 text format.

name : string​

Name of the MongoDB cluster. The name is unique within the folder. 1-63 characters long.

description : string​

Description of the MongoDB cluster. 0-256 characters long.

labels : string​

Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource.

environment : Environment​

Deployment environment of the MongoDB cluster.

monitoring : Monitoring​

Description of monitoring systems relevant to the MongoDB cluster.

config : ClusterConfig​

Configuration of the MongoDB cluster.

networkId : string​

ID of the network that the cluster belongs to.

health : Health​

Aggregated cluster health.

status : Status​

Current state of the cluster.

sharded : bool​

Indicates current sharding status of the cluster.

maintenanceWindow : MaintenanceWindow​

Maintenance window for the cluster.

plannedOperation : MaintenanceOperation​

Planned maintenance operation to be started for the cluster within the nearest maintenance_window.

securityGroupIds : string​

User security groups

deletionProtection : bool​

Deletion Protection inhibits deletion of the cluster

Monitoring​

Monitoring system.

name : string​

Name of the monitoring system.

description : string​

Description of the monitoring system.

Link to the monitoring system charts for the MongoDB cluster.

ClusterConfig​

version : string​

Version of MongoDB server software. Possible values: 3.6, 4.0, 4.2, 4.4, 4.4-enterprise, 5.0, 5.0-enterprise, 6.0, 6.0-enterprise, 7.0, 7.0-enterprise.

featureCompatibilityVersion : string​

MongoDB feature compatibility version. See usage details in MongoDB documentation.

Possible values:

  • 3.6 - persist data compatibility for version 3.6. After setting this option the data will not be compatible with 3.4 or lower.
  • 4.0 - persist data compatibility for version 4.0. After setting this option the data will not be compatible with 3.6 or lower.
  • 4.2 - persist data compatibility for version 4.2. After setting this option the data will not be compatible with 4.0 or lower.
  • 4.4 - persist data compatibility for version 4.4. After setting this option the data will not be compatible with 4.2 or lower.
  • 5.0 - persist data compatibility for version 5.0. After setting this option the data will not be compatible with 5.0 or lower.
  • 6.0 - persist data compatibility for version 6.0. After setting this option the data will not be compatible with 6.0 or lower.

One of mongodb​

Configuration for MongoDB servers in the cluster.

  • mongodb_3_6 : Mongodb3_6​

    Configuration and resource allocation for a MongoDB 3.6 cluster.

  • mongodb_4_0 : Mongodb4_0​

    Configuration and resource allocation for a MongoDB 4.0 cluster.

  • mongodb_4_2 : Mongodb4_2​

    Configuration and resource allocation for a MongoDB 4.2 cluster.

  • mongodb_4_4 : Mongodb4_4​

    Configuration and resource allocation for a MongoDB 4.4 cluster.

  • mongodb_5_0 : Mongodb5_0​

    Configuration and resource allocation for a MongoDB 5.0 cluster.

  • mongodb_6_0 : Mongodb6_0​

    Configuration and resource allocation for a MongoDB 6.0 cluster.

  • mongodb_4_4Enterprise : Mongodb4_4_enterprise​

    Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster.

  • mongodb_5_0Enterprise : Mongodb5_0_enterprise​

    Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster.

  • mongodb_6_0Enterprise : Mongodb6_0_enterprise​

    Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster.

backupWindowStart : google.type.TimeOfDay​

Time to start the daily backup, in the UTC timezone.

backupRetainPeriodDays : google.protobuf.Int64Value​

Retain period of automatically created backup in days

performanceDiagnostics : PerformanceDiagnosticsConfig​

Performance Diagnostic

access : Access​

Access policy to DB

mongodbConfig : Mongodb​

Configuration and resource allocation for a MongoDB Enterprise cluster.

MaintenanceWindow​

A maintenance window settings.

One of policy​

The maintenance policy in effect.

  • anytime : AnytimeMaintenanceWindow​

    Maintenance operation can be scheduled anytime.

  • weeklyMaintenanceWindow : WeeklyMaintenanceWindow​

    Maintenance operation can be scheduled on a weekly basis.

MaintenanceOperation​

A planned maintenance operation.

info : string​

Information about this maintenance operation.

delayedUntil : google.protobuf.Timestamp​

Time until which this maintenance operation is delayed.

Mongodb3_6​

Mongod​
config : config.MongodConfigSet3_6​

Configuration for a mongod 3.6 hosts.

resources : Resources​

Resources allocated to MongoDB hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfigSet3_6​
resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfigSet3_6​
resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfigSet3_6​
configMongocfg : config.MongoCfgConfigSet3_6​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 3.6 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 3.6 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 3.6 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 3.6 cluster.

Mongodb4_0​

Mongod​
config : config.MongodConfigSet4_0​

Configuration for mongod 4.0 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfigSet4_0​

Configuration for mongocfg 4.0 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfigSet4_0​

Configuration for mongos 4.0 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfigSet4_0​
configMongocfg : config.MongoCfgConfigSet4_0​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 4.0 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 4.0 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 4.0 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 4.0 cluster.

Mongodb4_2​

Mongod​
config : config.MongodConfigSet4_2​

Configuration for mongod 4.2 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfigSet4_2​

Configuration for mongocfg 4.2 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfigSet4_2​

Configuration for mongos 4.2 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfigSet4_2​
configMongocfg : config.MongoCfgConfigSet4_2​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 4.2 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 4.2 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 4.2 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 4.2 cluster.

Mongodb4_4​

Mongod​
config : config.MongodConfigSet4_4​

Configuration for mongod 4.4 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfigSet4_4​

Configuration for mongocfg 4.4 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfigSet4_4​

Configuration for mongos 4.4 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfigSet4_4​
configMongocfg : config.MongoCfgConfigSet4_4​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 4.4 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 4.4 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 4.4 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 4.4 cluster.

Mongodb5_0​

Mongod​
config : config.MongodConfigSet5_0​

Configuration for mongod 5.0 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfigSet5_0​

Configuration for mongocfg 5.0 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfigSet5_0​

Configuration for mongos 5.0 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfigSet5_0​
configMongocfg : config.MongoCfgConfigSet5_0​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 5.0 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 5.0 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 5.0 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 5.0 cluster.

Mongodb6_0​

Mongod​
config : config.MongodConfigSet6_0​

Configuration for mongod 6.0 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfigSet6_0​

Configuration for mongocfg 6.0 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfigSet6_0​

Configuration for mongos 6.0 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfigSet6_0​
configMongocfg : config.MongoCfgConfigSet6_0​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 6.0 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 6.0 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 6.0 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 6.0 cluster.

Mongodb4_4_enterprise​

Mongod​
config : config.MongodConfigSet4_4_enterprise​

Configuration for mongod 4.4 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfigSet4_4_enterprise​

Configuration for mongocfg 4.4 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfigSet4_4_enterprise​

Configuration for mongos 4.4 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfigSet4_4_enterprise​
configMongocfg : config.MongoCfgConfigSet4_4_enterprise​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 4.4 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 4.4 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 4.4 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 4.4 cluster.

Mongodb5_0_enterprise​

Mongod​
config : config.MongodConfigSet5_0_enterprise​

Configuration for mongod 5.0 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfigSet5_0_enterprise​

Configuration for mongocfg 5.0 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfigSet5_0_enterprise​

Configuration for mongos 5.0 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfigSet5_0_enterprise​
configMongocfg : config.MongoCfgConfigSet5_0_enterprise​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 5.0 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 5.0 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 5.0 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 5.0 cluster.

Mongodb6_0_enterprise​

Mongod​
config : config.MongodConfigSet6_0_enterprise​

Configuration for mongod 6.0 hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfigSet6_0_enterprise​

Configuration for mongocfg 6.0 hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfigSet6_0_enterprise​

Configuration for mongos 6.0 hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfigSet6_0_enterprise​
configMongocfg : config.MongoCfgConfigSet6_0_enterprise​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB 6.0 cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB 6.0 cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB 6.0 cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 6.0 cluster.

PerformanceDiagnosticsConfig​

profilingEnabled : bool​

Access​

dataLens : bool​

Allow access for DataLens.

dataTransfer : bool​

Allow access for DataTransfer.

Mongodb​

Mongod​
config : config.MongodConfigSet​

Configuration for mongod hosts.

resources : Resources​

Resources allocated to mongod hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​
config : config.MongoCfgConfigSet​

Configuration for mongocfg hosts.

resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​
config : config.MongosConfigSet​

Configuration for mongos hosts.

resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​
configMongos : config.MongosConfigSet​
configMongocfg : config.MongoCfgConfigSet​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

mongod : Mongod​

Configuration and resource allocation for mongod in a MongoDB cluster.

mongocfg : MongoCfg​

Configuration and resource allocation for mongocfg in a MongoDB cluster.

mongos : Mongos​

Configuration and resource allocation for mongos in a MongoDB cluster.

mongoinfra : MongoInfra​

Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB cluster.

AnytimeMaintenanceWindow​

WeeklyMaintenanceWindow​

Weelky maintenance window settings.

WeekDay​
  • WEEK_DAY_UNSPECIFIED

  • MON

  • TUE

  • WED

  • THU

  • FRI

  • SAT

  • SUN

day : WeekDay​

Day of the week (in DDD format).

hour : int64​

Hour of the day in UTC (in HH format).

MongodConfigSet3_6​

effectiveConfig : MongodConfig3_6​

Effective mongod settings for a MongoDB 3.6 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongodConfig3_6​

User-defined mongod settings for a MongoDB 3.6 cluster.

defaultConfig : MongodConfig3_6​

Default mongod configuration for a MongoDB 3.6 cluster.

Resources​

resourcePresetId : string​

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.

diskSize : int64​

Volume of the storage available to a host, in bytes.

diskTypeId : string​

Type of the storage environment for the host. Possible values:

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.

DiskSizeAutoscaling​

plannedUsageThreshold : google.protobuf.Int64Value​

Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.

emergencyUsageThreshold : google.protobuf.Int64Value​

Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.

diskSizeLimit : google.protobuf.Int64Value​

Limit on how large the storage for database instances can automatically grow, in bytes.

MongoCfgConfigSet3_6​

effectiveConfig : MongoCfgConfig3_6​

Effective mongocfg settings for a MongoDB 3.6 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongoCfgConfig3_6​

User-defined mongocfg settings for a MongoDB 3.6 cluster.

defaultConfig : MongoCfgConfig3_6​

Default mongocfg configuration for a MongoDB 3.6 cluster.

MongosConfigSet3_6​

effectiveConfig : MongosConfig3_6​

Effective settings for a MongoDB 3.6 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongosConfig3_6​

User-defined settings for a MongoDB 3.6 cluster.

defaultConfig : MongosConfig3_6​

Default configuration for a MongoDB 3.6 cluster.

Mongod​

config : config.MongodConfigSet3_6​

Configuration for a mongod 3.6 hosts.

resources : Resources​

Resources allocated to MongoDB hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoCfg​

config : config.MongoCfgConfigSet3_6​
resources : Resources​

Resources allocated to mongocfg hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Mongos​

config : config.MongosConfigSet3_6​
resources : Resources​

Resources allocated to mongos hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongoInfra​

configMongos : config.MongosConfigSet3_6​
configMongocfg : config.MongoCfgConfigSet3_6​
resources : Resources​

Resources allocated to mongoinfra (mongos+mongocfg) hosts.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

MongodConfigSet4_0​

effectiveConfig : MongodConfig4_0​

Effective mongod settings for a MongoDB 4.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongodConfig4_0​

User-defined mongod settings for a MongoDB 4.0 cluster.

defaultConfig : MongodConfig4_0​

Default mongod configuration for a MongoDB 4.0 cluster.

MongoCfgConfigSet4_0​

effectiveConfig : MongoCfgConfig4_0​

Effective mongocfg settings for a MongoDB 4.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongoCfgConfig4_0​

User-defined mongocfg settings for a MongoDB 4.0 cluster.

defaultConfig : MongoCfgConfig4_0​

Default mongocfg configuration for a MongoDB 4.0 cluster.

MongosConfigSet4_0​

effectiveConfig : MongosConfig4_0​

Effective mongos settings for a MongoDB 4.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongosConfig4_0​

User-defined mongos settings for a MongoDB 4.0 cluster.

defaultConfig : MongosConfig4_0​

Default mongos configuration for a MongoDB 4.0 cluster.

MongodConfigSet4_2​

effectiveConfig : MongodConfig4_2​

Effective mongod settings for a MongoDB 4.2 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongodConfig4_2​

User-defined mongod settings for a MongoDB 4.2 cluster.

defaultConfig : MongodConfig4_2​

Default mongod configuration for a MongoDB 4.2 cluster.

MongoCfgConfigSet4_2​

effectiveConfig : MongoCfgConfig4_2​

Effective mongocfg settings for a MongoDB 4.2 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongoCfgConfig4_2​

User-defined mongocfg settings for a MongoDB 4.2 cluster.

defaultConfig : MongoCfgConfig4_2​

Default mongocfg configuration for a MongoDB 4.2 cluster.

MongosConfigSet4_2​

effectiveConfig : MongosConfig4_2​

Effective mongos settings for a MongoDB 4.2 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongosConfig4_2​

User-defined mongos settings for a MongoDB 4.2 cluster.

defaultConfig : MongosConfig4_2​

Default mongos configuration for a MongoDB 4.2 cluster.

MongodConfigSet4_4​

effectiveConfig : MongodConfig4_4​

Effective mongod settings for a MongoDB 4.4 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongodConfig4_4​

User-defined mongod settings for a MongoDB 4.4 cluster.

defaultConfig : MongodConfig4_4​

Default mongod configuration for a MongoDB 4.4 cluster.

MongoCfgConfigSet4_4​

effectiveConfig : MongoCfgConfig4_4​

Effective mongocfg settings for a MongoDB 4.4 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongoCfgConfig4_4​

User-defined mongocfg settings for a MongoDB 4.4 cluster.

defaultConfig : MongoCfgConfig4_4​

Default mongocfg configuration for a MongoDB 4.4 cluster.

MongosConfigSet4_4​

effectiveConfig : MongosConfig4_4​

Effective mongos settings for a MongoDB 4.4 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongosConfig4_4​

User-defined mongos settings for a MongoDB 4.4 cluster.

defaultConfig : MongosConfig4_4​

Default mongos configuration for a MongoDB 4.4 cluster.

MongodConfigSet5_0​

effectiveConfig : MongodConfig5_0​

Effective mongod settings for a MongoDB 5.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongodConfig5_0​

User-defined mongod settings for a MongoDB 5.0 cluster.

defaultConfig : MongodConfig5_0​

Default mongod configuration for a MongoDB 5.0 cluster.

MongoCfgConfigSet5_0​

effectiveConfig : MongoCfgConfig5_0​

Effective mongocfg settings for a MongoDB 5.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongoCfgConfig5_0​

User-defined mongocfg settings for a MongoDB 5.0 cluster.

defaultConfig : MongoCfgConfig5_0​

Default mongocfg configuration for a MongoDB 5.0 cluster.

MongosConfigSet5_0​

effectiveConfig : MongosConfig5_0​

Effective mongos settings for a MongoDB 5.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongosConfig5_0​

User-defined mongos settings for a MongoDB 5.0 cluster.

defaultConfig : MongosConfig5_0​

Default mongos configuration for a MongoDB 5.0 cluster.

MongodConfigSet6_0​

effectiveConfig : MongodConfig6_0​

Effective mongod settings for a MongoDB 6.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongodConfig6_0​

User-defined mongod settings for a MongoDB 6.0 cluster.

defaultConfig : MongodConfig6_0​

Default mongod configuration for a MongoDB 6.0 cluster.

MongoCfgConfigSet6_0​

effectiveConfig : MongoCfgConfig6_0​

Effective mongocfg settings for a MongoDB 6.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongoCfgConfig6_0​

User-defined mongocfg settings for a MongoDB 6.0 cluster.

defaultConfig : MongoCfgConfig6_0​

Default mongocfg configuration for a MongoDB 6.0 cluster.

MongosConfigSet6_0​

effectiveConfig : MongosConfig6_0​

Effective mongos settings for a MongoDB 6.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongosConfig6_0​

User-defined mongos settings for a MongoDB 6.0 cluster.

defaultConfig : MongosConfig6_0​

Default mongos configuration for a MongoDB 6.0 cluster.

MongodConfigSet4_4_enterprise​

effectiveConfig : MongodConfig4_4_enterprise​

Effective mongod settings for a MongoDB 4.4 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongodConfig4_4_enterprise​

User-defined mongod settings for a MongoDB 4.4 cluster.

defaultConfig : MongodConfig4_4_enterprise​

Default mongod configuration for a MongoDB 4.4 cluster.

MongoCfgConfigSet4_4_enterprise​

effectiveConfig : MongoCfgConfig4_4_enterprise​

Effective mongocfg settings for a MongoDB 4.4 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongoCfgConfig4_4_enterprise​

User-defined mongocfg settings for a MongoDB 4.4 cluster.

defaultConfig : MongoCfgConfig4_4_enterprise​

Default mongocfg configuration for a MongoDB 4.4 cluster.

MongosConfigSet4_4_enterprise​

effectiveConfig : MongosConfig4_4_enterprise​

Effective mongos settings for a MongoDB 4.4 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongosConfig4_4_enterprise​

User-defined mongos settings for a MongoDB 4.4 cluster.

defaultConfig : MongosConfig4_4_enterprise​

Default mongos configuration for a MongoDB 4.4 cluster.

MongodConfigSet5_0_enterprise​

effectiveConfig : MongodConfig5_0_enterprise​

Effective mongod settings for a MongoDB 5.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongodConfig5_0_enterprise​

User-defined mongod settings for a MongoDB 5.0 cluster.

defaultConfig : MongodConfig5_0_enterprise​

Default mongod configuration for a MongoDB 5.0 cluster.

MongoCfgConfigSet5_0_enterprise​

effectiveConfig : MongoCfgConfig5_0_enterprise​

Effective mongocfg settings for a MongoDB 5.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongoCfgConfig5_0_enterprise​

User-defined mongocfg settings for a MongoDB 5.0 cluster.

defaultConfig : MongoCfgConfig5_0_enterprise​

Default mongocfg configuration for a MongoDB 5.0 cluster.

MongosConfigSet5_0_enterprise​

effectiveConfig : MongosConfig5_0_enterprise​

Effective mongos settings for a MongoDB 5.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongosConfig5_0_enterprise​

User-defined mongos settings for a MongoDB 5.0 cluster.

defaultConfig : MongosConfig5_0_enterprise​

Default mongos configuration for a MongoDB 5.0 cluster.

MongodConfigSet6_0_enterprise​

effectiveConfig : MongodConfig6_0_enterprise​

Effective mongod settings for a MongoDB 6.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongodConfig6_0_enterprise​

User-defined mongod settings for a MongoDB 6.0 cluster.

defaultConfig : MongodConfig6_0_enterprise​

Default mongod configuration for a MongoDB 6.0 cluster.

MongoCfgConfigSet6_0_enterprise​

effectiveConfig : MongoCfgConfig6_0_enterprise​

Effective mongocfg settings for a MongoDB 6.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongoCfgConfig6_0_enterprise​

User-defined mongocfg settings for a MongoDB 6.0 cluster.

defaultConfig : MongoCfgConfig6_0_enterprise​

Default mongocfg configuration for a MongoDB 6.0 cluster.

MongosConfigSet6_0_enterprise​

effectiveConfig : MongosConfig6_0_enterprise​

Effective mongos settings for a MongoDB 6.0 cluster (a combination of settings defined in user_config and default_config).

userConfig : MongosConfig6_0_enterprise​

User-defined mongos settings for a MongoDB 5.0 cluster.

defaultConfig : MongosConfig6_0_enterprise​

Default mongos configuration for a MongoDB 5.0 cluster.

MongodConfigSet​

effectiveConfig : MongodConfig​

Effective mongod settings for a MongoDB cluster (a combination of settings defined in user_config and default_config).

userConfig : MongodConfig​

User-defined mongod settings for a MongoDB cluster.

defaultConfig : MongodConfig​

Default mongod configuration for a MongoDB cluster.

MongoCfgConfigSet​

effectiveConfig : MongoCfgConfig​

Effective mongocfg settings for a MongoDB cluster (a combination of settings defined in user_config and default_config).

userConfig : MongoCfgConfig​

User-defined mongocfg settings for a MongoDB cluster.

defaultConfig : MongoCfgConfig​

Default mongocfg configuration for a MongoDB cluster.

MongosConfigSet​

effectiveConfig : MongosConfig​

Effective mongos settings for a MongoDB cluster (a combination of settings defined in user_config and default_config).

userConfig : MongosConfig​

User-defined mongos settings for a MongoDB cluster.

defaultConfig : MongosConfig​

Default mongos configuration for a MongoDB cluster.

MongodConfig3_6​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

Journal​
enabled : google.protobuf.BoolValue​

Whether the journal is enabled or disabled. Possible values:

  • true (default) - the journal is enabled.
  • false - the journal is disabled.
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][68].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

MongoCfgConfig3_6​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data. This is the default profiler level.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][69].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Operation profiling level. For details, see MongoDB documentation.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of incoming connections.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig3_6​

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of incoming connections.

net : Network​

Network settings for mongos.

MongodConfig4_0​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][70].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

MongoCfgConfig4_0​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][71].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig4_0​

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

net : Network​

Network settings for mongos.

MongodConfig4_2​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][72].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

SetParameter​
enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

setParameter : SetParameter​

replication section of mongod configuration.

MongoCfgConfig4_2​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][73].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig4_2​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

MongodConfig4_4​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][74].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

SetParameter​
enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

setParameter : SetParameter​

replication section of mongod configuration.

MongoCfgConfig4_4​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][75].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig4_4​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

MongodConfig5_0​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][76].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

SetParameter​
enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds : google.protobuf.Int64Value​

The minimum time window in seconds for which the storage engine keeps the snapshot history.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

setParameter : SetParameter​

SetParameter section of mongod configuration.

MongoCfgConfig5_0​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][77].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig5_0​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

MongodConfig6_0​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][78].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

SetParameter​
enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds : google.protobuf.Int64Value​

The minimum time window in seconds for which the storage engine keeps the snapshot history.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

setParameter : SetParameter​

SetParameter section of mongod configuration.

MongoCfgConfig6_0​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][79].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig6_0​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

MongodConfig4_4_enterprise​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][80].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

Security​
KMIP​
serverName : string​

KMIP server name

port : google.protobuf.Int64Value​

KMIP server port

serverCa : string​

KMIP Server CA

clientCertificate : string​

KMIP client certificate + private key (unencrypted)

keyIdentifier : string​

KMIP Key identifier (if any)

enableEncryption : google.protobuf.BoolValue​

If encryption at rest should be enabled or not

kmip : KMIP​

kmip section of mongod security config

AuditLog​
filter : string​

Audit filter

SetParameter​
auditAuthorizationSuccess : google.protobuf.BoolValue​

Enables the auditing of authorization successes

enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

security : Security​

security section of mongod configuration.

auditLog : AuditLog​

AuditLog section of mongod configuration.

setParameter : SetParameter​

SetParameter section of mongod configuration.

MongoCfgConfig4_4_enterprise​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][81].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig4_4_enterprise​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

MongodConfig5_0_enterprise​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][82].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

Security​
KMIP​
serverName : string​

KMIP server name

port : google.protobuf.Int64Value​

KMIP server port

serverCa : string​

KMIP Server CA

clientCertificate : string​

KMIP client certificate + private key (unencrypted)

keyIdentifier : string​

KMIP Key identifier (if any)

enableEncryption : google.protobuf.BoolValue​

If encryption at rest should be enabled or not

kmip : KMIP​

kmip section of mongod security config

AuditLog​
filter : string​

Audit filter

runtimeConfiguration : google.protobuf.BoolValue​

Allows runtime configuration of audit filter and auditAuthorizationSuccess

SetParameter​
auditAuthorizationSuccess : google.protobuf.BoolValue​

Enables the auditing of authorization successes

enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds : google.protobuf.Int64Value​

The minimum time window in seconds for which the storage engine keeps the snapshot history.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

security : Security​

security section of mongod configuration.

auditLog : AuditLog​

AuditLog section of mongod configuration.

setParameter : SetParameter​

SetParameter section of mongod configuration.

MongoCfgConfig5_0_enterprise​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][83].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig5_0_enterprise​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

MongodConfig6_0_enterprise​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][84].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

Security​
KMIP​
serverName : string​

KMIP server name

port : google.protobuf.Int64Value​

KMIP server port

serverCa : string​

KMIP Server CA

clientCertificate : string​

KMIP client certificate + private key (unencrypted)

keyIdentifier : string​

KMIP Key identifier (if any)

enableEncryption : google.protobuf.BoolValue​

If encryption at rest should be enabled or not

kmip : KMIP​

kmip section of mongod security config

AuditLog​
filter : string​

Audit filter

runtimeConfiguration : google.protobuf.BoolValue​

Allows runtime configuration of audit filter and auditAuthorizationSuccess

SetParameter​
auditAuthorizationSuccess : google.protobuf.BoolValue​

Enables the auditing of authorization successes

enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds : google.protobuf.Int64Value​

The minimum time window in seconds for which the storage engine keeps the snapshot history.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

security : Security​

security section of mongod configuration.

auditLog : AuditLog​

AuditLog section of mongod configuration.

setParameter : SetParameter​

SetParameter section of mongod configuration.

MongoCfgConfig6_0_enterprise​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][85].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig6_0_enterprise​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

MongodConfig​

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

####### CollectionConfig {#wiredtiger_collectionconfig}

######## Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

####### IndexConfig {#wiredtiger_indexconfig}

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

indexConfig : IndexConfig​

Index configuration for WiredTiger

Journal​
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][86].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

slowOpSampleRate : google.protobuf.DoubleValue​

The fraction of slow operations that should be profiled or logged. operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

compression : Compression​

Compression settings

Security​
KMIP​
serverName : string​

KMIP server name

port : google.protobuf.Int64Value​

KMIP server port

serverCa : string​

KMIP Server CA

clientCertificate : string​

KMIP client certificate + private key (unencrypted)

keyIdentifier : string​

KMIP Key identifier (if any)

enableEncryption : google.protobuf.BoolValue​

If encryption at rest should be enabled or not

kmip : KMIP​

kmip section of mongod security config

AuditLog​
filter : string​

Audit filter

runtimeConfiguration : google.protobuf.BoolValue​

Allows runtime configuration of audit filter and auditAuthorizationSuccess

SetParameter​
auditAuthorizationSuccess : google.protobuf.BoolValue​

Enables the auditing of authorization successes

enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

minSnapshotHistoryWindowInSeconds : google.protobuf.Int64Value​

The minimum time window in seconds for which the storage engine keeps the snapshot history.

storage : Storage​

storage section of mongod configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongod configuration.

net : Network​

net section of mongod configuration.

security : Security​

security section of mongod configuration.

auditLog : AuditLog​

AuditLog section of mongod configuration.

setParameter : SetParameter​

SetParameter section of mongod configuration.

MongoCfgConfig​

Storage​
WiredTiger​

Configuration of WiredTiger storage engine.

####### EngineConfig {#wiredtiger_engineconfig}

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

OperationProfiling​
Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][87].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode. For details see MongoDB documentation.

Network​
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongocfg will accept.

storage : Storage​

storage section of mongocfg configuration.

operationProfiling : OperationProfiling​

operationProfiling section of mongocfg configuration.

net : Network​

net section of mongocfg configuration.

MongosConfig​

Network​
Compression​

####### Compressor {#compression_compressor}

  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:
maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongos will accept.

compression : Compression​

Compression settings

net : Network​

Network settings for mongos.

EngineConfig​

cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig​

Compressor​
  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

WiredTiger​

Configuration of WiredTiger storage engine.

EngineConfig​
cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig​
Compressor​
  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

Journal​

enabled : google.protobuf.BoolValue​

Whether the journal is enabled or disabled. Possible values:

  • true (default) - the journal is enabled.
  • false - the journal is disabled.
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

Storage​

WiredTiger​

Configuration of WiredTiger storage engine.

EngineConfig​
cacheSizeGb : google.protobuf.DoubleValue​

The maximum size of the internal cache that WiredTiger will use for all data.

CollectionConfig​

####### Compressor {#collectionconfig_compressor}

  • COMPRESSOR_UNSPECIFIED

  • NONE

    No compression.

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

blockCompressor : Compressor​

Default type of compression to use for collection data.

engineConfig : EngineConfig​

Engine configuration for WiredTiger.

collectionConfig : CollectionConfig​

Collection configuration for WiredTiger.

Journal​
enabled : google.protobuf.BoolValue​

Whether the journal is enabled or disabled. Possible values:

  • true (default) - the journal is enabled.
  • false - the journal is disabled.
commitInterval : google.protobuf.Int64Value​

Commit interval between journal operations, in milliseconds. Default: 100.

wiredTiger : WiredTiger​

Configuration of the WiredTiger storage engine.

journal : Journal​

Configuration of the MongoDB journal.

OperationProfiling​

Mode​
  • MODE_UNSPECIFIED

  • OFF

    The profiler is off and does not collect any data.

  • SLOW_OP

    The profiler collects data for operations that take longer than the value of [slow_op_threshold][88].

  • ALL

    The profiler collects data for all operations.

mode : Mode​

Mode which specifies operations that should be profiled.

slowOpThreshold : google.protobuf.Int64Value​

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

Network​

maxIncomingConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections that mongod will accept.

IndexConfig​

prefixCompression : google.protobuf.BoolValue​

Enables or disables prefix compression

Compression​

Compressor​
  • COMPRESSOR_UNSPECIFIED

  • SNAPPY

    The Snappy compression.

  • ZLIB

    The zlib compression.

  • ZSTD

    The zstd compression.

  • DISABLED

    No compression

compressors : Compressor​

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

  • other members of the deployment if the instance is part of a replica set or a sharded cluster
  • mongosh
  • drivers that support the OP_COMPRESSED message format. MongoDB supports the following compressors:

SetParameter​

enableFlowControl : google.protobuf.BoolValue​

Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members majority committed lag under a configurable maximum value.

KMIP​

serverName : string​

KMIP server name

port : google.protobuf.Int64Value​

KMIP server port

serverCa : string​

KMIP Server CA

clientCertificate : string​

KMIP client certificate + private key (unencrypted)

keyIdentifier : string​

KMIP Key identifier (if any)

Security​

KMIP​
serverName : string​

KMIP server name

port : google.protobuf.Int64Value​

KMIP server port

serverCa : string​

KMIP Server CA

clientCertificate : string​

KMIP client certificate + private key (unencrypted)

keyIdentifier : string​

KMIP Key identifier (if any)

enableEncryption : google.protobuf.BoolValue​

If encryption at rest should be enabled or not

kmip : KMIP​

kmip section of mongod security config

AuditLog​

filter : string​

Audit filter