/ /

オートメーション構成

Overview

オートメーションは、オートメーション構成を使用して、MongoDB 配置の必要な状態を決定し、必要に応じて変更を適用します。 MongoDB Ops Managerのウェブインターフェイスを通じて配置を変更する場合、この構成を操作する必要はありません。

MongoDB Ops Managerなしでオートメーションを使用している場合は、構成を手動で構築して配布できます。

オプションフィールドはそのようにマークされます。

<number>を値として受け取るフィールドは、整数と浮動小数点数を取ることができます。

警告

Ops Manager のオートメーションでは、次の設定はサポートまたは検証されません。これらを使用すると、配置の失敗やダウンタイムが発生する可能性があります。

net.unixDomainSocket オプション（net.unixDomainSocket.enabled 、net.unixDomainSocket.pathPrefix 、net.unixDomainSocket.filePermissions など）。
Ops Manager のオートメーションでは、__exec や__rest などの内部設定を含む配置は拒否します。

これらの設定が必要な場合は、Ops Manager を使用せずに配置を手動で管理する必要があります。

構成バージョン

これには、自動化構成のバージョンが表示されます。

"version" : "<integer>"

名前	タイプ	必要性	説明
バージョン	integer	必須	このオートメーション構成ファイルを変更します。

ダウンロードベース

MongoDB Ops Managerは自動バージョンをダウンロードし、 options . DownloadBase のディレクトリで設定されたディレクトリで起動スクリプトを実行します。

"options" : {
  "downloadBase" : "<string>",
}

名前	タイプ	必要性	説明
options	オブジェクト	必須	新しいバージョンの自動ダウンロードのパス。
options.DownloadBase	string	必須	自動バージョンダウンロードとスタートアップスクリプトに関する Linux および UNIX プラットフォーム上のディレクトリ。

MongoDB バージョンの仕様

mongoDbVersions[n]配列は、 processes配列にある MongoDB インスタンスの仕様オブジェクトを定義します。 processes配列内の各 MongoDB インスタンスには、この配列内の仕様オブジェクトが必要です。

1 "mongoDbVersions[n]" : [
2   {
3    "name" : "<string>",
4     "builds" : [
5       {
6        "platform" : "<string>",
7         "url" : "<string>",
8         "gitVersion" : "<string>",
9         "modules" : [ "<string>", ... ],
10         "architecture" : "<string>",
11         "bits" : "<integer>",
12         "win2008plus" : "<Boolean>",
13         "winVCRedistUrl" : "<string>",
14         "winVCRedistOptions" : [ "<string>", ... ],
15         "winVCRedistDll" : "<string>",
16         "winVCRedistVersion" : "<string>"
17       },
18       ...
19     ],
20   },
21   ...
22 ]

名前	タイプ	必要性	説明
mongoDbVersions[n]	オブジェクトの配列	必須	プロセス配列にある MongoDB インスタンスの仕様オブジェクト。プロセス内の各 MongoDB インスタンスには、 mongoDbVersions[n]の仕様オブジェクトが必要です。
mongoDbVersions[n].name	string	必須	仕様オブジェクトの名前。この構成では、インスタンスのProcesss.versionパラメーターを介して MongoDB インスタンスに添付されます。
mongoDbVersions[n].Builds[k]	オブジェクトの配列	必須	この MongoDB インスタンスで利用可能なビルド。
mongoDbVersions[n].Builds[k].プラットフォーム	string	必須	この MongoDB インスタンスのプラットフォーム。
mongoDbVersions[n].Builds[k].url	string	必須	このインスタンスの MongoDB をダウンロードするURL 。
mongoDbVersions[n].Builds[k].gitVersion	string	必須	MongoDBプロセスを構築するために使用されるコードの状態を識別するコミット識別子。 MongoDB コマンドは GitVersion`buildInfo` 識別子を返します。
mongoDbVersions[n].Builds[k].modules	配列	必須	このバージョンのモジュールの一覧。 buildInfoコマンドが返すモジュールパラメーターに対応します。
mongoDbVersions[n].Builds[k].アーキテクチャ	string	必須	プロセッサのアーキテクチャ。 MongoDB Ops Managerはamd64またはppc64leを受け入れます。
mongoDbVersions[n].Builds[k].bits	integer	非推奨	プロセッサのバス幅。このパラメーターを削除したり変更したりしないでください。
mongoDbVersions[n].Builds[k].win2008++	ブール値	任意	Windows 7 以降または Windows Server 2008 R2 以降を必要とする Windows ビルドである場合は、をtrueに設定します。
mongoDbVersions[n].Builds[k].winVRedistUrl	string	任意	Microsoft Visual C++ 再ディストリビューションの必要なバージョンをダウンロードできるURL 。
mongoDbVersions[n].Builds[k].winVRedistOptions	文字列の配列	任意	Visualstring 再頒布可能インストーラーを実行するときに指定するコマンドラインオプションを一覧表示するMicrosoftC++ 値。各コマンドラインオプションは、配列内の個別の string です。
mongoDbVersions[n].Builds[k].winVRedistDll	string	任意	エージェントがチェックして新しいバージョンの Microsoft Visual C++再頒布可能ファイルが必要かどうかを判断するための Microsoft Visual C++ ランタイム DDL ファイルの名前。
mongoDbVersions[n].Builds[k].winVRedistVersion	string	任意	MicrosoftVisualC++ MicrosoftC++ランタイム DDL の最小

オートメーション

AgentVersionは MongoDB Agent のバージョンを指定します。

注意

バージョンが最新であることを確認するには、この構成プロパティを通じてMongoDB Agent を更新するのではなく、 Agent バージョンの更新エンドポイントを使用します。

"agentVersion" : {
  "name" : "<string>",
  "directoryUrl" : "<string>"
}

名前	タイプ	必要性	説明
agentVersion	オブジェクト	任意	実行する MongoDB Agent のバージョン。実行中のバージョンがこの設定と一致しない場合、MongoDB Agent は指定されたバージョンをダウンロードし、自分自身をシャットダウンして、新しいバージョンを起動します。
AgentVersion.name	string	任意	MongoDB Agent の希望バージョン。
AgentVersion.directoryUrl	string	任意	MongoDB Agent をダウンロードするURL 。

モニタリング

MonitoringVersions配列は、モニタリングエージェントのバージョンを指定します。 MongoDB Ops Manager では、このパラメーターは廃止されました。モニタリングログ設定を更新するには、モニタリング構成設定の更新エンドポイントを使用します。

1 "monitoringVersions" : [
2   {
3     "name" : "<string>",
4     "hostname" : "<string>",
5     "urls" : {
6       "<platform1>" : {
7         "<build1>" : "<string>",
8         ...,
9         "default" : "<string>"
10       },
11       ...
12     },
13     "baseUrl" : "<string>",
14     "logPath" : "<string>",
15     "logRotate" : {
16       "sizeThresholdMB" : <number>,
17       "timeThresholdHrs" : <integer>,
18       "numUncompressed": <integer>,
19       "percentOfDiskspace" : <number>,
20       "numTotal" : <integer>
21     }
22   },
23   ...
24 ]

