本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 中介裝置組態檔案
<a name="broker-file"></a>

代理程式組態檔案 (`/etc/dcv-session-manager-broker/session-manager-broker.properties`) 包含可設定為自訂 Session Manager 功能的參數。您可以使用偏好的文字編輯器編輯組態檔案。

**注意**  
`/etc/dcv-session-manager-broker/session-manager-broker.properties` 檔案包含敏感資料。根據預設，其寫入存取僅限於根目錄，其讀取存取僅限於根目錄和執行代理程式的使用者。根據預設，這是 `dcvsmbroker`使用者。代理程式會在啟動時檢查檔案是否具有預期的許可。

下表列出代理程式組態檔案中的參數。


| 參數名稱 | 必要 | 預設值 | Description | 
| --- | --- | --- | --- | 
| broker-java-home | 否 |  | 指定代理程式將使用的 Java 主目錄路徑，而不是系統預設目錄。如果設定，代理程式將在啟動<broker-java-home>/bin/java時使用 。 **秘訣**：代理程式需要 Java Runtime Environment 11，如果遺失做為成功安裝的相依性，則會安裝該代理程式。如果版本 11 未設定為預設 Java 環境，則可以使用下列命令來抓取其主目錄： <pre>$ sudo alternatives --display java</pre>  | 
| session-screenshot-max-width | 否 | 160 | 指定使用 GetSessionScreenshots API 擷取之工作階段螢幕擷取畫面的最大寬度，以像素為單位。 | 
| session-screenshot-max-height | 否 | 100 | 指定使用 GetSessionScreenshots API 擷取之工作階段螢幕擷取畫面的最大高度，以像素為單位。 | 
| session-screenshot-format | 否 | png | 使用 GetSessionScreenshots API 擷取的工作階段螢幕擷取畫面的影像檔案格式。 | 
| create-sessions-queue-max-size | 否 | 1000 | 可排入佇列的未履行 CreateSessions API 請求數目上限。當佇列已滿時，新的未履行請求會遭到拒絕。 | 
| create-sessions-queue-max-time-seconds | 否 | 1800 | 未履行的 CreateSessions API 請求可以保留在佇列中的時間上限，以秒為單位。如果無法在指定的時間內完成請求，則會失敗。 | 
| session-manager-working-path | 是 | /tmp | 指定代理程式寫入操作所需檔案的目錄路徑。此目錄必須只能供代理程式存取。 | 
| enable-authorization-server | 是 | true | 指定代理程式是否為用來為用戶端 API 產生 OAuth 2.0 存取字符的身分驗證伺服器。 APIs | 
| enable-authorization | 是 | true | 啟用或停用用戶端授權。如果您啟用用戶端授權，用戶端 API 必須在提出 API 請求時提供存取權杖。如果您停用用戶端授權，用戶端 APIs可以在沒有存取權杖的情況下提出請求。 | 
| enable-agent-authorization | 是 | true | 啟用或停用代理程式授權。如果您啟用代理程式授權，代理程式在與代理程式通訊時必須提供存取權杖。 | 
| delete-session-duration-hours | 否 | 1 | 指定刪除的工作階段變得不可見且不再由 DescribeSession API 呼叫傳回的時數。已棄用：delete-session-duration-hours變更為 delete-session-duration-seconds - 自 2024.0-493 版起可用。 | 
| delete-session-duration-seconds | 否 | 3600 | 指定刪除的工作階段變得不可見且不再由 DescribeSession API 呼叫傳回的秒數。此參數取代已棄用的delete-session-duration-hours參數 — 自 2024.0-493 版起可用。 | 
| connect-session-token-duration-minutes | 否 | 60 | 指定 ConnectSession 權杖保持有效的分鐘數。 | 
| client-to-broker-connector-https-port | 是 | 8443 | 指定代理程式接聽用戶端連線的 HTTPS 連接埠。 | 
| client-to-broker-connector-bind-host | 否 | 0.0.0.0 | 指定代理程式為用戶端連線繫結的主機 IP 地址。 | 
| client-to-broker-connector-key-store-file | 是 |  | 指定用於 TLS 用戶端連線的金鑰存放區。 | 
| client-to-broker-connector-key-store-pass | 是 |  | 指定金鑰存放區傳遞。 | 
| agent-to-broker-connector-https-port | 是 | 8445 | 指定代理程式接聽代理程式連線的 HTTPS 連接埠。 | 
| agent-to-broker-connector-bind-host | 否 | 0.0.0.0 | 指定代理程式為代理程式連線繫結的主機 IP 地址。 | 
| agent-to-broker-connector-key-store-file | 是 |  | 指定用於 TLS 代理程式連線的金鑰存放區。 | 
| agent-to-broker-connector-key-store-pass | 是 |  | 指定金鑰存放區傳遞。 | 
| broker-to-broker-port | 是 | 47100 | 指定用於broker-to-broker連線的連接埠。 | 
| broker-to-broker-bind-host | 否 | 0.0.0.0 | 指定代理程式為broker-to-broker連線繫結的主機 IP 地址。 | 
| broker-to-broker-discovery-port | 是 | 47500 | 指定代理程式用來探索彼此的連接埠。 | 
| broker-to-broker-discovery-addresses | 否 |  | 以 ip\$1address：port 格式指定機群中其他代理程式的 IP 地址和連接埠。如果有多個代理程式，請以逗號分隔值。如果您指定 broker-to-broker-discovery-multicast-group、broker-to-broker-discovery-multicast-port、 broker-to-broker-discovery-AWS-region或 broker-to-broker-discovery-AWS-alb-target-group-arn，請省略此參數。 | 
| broker-to-broker-discovery-multicast-group | 否 |  | 指定broker-to-roker探索的多點傳送群組。如果您指定 broker-to-broker-discovery-addresses、 broker-to-broker-discovery-aws-region或 broker-to-broker-discovery-AWS-alb-target-group-arn，請省略此參數。 | 
| broker-to-broker-discovery-multicast-port | 否 |  | 指定broker-to-broker探索的多點傳送連接埠。如果您指定 broker-to-broker-discovery-addresses、 broker-to-broker-discovery-AWS-region或 broker-to-broker-discovery-AWS-alb-target-group-arn，請省略此參數。 | 
| broker-to-broker-discovery-AWS-region | 否 |  | 指定用於代理程式探索的應用程式負載平衡器 AWS 區域。如果您指定 broker-to-broker-discovery-multicast-group、 broker-to-broker-discovery-multicast-port或 broker-to-broker-discovery-addresses，請省略此參數。 | 
| broker-to-broker-discovery-AWS-alb-target-group-arn | 否 |  | 應用程式負載平衡器目標群組使用者的 ARNbroker-to-broker探索。如果您指定 broker-to-broker-discovery-multicast-group、 broker-to-broker-discovery-multicast-port或 broker-to-broker-discovery-addresses，請省略此參數。 | 
| broker-to-broker-distributed-memory-max-size-mb | 否 | 4096 | 指定單一代理程式用來存放 Amazon DCV 工作階段資料的關閉堆積記憶體數量上限。 | 
| broker-to-broker-key-store-file | 是 |  | 指定用於 TLS 代理程式連線的金鑰存放區。 | 
| broker-to-broker-key-store-pass | 是 |  | 指定金鑰存放區傳遞。 | 
| enable-cloud-watch-metrics | 否 | false | 啟用或停用 Amazon CloudWatch 指標。如果您啟用 CloudWatch 指標，您可能需要指定 的值cloud-watch-region。 | 
| cloud-watch-region | 否 | 只有在 enable-cloud-watch-metrics 設定為 時才需要true。如果代理程式安裝在 Amazon EC2 執行個體上，則會從 IMDS 擷取區域。 | 張貼 CloudWatch 指標 AWS 的區域。 | 
| max-api-requests-per-second | 否 | 1000 | 指定代理程式 API 在調節之前每秒可處理的請求數目上限。 | 
| enable-throttling-forwarded-for-header | 否 | false | 如果設定為調節true，則會從 X-Forwared-For 標頭擷取呼叫者 ip，如果有的話。 | 
| create-sessions-number-of-retries-on-failure | 否 | 2 | 指定在 Amazon DCV 伺服器主機上建立工作階段請求失敗後要執行的重試次數上限。設為 0 以永遠不會在失敗時執行重試。 | 
| autorun-file-arguments-max-size | 否 | 50 | 指定可傳遞至自動執行檔案的引數數目上限。 | 
| autorun-file-arguments-max-argument-length | 否 | 150 | 指定每個自動執行檔案引數的字元長度上限。 | 
| enable-persistence | 是 | false | 如果設定為 true，代理程式狀態資料會保留在外部資料庫。 | 
| persistence-db | 否 | 只有在 enable-persistence 設定為 時才需要true。 | 指定用於持久性的資料庫。唯一支援的值為： dynamodb和 mysql。 | 
| dynamodb-region | 否 | 只有在 enable-persistence 設為 true且 persistence-db 設為 時才需要dynamodb。 | 指定建立和存取 DynamoDB 資料表的區域。 | 
| dynamodb-table-rcu | 否 | 只有在 enable-persistence 設為 true且 persistence-db 設為 時才需要dynamodb。 | 指定每個 DynamoDB 資料表的讀取容量單位 (RCU) 如需 RCU 的詳細資訊，請參閱[佈建容量的定價](https://aws.amazon.com/dynamodb/pricing/provisioned/)。 | 
| dynamodb-table-wcu | 否 | 只有在 enable-persistence 設為 true且 persistence-db 設為 時才需要dynamodb。 | 指定每個 DynamoDB 資料表的寫入容量單位 (WCU)。如需 WCU 的詳細資訊，請參閱[佈建容量的定價](https://aws.amazon.com/dynamodb/pricing/provisioned/)。 | 
| dynamodb-table-name-prefix | 否 | 只有在 enable-persistence 設為 true且 persistence-db 設為 時才需要dynamodb。 | 指定新增到每個 DynamoDB 資料表的字首 （可用來區分使用相同 AWS 帳戶的多個代理程式叢集）。僅允許英數字元、點、破折號和底線。 | 
| jdbc-connection-url | 否 | 只有在 enable-persistence 設為 true且 persistence-db 設為 時才需要mysql。 | 指定 MariaDB/MySQL 資料庫的連線 URL；其中包含端點和資料庫名稱。URL 應該具有此格式：<pre>jdbc:mysql://<db_endpoint>:<db_port>/<db_name>?createDatabaseIfNotExist=true</pre> 其中 <db\$1endpoint>是 MariaDB/MySQL 資料庫端點， <db\$1port>是資料庫連接埠，而 <db\$1name>是資料庫名稱。 | 
| jdbc-user | 否 | 只有在 enable-persistence 設為 true且 persistence-db 設為 時才需要mysql。 | 指定可存取 MariaDB/MySQL 資料庫的使用者名稱。 | 
| jdbc-password | 否 | 只有在 enable-persistence 設為 true且 persistence-db 設為 時才需要mysql。 | 指定可存取 MariaDB/MySQL 資料庫之使用者的密碼。 | 
| seconds-before-deleting-unreachable-dcv-server | 否 | 1800 | 指定從系統刪除無法連線 Amazon DCV 伺服器的秒數。 | 
| seconds-before-deleting-sessions-unreachable-server | 否 |  | 指定從系統刪除無法連線 Amazon DCV 伺服器上工作階段的秒數。預設會停用從無法連線的伺服器移除工作階段。若要啟用從無法連線的伺服器移除工作階段，請提供有效的值。 | 
| session-screenshot-max-width | 否 | 160 | 指定使用 [GetSessionScreenshots](https://docs.aws.amazon.com/dcv/latest/sm-dev/GetSessionScreenshots.html) API 擷取之工作階段螢幕擷取畫面的最大寬度，以像素為單位。如果在 [Web 用戶端組態檔案中](https://docs.aws.amazon.com/dcv/latest/access-console/web-client-config-files.html)設定 session-screenshot-max-width ，則會優先並覆寫此預設值。請注意，這是最大寬度，因此實際螢幕擷取畫面解析度可能會較低。 | 
| session-screenshot-max-height | 否 | 100 | 指定使用 [GetSessionScreenshots](https://docs.aws.amazon.com/dcv/latest/sm-dev/GetSessionScreenshots.html) API 擷取之工作階段螢幕擷取畫面的最大高度，以像素為單位。如果在 [Web 用戶端組態檔案中](https://docs.aws.amazon.com/dcv/latest/access-console/web-client-config-files.html)設定 session-screenshot-max-height ，則會優先並覆寫此預設值。請注意，這是高度上限，因此實際螢幕擷取畫面解析度可能會較低。 |