Ottenere assistenza con i comandi

Puoi ricevere assistenza con qualsiasi comando quando usi Amazon DCV Session ManagerCLI. Per farlo, basta digitare --help al termine del nome di un comando.

Ad esempio, il comando seguente mostra la guida per le CLI opzioni DCV SM generali e i comandi di primo livello disponibili.

dcvsm --help

L'esempio seguente mostra l'output dell'CLIaiuto.

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.

Tutti i comandi accettano --help per informazioni di aiuto contestuali. Ad esempio, il comando seguente visualizza la guida per il comando create-session.

dcvsm create-session --help

L'esempio seguente mostra l'output 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.

L'Amazon DCV SM CLI Command Reference contiene anche il contenuto di aiuto per tutti i CLI comandi Amazon DCV SM. Tutti i comandi in Amazon DCV SM CLI corrispondono alle richieste fatte al broker. APIs Ciascuna API ha un API riferimento che può essere trovato nella sezione Amazon DCV Session Manager Developer Guide.

Tipi di parametro

Se hai problemi a formattare un'opzione o un argomento per un comando specifico, la guida di ogni comando descrive la funzione e le opzioni accettate.

Stringa

I parametri delle stringhe possono contenere lettere, numeri e spazi bianchi. Le stringhe che contengono spazi vuoti devono essere racchiuse tra virgolette. Le stringhe possono essere racchiuse tra virgolette singole, doppie o senza di esse. Si consiglia di non utilizzare simboli perché ciò può causare risultati imprevisti.

Elenco

Una o più stringhe separate da virgole e racchiuse tra virgolette. L'esempio seguente mostra un elenco di. --session-ids

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

Booleano

Bandiera binaria che attiva o disattiva un'opzione. Ad esempio, --debug describe-sessions ha un'opzione booleana --debug che, quando specificata, chiama l'abilitazione del debug. API

dcvsm --debug describe-sessions

Se non specifichi esplicitamente un'opzione booleana, per impostazione predefinita viene impostata su. FALSE

Numero intero

Numero intero senza firma.

dcvsm describe-sessions --max-results 2