名前	タイプ	必要性	説明
MonitoringVersions	オブジェクトの配列	任意	各モニタリングエージェントのバージョン情報を定義するオブジェクト。
MonitoringVersions.name	string	必須	モニタリングエージェントのバージョン。詳細については、「 MongoDB 互換性マトリクス」を参照してください。重要:このプロパティは読み取り専用です。このプロパティに加えられた変更は、 APIを通じてモニタリングエージェントを更新する場合には反映されません。モニタリングエージェントのバージョンを更新するには、このエンドポイントを参照してください。
MonitoringVersions.hostname	string	必須	モニタリングエージェントを実行するホストのFQDN 。モニタリングエージェントがホストで実行されていない場合、Ops Manager は MongoDB Ops Manager で指定されたロケーションからエージェントをインストールします。
MonitoringVersions.urls	オブジェクト	必須	モニタリングエージェントをダウンロードするプラットフォーム固有およびビルド固有のURL 。
MongoDB_ENUS_JAJP<platform>	オブジェクト	必須	オペレーティングシステムとそのバージョンを識別するラベル。フィールドには、キーと値のペアを持つオブジェクトが含まれています。各キーはビルドまたはデフォルトの名前で、各値はモニタリングエージェントをダウンロードするためのURLです。オブジェクトには、プラットフォームのデフォルトのダウンロード URL に設定されたデフォルトのキーが含まれている必要があります。
monitoringVersions.baseUrl	string	必須	mmsbaseurl 設定に使用されるベース URL 。
MonitoringVersions.logPath	string	任意	エージェントがログを保存するディレクトリ。デフォルトでは、ログは/dev/nullに保存されます。
MonitoringVersions.logRotate	オブジェクト	任意	プロセスの MongoDB ログのログローテーションを有効にします。
MonitoringVersions.logRotate.sizeThresholdMB	数値	必須	ローテーション前の個々のログファイルの最大サイズ（MB 単位）。
MonitoringVersions.logate.timeThresholdHrs	integer	必須	ローテーション前の個々のログファイルの最大時間（時間単位）。
MonitoringVersions.logRotate.numUncompressed	integer	任意	現在のログファイルを含む、非圧縮のままにするログファイルの最大数。デフォルトは5です。 MongoDB Ops Managerの以前のバージョンでは、このフィールドはmaxUncompressedという名前でした。以前の名前は引き続き認識されますが、新しいバージョンが優先されます。
MonitoringVersions.logRotate.percentOfDiskspace	数値	任意	削除前に、すべてのログファイルが消費するディスク領域の最大パーセンテージ。デフォルトは.02です。
MonitoringVersions.logRotate.num Total	integer	任意	ログファイルの合計数。数値が指定されていない場合、ログファイルの合計数はデフォルトで0になり、他のMonitorVersions.logRotate設定によって決まります。

バックアップ

backupVersions配列はバックアップエージェントのバージョンを指定します。 MongoDB Ops Manager では、このパラメーターは廃止されました。バックアップログ設定を更新するには、バックアップ構成設定の更新エンドポイントを使用します。

1 "backupVersions[n]" : [
2   {
3    "name" : "<string>",
4     "hostname" : "<string>",
5     "urls" : {
6      "<platform1>" : {
7        "<build1>" : "<string>",
8         ...,
9         "default" : "<string>"
10       },
11       ...
12     },
13     "baseUrl" : "<string>",
14     "logPath" : "<string>",
15     "logRotate" : {
16      "sizeThresholdMB" : "<number>",
17       "timeThresholdHrs" : "<integer>",
18       "numUncompressed": "<integer>",
19       "percentOfDiskspace" : "<number>",
20       "numTotal" : "<integer>"
21     }
22   },
23   ...
24 ]

名前	タイプ	必要性	説明
backupVersions[n]	オブジェクトの配列	任意	各バックアップエージェントのバージョン情報を定義するオブジェクト。
backupVersions[n].name	string	必須	バックアップエージェントのバージョン。詳細については、「 MongoDB 互換性マトリクス」を参照してください。重要:このプロパティは読み取り専用です。このプロパティに加えられた変更は、 API経由でバックアップエージェントを更新する場合には反映されません。バックアップエージェントのバージョンを更新するには、このエンドポイントを参照してください。
backupVersions[n].hostname	string	必須	バックアップエージェントを実行するホストのFQDN 。ホスト上でバックアップエージェントが実行されていない場合、 MongoDB Ops ManagerはbackupVersions[n].urlsで指定された場所からエージェントをインストールします。
backupVersions[n].urls	オブジェクト	必須	バックアップエージェントをダウンロードするためのプラットフォーム固有およびビルド固有のURL 。
backupVersions[n].urls.<platform>	オブジェクト	必須	オペレーティングシステムとそのバージョンを識別するラベル。フィールドには、キーと値のペアを持つオブジェクトが含まれます。各キーはビルドまたはデフォルトの名前で、各値はバックアップエージェントをダウンロードするためのURLです。オブジェクトには、プラットフォームのデフォルトのダウンロード URL に設定されたデフォルトのキーが含まれている必要があります。
backupVersions[n].baseUrl	string	必須	カスタム設定のマスターシップと HTTPS 設定に使用されるベースURL 。例、"baseUrl""= https://cloud.mongodb.com の場合、バックアップ構成フィールドには次の値が含まれます。 servership=api-backup.mongodb.com と https:// クラウド .mongodb.com 。
backupVersions[n].logPath	string	任意	エージェントがログを保存するディレクトリ。デフォルトでは、ログは/dev/nullに保存されます。
backupVersions[n].logRotate	オブジェクト	任意	プロセスの MongoDB ログのログローテーションを有効にします。
backupVersions[n].logRotate.sizeThresholdMB	数値	必須	ローテーション前の個々のログファイルの最大サイズ（MB 単位）。
backupVersions[n].logRotate.timeThresholdHrs	integer	必須	ローテーション前の個々のログファイルの最大時間（時間単位）。
backupVersions[n].logRotate.numUncompressed	integer	任意	現在のログファイルを含む、非圧縮のままにするログファイルの最大数。デフォルトは5です。
backupVersions[n].logRotate.percentOfDiskspace	数値	任意	削除前に、すべてのログファイルが消費するディスク領域の最大パーセンテージ。デフォルトは.02です。
backupVersions[n].logRotate.num Total	integer	任意	数値が指定されていない場合、ログファイルの合計数はデフォルトで0になり、他のbackupVersion.logRotate設定によって決まります。

MongoDB インスタンス

プロセス配列によって、MongoDB インスタンスの構成が決まります。この配列を使用すると、次のことができます。

インスタンスを復元します。
1 つ以上の MongoDB インスタンスで最初の同期プロセスを開始します。

1 "processes": [{
2   "<args>": {},
3   "alias": "<string>",
4   "authSchemaVersion": "<integer>",
5   "backupRestoreUrl": "<string>",
6   "certificatesVersion": "<integer>",
7   "cluster": "<string>",
8   "defaultRWConcern": {
9     "defaultReadConcern": {
10       "level": "<string>"
11     },
12     "defaultWriteConcern": {
13       "j": "<boolean>",
14       "w": "<string>",
15       "wtimeout": "<integer>"
16     }
17   }
18   "disabled": "<Boolean>",
19   "featureCompatibilityVersion": "<string>",
20   "hostname": "<string>",
21   "lastCompact" : "<dateInIso8601Format>",
22   "lastRestart" : "<dateInIso8601Format>",
23   "lastResync" : "<dateInIso8601Format>",
24   "lastKmipMasterKeyRotation" : "<dateInIso8601Format>",
25   "logRotate": {
26     "sizeThresholdMB": "<number>",
27     "timeThresholdHrs": "<integer>",
28     "numUncompressed": "<integer>",
29     "percentOfDiskspace": "<number>",
30     "numTotal": "<integer>"
31   },
32   "manualMode": "<Boolean>",
33   "name": "<string>",
34   "numCores": "<integer>",
35   "processType": "<string>",
36   "version": "<string>"
37 }]

