View a markdown version of this page

Obtenir de l'aide concernant les commandes - Gestionnaire de sessions Amazon DCV
Types de paramètres

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Obtenir de l'aide concernant les commandes

Vous pouvez obtenir de l'aide pour n'importe quelle commande lorsque vous utilisez la CLI Amazon DCV Session Manager. Pour cela, il vous suffit de saisir --help à la fin d'un nom de commande.

Exemple

Par exemple, la commande suivante affiche de l'aide concernant les options générales de la CLI DCV SM et les commandes de haut niveau disponibles.

dcvsm --help

L'exemple suivant montre le résultat de l'aide 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.

Toutes les commandes acceptent --help pour les informations d'aide contextuelle. Par exemple, la commande suivante affiche l'aide relative à la commande create-Session.

dcvsm create-session --help

L'exemple suivant montre le résultat de la create-session --help commande.

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 référence des commandes de la CLI Amazon DCV SM contient également le contenu d'aide pour toutes les commandes de la CLI Amazon DCV SM. Toutes les commandes de la CLI Amazon DCV SM correspondent aux demandes adressées APIs au courtier. Chaque API possède une référence d'API qui se trouve dans la section Amazon DCV Session Manager Developer Guide.

Types de paramètres

Si vous ne parvenez pas à formater une option ou un argument pour une commande spécifique, l'aide de chaque commande décrit sa fonction et les options acceptées.

Chaîne

Les paramètres de chaîne peuvent contenir des lettres, des chiffres et des espaces blancs. Les chaînes qui contiennent des espaces doivent être placées entre guillemets. Les chaînes peuvent être entourées de guillemets simples, de guillemets doubles ou sans ceux-ci. Nous vous recommandons de ne pas utiliser de symboles car cela peut entraîner des résultats inattendus.

Liste

Une ou plusieurs chaînes séparées par des virgules et entourées de guillemets. L'exemple suivant montre une liste de--session-ids.

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

Booléen

Drapeau binaire qui active ou désactive une option. Par exemple, --debug describe-sessions possède une option booléenne --debug qui, lorsqu'elle est spécifiée, appelle l'API permettant le débogage.

dcvsm --debug describe-sessions

Si vous ne spécifiez pas explicitement d'option booléenne, elle est définie sur FALSE par défaut.

Entier

Nombre entier non signé.

dcvsm describe-sessions --max-results 2