AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

オートメーション構成

Overview

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

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

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

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

警告

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

これらの設定が必要な場合は、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 インスタンスには、この配列内の仕様オブジェクトが必要です。

"mongoDbVersions[n]" : [  {   "name" : "<string>",    "builds" : [      {       "platform" : "<string>",        "url" : "<string>",        "gitVersion" : "<string>",        "modules" : [ "<string>", ... ],        "architecture" : "<string>",        "bits" : "<integer>",        "win2008plus" : "<Boolean>",        "winVCRedistUrl" : "<string>",        "winVCRedistOptions" : [ "<string>", ... ],        "winVCRedistDll" : "<string>",        "winVCRedistVersion" : "<string>"      },      ...    ],  },  ...]
名前
タイプ
必要性
説明

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 buildInfo コマンドは GitVersion 識別子を返します。

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 バージョンを更新するのではなく、エージェント バージョンの更新 エンドポイントとなる接続されたデバイスを使用します。

"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 では、このパラメーターは廃止されました。 モニタリングログ設定を更新するには、モニタリング構成設定の更新エンドポイントを使用します。

"monitoringVersions" : [  {    "name" : "<string>",    "hostname" : "<string>",    "urls" : {      "<platform1>" : {        "<build1>" : "<string>",        ...,        "default" : "<string>"      },      ...    },    "baseUrl" : "<string>",    "logPath" : "<string>",    "logRotate" : {      "sizeThresholdMB" : <number>,      "timeThresholdHrs" : <integer>,      "numUncompressed": <integer>,      "percentOfDiskspace" : <number>,      "numTotal" : <integer>    }  },  ...]
名前
タイプ
必要性
説明

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 では、このパラメーターは廃止されました。 バックアップログ設定を更新するには、バックアップ構成設定の更新エンドポイントを使用します。

"backupVersions[n]" : [  {   "name" : "<string>",    "hostname" : "<string>",    "urls" : {     "<platform1>" : {       "<build1>" : "<string>",        ...,        "default" : "<string>"      },      ...    },    "baseUrl" : "<string>",    "logPath" : "<string>",    "logRotate" : {     "sizeThresholdMB" : "<number>",      "timeThresholdHrs" : "<integer>",      "numUncompressed": "<integer>",      "percentOfDiskspace" : "<number>",      "numTotal" : "<integer>"    }  },  ...]
名前
タイプ
必要性
説明

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

必須

ベース URL は、 カスタム設定 の マザーシップ および HTTPS 設定に使用されます。例えば、"baseUrl"=https://cloud.mongodb.com の場合、バックアップ構成フィールドは次の値になります。mothership=api-backup.mongodb.com および HTTPS"=true。

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 インスタンスで最初の同期プロセスを開始します。

"processes": [{  "<args>": {},  "alias": "<string>",  "authSchemaVersion": "<integer>",  "backupRestoreUrl": "<string>",  "certificatesVersion": "<integer>",  "cluster": "<string>",  "defaultRWConcern": {    "defaultReadConcern": {      "level": "<string>"    },    "defaultWriteConcern": {      "j": "<boolean>",      "w": "<string>",      "wtimeout": "<integer>"    }  }  "disabled": "<Boolean>",  "featureCompatibilityVersion": "<string>",  "hostname": "<string>",  "lastCompact" : "<dateInIso8601Format>",  "lastRestart" : "<dateInIso8601Format>",  "lastResync" : "<dateInIso8601Format>",  "lastKmipMasterKeyRotation" : "<dateInIso8601Format>",  "logRotate": {    "sizeThresholdMB": "<number>",    "timeThresholdHrs": "<integer>",    "numUncompressed": "<integer>",    "percentOfDiskspace": "<number>",    "numTotal": "<integer>"  },  "manualMode": "<Boolean>",  "name": "<string>",  "numCores": "<integer>",  "processType": "<string>",  "version": "<string>"}]
名前
タイプ
必要性
説明

プロセス

配列

必須