名前	タイプ	必要性	説明
プロセス	配列	必須	Ops Manager`mongosmongod` が監視するインスタンスとインスタンスを定義するオブジェクトが含まれます。各オブジェクトは、異なるインスタンスを定義します。
process[n].args2_6	オブジェクト	必須	MongoDB バージョン 2.6 以降の MongoDB 構成オブジェクト。 `processes.args2_6`オブジェクトは、MongoDB バージョン 2.6 以降のほとんどの MongoDB 設定とパラメータを受け入れます。詳しくは、「 MongoDB 設定とオートメーションサポート」を参照してください。
process[n].args2_6シャーディング.clusterRole	string	条件付き	シャーディングされたクラスターにおけるこの`mongod` プロセスのロール。構成サーバーおよびシャードノードのプロセスに必要です。このフィールドを省略すると、対応するスタートアップフラグがないとMongoDB が起動できないため、配置が目的の状態のままになる可能性があります。指定できる値は以下のとおりです。 `configsvr` — 構成サーバープロセスの場合。 `shardsvr` — シャードノードプロセスの場合。
operations[n]. CLI は、	string	任意	プロセスが実行されるホストのホスト名エイリアス（多くの場合はDNS CNAME）。エイリアスが指定されている場合、MongoDB Agent はホストに接続するときに、process.hostname で指定されたホスト名よりもこのエイリアスを優先します。このエイリアスはreplicaSets.hostおよびsharding.configServerで指定することもできます。
process[n].authSchemaVersion	integer	必須	MongoDB データベースユーザーのユーザー認証情報のスキーマバージョン。これは、同じクラスターに属するプロセス配列の他のすべての要素と一致する必要があります。 MongoDB Ops Manager は、このパラメーターに3と5を受け入れます。 MongoDB 3.x および 4.x クラスターのデフォルトは5です。 MongoDB 2.6 クラスターのデフォルトは3です。詳細については、データベースマニュアルのSCRAMを参照してください。
process[n].backupRestoreUrl	string	任意	復元用の配信URL 。 Ops Manager は復元の作成時にこれを設定します。進行中の復元操作をキャンセルするには、このオプションを `CANCEL` に設定します。詳しくは、「 API を使用してバックアップ復元を自動化する」を参照してください。
processes[n].certificatesVersion	integer	任意	Counter that triggers zero-downtime TLS certificate rotation. When you increment this value, the MongoDB Agent runs `db.adminCommand({ rotateCertificates: 1 })` on each eligible process instead of restarting it. Rotation applies only to `mongod` and `mongos` processes running MongoDB 5.0 or later with TLS configured. Omit or set to `null` to treat as `0`. Equal values do not trigger rotation. Ops Manager rejects decrements with `HTTP 400 INVALID_AUTOMATION_CONFIG`. To learn more, see Rotate TLS Certificates Without Downtime.
operations[n].cluster	string	条件付き	シャーディングされたクラスターの名前。この値を、のシャーディング配列のシャーディング.name `mongos`パラメーターで同じ値に設定します。に必須です。`mongos` `mongod`では必要ありません。
defaultRWConcern.defaultReadConcern.level	string	任意	レプリカセットおよびレプリカセットシャードから読み取られたデータの整合性と分離プロパティ。 MongoDB Atlas は、次の値を受け入れます。 "available" "local" "過半数"
デフォルト RWConcern.defaultWriteConcern.j	ブール値	任意	書込み (write) 確認応答をディスク上のジャーナルに書込む必要があるかどうかを示すフラグ。
デフォルト RWConcern.defaultWriteConcern.w	string	任意	レプリカセットおよびレプリカセットシャードで書込み (write) 操作を確認する必要がある mongod インスタンスの希望数。 MongoDB Atlas は、次の値を受け入れます。任意の数値 0 以上 "過半数"
デフォルト RWConcern.defaultWriteConcern.wtimeout	数値	任意	書込み保証 (write concern)に希望する時間制限（ミリ秒単位）。デフォルト RWConcern.defaultWriteConcern.w を1 より大きい値に設定する場合に、この値を設定します。
operations[n].disabled	ブール値	任意	このプロセスをシャットダウンするかどうかを示すフラグ。プロセスをシャットダウンするにはtrueに設定します。
process[n].featureCompatibilityVersion	string	必須	このプロセスが機能と互換性がある MongoDB のバージョン。この値を変更すると、選択したfeatureCompatibilityVersionよりも前のバージョンまたはそれ以降の MongoDB バージョンと互換性のないデータを保持する特定の機能を有効または無効にできます。 MongoDB Ops Manager は、パラメーター値として 5.0、6.0、および 7.0 を受け入れます。既存の配置がある場合、MongoDB Ops Manager は、配置した MongoDB バージョンと同じか、1 リリース古い featureCompatibilityVersion のみ受け入れます。各 MongoDB バージョンでどのパラメータ値がサポートされているか、また、各値でどの機能が有効または無効になるかを確認するには、MongoDB Manual の `setFeatureCompatibilityVersion` を参照してください。 MongoDB Ops Manager は、このパラメーターを新しい配置の MongoDB バージョンと一致するように設定します。 MongoDB Ops Manager は、ホストをある MongoDB バージョンから次のバージョンにアップグレードしても、このパラメーターを自動的に増加させません。詳しくは、`setFeatureCompatibilityVersion` を参照してください。
process[n].hostname	string	必須	このプロセスを提供するホストの名前。デフォルトはlocalhostです。
process[n].lastCompact	string	任意	Timestamp in ISO 8601 date and time format in UTC when Ops Manager last reclaimed free space on a cluster's disks. During certain operations, MongoDB might move or delete data but it doesn't free the currently unused space. Ops Manager reclaims the disk space in a rolling fashion across members of the replica set or shards. このスペースを再利用するには、次の手順に従います。すぐに、この値を ISO8601 タイムスタンプとして現在の時刻に設定します。後で、この値を将来の ISO8601 タイムスタンプに設定します。 MongoDB Ops Manager は、現在の時刻が指定されたタイムスタンプを経過した後に、スペースを再利用します。クラスターのディスクの領域を再利用するときになどのあいまいさを排除するには、ISO8601 タイムスタンプを持つタイムゾーンを指定します。例、process.lastCompact 282021243を::52 PM（米国中央標準時間）に 1 月に設定するには、を使用します`"processes.lastCompact" : "2021-01-28T14:43:52-06:00"`
process[n].lastRestart	string	任意	Ops Manager がこのプロセスを最後に再起動したときの ISO 8601の日付と時刻形式（UTC）のタイムスタンプ。このパラメータを現在のタイムスタンプに設定すると、この構成をアップロードした後に Ops Manager はこのプロセスを強制的に再起動します。このパラメーターを同じクラスター内の複数のプロセスに設定すると、Ops Manager はレプリカセットまたはシャードのノード全体で選択したプロセスを順次再起動します。
process[n].lastResync	string	任意	Ops Manager がノードで実行した最後の最初の同期プロセスの ISO 8601 の日付と時刻形式（UTC）のタイムスタンプ。ノードで最初の同期プロセスをすぐにトリガーするには、この値を ISO8601 タイムスタンプとして現在の時刻に設定します。警告: このパラメータの使用には注意が必要です。最初の同期中に、オートメーションはノードの `dbPath`ディレクトリのコンテンツ全体を削除します。このパラメーターを設定すると、次の効果が生じます。セカンダリノードでは、MongoDB Agent は、指定されたタイムスタンプが最後の再同期の時点よりも後のかどうかを確認し、確認された場合は、このノードで最初の同期を開始します。たとえば、セカンダリノードの`processes.lastResync`を28 2021 、 2 : 43 : 52 PM（米国中央標準時間）に設定するには、次のコマンドを使用します。 `"processes.lastResync" : "2021-05-28T14:43:52-06:00"` MongoDB Agent は、このタイムスタンプが最後の再同期の記録時刻よりも後のことを確認すると、ノードで最初の同期を開始します。プライマリノードでは、 MongoDB Agent は、メソッドを使用してプライマリノードをセカンダリになるように要求するまで待機し、このノードで最初の同期`rs.stepDown()` を開始します。プライマリを含む同じクラスター内のすべてのノードで、 MongoDB Agent は、指定されたタイムスタンプが最後の再同期の時刻よりも後のかどうかを確認し、確認された場合は、セカンダリノードでローリング方式で最初の同期を開始します。 MongoDB Agent は、メソッドを使用してプライマリノードをセカンダリになるように要求するまで待機し、このノードで最初の同期`rs.stepDown()` を開始します。「最初の同期」を参照してください。
process[n].lastKmip MasterKeyRotation	string	任意	Timestamp in ISO 8601 date and time format in UTC when Ops Manager last rotated the master KMIP key. If you set this parameter to the current timestamp, Ops Manager rotate the key after you upload this configuration.
process[n].logRotate	オブジェクト	任意	プロセスの MongoDB ログをローテーションするための MongoDB 構成オブジェクト。
process[n].logRotate num Total	integer	任意	MongoDB Ops Managerが保持するログファイルの合計数。この値を設定しない場合、ログファイルの合計数はデフォルトで0になります。 MongoDB Ops Managerは、他のprocess.logRotate 設定に基づくローテーションに基づいます。
process[n].logRotate numUncompressed	integer	任意	現在のログファイルを含む、非圧縮のままにするログファイルの最大数。デフォルトは5です。
process[n].logRotate percentOfDiskspace	数値	任意	MongoDB Ops Managerがログファイルを保存するために使用できる合計ディスク領域の最大パーセンテージは小数で表されます。この制限を超えた場合、 MongoDB Ops Managerは、この制限を満たすまで圧縮されたログファイルを削除します。 MongoDB Ops Managerは、最も古いログファイルを最初に削除します。デフォルトは0.02です。
process[n].logRotate sizeThresholdMB	数値	必須	MongoDB Ops Managerがログファイルをローテーションする前の、個々のログファイルの最大サイズ（MB 単位）。 MongoDB Ops Manager は、このsizeThresholdMBまたは projects.logRotate.timeThresholdHrs のいずれかに指定された値を満たす場合、ログファイルをすぐにローテーションします。制限があります。
process[n].logRotate timeThresholdHrs	integer	必須	次のローテーションまでの個々のログファイルの最大期間（時間単位）。は最後のローテーション以降の時間です。 MongoDB Ops Manager は、ファイルがこのtimeThresholdHrsまたはprocesss.logRotate.sizeThresholdMBのいずれかを満たすと、ログファイルをローテーションします。制限があります。
process[n].manualMode	ブール値	任意	MongoDB Agent がこのプロセスを自動化するかどうかを示すフラグ。デフォルトはfalseです。このプロセス上のオートメーションを一時停止するには、true に設定します。MongoDB Agent は、オートメーションが再開されるまで、このプロセスに対してそれ以上のアクションは実行しません。このプロセスでオートメーションを有効にするには、 falseに設定します。 MongoDB Agent は、このプロセス上のアクションを自動化します。
operations[n].name	string	必須	インスタンスを識別するための一意の名前。
process[n].numCores	integer	任意	MongoDB Ops Managerがこのプロセスにバインドするコアの数。 MongoDB Agent は、プロセスを可能な限り均等に分散します。
operations[n].processType	string	必須	実行されているMongoDBプロセスのタイプ。 MongoDB Ops Manager は、このパラメータに`mongodmongos` またはを受け入れます。
process[n].version	string	必須	このインスタンスで使用されるmongoDbVersions仕様の名前。

