명령에 대한 도움말 가져오기 - Amazon DCV 세션 관리자
파라미터 유형

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

명령에 대한 도움말 가져오기

Amazon DCV 세션 관리자 CLI를 사용할 때 모든 명령에 대한 도움말을 얻을 수 있습니다. 이를 위해 명령 이름 끝에 --help를 입력하기만 하면 됩니다.

예

예를 들어 다음 명령은 일반 DCV SM CLI 옵션에 대한 도움말과 사용 가능한 최상위 명령을 표시합니다.

dcvsm --help

다음 예제에서는 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.

모든 명령은 상황에 맞는 도움말 정보로 --help를 허용합니다. 예를 들어, 다음 명령은 create-session 명령에 대한 도움말을 표시합니다.

dcvsm create-session --help

다음 예제에서는 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.

Amazon DCV SM CLI 명령 참조에는 모든 Amazon DCV SM CLI 명령에 대한 도움말 콘텐츠도 포함되어 있습니다. Amazon DCV SM CLI의 모든 명령은 브로커의 API에 대해 이루어진 요청에 해당합니다. 각 API에는 Amazon DCV 세션 관리자 개발자 안내서 섹션에서 찾을 수 있는 API 참조가 있습니다.

파라미터 유형

특정 명령에 대한 옵션 또는 인수의 형식을 지정하는 데 문제가 있는 경우, 각 명령에 대한 도움말에서 해당 명령의 기능과 허용되는 옵션을 설명합니다.

String

문자열 파라미터에는 문자, 숫자 및 공백이 포함될 수 있습니다. 공백이 포함된 문자열은 인용 부호로 묶어야 합니다. 문자열은 작은따옴표, 큰따옴표로 묶거나 따옴표를 사용하지 않을 수도 있습니다. 기호를 사용하면 예상치 못한 결과가 발생할 수 있으므로 사용하지 않는 것이 좋습니다.

나열

쉼표로 구분되고 따옴표로 묶인 하나 이상의 문자열입니다. 다음 예제에서는 --session-ids의 목록을 보여줍니다.

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

불

옵션을 켜거나 끄는 이진 플래그입니다. 예를 들어 --debug describe-sessions에는 부울 --debug 옵션이 있으며, 이 옵션을 지정하면 API를 직접적으로 호출하여 디버깅을 활성화합니다.

dcvsm --debug describe-sessions

부울 옵션을 명시적으로 지정하지 않으면 기본적으로 FALSE로 설정됩니다.

Integer

부호가 없는 정수입니다.

dcvsm describe-sessions --max-results 2