Mendapatkan bantuan dengan perintah

Anda bisa mendapatkan bantuan dengan perintah apa pun saat menggunakan Amazon DCV Session Manager CLI. Untuk melakukannya, cukup ketik --help di akhir nama perintah.

contoh

Misalnya, perintah berikut menampilkan bantuan untuk opsi CLI DCV SM umum dan perintah tingkat atas yang tersedia.

dcvsm --help

Contoh berikut menunjukkan output dari bantuan 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.

Semua perintah menerima --help untuk informasi bantuan kontekstual. Misalnya, perintah berikut menampilkan bantuan untuk perintah create-session.

dcvsm create-session --help

Contoh berikut menunjukkan output untuk create-session --help perintah.

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.

Referensi Perintah Amazon DCV SM CLI juga berisi konten bantuan untuk semua perintah Amazon DCV SM CLI. Semua perintah di Amazon DCV SM CLI sesuai dengan permintaan yang dibuat APIs ke broker. Setiap API memiliki referensi API yang dapat ditemukan di bagian Panduan Pengembang Manajer Sesi Amazon DCV.

Jenis parameter

Jika Anda mengalami masalah dalam memformat opsi atau argumen untuk perintah tertentu, bantuan untuk setiap perintah menjelaskan fungsi dan opsi yang diterima.

String

Parameter string dapat berisi huruf, angka, dan spasi putih. String yang berisi spasi putih harus dikelilingi oleh tanda kutip. String dapat dikelilingi oleh tanda kutip tunggal, tanda kutip ganda, atau tanpa tanda kutip. Kami menyarankan Anda untuk tidak menggunakan simbol karena dapat menyebabkan hasil yang tidak terduga.

Daftar

Satu atau lebih string dipisahkan oleh koma dan dikelilingi oleh tanda kutip. Contoh berikut menunjukkan daftar--session-ids.

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

Boolean

Bendera biner yang mengaktifkan atau menonaktifkan opsi. Misalnya, --debug describe-sessions memiliki opsi Boolean --debug yang, ketika ditentukan, memanggil API yang mengaktifkan debugging.

dcvsm --debug describe-sessions

Jika Anda tidak menentukan secara eksplisit opsi boolean, itu disetel ke FALSE secara default.

Bilangan Bulat

Nomor bulat yang tidak ditandatangani.

dcvsm describe-sessions --max-results 2