クラスター全体

clusterWithConfigurationsでは、ローリング再起動を必要とせずにレプリカセットまたはシャーディングされたクラスター全体に設定するパラメーターを指定します。

1 "clusterWideConfigurations" : {
2   "<replicaSetID/clusterName>": {
3     "changeStreamOptions": {
4       "preAndPostImages": {
5         "expireAfterSeconds": <integer>
6       }
7     }
8   }
9 }

名前	タイプ	必要性	説明
replicaSetID/clusterName	オブジェクト	任意	レプリカセットまたはシャーディングされたクラスターに適用する変更ストリームオプション。 MongoDB Agent は、この構成が有効なJSON形式であるかどうかのみをチェックしますが、値が正確かどうかはチェックしません。
changeStreamOptions.preAndPostImages.expirationAfterSeconds	数値	必須	変更ストリームの事前イメージと事後イメージの保持ポリシー（秒単位）。値を省略すると、クラスターは対応する変更ストリームイベントを oplog から削除するまで、変更前と変更後のイメージを保持します。この値を削除すると、MongoDB Agent はこのパラメーターをオートメーション構成からのみ削除しますが、サーバーからは削除しません。詳しくは、`changeStreamOptions` を参照してください。

レプリカセット

レプリカセット配列は、各レプリカセットの構成を定義します。このフィールドは、レプリカセットを使用した配置に必須です。

1 "replicaSets":
2 [
3   {
4     "_id": "<string>",
5     "protocolVersion": "<string>",
6     "members":
7     [
8       {
9         "_id": "<integer>",
10         "host": "<string>",
11         "arbiterOnly": "<boolean>",
12         "buildIndexes": "<boolean>",
13         "hidden": "<boolean>",
14         "priority": "<number>",
15         "tags": "<object>",
16         "secondaryDelaySecs": "<integer>",
17         "votes": "<number>"
18       },{
19         "_id": "<integer>",
20         "host": "<string>",
21         "arbiterOnly": "<boolean>",
22         "buildIndexes": "<boolean>",
23         "hidden": "<boolean>",
24         "priority": "<number>",
25         "tags": "<object>",
26         "secondaryDelaySecs": "<integer>",
27         "votes": "<number>"
28       },{
29         "_id": "<integer>",
30         "host": "<string>",
31         "arbiterOnly": "<boolean>",
32         "buildIndexes": "<boolean>",
33         "hidden": "<boolean>",
34         "priority": "<number>",
35         "tags": "<object>",
36         "secondaryDelaySecs": "<integer>",
37         "votes": "<number>"
38       }
39     ],
40     "force":
41     {
42       "currentVersion": "<integer>"
43     }
44   }
45 ]

名前	タイプ	必要性	説明
レプリカセット	配列	任意	各レプリカセットの構成。 MongoDB Agent はこの配列の値を使用して、有効なレプリカセット構成ドキュメントを作成します。エージェントは、レプリカセットが正しく構成されていることを定期的にチェックします。問題が発生した場合、エージェントは構成ドキュメントに従ってレプリカセットを再構成します。配列には、レプリカセット構成ドキュメントの次の最上位フィールドを含めることができます。 _id 、バージョン。およびメンバー。詳しくは、`replSetGetConfig` を参照してください。
レプリカセット[n]._id	string	必須	レプリカセットの名前です。
replicaSets[n].protocolVersion	string	任意	レプリカセットのプロトコルバージョン。
レプリカセット[n].members	配列	任意	レプリカセットの各ノードを定義するオブジェクト。 groups.hostフィールドでは、process.name にリストされているホスト名を指定する必要があります。 MongoDB Agent は、ホストフィールドを展開して有効なレプリカセット構成を作成します。詳しくは、`replSetGetConfig` を参照してください。
レプリカセット[n].members[m]._id	integer	必須	レプリカセットのノードを示す任意の正の整数。
replicaSets[n].members[m].host	string	任意	このレプリカセットノードを提供するホスト名とポート番号（該当する場合）。
replicaSets[n].members[m].arbiterOnly	ブール値	任意	このレプリカセットがアービタとして機能するかどうかを示すフラグ。
レプリカセット[n].members[m].BuildIndexes	ブール値	任意	`mongod`プロセスがこのレプリカセットメンバーにインデックスを構築するかどうかを示すフラグ。
replicaSets[n].members[m].trigger	ブール値	任意	レプリカセットがこのノードに読み取り操作を受け入れることを許可しているかどうかを示すフラグ。
replicaSets[n].members[m].priority	数値	任意	MongoDB Ops Managerがこのレプリカセットノードをプライマリとして選択する相対的な資格。数値が大きいほど、資格が増加します。この値は、データを保持するノードの場合、0 から 1000 までの範囲で指定できます。アービタの値は 0 または 1 です。
レプリカセット[n].members[m]. tags	オブジェクト	任意	このレプリカセットに適用されるユーザー定義のラベルとその値のリスト。
replicaSets[n].members[m].secondaryDelaySecs	integer	任意	このレプリカセットがプライマリより遅れる時間（秒単位）。
レプリカセット[n].members[m]. Atlas	数値	任意	このレプリカセットノードがレプリカセット選挙のために投じる投票の量。データを保持するすべてのノードは 0 または 1 の投票を含むことができます。アービタの投票権は常に 1 票です。
レプリカセット[n]. force	オブジェクト	任意	レプリカセットがレプリカセット . force.currentVersion で指定された構成バージョンを使用するように強制するよう、MongoDB Agentに指示します。このオブジェクトを使用すると、MongoDB Agent はレプリカセットに新しい構成を強制的に受け入れて、ノードの少数が利用可能な状態から回復できます。
レプリカセット[n]. force.currentVersion	integer	任意	MongoDB Agent がレプリカセットに使用を強制する構成バージョン。レプリカセットに新しい構成を強制的に受け入れさせるには、を-1に設定します。警告:レプリカセットの再構成を強制すると、コミットされた過半数の書込み (write) がロールバックされる可能性があります。慎重に進む必要があります。この操作の潜在的な影響について質問がある場合は、 MongoDB サポートにお問い合わせください。

シャーディングされたクラスター

シャーディング配列は、各シャーディングされたクラスターの構成を定義します。このパラメーターは、シャーディングされたクラスターを使用した配置に必要です。

1 "sharding" : [
2   {
3     "managedSharding" : false,
4     "name" : "<string>",
5     "configServerReplica" : "<string>",
6     "shards" : [
7       {
8         "_id" : "<string>",
9         "rs" : "<string>",
10         "tags" : [ "<string>", ... ]
11       },
12       ...
13     ],
14   },
15   ...
16 ]