がモニターするmongos mongodMongoDB Ops Manager{3 } インスタンスと インスタンスを定義するオブジェクトを含みます。各 オブジェクトは、異なる インスタンスを定義します。

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

任意

復元用の配送 URLMongoDB Ops Manager は、復元するを作成する際にこれを設定します。実行中の復元する操作をキャンセルするには、このオプションを CANCEL に設定します。

詳しくは、「 API を使用してバックアップ復元を自動化する 」を参照してください。

processes[n].certificatesVersion

integer

任意

ゼロダウンタイム TLS 証明書ローテーションをトリガーするカウンター。この値をインクリメントすると、MongoDB Agent は再起動する代わりに、各対象プロセスで db.adminCommand({ rotateCertificates: 1 }) を実行します。ローテーションは、mongod mongos50TLS が構成されている MongoDB. 以降を実行している および プロセスにのみ適用されます。0 として扱うには、省略するか、null に設定します。同じ値はローテーションをtriggerしません。MongoDB Ops Manager は HTTP 400 INVALID_AUTOMATION_CONFIG を伴う減少を拒否します。詳細を学ぶには、「ダウンタイムなしで TLS 証明書をローテーションする」を参照してください。

operations[n].cluster

string

条件付き

シャーディングされたクラスターの名前。 この値を、 の シャーディングmongos 配列の sharding.name パラメータで同じ値に設定します。

  • に 必須 です。mongos

  • にmongod は必要ありません 。

defaultRWConcern.defaultReadConcern.level

string

任意

レプリカセットおよびレプリカセット シャードから読み取られたデータの整合性と分離プロパティ。 MongoDB Atlas は、次の値を受け入れます。

  • "available"

  • "local"

  • "過半数"

デフォルト RWConcern.defaultWriteConcern.j

ブール値

任意

デフォルト RWConcern.defaultWriteConcern.w

string

任意

レプリカセットおよびレプリカセット シャードで書込み (write) 操作を確認する必要がある mongod インスタンスの希望数。 MongoDB Atlas は、次の値を受け入れます。

  • 任意の数値 0 以上

  • "過半数"

デフォルト RWConcern.defaultWriteConcern.wtimeout

数値

任意

書込み保証 (write concern) に希望する時間制限（ミリ秒単位）。 defaultRWConcern.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 マニュアルのsetFeatureCompatibilityVersionを参照してください。

  • MongoDB Ops Manager は、このパラメーターを新しい配置の MongoDB バージョンと一致するように設定します。

  • MongoDB Ops Manager は、ホストをある MongoDB バージョンから次のバージョンにアップグレードしても、このパラメーターを自動的に増加させません。

詳細については、setFeatureCompatibilityVersion をご覧ください。

process[n].hostname

string

必須

このプロセスを提供するホストの名前。 デフォルトはlocalhostです。

process[n].lastCompact

string

任意

Ops Manager がクラスターのディスクの空き領域を最後に再利用したときの ISO8601 の日付と時刻形式（UTC）のタイムスタンプ。特定の操作中にMongoDBデータが移動または削除される場合がありますが、現在未使用の領域は解放されません。 Ops Manager は、レプリカセットまたはシャードのノード全体でディスク領域をローリング方式で再利用します。

このスペースを再利用するには、次の手順に従います。

  • すぐに、この値をISO 8601タイムスタンプとして現在の時刻に設定します。

  • 後で、この値を将来のISO 8601タイムスタンプに設定します。MongoDB Ops Manager は、現在の時刻が指定されたタイムスタンプを経過した後に、スペースを再利用します。

クラスターのディスクの領域を再利用するときに などのあいまいさを排除するには、ISO8601 タイムスタンプを含むタイムゾーンを指定します。例、process.lastCompact を 281 月 2021 に 2:43:52PM（米国中央標準時間）に設定するには、"processes.lastCompact" : "2021-01-28T14:43:52-06:00" を使用します

process[n].lastRestart

string

任意

