Obtención de ayuda con comandos - Amazon DCV Session Manager
Tipos de parámetros

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Obtención de ayuda con comandos

Puede obtener ayuda con cualquier comando cuando utilice la CLI de Amazon DCV Session Manager. Para ello, simplemente escriba --help al final del nombre de un comando.

ejemplo

Por ejemplo, el siguiente comando muestra la ayuda de las opciones generales de la CLI de DCV SM generales y los comandos de nivel superior.

dcvsm --help

El siguiente ejemplo muestra la salida de la ayuda de la 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 los comandos aceptan --help para obtener información de ayuda contextual. Por ejemplo, el comando siguiente muestra la ayuda del comando create-session.

dcvsm create-session --help

El siguiente ejemplo muestra los resultados del 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.

La Referencia de comandos de CLI de Amazon DCV SM también contiene la ayuda de todos los comandos de la CLI de Amazon DCV SM. Todos los comandos de la CLI de Amazon DCV SM corresponden a las solicitudes realizadas a las API del broker. Todas las API tienen una referencia de API que puede encontrarse en la sección Guía para desarrolladores de Amazon DCV Session Manager.

Tipos de parámetros

Si tiene problemas con el formato de una opción o un argumento para un comando específico, la ayuda de cada comando describe su función y opciones aceptadas.

Cadena

Los parámetros de cadena pueden contener letras, números y espacios en blanco. Las cadenas que contienen espacios en blanco deben entrecomillarse. Las cadenas pueden estar entre comillas simples, comillas dobles o sin ellas. Le recomendamos que no utilice símbolos porque podrían producirse resultados inesperados.

Enumeración

Una o más cadenas separadas por comas y entre comillas. En la siguiente imagen se muestra un ejemplo de --session-ids.

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

Booleano

Marcador binario que activa o desactiva una opción. Por ejemplo, --debug describe-sessions tiene una opción booleana --debug que, cuando se especifica, llama a la API que permite la depuración.

dcvsm --debug describe-sessions

Si no especifica una opción booleana de forma explícita, se establece en FALSE de forma predeterminada.

Entero

Un número entero sin firma.

dcvsm describe-sessions --max-results 2