名前	タイプ	必要性	説明
シャーディング	オブジェクトの配列	任意	各シャーディングされたクラスターの構成を定義するオブジェクト。配列内の各オブジェクトには、1 つのクラスターの仕様が含まれています。 MongoDB Agent は、各クラスターの状態を仕様に対して定期的にチェックします。仕様とクラスターが一致しない場合、エージェントはクラスターの構成を変更し、バランサーがチャンクを移行する可能性があります。
sharding.managedSharding	ブール値	任意	Ops Manager Automation が配置内のすべてのシャーディングされたコレクションとタグを管理するかどうかを示すフラグ。 MongoDB Ops Manager7 バージョン.0 以降では、これは`false` にのみ設定できます。
sharding.name	string	条件付き	クラスターの名前。これは、のprocess.cluster `mongos`の値に対応する必要があります。
sharding.configServerReplica	string	条件付き	コンフィギュレーションサーバーのレプリカセットの名前。コンフィギュレーションサーバーがレプリカセットとして実行される場合は、この配列パラメーターを追加できます。レプリカセットとして実行されない、ミラー化されたレガシーコンフィギュレーションサーバーを実行する場合は、 sharding.configServerを使用します。
sharding.configServer	文字列の配列	条件付き	コンフィギュレーションサーバーホストの名前。ホスト名は、各ホストのprocess.nameパラメータで使用される名前と一致します。重要: MongoDB 3.4では、ミラーリングされたコンフィギュレーションサーバーのサポートが排除されます。シャーディングされたシャーディングされたクラスターでMongoDB 3.4以降が実行されている場合は、シャーディング.configServerReplicaを使用します。
sharding.shards	オブジェクトの配列	条件付き	クラスターのシャード。
sharding.shards._id	string	条件付き	シャードの名前。
sharding.shards.rs	string	条件付き	シャードのレプリカセットの名前。これはreplicaSets._idで指定されます許可されます。
sharding.shards. tags	文字列の配列	条件付き	このシャードに割り当てられたゾーン。ゾーンシャーディングを使用する場合は、この配列パラメーターを追加できます。

クラスターバランサー

バランサーオブジェクトは任意であり、各クラスターのバランサー設定を定義します。

1 "balancer": {
2   "<clusterName1>": {},
3   "<clusterName2>": {},
4   ...
5 }

名前	タイプ	必要性	説明
バランサー	オブジェクト	任意	各クラスターに対してという名前のパラメーター。各パラメーターには、そのクラスターのバランサー設定を持つオブジェクトが含まれています。オブジェクトは、停止したウィンドウとアクティブなWindowパラメーターを使用します。詳細については、 MongoDBマニュアルのシャードクラスタバランサーの管理を参照してください。

認証

認証を有効にするには、 authオブジェクトを設定します。このオブジェクトは任意であり、認証関連の設定を定義します。

1 {
2   "auth": {
3     "authoritativeSet": "<boolean>",
4     "autoUser": "<string>",
5     "autoPwd": "<string>",
6     "disabled": "<boolean>",
7     "deploymentAuthMechanisms": ["<string>", "<string>"],
8     "autoAuthMechanisms": ["<string>"],
9     "key": "<string>",
10     "keyfile": "<string>",
11     "newAutoPwd": "<string>",
12     "newKey": "<string>",
13     "usersDeleted": [{
14       "user": "<string>",
15       "dbs": ["<string>", "<string>"]
16     }],
17     "usersWanted": [{
18       "authenticationRestrictions": [{
19         "clientSource": ["(IP | CIDR range)", "(IP | CIDR range)"],
20         "serverAddress": ["(IP | CIDR range)", "(IP | CIDR range)"]
21       }],
22       "db": "<string>",
23       "initPwd": "<string>",
24       "otherDBRoles": {
25         "<string>": ["<string>", "<string>"]
26       },
27       "roles": [{
28         "db": "<string>",
29         "role": "<string>"
30       }],
31       "pwd": "<string>",
32       "user": "<string>"
33     }]
34   }
35 }

名前

タイプ

必要性

説明

認証

オブジェクト

任意

認証関連の設定を定義します。

このパラメーターを省略すると、このセクションの残りの部分がスキップされます。

auth. authoritativeSet

ブール値

条件付き

MongoDB Ops Managerがプロジェクト内のすべての管理対象配置で、管理対象のMongoDBユーザーとロールの一貫したセットを強制するかどうかを設定します。

"auth. authoritativeSet" : true の場合、 MongoDB Ops Managerは一貫したユーザーとロールを強制します。
"auth. authoritativeSet" : falseの場合、 MongoDB Ops Managerは一貫したユーザーとロールを強制しません。

auth . authoritativeSet のデフォルトはfalseです。

認証を有効にする場合は必須です。

auth.autoUser

string

条件付き

オートメーションがインスタンスに接続するときに使用するユーザー名。

認証を有効にする場合は必須です。

auth.autoPwd

string

条件付き

オートメーションがインスタンスに接続するときに使用するパスワード。

認証を有効にする場合は必須です。

auth.disabled

ブール値

任意

認証が無効になっているかどうかを示すフラグ。指定されていない場合、無効化されたはデフォルトでfalseになります。

auth.deploymentAuthMechanisms

文字列の配列

条件付き

配置内のプロセスに対してサポートされている認証メカニズムを一覧表示します。

認証を有効にする場合は必須です。

次の値を指定します。

値	認証メカニズム
MONGODB-CR	SCRAM-SHA-1
SCRAM-SHA-256	SCRAM-SHA-256
MONGODB-X509	x.509 クライアント証明書
PLAIN	LDAP
GSSAPI	Kerberos

auth.autoAuthMechanisms

文字列の配列

条件付き

オートメーションで使用される認証メカニズムを設定します。指定されていない場合、無効化されたはデフォルトでfalseになります。

認証を有効にする場合は必須です。

このパラメーターに複数の要素が含まれるのは、SCRAM-SHA-1 と SCRAM-SHA-256 の両方に構成されている場合のみです。

次の値を指定します。

値	認証メカニズム
MONGODB-CR	SCRAM-SHA-1
SCRAM-SHA-256	SCRAM-SHA-256
MONGODB-X509	x.509 クライアント証明書
PLAIN	LDAP
GSSAPI	Kerberos

auth.key

string

条件付き

MongoDB Ops Manager が MongoDB プロセスへの認証に使用するキーファイルの内容。

認証を有効にし、 "auth.disabled" : falseを有効にする場合は必須です。

auth.key の値を変更する場合は、 auth.keyfileの値を変更する必要があります。

auth.keyfile

string

条件付き

MongoDB Ops Manager が MongoDB プロセスへの認証に使用するキーファイルのパスと名前。

認証を有効にし、 "auth.disabled" : falseを有効にする場合は必須です。

auth.keyfile値を変更する場合は、 auth.keyの値も変更する必要があります。

auth
.newAutoPwd

string

任意

オートメーションがインスタンスに接続するときに使用する新しいパスワード。接続を失うことなくパスワードをローテーションするには、次の手順に従います。

auth.newAutoPwdを設定し、現在のパスワードと共にauth.autoPwdを残ります。
ターゲットの状態を待ちます。
auth.newAutoPwdはauth.autoPwdパスワードを自動的にコピーします。

このオプションは、 auth.autoAuthMechanismsのオートメーションの認証メカニズムの 1 つとして SCRAM-SHA-1 または SCRAM-SHA-256 を含めている場合にのみ設定できます。

auth.newKey

string

任意

MongoDB プロセスへの認証に MongoDB Ops Manager が使用する新しいキーファイルの内容。

このオプションを設定すると、 MongoDB Ops Managerは、アプリケーションが配置内のMongoDBプロセスへの認証に使用するキーをローテーションします。すべてのMongoDBエージェントが新しいキーを使用すると、 MongoDB Ops Managerは auth.key の値をauth.newKeyで指定した新しいキーに置き換え、オートメーション構成からauth.newKeyを削除します。

auth.usersDeleted

オブジェクトの配列

任意

指定されたデータベースまたはすべてのデータベースから削除する認証済みユーザーを定義するオブジェクト。この配列にはauth.usersDeleted.userとauth.usersDeleted.dbsが含まれている必要があります。

auth.usersDeleted[n].user

string

任意

MongoDB Ops Manager が削除するユーザーのユーザー名。

auth.usersDeleted[n].dbs

文字列の配列

任意

MongoDB Ops Manager が認証されたユーザーを削除するデータベースの名前を一覧表示します。

auth.usersWanted

オブジェクトの配列

任意

