atlas clusters advancedSettings update
Update advanced configuration settings for one cluster.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. Atlas supports this command only for M10+ clusters.
Syntax
atlas clusters advancedSettings update <clusterName> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
clusterName | string | true | Name of the cluster to update. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--disableFailIndexKeyTooLong | false | Flag that disables writing documents that exceed 1024 bytes without indexing. Mutually exclusive with --enableFailIndexKeyTooLong. | |
--disableJavascript | false | Flag that disables the execution of operations that perform server-side executions of JavaScript. Mutually exclusive with --enableJavascript. | |
--disableTableScan | false | Flag that disables executing any query that requires a collection scan to return results. Mutually exclusive with --enableTableScan. | |
--enableFailIndexKeyTooLong | false | Flag that enables writing documents that exceed 1024 bytes without indexing. Mutually exclusive with --disableFailIndexKeyTooLong. | |
--enableJavascript | false | Flag that enables the execution of operations that perform server-side executions of JavaScript. Mutually exclusive with --disableJavascript. | |
--enableTableScan | false | Flag that enables executing any query that requires a collection scan to return results. Mutually exclusive with --disableTableScan. | |
-h, --help | false | help for update | |
--oplogMinRetentionHours | float | false | Minimum retention window for cluster's oplog expressed in hours. |
--oplogSizeMB | int | false | Storage limit of cluster's oplog expressed in megabytes. |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
--readConcern | string | false | Default level of acknowledgment requested from MongoDB for read operations set for this cluster. |
--sampleRefreshIntervalBIConnector | int | false | Interval in seconds at which the mongosqld process re-samples data to create its relational schema. This value defaults to -1. |
--sampleSizeBIConnector | int | false | Number of documents per database to sample when gathering schema information. This value defaults to -1. |
--tlsProtocol | string | false | Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. |
--writeConcern | string | false | Default level of acknowledgment requested from MongoDB for write operations set for this cluster. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
Updating advanced configuration settings of your cluster'.
Examples
# Update the minimum oplog size for a cluster: atlas cluster advancedSettings update <clusterName> --projectId <projectId> --oplogSizeMB 1000
# Update the minimum TLS protocol version for a cluster: atlas cluster advancedSettings update <clusterName> --projectId <projectId> --minimumEnabledTLSProtocol "TLS1_2"