Arquivo de configuração do agente

Modo de foco

Arquivo de configuração do agente - Gerenciador de Sessões do Amazon DCV

O arquivo de configuração do agente (/etc/dcv-session-manager-broker/session-manager-broker.properties) inclui parâmetros que podem ser configurados para personalizar a funcionalidade Gerenciador de Sessões. Você pode editar o arquivo de configuração usando o editor de texto de sua preferência.

nota

O arquivo /etc/dcv-session-manager-broker/session-manager-broker.properties contém dados confidenciais. Por padrão, seu acesso de gravação é restrito à raiz e seu acesso de leitura é restrito à raiz e ao usuário que executa o agente. Por padrão, esse é o usuário dcvsmbroker. O agente verifica na inicialização se o arquivo tem as permissões esperadas.

A tabela a seguir lista os parâmetros no arquivo de configuração do agente.

Nome do parâmetro	Obrigatório	Valor padrão	Descrição
`broker-java-home`	Não		Especifica o caminho para o diretório inicial Java que o agente usará em vez do diretório padrão do sistema. Se definido, o agente usará `<broker-java-home>/bin/java` na inicialização. Dica: o agente requer o Java Runtime Environment 11 e, caso ele não exista no sistema, será instalado como uma dependência após a instalação bem-sucedida. Se a versão 11 não estiver definida como ambiente Java padrão, seu diretório inicial poderá ser obtido usando o seguinte comando: `$ sudo alternatives --display java`
`session-screenshot-max-width`	Não	`160`	Especifica a largura máxima, em pixels, das capturas de tela da sessão feitas usando a GetSessionScreenshotsAPI.
`session-screenshot-max-height`	Não	`100`	Especifica a altura máxima, em pixels, das capturas de tela da sessão feitas usando a GetSessionScreenshotsAPI.
`session-screenshot-format`	Não	`png`	O formato do arquivo de imagem das capturas de tela da sessão feitas usando a GetSessionScreenshotsAPI.
`create-sessions-queue-max-size`	Não	`1000`	O número máximo de solicitações de CreateSessionsAPI não atendidas que podem ser enfileiradas. Quando a fila está cheia, novas solicitações não atendidas são rejeitadas.
`create-sessions-queue-max-time-seconds`	Não	`1800`	O tempo máximo, em segundos, em que uma solicitação de CreateSessionsAPI não atendida pode permanecer na fila. Se a solicitação não puder ser atendida dentro do período de tempo especificado, ela falhará.
`session-manager-working-path`	Sim	`/tmp`	Especifica o caminho para o diretório no qual o agente grava os arquivos necessários para operar. Esse diretório deve estar acessível somente para o agente.
`enable-authorization-server`	Sim	`true`	Especifica se o broker é o servidor de autenticação usado para gerar tokens de acesso OAuth 2.0 para o cliente APIs.
`enable-authorization`	Sim	`true`	Ativa ou desativa a autorização do cliente. Se você ativar a autorização do cliente, a API do cliente deverá fornecer um token de acesso ao fazer solicitações de API. Se você desativar a autorização do cliente, o cliente APIs poderá fazer solicitações sem tokens de acesso.
`enable-agent-authorization`	Sim	`true`	Ativa ou desativa a autorização do atendente. Se você ativar a autorização do atendente, ele deverá fornecer um token de acesso ao se comunicar com o agente.
`delete-session-duration-hours`	Não	`1`	Especifica o número de horas após as quais as sessões excluídas se tornam invisíveis e não são mais retornadas por chamadas de API `DescribeSession`. Obsoleto: `delete-session-duration-hours` altere para `delete-session-duration-seconds` — Disponível desde a versão 2024.0-493.
`delete-session-duration-seconds`	Não	`3600`	Especifica o número de segundos após os quais as sessões excluídas se tornam invisíveis e não são mais retornadas pelas chamadas de `DescribeSession` API. Esse parâmetro substitui o parâmetro obsoleto — Disponível desde a versão `delete-session-duration-hours` 2024.0-493.
`connect-session-token-duration-minutes`	Não	`60`	Especifica o número de minutos durante os quais o ConnectSession token permanece válido.
`client-to-broker-connector-https-port`	Sim	`8443`	Especifica a porta HTTPS na qual o agente escuta as conexões do cliente.
`client-to-broker-connector-bind-host`	Não	`0.0.0.0`	Especifica o endereço IP do host ao qual o agente se vincula às conexões do cliente.
`client-to-broker-connector-key-store-file`	Sim		Especifica o armazenamento de chaves usado para conexões de clientes TLS.
`client-to-broker-connector-key-store-pass`	Sim		Especifica a transmissão do armazenamento de chaves.
`agent-to-broker-connector-https-port`	Sim	`8445`	Especifica a porta HTTPS na qual o agente escuta as conexões do atendente.
`agent-to-broker-connector-bind-host`	Não	`0.0.0.0`	Especifica o endereço IP do host ao qual o agente se vincula às conexões do atendente.
`agent-to-broker-connector-key-store-file`	Sim		Especifica o armazenamento de chaves usado para conexões de agentes de TLS.
`agent-to-broker-connector-key-store-pass`	Sim		Especifica a transmissão do armazenamento de chaves.
`broker-to-broker-port`	Sim	`47100`	Especifica a porta usada para broker-to-broker conexões.
`broker-to-broker-bind-host`	Não	`0.0.0.0`	Especifica o endereço IP do host ao qual o broker se vincula para broker-to-broker conexões.
`broker-to-broker-discovery-port`	Sim	`47500`	Especifica a porta usada pelos agentes para descobrirem uns aos outros.
`broker-to-broker-discovery-addresses`	Não		Especifica os endereços IP e as portas dos outros corretores na frota no formato`ip_address`:`port`. Se houver vários agentes, separe os valores com uma vírgula. Se você especificar`broker-to-broker-discovery-multicast-group`, `broker-to-broker-discovery-multicast-port`, `broker-to-broker-discovery-AWS-region` ou `broker-to-broker-discovery-AWS-alb-target-group-arn`, omita esse parâmetro.
`broker-to-broker-discovery-multicast-group`	Não		Especifica o grupo multicast para broker-to-roker descoberta. Se você especificar `broker-to-broker-discovery-addresses`, `broker-to-broker-discovery-aws-region` ou `broker-to-broker-discovery-AWS-alb-target-group-arn`, omita esse parâmetro.
`broker-to-broker-discovery-multicast-port`	Não		Especifica a porta multicast para broker-to-broker descoberta. Se você especificar `broker-to-broker-discovery-addresses`, `broker-to-broker-discovery-AWS-region` ou `broker-to-broker-discovery-AWS-alb-target-group-arn`, omita esse parâmetro.
`broker-to-broker-discovery-AWS-region`	Não		Especifica a AWS região do balanceador de carga do aplicativo usado para a descoberta de intermediário a intermediário. Se você especificar `broker-to-broker-discovery-multicast-group`, `broker-to-broker-discovery-multicast-port` ou `broker-to-broker-discovery-addresses`, omita esse parâmetro.
`broker-to-broker-discovery-AWS-alb-target-group-arn`	Não		O ARN do grupo alvo do balanceador de carga do aplicativo para descoberta. broker-to-broker Se você especificar `broker-to-broker-discovery-multicast-group`, `broker-to-broker-discovery-multicast-port` ou `broker-to-broker-discovery-addresses`, omita esse parâmetro.
`broker-to-broker-distributed-memory-max-size-mb`	Não	`4096`	Especifica a quantidade máxima de memória off-heap a ser usada por um único agente para armazenar dados da sessão NICE DCV.
`broker-to-broker-key-store-file`	Sim		Especifica o armazenamento de chaves usado para conexões de agentes do TLS.
`broker-to-broker-key-store-pass`	Sim		Especifica a transmissão do armazenamento de chaves.
`enable-cloud-watch-metrics`	Não	`false`	Ativa ou desativa as CloudWatch métricas da Amazon. Se você habilitar CloudWatch Métricas, talvez seja necessário especificar um valor para`cloud-watch-region`.
`cloud-watch-region`	Não	Necessário somente se `enable-cloud-watch-metrics` estiver definido como `true`. Se o broker estiver instalado em uma EC2 instância da Amazon, a região será recuperada do IMDS.	A AWS região em que as CloudWatch métricas são publicadas.
`max-api-requests-per-second`	Não	`1000`	Especifica o número máximo de solicitações que a API do agente pode processar a cada segundo antes de ser limitada.
`enable-throttling-forwarded-for-header`	Não	`false`	Se definido como limitação, `true` recupera o ip do chamador do cabeçalho, se presente. X-Forwared-For
`create-sessions-number-of-retries-on-failure`	Não	`2`	Especifica o número máximo de novas tentativas a serem executadas após a falha de uma solicitação de criação de sessão em um host de servidor Amazon DCV. Defina como 0 para nunca realizar novas tentativas em caso de falhas.
`autorun-file-arguments-max-size`	Não	`50`	Especifica o número máximo de argumentos que podem ser transmitidos ao arquivo de execução automática.
`autorun-file-arguments-max-argument-length`	Não	`150`	Especifica o tamanho máximo em caracteres de cada argumento do arquivo de execução automática.
`enable-persistence`	Sim	`false`	Se definido como `true`, os dados de status do broker serão mantidos em um banco de dados externo.
`persistence-db`	Não	Necessário somente se `enable-persistence` estiver definido como `true`.	Especifica qual banco de dados é usado para persistência. Os únicos valores compatíveis são: `dynamodb` e `mysql`.
`dynamodb-region`	Não	Só é necessário se `enable-persistence` estiver definido como `true` e `persistence-db` estiver definido como `dynamodb`.	Especifica a região na qual as tabelas do DynamoDB são criadas e acessadas.
`dynamodb-table-rcu`	Não	Só é necessário se `enable-persistence` estiver definido como `true` e `persistence-db` estiver definido como `dynamodb`.	Especifica as Unidades de Capacidade de Leitura (RCU) para cada tabela do DynamoDB. Para obter mais informações sobre RCU, consulte Preços da capacidade provisionada.
`dynamodb-table-wcu`	Não	Só é necessário se `enable-persistence` estiver definido como `true` e `persistence-db` estiver definido como `dynamodb`.	Especifica as Unidades de Capacidade de Gravação (WCU) para cada tabela do DynamoDB. Para obter mais informações sobre WCU, consulte Preço da capacidade provisionada.
`dynamodb-table-name-prefix`	Não	Só é necessário se `enable-persistence` estiver definido como `true` e `persistence-db` estiver definido como `dynamodb`.	Especifica o prefixo que é adicionado a cada tabela do DynamoDB (útil para distinguir vários clusters de agentes usando a mesma conta). AWS São permitidos somente caracteres alfanuméricos, ponto, traço e sublinhado.
`jdbc-connection-url`	Não	Só é necessário se `enable-persistence` estiver definido como `true` e `persistence-db` estiver definido como `mysql`.	Especifica o URL de conexão com o banco de dados MariaDB/MySQL; ele contém o endpoint e o nome do banco de dados. O URL deve ter este formato: `jdbc:mysql://<db_endpoint>:<db_port>/<db_name>?createDatabaseIfNotExist=true` Sendo que `<db_endpoint>` é o endpoint do banco de dados MariaDB/MySQL, `<db_port>` é a porta do banco de dados e `<db_name>` é o nome do banco de dados.
`jdbc-user`	Não	Só é necessário se `enable-persistence` estiver definido como `true` e `persistence-db` estiver definido como `mysql`.	Especifica o nome do usuário que tem acesso ao banco de dados MariaDB/MySQL.
`jdbc-password`	Não	Só é necessário se `enable-persistence` estiver definido como `true` e `persistence-db` estiver definido como `mysql`.	Especifica a senha do usuário que tem acesso ao banco de dados MariaDB/MySQL.
`seconds-before-deleting-unreachable-dcv-server`	Não	`1800`	Especifica o número de segundos após os quais um servidor Amazon DCV inacessível é excluído do sistema.
`seconds-before-deleting-sessions-unreachable-server`	Não		Especifica o número de segundos após os quais as sessões em um servidor Amazon DCV inacessível são excluídas do sistema. A remoção de sessões de um servidor inacessível é desativada por padrão. Para permitir a remoção de sessões de servidores inacessíveis, forneça um valor válido.
`session-screenshot-max-width`	Não	`160`	Especifica a largura máxima, em pixels, das capturas de tela da sessão feitas usando a GetSessionScreenshotsAPI. Se `session-screenshot-max-width` estiver definido no arquivo de configuração do Web Client, ele terá precedência e substituirá esse valor padrão. Observe que essa é a largura máxima, portanto, a resolução real da captura de tela pode ser menor.
`session-screenshot-max-height`	Não	`100`	Especifica a altura máxima, em pixels, das capturas de tela da sessão feitas usando a GetSessionScreenshotsAPI. Se `session-screenshot-max-height` estiver definido no arquivo de configuração do Web Client, ele terá precedência e substituirá esse valor padrão. Observe que essa é a altura máxima, portanto, a resolução real da captura de tela pode ser menor.