指定されたデータベースに追加する認証済みユーザーを定義するオブジェクトが含まれます。各オブジェクトにはauth.usersWanted[n].dbが必要です。 auth.usersWanted[n].user, およびauth.usersWanted[n].roles パラメーター、 auth.usersWanted[n].initPwd 、またはauth.usersWanted[n].userSource

auth.usersWanted[n].db

string

条件付き

ユーザーを追加するデータベース。

auth.usersWanted[n].user

string

条件付き

MongoDB Ops Manager が追加するユーザーの名前。

auth.usersWanted[n].roles

配列

条件付き

ユーザーのデータベースからユーザーに割り当てられるロールのリスト。このロールはauth.usersWalted[n].dbで指定されます。

auth.usersWanted[n].pwd

string

条件付き

現在ユーザーに割り当てられているパスワードの 32 文字の 16 進数SCRAM-SHA-1ハッシュ。

MongoDB Ops Manager は、パスワードを設定または変更するために、このパラメーターを使用することはありません。

次の場合に必須:

認証を有効にする
"auth.deploymentAuthMechanisms" : "MONGODB-CR"
"auth.usersWanted[n].initPwd"が設定されていない

auth.usersWanted[n].initPwd

string

条件付き

ユーザーに割り当てるクリアテキストのパスワード。

次の場合に必須:

認証を有効にする
"auth.deploymentAuthMechanisms" : "MONGODB-CR"
"auth.usersWanted[n].initPwd"が設定されていない

auth.usersWanted[n].userSource

string

非推奨

サポートされなくなりました。

auth.usersWanted[n].OTHERDBRoles

オブジェクト

任意

ユーザーのデータベース"auth.usersWanted[n].db" : "admin"を割り当てると、このオブジェクトを使用して他のデータベースのユーザーロールも割り当てることができます。オブジェクトには、キーと値のペアが含まれています。キーはデータベースの名前で、値はそのデータベースから割り当てられるロールをリストするstring値の配列です。

auth.usersWanted[n].authenticationRestrictions

ドキュメントの配列

任意

ホストがユーザーに強制する認証制限。

警告:ユーザーが互換性のない認証制限を持つ複数のロールを継承すると、そのユーザーは使用できなくなります。たとえば、ユーザーが、 clientSourceフィールドが[198.51.100.0]であるロールと、 clientSourceフィールドが[203.0.113.0]である別のロールを継承した場合、サーバーはユーザーを認証できません。 MongoDB での認証の詳細については、「認証」を参照してください。

auth.usersWanted[n].authenticationRestrictions[k].clientSource

文字列の配列

条件付き

ユーザーの認証時に存在する場合、ホストは指定されたリストにクライアントの IP アドレスCIDR範囲が含まれていることを確認します。クライアントの IP アドレスが存在しない場合、ホストはユーザーを認証しません。

auth.usersWanted[n].authenticationRestrictions[k].serverAddress

文字列の配列

条件付き

クライアントが接続できる IP アドレスのカンマ区切り配列。存在する場合、ホストは MongoDB Ops Manager が指定された配列内の IP アドレスからのクライアントの接続を受け入れたことを確認します。認識されない IP アドレスから接続が受け入れられた場合、ホストはユーザーを認証しません。

LDAP

ldap オブジェクトにより、LDAP 認証が有効になります。このオブジェクトは任意です。詳細については、「Ops Manager プロジェクトの LDAP認証の有効化」を参照してください。

 "ldap": {
   "servers": "<host>:<port>, <host>:<port>",
   "timeoutMS": "<time>",
   "bindMethod": "<sasl/simple>",
   "bindSaslMechanisms": "<sasl-mechanism>, <sasl-mechanism>",
   "bindQueryUser": <ldap-dn>",
   "bindQueryPassword": "<password>",
   "userCacheInvalidationPeriod": "<interval>",
   "authzQueryTemplate": "<rfc-4516-url>",
   "userToDNMapping": [
             {
                     "match": "<ECMAScript-regex>",
                     "<substition/ldapQuery>": "<DN-string/RFC4516-encoded-LDAP-query>"
             }
   ]
}

名前	タイプ	必要性	説明
ldap	オブジェクト	任意	LDAP 認証を有効にして構成するための設定を含むオブジェクト。
ldap.servers	string	条件付き	Comma-separated string that contains one or more LDAP servers in `<host>:<port>` format to execute queries against. You can use `setParameter` to configure this setting on a running system. For LDAP authorization, you must specify this setting.
ldap.timeoutMS	long	任意	Amount of time in milliseconds that MongoDB waits for an LDAP server to respond to a request before timing out. You can use `setParameter` to configure this setting on a running system. By default, MongoDB times out after ten seconds.
ldap.bindメソッド	string	任意	自身の認証に単純認証を使用するか、SASLプロトコルを使用するかを示す、人間が判読可能な文字列。 `simple` または `sasl` を指定できます。デフォルトでは、 MongoDB は簡易認証を使用します。
ldap.bindSaslMechanisms	string	任意	MongoDB がバインディング中に LDAPサーバーに対して認証を試行するための SASL メカニズムのコンマ区切りリストを含む string。デフォルトでは、 MongoDB は`DIGEST-MD5` を使用してバインドします。
ldap.bindQueryUser	string	条件付き	LDAP entity domain name that MongoDB binds as when it connects to an LDAP server. You can use `setParameter` to configure this setting on a running system. For MongoDB to bind with authentication credentials, you must specify this setting.
ldap.bindQueryPassword	string	条件付き	Password that MongoDB binds with when it connects to an LDAP server. You can use `setParameter` to configure this setting on a running system. For MongoDB to bind with a password, you must specify this setting.
ldap.userCacheInvalidationPerid	integer	任意	MongoDB がユーザーキャッシュのフラッシュ間で待機する間隔。外部ユーザーキャッシュがフラッシュされると、LDAP 認可ユーザーが実行する次の操作にはロールが必要です。値を大きくすると、LDAP サーバーの負荷が軽減され、 MongoDBロールと LDAP グループメンバーシップの同期に必要な時間が長くなる可能性があります。デフォルトでは、 MongoDB はキャッシュのフラッシュ間で 30 秒待機します。
ldap.authzQueryTemplate	string	条件付き	RFC 4516 formatted URL of the LDAP query to execute to obtain LDAP groups relative to the `ldap.server` setting. In this URL, the placeholder token string `{USER}` is replaced with the acquired user domain name. You can use `setParameter` to configure this setting on a running system. For LDAP authorization, you must specify this setting.
ldap.userToDNMapping	配列	任意	JSON-formatted array that contains the ordered transformations that MongoDB applies to authenticate MongoDB user names to match their domain names. You can specify this setting if you use an alternate authentication method, or if the user name passed to MongoDB for authentication doesn't match the LDAP domain name. You can use `setParameter` to configure this setting on a running system. By default, MongoDB uses user names as the domain names for automatic LDAP authorization.

ssl

sslオブジェクトは、接続を暗号化するためのTLSを有効にします。このオブジェクトは任意です。

"ssl" : {
  "CAFilePath" : "<string>"
}

名前	タイプ	必要性	説明
ssl	オブジェクト	任意	接続を暗号化するためにTLSを有効にします。 TLSを使用するには、 TLSをサポートするパッケージを選択してください。 MongoDB Enterpriseをサポートするすべてのプラットフォームは、 TLSもサポートしています。
ssl.clientCertificateMode	string	条件付き	MongoDB Ops Manager への接続にTLS証明書が必要かどうかを示します。値は任意で、必須です。
ssl.CAFilePath	string	条件付き	Linux または UNIX ホスト上のTLS経由で認証するために使用される証明書への絶対ファイルパス。 MongoDB Ops Manager には、次の場合に ssl.CAFilePath または ssl.CAFilePathWindows のいずれかが必要です。 TLS または X.509認証を使用しており、 CA ファイルはオペレーティングシステムのルート証明書に含まれていません。
ssl.CAFilePathWindows	string	条件付き	Windows ホスト上でTLS経由で認証するために使用される証明書への絶対ファイルパス。 MongoDB Ops Manager には、次の場合に ssl.CAFilePath または ssl.CAFilePathWindows のいずれかが必要です。 TLS または X.509認証を使用しており、 CA ファイルはオペレーティングシステムのルート証明書に含まれていません。
ssl.autoPEMKeyFilePath	string	条件付き	Linux または UNIX ホスト上のTLS接続を認証するクライアント秘密キー（PEM）ファイルへの絶対ファイルパス。 Ops Manager requires either ssl.autoPEMKeyFilePath or ssl.autoPEMKeyFilePathWindows if you're using TLS or X.509 authentication.
ssl.autoPEMKeyFilePathWindows	string	条件付き	Windows ホスト上でTLS接続を認証するクライアント秘密キー（PEM）ファイルへの絶対ファイルパス。 Ops Manager requires either ssl.autoPEMKeyFilePath or ssl.autoPEMKeyFilePathWindows if you're using TLS or X.509 authentication.
ssl.autoPEMKeyFilePwd	string	条件付き	ssl.autoPEMKeyFilePath または ssl.autoPEMKeyFilePathWindows で指定された秘密キー（PEM）ファイルのパスワード。PEMファイルが暗号化されている場合、MongoDB Ops Manager ではこのパスワードが必要です。