Ops Manager がこのプロセスを最後に再起動したときの ISO8601 の日付と時刻形式（UTC）のタイムスタンプ。このパラメータを現在のタイムスタンプに設定すると、この構成をアップロードした後に Ops Manager はこのプロセスを強制的に再起動します。このパラメーターを同じクラスター内の複数の プロセスに設定すると、Ops Manager はレプリカセットまたはシャードのノード全体で選択したプロセスを順次再起動します。

process[n].lastResync

string

任意

Ops Manager がノードで実行した最後の最初の同期プロセスの ISO の日付と時刻形式（UTC）のタイムスタンプ。8601

ノードで最初の同期プロセスをすぐにトリガーするには、この値をISO 8601タイムスタンプとして現在の時刻に設定します。

警告:このパラメータの使用には注意が必要です。 最初の同期中に、オートメーションはノードの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

任意

Ops Manager がマスター KMIP キーを最後にローテーションしたときの ISO8601 の日付と時刻形式（UTC）のタイムスタンプ。このパラメータを現在のタイムスタンプに設定すると、Ops Manager はこの構成をアップロード後にキーをローテーションします。

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 は、このパラメータにmongodまたはmongosを受け入れます。

process[n].version

string

必須

このインスタンスで使用されるmongoDbVersions仕様の名前。

クラスター全体

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

"clusterWideConfigurations" : {  "<replicaSetID/clusterName>": {    "changeStreamOptions": {      "preAndPostImages": {        "expireAfterSeconds": <integer>      }    }  }}
名前
タイプ
必要性
説明

replicaSetID/clusterName

オブジェクト

任意

レプリカセットまたはシャーディングされたクラスターに適用する 変更ストリーム オプション 。 MongoDB Agent は、この構成が有効なJSON形式であるかどうかのみをチェックしますが、値が正確かどうかはチェックしません。

changeStreamOptions.preAndPostImages.expirationAfterSeconds

数値

必須

変更ストリームの事前イメージと事後イメージの保持ポリシー（秒単位）。 値を省略すると、クラスターは対応する変更ストリーム イベントを oplog から削除するまで、変更前と変更後のイメージを保持します。

この値を削除すると、MongoDB Agent はこのパラメーターをオートメーション構成からのみ削除しますが、サーバーからは削除しません。

詳細については、changeStreamOptions をご覧ください。

レプリカセット

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

"replicaSets":[  {    "_id": "<string>",    "protocolVersion": "<string>",    "members":    [      {        "_id": "<integer>",        "host": "<string>",        "arbiterOnly": "<boolean>",        "buildIndexes": "<boolean>",        "hidden": "<boolean>",        "priority": "<number>",        "tags": "<object>",        "secondaryDelaySecs": "<integer>",        "votes": "<number>"      },{        "_id": "<integer>",        "host": "<string>",        "arbiterOnly": "<boolean>",        "buildIndexes": "<boolean>",        "hidden": "<boolean>",        "priority": "<number>",        "tags": "<object>",        "secondaryDelaySecs": "<integer>",        "votes": "<number>"      },{        "_id": "<integer>",        "host": "<string>",        "arbiterOnly": "<boolean>",        "buildIndexes": "<boolean>",        "hidden": "<boolean>",        "priority": "<number>",        "tags": "<object>",        "secondaryDelaySecs": "<integer>",        "votes": "<number>"      }    ],    "force":    {      "currentVersion": "<integer>"    }  }]
名前
タイプ
必要性
説明

レプリカセット

配列

任意

各レプリカセットの構成。 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 サポートにお問い合わせください。

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

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

"sharding" : [  {    "managedSharding" : false,    "name" : "<string>",    "configServerReplica" : "<string>",    "shards" : [      {        "_id" : "<string>",        "rs" : "<string>",        "tags" : [ "<string>", ... ]      },      ...    ],  },  ...]
名前
タイプ
必要性
説明

シャーディング

オブジェクトの配列

任意

各シャーディングされたクラスターの構成を定義するオブジェクト。 配列内の各オブジェクトには、1 つのクラスターの仕様が含まれています。 MongoDB Agent は、各クラスターの状態を 仕様に対して定期的にチェックします。 仕様とクラスターが一致しない場合、エージェントはクラスターの構成を変更し、バランサーがチャンクを移行する可能性があります。

