Fichier de configuration du broker

Le fichier de configuration du broker (/etc/dcv-session-manager-broker/session-manager-broker.properties) inclut des paramètres qui peuvent être configurés pour personnaliser les fonctionnalités du gestionnaire de session. Vous pouvez modifier le fichier de configuration à l'aide de votre éditeur de texte préféré.

Note

Le /etc/dcv-session-manager-broker/session-manager-broker.properties fichier contient des données sensibles. Par défaut, son accès en écriture est limité à root et son accès en lecture est limité à root et à l'utilisateur exécutant le broker. Par défaut, il s'agit de l'dcvsmbrokerutilisateur. Le broker vérifie au démarrage que le fichier possède les autorisations attendues.

Le tableau suivant répertorie les paramètres du fichier de configuration du broker.

Nom du paramètre	Obligatoire	Valeur par défaut	Description
broker-java-home	Non		Spécifie le chemin d'accès au répertoire de base Java que le courtier utilisera à la place du répertoire par défaut du système. Si cette option est définie, le broker l'utilisera <broker-java-home>/bin/java au démarrage. Conseil : le broker nécessite Java Runtime Environment 11 et il est installé s'il est absent en tant que dépendance une fois l'installation réussie. Si la version 11 n'est pas définie comme environnement Java par défaut, son répertoire personnel peut être récupéré à l'aide de la commande suivante : $ sudo alternatives --display java
session-screenshot-max-width	Non	160	Spécifie la largeur maximale, en pixels, des captures d'écran de session prises à l'aide du GetSessionScreenshotsAPI.
session-screenshot-max-height	Non	100	Spécifie la hauteur maximale, en pixels, des captures d'écran de session prises à l'aide du GetSessionScreenshotsAPI.
session-screenshot-format	Non	png	Le format de fichier image des captures d'écran de session prises à l'aide du GetSessionScreenshotsAPI.
create-sessions-queue-max-size	Non	1000	Le nombre maximum de CreateSessionsAPIdemandes non satisfaites qui peuvent être mises en file d'attente. Lorsque la file d'attente est pleine, les nouvelles demandes non satisfaites sont rejetées.
create-sessions-queue-max-time-seconds	Non	1800	Durée maximale, en secondes, pendant laquelle une CreateSessionsAPIdemande non satisfaite peut rester dans la file d'attente. Si la demande ne peut pas être satisfaite dans le délai imparti, elle échoue.
session-manager-working-path	Oui	/tmp	Spécifie le chemin d'accès au répertoire dans lequel le broker écrit les fichiers nécessaires à son fonctionnement. Ce répertoire doit être accessible uniquement au courtier.
enable-authorization-server	Oui	true	Spécifie si le broker est le serveur d'authentification utilisé pour générer des jetons d'accès OAuth 2.0 pour le clientAPIs.
enable-authorization	Oui	true	Active ou désactive l'autorisation du client. Si vous activez l'autorisation du client, le client API doit fournir un jeton d'accès lorsqu'il fait des demandes. API Si vous désactivez l'autorisation du client, celui-ci APIs peut faire des demandes sans jetons d'accès.
enable-agent-authorization	Oui	true	Active ou désactive l'autorisation de l'agent. Si vous activez l'autorisation de l'agent, celui-ci doit fournir un jeton d'accès lorsqu'il communique avec le courtier.
delete-session-duration-hours	Non	1	Spécifie le nombre d'heures après lesquelles les sessions supprimées deviennent invisibles et ne sont plus renvoyées par DescribeSession API des appels.
connect-session-token-duration-minutes	Non	60	Spécifie le nombre de minutes pendant lesquelles le ConnectSession jeton reste valide.
client-to-broker-connector-https-port	Oui	8443	Spécifie le HTTPS port sur lequel le broker écoute les connexions des clients.
client-to-broker-connector-bind-host	Non	0.0.0.0	Spécifie l'adresse IP de l'hôte sur lequel le broker se lie pour les connexions client.
client-to-broker-connector-key-store-file	Oui		Spécifie le magasin de clés utilisé pour les connexions TLS client.
client-to-broker-connector-key-store-pass	Oui		Spécifie le code d'accès au magasin de clés.
agent-to-broker-connector-https-port	Oui	8445	Spécifie le HTTPS port sur lequel le broker écoute les connexions des agents.
agent-to-broker-connector-bind-host	Non	0.0.0.0	Spécifie l'adresse IP de l'hôte sur lequel le broker se lie pour les connexions aux agents.
agent-to-broker-connector-key-store-file	Oui		Spécifie le magasin de clés utilisé pour les connexions aux TLS agents.
agent-to-broker-connector-key-store-pass	Oui		Spécifie le code d'accès au magasin de clés.
broker-to-broker-port	Oui	47100	Spécifie le port utilisé pour les broker-to-broker connexions.
broker-to-broker-bind-host	Non	0.0.0.0	Spécifie l'adresse IP de l'hôte sur lequel le broker se lie pour les broker-to-broker connexions.
broker-to-broker-discovery-port	Oui	47500	Spécifie le port utilisé par les courtiers pour se découvrir mutuellement.
broker-to-broker-discovery-addresses	Non		Spécifie les adresses IP et les ports des autres courtiers de la flotte dans ip_address:port . S'il existe plusieurs courtiers, séparez les valeurs par une virgule. Si vous spécifiezbroker-to-broker-discovery-multicast-group,broker-to-broker-discovery-multicast-port, ou broker-to-broker-discovery-AWS-regionbroker-to-broker-discovery-AWS-alb-target-group-arn, omettez ce paramètre.
broker-to-broker-discovery-multicast-group	Non		Spécifie le groupe de multidiffusion pour la broker-to-roker découverte. Si vous spécifiez broker-to-broker-discovery-addresses ou broker-to-broker-discovery-AWS-alb-target-group-arn omettez ce paramètre. broker-to-broker-discovery-aws-region
broker-to-broker-discovery-multicast-port	Non		Spécifie le port de multidiffusion pour la broker-to-broker découverte. Si vous spécifiez broker-to-broker-discovery-addresses ou broker-to-broker-discovery-AWS-alb-target-group-arn omettez ce paramètre. broker-to-broker-discovery-AWS-region
broker-to-broker-discovery-AWS-region	Non		Spécifie le AWS Région de l'équilibreur de charge de l'application utilisée pour la découverte d'un courtier à un autre. Si vous spécifiez broker-to-broker-discovery-multicast-group ou broker-to-broker-discovery-addresses omettez ce paramètre. broker-to-broker-discovery-multicast-port
broker-to-broker-discovery-AWS-alb-target-group-arn	Non		Nom ARN de l'utilisateur du groupe cible de l'équilibreur de charge d'application à des fins de broker-to-broker découverte. Si vous spécifiez broker-to-broker-discovery-multicast-group ou broker-to-broker-discovery-addresses omettez ce paramètre. broker-to-broker-discovery-multicast-port
broker-to-broker-distributed-memory-max-size-mb	Non	4096	Spécifie la quantité maximale de mémoire hors segment à utiliser par un seul broker pour stocker les données de NICE DCV session.
broker-to-broker-key-store-file	Oui		Spécifie le magasin de clés utilisé pour les connexions entre TLS courtiers.
broker-to-broker-key-store-pass	Oui		Spécifie le code d'accès au magasin de clés.
enable-cloud-watch-metrics	Non	false	Active ou désactive les CloudWatch métriques Amazon. Si vous activez CloudWatch les métriques, vous devrez peut-être spécifier une valeur pourcloud-watch-region.
cloud-watch-region	Non	Nécessaire uniquement s'enable-cloud-watch-metricsil est défini surtrue. Si le broker est installé sur une EC2 instance Amazon, la région est extraite duIMDS.	Le AWS région où les CloudWatch statistiques sont publiées.
max-api-requests-per-seconde	Non	1000	Spécifie le nombre maximum de demandes que l'API du courtier peut traiter chaque seconde avant d'être limitée.
enable-throttling-forwarded-for-header	Non	false	S'il est réglé sur true le throttling, il récupère l'adresse IP de l'appelant dans l'en-tête X-Forwared-For, s'il est présent.
create-sessions-number-of-retries-on-failure	Non	2	Spécifie le nombre maximal de tentatives à effectuer après l'échec d'une demande de création de session sur un hôte de NICE DCV serveur. Définissez cette valeur sur 0 pour ne jamais effectuer de nouvelles tentatives en cas d'échec.
autorun-file-arguments-max-size	Non	50	Spécifie le nombre maximum d'arguments pouvant être transmis au fichier autorun.
autorun-file-arguments-max-argument-length	Non	150	Spécifie la longueur maximale en caractères de chaque argument de fichier autorun.
enable-persistence	Oui	false	Si ce paramètre est défini surtrue, les données d'état du courtier sont conservées dans une base de données externe.
persistence-db	Non	Nécessaire uniquement s'enable-persistenceil est défini surtrue.	Spécifie la base de données utilisée pour la persistance. Les seules valeurs prises en charge sont : dynamodb etmysql.
dynamodb-region	Non	Nécessaire uniquement s'enable-persistenceil est défini sur true et persistence-db est défini surdynamodb.	Spécifie la région dans laquelle les tables DynamoDB sont créées et accessibles.
dynamodb-table-rcu	Non	Nécessaire uniquement s'enable-persistenceil est défini sur true et persistence-db est défini surdynamodb.	Spécifie les unités de capacité de lecture (RCU) pour chaque table DynamoDB. Pour plus d'informations, voir Tarification de RCU la capacité allouée.
dynamodb-table-wcu	Non	Nécessaire uniquement s'enable-persistenceil est défini sur true et persistence-db est défini surdynamodb.	Spécifie les unités de capacité d'écriture (WCU) pour chaque table DynamoDB. Pour plus d'informationsWCU, consultez la section Tarification de la capacité allouée.
dynamodb-table-name-prefix	Non	Nécessaire uniquement s'enable-persistenceil est défini sur true et persistence-db est défini surdynamodb.	Spécifie le préfixe qui est ajouté à chaque table DynamoDB (utile pour distinguer plusieurs clusters de courtiers utilisant la même AWS compte). Seuls les caractères alphanumériques, les points, les tirets et les traits de soulignement sont autorisés.
jdbc-connection-url	Non	Nécessaire uniquement s'enable-persistenceil est défini sur true et persistence-db est défini surmysql.	Spécifie la connexion URL à la base de données MariaDB/My ; elle contient le point de terminaison et le nom de la SQL base de données. L'URL doit avoir le format suivant : jdbc:mysql://<db_endpoint>:<db_port>/<db_name>?createDatabaseIfNotExist=true Où <db_endpoint> se trouvent le point de terminaison de SQL base de données MariaDB/My, <db_port> le port de base de données et <db_name> le nom de la base de données.
jdbc-user	Non	Nécessaire uniquement s'enable-persistenceil est défini sur true et persistence-db est défini surmysql.	Spécifie le nom de l'utilisateur ayant accès à la base de données SQL MariaDB/My.
jdbc-password	Non	Nécessaire uniquement s'enable-persistenceil est défini sur true et persistence-db est défini surmysql.	Spécifie le mot de passe de l'utilisateur qui a accès à la base de données SQL MariaDB/My.
seconds-before-deleting-unreachable-dcv-server	Non	1800	Spécifie le nombre de secondes au bout duquel un serveur inaccessible est supprimé du système.