MongoDB のロール

roles配列は任意であり、ユーザー定義のロールを記述します。

1 "roles" : [
2   {
3     "role" : "<string>",
4     "db" : "<string>",
5     "privileges" : [
6       {
7         "resource" : { ... },
8         "actions" : [ "<string>", ... ]
9       },
10       ...
11     ],
12     "roles" : [
13       {
14         "role" : "<string>",
15         "db" : "<string>"
16       }
17     ]
18     "authenticationRestrictions" : [
19      {
20       "clientSource": [("<IP>" | "<CIDR range>"), ...],
21       "serverAddress": [("<IP>" | "<CIDR range>"), ...]
22     }, ...
23   ]
24   },
25   ...
26 ]

名前	タイプ	必要性	説明
役割	オブジェクトの配列	任意	MongoDB がクラスターのユーザー定義ロールに割り当てたロールと権限。各オブジェクトは、異なるユーザー定義ロールについて説明します。この配列内のオブジェクトには、システムロールコレクションのドキュメントと同じフィールドが含まれていますが、_id フィールドは除きます。
role[n].role	string	条件付き	ユーザー定義ロールの名前。
role[n].db	string	条件付き	ユーザー定義ロールが属するデータベース。
role[n].rivileges	ドキュメントの配列	条件付き	このロールが実行できる特権。
role[n].services[k].resource	string	条件付き	特権アクションが適用されるリソースを指定します。
role[n].rivileges[k].actions	string	条件付き	リソースに対して許可されるアクション。詳しくは、特権アクションを参照してください。
roles[n].roles	ドキュメントの配列	条件付き	このロールが特権を継承するロール。
role[n].authenticationRestrictions	ドキュメントの配列	任意	MongoDB サーバーがこのロールに強制する認証制限。警告:ユーザーが互換性のない認証制限を持つ複数のロールを継承すると、そのユーザーは使用できなくなります。たとえば、ユーザーが、 `clientSource`フィールドが`[198.51.100.0]`であるロールと、 `clientSource`フィールドが`[203.0.113.0]`である別のロールを継承した場合、サーバーはユーザーを認証できません。 MongoDB での認証の詳細については、「認証」を参照してください。
role[n].authenticationRestrictions[k].clientSource	文字列の配列	条件付き	存在する場合、MongoDB サーバーはユーザーを認証する際に、クライアントの IP アドレスが指定されたリストにあること、またはリスト内のCIDR範囲に属していることを確認します。クライアントの IP アドレスが存在しない場合、MongoDB サーバーはユーザーを認証しません。
role[n].authenticationRestrictions[k].serverAddress	文字列の配列	条件付き	クライアントが接続できる IP アドレスのカンマ区切り配列。存在する場合、MongoDB サーバーは、指定された配列内の IP アドレスからのクライアントの接続を受け入れたことを確認します。 MongoDB サーバーが認識されていない IP アドレスからの接続を受け入れた場合、MongoDB サーバーはユーザーを認証しません。

Kerberos

kerberosオブジェクトは任意であり、認証で使用される Kerberos サービス名を定義します。

"kerberos": {
  "serviceName": "<string>"
}

名前	タイプ	必要性	説明
kerberos	オブジェクト	任意	エージェントが Kerberos 経由で認証するために使用する Kerberos サービス名を定義するキーと値のペア。
kerberos.serviceName	string	必須	次の要素を設定するラベル。エージェントが Kerberos`mongodmongos` を介してまたはに認証するために使用するサービス名。 saslServiceName オプションは MongoDB Server パラメーターです。

Indexes

indexConfigs配列は任意であり、特定のレプリカセットに対して構築するインデックスを定義します。

1 "indexConfigs": [{
2   "key": [
3     ["<string>", "<value>"]
4   ],
5   "rsName": "<string>",
6   "dbName": "<string>",
7   "collectionName": "<string>",
8   "collation": {
9     "locale": "<string>",
10     "caseLevel": <boolean>,
11     "caseFirst": "<string>",
12     "strength": <number>,
13     "numericOrdering": <boolean>,
14     "alternate": "<string>",
15     "maxVariable": "<string>",
16     "normalization": <boolean>,
17     "backwards": <boolean>
18   },
19   "options": {
20     "<key>": "<value>"
21   }
22 }]

名前

タイプ

必要性

説明

indexConfigs

オブジェクトの配列

任意

特定のレプリカセットに対して構築される特定のインデックス。

indexConfigs.key

配列の配列

必須

インデックス内のキー。この "配列の配列" には、インデックスのキーが 1 つのみという条件を満たす場合、単一の配列が含まれます。

indexConfigs.rsName

string

必須

MongoDB がインデックスを構築するレプリカセット。

indexConfigs.dbName

string

必須

MongoDB がインデックスを作成するデータベース。

indexConfigs.collectionName

string

必須

MongoDB がインデックスするコレクション。

indexConfigs.collation

オブジェクト

任意

インデックスが照合を使用する場合に、string をソートして一致させるときに使用する言語固有のルール。

indexConfigs.collationオブジェクトを含める場合は、 indexConfigs.collation.localeパラメータを含める必要があります。その他のパラメーターはすべてオプションです。

indexConfigs.collationオブジェクトを含めない場合、インデックスには照合を含めることはできません。

indexConfigs.collation.locale

string

必須

ICU が定義するロケール。

MongoDB Serverマニュアルでは、照合ロケールとデフォルトパラメーターセクションにサポートされているロケールが一覧化されています。

単純なバイナリ比較を指定するには、この値をsimpleに設定します。

indexConfigs.collation.caseLevel

ブール値

任意

インデックスが大文字と小文字比較を使用する方法を示すフラグ。

このパラメーターをtrueに設定すると、インデックスは大文字と小文字の比較を使用します。

このパラメータは、 indexConfigs.collation.stringthを1または2に設定した場合にのみ適用されます。

「照合」を参照してください。

indexConfigs.collation. caseFirst

string

任意

三次レベルの比較中に、大文字と小文字の相違をソート順序で並べ替えます。

MongoDB Serverマニュアルでは、照合セクションに可能な値がリストされています。

indexConfigs.collation.stringth

数値

任意

実行する比較のレベル。 ICU の比較レベルに対応します。

MongoDB Serverマニュアルでは、照合セクションに可能な値がリストされています。

indexConfigs.collation.numericOrdering

ブール値

任意

数字の string を比較する方法を示すフラグ。

値	照合方法	例
true	数値として比較された数字の string	10 > 2.
false	string と比較された数字 string	10 < 2 。

デフォルトはfalseです。

「照合」を参照してください。

indexConfigs.collation.alternate

string

任意

照合で、空白と句読点を比較中の基本文字として空白と句読点の基本文字として考慮する方法を決定する設定。

MongoDB Serverマニュアルでは、照合セクションに可能な値がリストされています。

indexConfigs.collation.maxVvariable

string

任意

インデックスが無視できる文字。このパラメーターは、 indexConfigs.collation.alternateがシフトに設定されている場合にのみ適用されます。

MongoDB Serverマニュアルでは、照合セクションに可能な値がリストされています。

indexConfigs.collation. Normalization

ブール値

任意

テキストを正規化する必要があるかどうかを示すフラグ。

このパラメーターをtrueに設定すると、照合は次のようになります。

テキストに正規化が必要かどうかを確認します。
テキストを比較するために正規化を実行します。

デフォルトはfalseです。

「照合」を参照してください。

indexConfigs.collation.backwards

ブール値

任意

インデックスが発音区別符号付き文字列を処理する方法を示すフラグ。