sharding.managedSharding

ブール値

任意

MongoDB Ops Manager Automation が配置内のすべてのシャーディングされたコレクションとタグを管理するかどうかを示すフラグ。 MongoDB Ops Managerバージョン 7.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

文字列の配列

条件付き

クラスター バランサー

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

"balancer": {  "<clusterName1>": {},  "<clusterName2>": {},  ...}
名前
タイプ
必要性
説明

バランサー

オブジェクト

任意

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

認証

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

{  "auth": {    "authoritativeSet": "<boolean>",    "autoUser": "<string>",    "autoPwd": "<string>",    "disabled": "<boolean>",    "deploymentAuthMechanisms": ["<string>", "<string>"],    "autoAuthMechanisms": ["<string>"],    "key": "<string>",    "keyfile": "<string>",    "newAutoPwd": "<string>",    "newKey": "<string>",    "usersDeleted": [{      "user": "<string>",      "dbs": ["<string>", "<string>"]    }],    "usersWanted": [{      "authenticationRestrictions": [{        "clientSource": ["(IP | CIDR range)", "(IP | CIDR range)"],        "serverAddress": ["(IP | CIDR range)", "(IP | CIDR range)"]      }],      "db": "<string>",      "initPwd": "<string>",      "otherDBRoles": {        "<string>": ["<string>", "<string>"]      },      "roles": [{        "db": "<string>",        "role": "<string>"      }],      "pwd": "<string>",      "user": "<string>"    }]  }}
名前
タイプ
必要性
説明

認証

オブジェクト

任意

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

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

auth. authoritativeSet

ブール値

条件付き

プロジェクト内のすべてのマネージド配置で、MongoDB Ops Manager がマネージド MongoDB ユーザーとロールのコンシステントなセットを強制するかどうかを設定します。

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

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

auth.autoUser

string

条件付き

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

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

auth.autoPwd

string

条件付き

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

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

auth.disabled

ブール値

任意

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

auth.deploymentAuthMechanisms

文字列の配列

条件付き

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

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

次の値を指定します。

auth.autoAuthMechanisms

文字列の配列

条件付き

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

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

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

次の値を指定します。

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

任意

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

  1. auth.newAutoPwdを設定し、現在のパスワードと共にauth.autoPwdを残ります。

  2. ターゲットの状態を待ちます。

  3. 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 認証が有効になります。このオブジェクトは任意です。詳細については、「MongoDB 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

条件付き

クエリを実行するstring 形式の 1LDAP つ以上のサーバーを含むコンマ区切りの<host>:<port> 。setParameter を使用して、実行中のシステムでこの設定を構成できます。LDAP 認証の場合は、この設定を指定する必要があります。

ldap.timeoutMS

long

任意

MongoDB が LDAP サーバーからリクエストへの応答があるまで待機し、タイムアウトするまでの時間（ミリ秒単位）。setParameter を使用して、実行中のシステムでこの設定を構成できます。デフォルトでは、MongoDB は 10 秒後にタイムアウトします。

ldap.bindメソッド

string

任意

自身を認証するために単純認証または SASL プロトコルを使用するかどうかを示す人間が読み取りやすい string。simple または sasl を指定できます。デフォルトで、MongoDB は簡易認証を使用します。

ldap.bindSaslMechanisms

string

任意

MongoDB が bind 時に LDAP サーバーへの認証を試みるための SASL メカニズムのカンマ区切りリストを含む string。デフォルトでは、MongoDB は DIGEST-MD5 を使用してバインドします。

ldap.bindQueryUser

string

条件付き

MongoDB が LDAP サーバーに接続するときにバインドする LDAP エンティティドメイン名。setParameter を使用して、実行中のシステムでこの設定を構成できます。MongoDB が認証情報とバインドするには、この設定を指定する必要があります。

ldap.bindQueryPassword

string

条件付き

