View a markdown version of this page

Hilfe bei Befehlen erhalten - Amazon DCV-Sitzungsmanager
Parametertypen

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Hilfe bei Befehlen erhalten

Sie können Hilfe zu jedem Befehl erhalten, wenn Sie die Amazon DCV Session Manager-CLI verwenden. Geben Sie dazu hinter einem Befehlsnamen einfach --help ein.

Beispiel

Mit dem folgenden Befehl wird beispielsweise Hilfe zu den allgemeinen DCV SM CLI-Optionen und den verfügbaren Befehlen der obersten Ebene angezeigt.

dcvsm --help

Das folgende Beispiel zeigt die Ausgabe der CLI-Hilfe.

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.

Alle Befehle akzeptieren --help für kontextuelle Hilfeinformationen. Mit dem folgenden Befehl wird beispielsweise Hilfe für den Befehl create-session angezeigt.

dcvsm create-session --help

Das folgende Beispiel zeigt die Ausgabe für den create-session --help Befehl.

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.

Die Amazon DCV SM CLI Command Reference enthält auch den Hilfeinhalt für alle Amazon DCV SM CLI-Befehle. Alle Befehle in der Amazon DCV SM CLI entsprechen Anfragen APIs an den Broker. Jede API hat eine API-Referenz, die Sie im Amazon DCV Session Manager Developer Guide finden.

Parametertypen

Wenn Sie Probleme beim Formatieren einer Option oder eines Arguments für einen bestimmten Befehl haben, finden Sie in der Hilfe zu jedem Befehl eine Beschreibung seiner Funktion und der akzeptierten Optionen.

String

Zeichenkettenparameter können Buchstaben, Zahlen und Leerraum enthalten. Zeichenfolgen, die Leerzeichen enthalten, müssen in Anführungszeichen gesetzt werden. Zeichenketten können von einfachen Anführungszeichen, doppelten Anführungszeichen oder ohne Anführungszeichen umgeben sein. Wir empfehlen, keine Symbole zu verwenden, da dies zu unerwarteten Ergebnissen führen kann.

Auflisten

Eine oder mehrere durch Kommas getrennte und von Anführungszeichen umgebene Zeichenketten. Das folgende Beispiel zeigt eine Liste von. --session-ids

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

Boolesch

Binäres Flag, das eine Option aktiviert oder deaktiviert. Zum Beispiel hat --debug describe-sessions die boolesche Option --debug, die, falls angegeben, die API aufruft, die das Debuggen ermöglicht.

dcvsm --debug describe-sessions

Wenn Sie eine boolesche Option nicht explizit angeben, ist sie standardmäßig auf FALSE gesetzt.

Ganzzahl

Eine nicht signierte ganze Zahl.

dcvsm describe-sessions --max-results 2