このパラメーターをtrueに設定すると、発音区別符号付きの string は、string の後ろから前にソートされます。

デフォルトはfalseです。

「照合」を参照してください。

indexConfigs.options

ドキュメント

必須

MongoDB Go ドライバーがサポートするインデックスオプション。

戻る

高度なオプション

MongoDB設定とオートメーション

1	"mongoDbVersions[n]" : [
2	{
3	"name" : "<string>",
4	"builds" : [
5	{
6	"platform" : "<string>",
7	"url" : "<string>",
8	"gitVersion" : "<string>",
9	"modules" : [ "<string>", ... ],
10	"architecture" : "<string>",
11	"bits" : "<integer>",
12	"win2008plus" : "<Boolean>",
13	"winVCRedistUrl" : "<string>",
14	"winVCRedistOptions" : [ "<string>", ... ],
15	"winVCRedistDll" : "<string>",
16	"winVCRedistVersion" : "<string>"
17	},
18	...
19	],
20	},
21	...
22	]

1	"monitoringVersions" : [
2	{
3	"name" : "<string>",
4	"hostname" : "<string>",
5	"urls" : {
6	"<platform1>" : {
7	"<build1>" : "<string>",
8	...,
9	"default" : "<string>"
10	},
11	...
12	},
13	"baseUrl" : "<string>",
14	"logPath" : "<string>",
15	"logRotate" : {
16	"sizeThresholdMB" : <number>,
17	"timeThresholdHrs" : <integer>,
18	"numUncompressed": <integer>,
19	"percentOfDiskspace" : <number>,
20	"numTotal" : <integer>
21	}
22	},
23	...
24	]

1	"backupVersions[n]" : [
2	{
3	"name" : "<string>",
4	"hostname" : "<string>",
5	"urls" : {
6	"<platform1>" : {
7	"<build1>" : "<string>",
8	...,
9	"default" : "<string>"
10	},
11	...
12	},
13	"baseUrl" : "<string>",
14	"logPath" : "<string>",
15	"logRotate" : {
16	"sizeThresholdMB" : "<number>",
17	"timeThresholdHrs" : "<integer>",
18	"numUncompressed": "<integer>",
19	"percentOfDiskspace" : "<number>",
20	"numTotal" : "<integer>"
21	}
22	},
23	...
24	]

1	"processes": [{
2	"<args>": {},
3	"alias": "<string>",
4	"authSchemaVersion": "<integer>",
5	"backupRestoreUrl": "<string>",
6	"certificatesVersion": "<integer>",
7	"cluster": "<string>",
8	"defaultRWConcern": {
9	"defaultReadConcern": {
10	"level": "<string>"
11	},
12	"defaultWriteConcern": {
13	"j": "<boolean>",
14	"w": "<string>",
15	"wtimeout": "<integer>"
16	}
17	}
18	"disabled": "<Boolean>",
19	"featureCompatibilityVersion": "<string>",
20	"hostname": "<string>",
21	"lastCompact" : "<dateInIso8601Format>",
22	"lastRestart" : "<dateInIso8601Format>",
23	"lastResync" : "<dateInIso8601Format>",
24	"lastKmipMasterKeyRotation" : "<dateInIso8601Format>",
25	"logRotate": {
26	"sizeThresholdMB": "<number>",
27	"timeThresholdHrs": "<integer>",
28	"numUncompressed": "<integer>",
29	"percentOfDiskspace": "<number>",
30	"numTotal": "<integer>"
31	},
32	"manualMode": "<Boolean>",
33	"name": "<string>",
34	"numCores": "<integer>",
35	"processType": "<string>",
36	"version": "<string>"
37	}]

1	"clusterWideConfigurations" : {
2	"<replicaSetID/clusterName>": {
3	"changeStreamOptions": {
4	"preAndPostImages": {
5	"expireAfterSeconds": <integer>
6	}
7	}
8	}
9	}

1	"replicaSets":
2	[
3	{
4	"_id": "<string>",
5	"protocolVersion": "<string>",
6	"members":
7	[
8	{
9	"_id": "<integer>",
10	"host": "<string>",
11	"arbiterOnly": "<boolean>",
12	"buildIndexes": "<boolean>",
13	"hidden": "<boolean>",
14	"priority": "<number>",
15	"tags": "<object>",
16	"secondaryDelaySecs": "<integer>",
17	"votes": "<number>"
18	},{
19	"_id": "<integer>",
20	"host": "<string>",
21	"arbiterOnly": "<boolean>",
22	"buildIndexes": "<boolean>",
23	"hidden": "<boolean>",
24	"priority": "<number>",
25	"tags": "<object>",
26	"secondaryDelaySecs": "<integer>",
27	"votes": "<number>"
28	},{
29	"_id": "<integer>",
30	"host": "<string>",
31	"arbiterOnly": "<boolean>",
32	"buildIndexes": "<boolean>",
33	"hidden": "<boolean>",
34	"priority": "<number>",
35	"tags": "<object>",
36	"secondaryDelaySecs": "<integer>",
37	"votes": "<number>"
38	}
39	],
40	"force":
41	{
42	"currentVersion": "<integer>"
43	}
44	}
45	]

1	"sharding" : [
2	{
3	"managedSharding" : false,
4	"name" : "<string>",
5	"configServerReplica" : "<string>",
6	"shards" : [
7	{
8	"_id" : "<string>",
9	"rs" : "<string>",
10	"tags" : [ "<string>", ... ]
11	},
12	...
13	],
14	},
15	...
16	]

1	"balancer": {
2	"<clusterName1>": {},
3	"<clusterName2>": {},
4	...
5	}

1	{
2	"auth": {
3	"authoritativeSet": "<boolean>",
4	"autoUser": "<string>",
5	"autoPwd": "<string>",
6	"disabled": "<boolean>",
7	"deploymentAuthMechanisms": ["<string>", "<string>"],
8	"autoAuthMechanisms": ["<string>"],
9	"key": "<string>",
10	"keyfile": "<string>",
11	"newAutoPwd": "<string>",
12	"newKey": "<string>",
13	"usersDeleted": [{
14	"user": "<string>",
15	"dbs": ["<string>", "<string>"]
16	}],
17	"usersWanted": [{
18	"authenticationRestrictions": [{
19	"clientSource": ["(IP \| CIDR range)", "(IP \| CIDR range)"],
20	"serverAddress": ["(IP \| CIDR range)", "(IP \| CIDR range)"]
21	}],
22	"db": "<string>",
23	"initPwd": "<string>",
24	"otherDBRoles": {
25	"<string>": ["<string>", "<string>"]
26	},
27	"roles": [{
28	"db": "<string>",
29	"role": "<string>"
30	}],
31	"pwd": "<string>",
32	"user": "<string>"
33	}]
34	}
35	}

1	"roles" : [
2	{
3	"role" : "<string>",
4	"db" : "<string>",
5	"privileges" : [
6	{
7	"resource" : { ... },
8	"actions" : [ "<string>", ... ]
9	},
10	...
11	],
12	"roles" : [
13	{
14	"role" : "<string>",
15	"db" : "<string>"
16	}
17	]
18	"authenticationRestrictions" : [
19	{
20	"clientSource": [("<IP>" \| "<CIDR range>"), ...],
21	"serverAddress": [("<IP>" \| "<CIDR range>"), ...]
22	}, ...
23	]
24	},
25	...
26	]

1	"indexConfigs": [{
2	"key": [
3	["<string>", "<value>"]
4	],
5	"rsName": "<string>",
6	"dbName": "<string>",
7	"collectionName": "<string>",
8	"collation": {
9	"locale": "<string>",
10	"caseLevel": <boolean>,
11	"caseFirst": "<string>",
12	"strength": <number>,
13	"numericOrdering": <boolean>,
14	"alternate": "<string>",
15	"maxVariable": "<string>",
16	"normalization": <boolean>,
17	"backwards": <boolean>
18	},
19	"options": {
20	"<key>": "<value>"
21	}
22	}]

オートメーション構成

Overview

構成バージョン

ダウンロード ベース

MongoDB バージョンの仕様

オートメーション

モニタリング

バックアップ

MongoDB インスタンス

クラスター全体

レプリカセット

シャーディングされたクラスター

クラスター バランサー

認証

LDAP

ssl

MongoDB のロール

Kerberos

Indexes

ダウンロードベース

クラスターバランサー