取得說明 - NICE DCV 工作階段管理員

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

取得說明

使用 DCV SM 命令列界面 (DCV SM CLI) 時,您可以獲得任何命令的説明。若要這樣做,只需在命令名稱結尾輸入 --help

例如,下列命令會顯示一般 DCV SM CLI 選項與可用之頂級命令的説明。

dcvsm --help

下列範例顯示 CLI 幫助的輸出。

Usage: dcvsm [OPTIONS] COMMAND [ARGS]... NICE 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 NICE DCV server create-session Creates a new NICE DCV session delete-session Deletes the specified NICE DCV session describe-servers Describes one or more NICE DCV servers describe-sessions Describes one or more NICE DCV sessions get-session-connection-data Gets connection data for a specific NICE DCV session. get-session-screenshots Gets screenshots of one or more NICE DCV sessions. open-servers Opens one or more NICE DCV servers update-session-permissions Updates the user permissions for a specific NICE DCV 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 NICE 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 NICE 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.

NICE DCV SM CLI 命令參考也包含所有 NICE DCV SM CLI 命令的説明內容。NICE DCV SM CLI 中的所有命令均對應於對代理 API 發出的請求。每個 API 都有 API 參考,可以在 NICE DCV 會話管理器開發人員指南部分找到。