Como obter ajuda com comandos - Gerenciador de Sessões do Amazon DCV
Tipos de parâmetros

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Como obter ajuda com comandos

Você pode obter ajuda com qualquer comando ao usar a CLI do Gerenciador de Sessões do Amazon DCV. Para fazer isso, basta digitar --help no final de um nome do comando.

exemplo

Por exemplo, o comando a seguir exibe a ajuda para as opções gerais da CLI do DCV SM e os comandos de nível superior disponíveis.

dcvsm --help

O exemplo a seguir mostra a saída do comando de ajuda da CLI.

Usage: dcvsm [OPTIONS] COMMAND [ARGS]...

  Amazon DCV Session Manager CLI

Options:
  --conf TEXT           Name of the configuration file to read the
                        configuration parameters
  --broker-url TEXT     The URL of the broker
  --debug               Specify to enable the debug mode. By default is
                        disabled
  --no-verify-ssl       Specify to disable the verification of SSL
                        certification. By default is enabled
  --output-format TEXT  Specify the format of the output
  --ca-bundle TEXT      Specifies the path to a custom certificate bundle 
                        (a file with a .pem extension) of CA to use when 
                        establishing SSL/TLS connections
  --auth-server TEXT    URL of the authentication server used to request
                        the token
  --version             Show the version and exit.
  -h, --help            Show this message and exit.

Commands:
  close-servers                 Closes one or more Amazon DCV server
  create-session               Creates a new Amazon DCV session
  delete-session               Deletes the specified Amazon DCV session
  describe-servers             Describes one or more Amazon DCV servers
  describe-sessions            Describes one or more Amazon DCV sessions
  get-session-connection-data  Gets connection data for a specific Amazon DCV session.
  get-session-screenshots      Gets screenshots of one or more Amazon DCV sessions.
  open-servers                 Opens one or more Amazon DCV servers
  update-session-permissions   Updates the user permissions for a specific Amazon DCV session.

Todos os comandos aceitam --help para obter informações de ajuda contextual. Por exemplo, o comando a seguir exibe a ajuda para o comando create-session.

dcvsm create-session --help

O exemplo a seguir mostra a saída do comando create-session --help.

Usage: dcvsm create-session [OPTIONS]

  Create sessions API

Options:
  --name TEXT                     The name for the session  [required]
  --owner TEXT                    The name of the session owner  [required]
  --type TEXT                     Session type: CONSOLE|VIRTUAL  [required]
  --init-file-path TEXT           Supported with virtual sessions on Linux
                                  Amazon DCV servers
  --autorun-file TEXT             The path to a file on the host server that
                                  is to be run inside the session
  --autorun-file-arguments TEXT   Command-line arguments passed to AutorunFile
                                  upon its execution inside the session
  --max-concurrent-clients INTEGER RANGE
                                  The maximum number of concurrent Amazon DCV
                                  clients, if provided must be between 1 and
                                  100 [1<=x<=100]
  --dcv-gl-enabled                Indicates whether the virtual session is
                                  configured to use hardware-based OpenGL.
                                  Specify to enable it, by default is disabled
  --permissions-file TEXT         The Base64-encoded contents of the
                                  permissions file
  --requirements TEXT             The requirements that the server must
                                  satisfy in order to place the session
  --storage-root TEXT             Specifies the path to the folder used for
                                  session storage
  -h, --help                          Show this message and exit.

A referência de comandos da CLI do SM do Amazon DCV também contém o conteúdo de ajuda para todos os comandos da CLI do SM do Amazon DCV. Todos os comandos na CLI do SM do Amazon DCV correspondem às solicitações feitas às APIs do broker. Cada API tem uma referência da API que pode ser encontrada na seção Guia do Desenvolvedor do Gerenciador de Sessões do Amazon DCV.

Tipos de parâmetros

Se você estiver tendo problemas para formatar uma opção ou argumento para um comando específico, a ajuda para cada comando descreve sua função e as opções aceitas.

String

Os parâmetros da string podem conter letras, números e espaço em branco. Strings com espaço em branco devem ser incluídas entre aspas. As strings podem ser cercadas por aspas simples, aspas duplas ou sem elas. Recomendamos que você não use símbolos pois isso pode causar resultados inesperados.

Lista

Uma ou mais strings separadas por vírgula e cercadas por aspas. O exemplo a seguir mostra uma lista de --session-ids.

dcvsm describe-sessions --session-ids "session123,session456"

Booleano

Sinalizador binário que ativa ou desativa uma opção. Por exemplo, --debug describe-sessions tem uma opção booleana --debug que, quando especificada, chama a API que ativa a depuração.

dcvsm --debug describe-sessions

Se você não especificar explicitamente uma opção booleana, ela será definida como FALSA por padrão.

Inteiro

Um número inteiro não assinado.

dcvsm describe-sessions --max-results 2