MongoDB が LDAP サーバーに接続するときにバインドするパスワード。setParameter を使用して、実行中のシステムでこの設定を構成できます。MongoDB がパスワードでバインドするには、この設定を指定する必要があります。

ldap.userCacheInvalidationPerid

integer

任意

MongoDB がユーザー キャッシュのフラッシュ間に待機する間隔。外部ユーザー キャッシュがフラッシュされると、LDAP 認可ユーザーが行う次の操作にはロールの再取得が必要になります。高い値を指定すると、LDAP サーバーの負荷を軽減できる可能性があります。また、MongoDB ロールを LDAP グループメンバーシップと同期するのに必要な時間が増える可能性があります。デフォルトで、MongoDB はキャッシュのフラッシュ間に 30 秒待機します。

ldap.authzQueryTemplate

string

条件付き

RFC4516 形式の LDAPURLで、 設定に対する LDAP ldap.serverグループが取得されます。このURLでは、プレースホルダー トークン文字列{USER} は取得されたユーザー ドメイン名に置き換えられます。この設定は実行中のシステムで構成するには、setParameter を使用します。 LDAP認可の場合は、この設定を指定する必要があります。

ldap.userToDNMapping

配列

任意

MongoDB ユーザー名をドメイン名と一致するように認証するために MongoDB が適用する順序付けられた変換を含む JSON 形式の配列。別の認証方法を使用する場合、または認証のために MongoDB に渡されるユーザー名が LDAP ドメイン名と一致しない場合、この設定を指定できます。setParameter を使用して、実行中のシステムでこの設定を構成できます。デフォルトでは、MongoDB は自動 LDAP 認証のドメイン名としてユーザー名を使用します。

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 は、TLS または X. 認証を使用する場合、**ssl.autoPEMKeyFilePath** または **ssl.autoPEMKeyFilePathWindows**509 が必要です。

ssl.autoPEMKeyFilePathWindows

string

条件付き

Windows ホスト上でTLS接続を認証するクライアント秘密キー（PEM）ファイルへの絶対ファイル パス。

Ops Manager は、TLS または X. 認証を使用する場合、**ssl.autoPEMKeyFilePath** または **ssl.autoPEMKeyFilePathWindows**509 が必要です。

ssl.autoPEMKeyFilePwd

string

条件付き

ssl.autoPEMKeyFilePath または ssl.autoPEMKeyFilePathWindows で指定された秘密キー（PEM）ファイルのパスワード。PEMファイルが暗号化されている場合、MongoDB Ops Manager ではこのパスワードが必要です。

MongoDB のロール

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

"roles" : [  {    "role" : "<string>",    "db" : "<string>",    "privileges" : [      {        "resource" : { ... },        "actions" : [ "<string>", ... ]      },      ...    ],    "roles" : [      {        "role" : "<string>",        "db" : "<string>"      }    ]    "authenticationRestrictions" : [     {      "clientSource": [("<IP>" | "<CIDR range>"), ...],      "serverAddress": [("<IP>" | "<CIDR range>"), ...]    }, ...  ]  },  ...]
名前
タイプ
必要性
説明

役割

オブジェクトの配列

任意

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 を介して mongod または mongos を認証するために使用するサービス名。

  • MongoDB Server パラメーター の saslServiceName オプション。

Indexes

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

"indexConfigs": [{  "key": [    ["<string>", "<value>"]  ],  "rsName": "<string>",  "dbName": "<string>",  "collectionName": "<string>",  "collation": {    "locale": "<string>",    "caseLevel": <boolean>,    "caseFirst": "<string>",    "strength": <number>,    "numericOrdering": <boolean>,    "alternate": "<string>",    "maxVariable": "<string>",    "normalization": <boolean>,    "backwards": <boolean>  },  "options": {    "<key>": "<value>"  }}]
名前
タイプ
必要性
説明

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: 数字列は数値として比較されます。例: 10 > 2。

  • false: 数字列はストリングとして比較されます。例、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設定とオートメーション
このページを評価

項目一覧