NICE DCV Session Manager. Guide CLI

(1)

NICE DCV Session Manager

Guide CLI

(2)

NICE DCV Session Manager: Guide CLI

Les marques et la présentation commerciale d'Amazon ne peuvent être utilisées en relation avec un produit ou un service qui n'est pas d'Amazon, d'une manière susceptible de créer une confusion parmi les clients, ou d'une manière qui dénigre ou discrédite Amazon. Toutes les autres marques commerciales qui ne sont pas la propriété d’Amazon appartiennent à leurs propriétaires respectifs, qui peuvent ou non être affiliés, connectés à ou sponsorisés par Amazon.

(3)

Qu'est-ce que l'interface de ligne de commande NICE DCV Session Manager ?

NICE DCV Session Manager est un ensemble de progiciels installables (un agent et un courtier) et une interface de programmation d'applications (API) qui permet aux développeurs et aux éditeurs de logiciels indépendants (ISV) de créer facilement des applications frontales qui créent et gèrent par programmation le cycle de vie de NICE DCV sessions sur une flotte de serveurs NICE DCV.

Vous pouvez utiliser l'interface de ligne de commande (CLI) NICE DCV pour interagir avec un courtier DCV Session Manager à l'aide des commandes du shell de ligne de commande.

• Shell Linux — Utilisez des programmes Shell courants tels quebash,zsh, ettcshpour exécuter des commandes sous Linux ou macOS.

• Ligne de commande Windows : exécutez des commandes à l'invite de commande Windows ou PowerShell.

Vous pouvez utiliser NICE DCV Session Manager CLI pour créer et gérer le cycle de vie des sessions NICE DCV. Ils sont gérés par un gestionnaire de session NICE DCV.

(6)

Conditions préalables à l'installation de NICE DCV Session Manager CLI

Installation de l'interface de ligne de commande NICE DCV Session Manager

Cette section explique comment installer l'interface de ligne de commande (CLI) NICE DCV Session Manager sur Linux, macOS et Windows.

Conditions préalables à l'installation de NICE DCV Session Manager CLI

Cette section inclut les conditions préalables à l'installation de l'interface de ligne de commande NICE DCV Session Manager sous Linux, macOS et Windows.

Linux and macOS

• Python version 3.6 ou suivante.

• Possibilité d'extraire ou de décompresser un fichier compressé téléchargé. Si votre système d'exploitation ne dispose pas de la commande unzip intégrée, utilisez un équivalent.

Windows

• Python version 3.6 ou suivante.

• Python doit être correctement défini dans la variable d'environnement PATH pour exécuter NICE DCV Session Manager CLI à l'aide du script de démarrage.

Installation de NICE DCV Session Manager CLI

Cette section décrit le processus d'installation de NICE DCV Session Manager CLI sous Linux, macOS et Windows.

Linux and macOS

Pour installer NICE DCV Session Manager CLI sous Linux et macOS 1. Téléchargez le package zippé depuis leSite NICE DCV.

2. Décompressez le package téléchargé. Si votre distribution Linux n'a pas de commande intégrée de décompression, utilisez un équivalent pour procéder à la décompression. L'exemple de commande suivant décompression du package et crée un répertoire nomménice-dcv- session-manager-cli-1.0.0-37sous le répertoire actuel.

$ unzip nice-dcv-session-manager-cli-1.0.0-37.zip

3. Pour valider le contenu du fichier zip, exécutez la commande suivante dans le dossier extrait à l'étape précédente :

(7)

Installation de NICE DCV Session Manager CLI

./dcvsm --version

Windows NICE DCV server

Pour installer NICE DCV Session Manager CLI sous Windows 1. Téléchargez le package zippé depuis leSite NICE DCV.

2. Décompressez le package téléchargé.

3. Pour valider le contenu du fichier zip, exécutez la commande suivante :

C:\> dcvsm --version

(8)

Concepts de base de la configuration

Configuration de l'interface de ligne de commande NICE DCV Session Manager

Cette section explique comment configurer les paramètres que l'interface de ligne de commande (CLI) de NICE DCV Session Manager utilise pour interagir avec le courtier.

Concepts de base de la configuration

Pour travailler avec l'interface de ligne de commande, vous devez enregistrer un client Session Manager auprès du courtier et générer des informations d'identification du client. Suivez le processus décrit dans leRéférence de l'interface de ligne de commande.

L'interface CLI NICE DCV Session Manager comporte un ensemble de paramètres de configuration que l'utilisateur peut spécifier. Les paramètres suivants sont obligatoires :

• URL d'agent

• ID client

• mot de passe client

Les paramètres de configuration peuvent être définis de trois manières suivantes :

• Ligne de commande

• Variables d’environnement

• Fichier de configuration

Hiérarchie des paramètres de configuration

L'interface CLI DCV SM utilise des informations d'identification et des paramètres de configuration situés à plusieurs endroits. Ceux-ci comprennent les variables d'environnement utilisateur, le fichier de configuration DCV SM local ou les informations explicitement déclarées sur la ligne de commande en tant que paramètre. Certains emplacements l'emportent sur d'autres.

Les informations d'identification de l'interface de ligne de commande de NICE DCV et les paramètres de configuration ont priorité dans l'ordre suivant :

• Options de ligne de commande : remplace les paramètres de n'importe quel autre emplacement.

• Variables d'environnement : certaines valeurs peuvent être stockées dans les variables d'environnement système.

• Fichier de configuration de l'interface de ligne de commande : spécifie les options dans le fichier de configuration.

(9)

Options de ligne de commande

Dans l'interface de ligne de commande DCV SM, vous pouvez utiliser les options de ligne de commande suivantes pour remplacer les paramètres de configuration par défaut, tout paramètre de profil

correspondant ou paramètre de variable d'environnement pour cette commande unique. Vous ne pouvez pas utiliser les options de ligne de commande pour spécifier directement des informations d'identification.

Chaque option qui prend un argument nécessite un espace ou un signe égal (=) qui sépare l'argument du nom de l'option.

--conf

Spécifie le chemin du fichier de configuration. S'il n'est pas défini, l'interface de ligne de commande utilise le fichier de configuration par défaut. Pour de plus amples informations sur le fichier de configuration, consultez la section.Fichier de configuration (p. 7).

Type : Chaîne --broker-url

Spécifie l'URL à laquelle envoyer la requête.

Type : Chaîne --debug

Commutateur booléen qui active la journalisation du débogage. Par défaut, l'interface CLI DCV SM fournit des informations nettoyées concernant les succès ou les échecs concernant les résultats des commandes dans la sortie de la commande. L'option —debug fournit les journaux complets. Cela inclut des informations de diagnostic supplémentaires sur l'opération de la commande qui peuvent être utiles pour déterminer pourquoi une commande fournit des résultats inattendus.

Type : Booléenne Type : Chaîne --no-verify-ssl

Avec cette option, vous pouvez désactiver la vérification des certificats SSL, mais elle est déconseillée pour des raisons de sécurité. Par défaut, l'interface de ligne de commande DCV SM utilise SSL lors de la communication avec les services de courtier.

Type : Booléenne --ca-bundle

Indique le chemin d'accès à un ensemble de certificats personnalisé (un fichier avec un fichier contenant un.pem) de l'autorité de certification à utiliser lors de l'établissement de connexions SSL/

TLS

--auth-server-url

Spécifie le nom d'hôte du serveur d'authentification utilisé pour demander le jeton d'accès OAuth 2.0.

Si elle n'est pas spécifiée, l'URL du courtier est utilisée.

Type : Chaîne --version

Affiche la version actuelle du programme de ligne de commande DCV SM qui est en cours d'exécution.

Type : Chaîne --help

Affichez la liste des options et des commandes de l'interface de ligne de commande DCV SM.

(10)

Variables d’environnement

Type : Chaîne

Variables d’environnement

Les variables d'environnement fournissent un autre moyen de spécifier certaines options de configuration et des informations d'identification.

Les exemples suivants décrivent comment vous pouvez configurer des variables d'environnement pour l'utilisateur par défaut.

Définir les variables d'environnement sur Linux ou macOS

Exécutez les commandes suivantes pour définir des variables d'environnement sur Linux ou macOS :

$ export DCV_SM_AUTH_SERVER_URL=https://example.com

$ export DCV_SM_CLIENT_ID=ExampleClientID

La définition de la variable d'environnement permet de modifier la valeur utilisée jusqu'à la fin de votre session shell, ou jusqu'à ce que vous définissiez la variable sur une autre valeur. Vous pouvez rendre les variables persistantes dans les sessions futures en les définissant dans le script de démarrage de votre shell.

Définir les variables d'environnement sous Windows

Exécutez les commandes suivantes pour définir des variables d'environnement sur l'invite de commande Windows :

$ setx DCV_SM_AUTH_SERVER_URL https://example.com

$ setx DCV_SM_CLIENT_ID ExampleClientID

A l'aide desetPour définir une variable d'environnement, modifie la valeur utilisée jusqu'à la fin de la session d'invite de commande en cours. Ou bien, c'est jusqu'à ce que vous définissiez la variable sur une autre valeur. A l'aide desetxPour définir une variable d'environnement, modifie la valeur utilisée dans la session d'invite de commande en cours et toutes les sessions d'invite de commande. Ces sessions que vous créez après avoir exécuté la commande. Cela n'affecte pas les autres shells de commande qui sont déjà en cours d'exécution au moment où vous exécutez la commande.

Définir les variables d'environnement avec PowerShell

Exécutez les commandes suivantes pour définir des variables d'environnement à l'aide de PowerShell :

$ $Env:DCV_SM_AUTH_SERVER_URL="https://example.com"

$ $Env:DCV_SM_CLIENT_ID="ExampleClientID"

Si vous définissez une variable d'environnement à l'invite de commande PowerShell, comme illustré dans les exemples précédents, la valeur est enregistrée uniquement pour la durée de la session en cours.

(11)

Variables d'environnement prises en charge NICE DCV Session Manager

Pour que la définition de la variable d'environnement perdure sur l'ensemble des sessions d'invite de commande et PowerShell, conservez-la à l'aide de l'application *System* dans *Panneau de configuration*.

Vous pouvez également définir la variable pour toutes les futures sessions PowerShell en les ajoutant à votre profil PowerShell. Pour plus d'informations sur le stockage des variables d'environnement ou leur conservation dans une session, consultez la section.la documentation PowerShell.

Variables d'environnement prises en charge NICE DCV Session Manager

NICE DCV Session Manager prend en charge les variables d'environnement suivantes :

• DCV_SM_AUTH_SERVER_URL

Spécifie le nom d'hôte du serveur d'authentification utilisé pour demander le jeton d'accès OAuth 2.0. Si elle est définie, cette variable d'environnement remplace la valeur du fichier de configuration.

• DCV_SM_CLIENT_ID

ID client unique utilisé par le client Session Manager pour récupérer un jeton d'accès OAuth 2.0.

• DCV_SM_CLIENT_PASSWORD

Mot de passe utilisé par le client Session Manager pour récupérer un jeton d'accès OAuth 2.0.

• DCV_SM_OAUTH2_TOKEN

Jeton d'accès utilisé pour effectuer une demande d'API.

Fichier de configuration

Le fichier de configuration est le troisième moyen de spécifier certaines options de configuration et des informations d'identification. Par défaut, il est fourni dans le fichier zip à l'adresse/conf/dcvsmcli.conf.

L'utilisateur peut spécifier le chemin d'accès du fichier de configuration en ligne de commande. Si

l'utilisateur ne spécifie pas explicitement le fichier de configuration, il sera lu par défaut à partir d'un dossier spécifique en fonction des systèmes d'exploitation :

• Systèmes basés sur Unix :$XDG_CONFIG_HOME/dcvsmcli.conf

• Systèmes Windows :%UserProfile%\dcvsmcli.conf

Si le fichier de configuration n'est pas trouvé, l'interface de ligne de commande lit le fichier à partir du chemin d'accès/conf/dcvsmcli.conffourni avec le fichier .zip. Le fichier de configuration est structuré comme suit :

[output]

# The formatting style for command output.

output-format = json

# Turn on debug logging debug = true

[security]

# Disable SSL certificates verification.

no-verify-ssl = true

# CA certificate bundle to use when verifying SSL certificates.

ca-bundle = ca-bundle.pem

(12)

Fichier de configuration

[authentication]

# hostname of the authentication server used to request the token auth-server-url = https://broker-host:broker-port/oauth2/token

# The client ID client-id = username

# The client password client-password = password [broker]

# hostname or IP of the broker url = https://broker-host:broker-port

(13)

Obtenir de l'aide

Utilisation de l'interface de ligne

de commande NICE DCV Session Manager

Cette section présente de nombreuses fonctionnalités courantes et les options disponibles dans l'Interface de ligne de commande DCV SM (DCV SM CLI).

Obtenir de l'aide

Vous pouvez obtenir de l'aide avec n'importe quelle commande en utilisant l'Interface de ligne de commande DCV SM (DCV SM CLI). Pour cela, il vous suffit de saisir --help à la fin d'un nom de commande.

Par exemple, la commande suivante affiche l'aide pour les options générales de l'interface de ligne de commande DCV SM et les commandes de niveau supérieur disponibles.

dcvsm --help

L'exemple suivant illustre la sortie de l'aide de l'interface de ligne de commande.

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.

(14)

Structure de commande

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.

Toutes les commandes acceptent —help pour obtenir des informations d'aide contextuelles. Par exemple, la commande suivante affiche l'aide pour la commande de création de session.

dcvsm create-session --help

L'exemple suivant illustre la sortie de l'create-session --helpcommande.

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.

La référence de commande NICE DCV SM CLI contient également le contenu d'aide pour toutes les commandes CLI NICE DCV SM. Toutes les commandes de l'interface de ligne de commande NICE DCV SM correspondent aux demandes effectuées vers les API du courtier. Chaque API possède une référence d'API disponible dans la section Guide du développeur de NICE DCV Session Manager.

Structure de commande

Cette rubrique explique comment la commande DCV SM Command Line Interface (DCV SM CLI) est structurée. L'interface de ligne de commande DCV utilise une structure en plusieurs parties sur la ligne de commande qui doit être spécifiée dans l'ordre suivant :

1. L'appel de base pour le programme ./dcvsm.

2. Leoptionsqui correspond aux options courantes utilisées par toutes les commandes et vous pouvez les spécifier dans n'importe quel ordre.

3. Lecommandsqui spécifie l'opération à effectuer.

4. Leargscorrespond aux arguments requis par la commande.

(15)

Syntaxe

dcvsm [options] commands args

Les arguments peuvent prendre différents types de valeurs en entrée. Il s'agit notamment de nombres, de chaînes, de booléens. Ce qui est pris en charge dépend de la commande que vous spécifiez.

Types de paramètres

Cette section décrit certains types de paramètres communs et le format typique requis. Si vous rencontrez des difficultés pour la mise en forme d'une option ou d'un argument d'une commande spécifique, consultez l'aide ; pour ce faire, saisissez après le nom de la commande. L'aide de chaque commande décrit sa fonction et les options acceptées.

Chaîne

Les paramètres de chaîne peuvent contenirlettres, 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 elles. Nous vous recommandons de ne pas utiliser de symboles car il peut entraîner des résultats inattendus.

Chaîne

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

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

Booléen

Binaire qui active ou désactive une option. Par exemple, —debug describe-sessions dispose d'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 une option booléenne, elle est définie sur FALSE par défaut.

Entier

Nombre entier non signé.

dcvsm describe-sessions --max-results 2

Codes de retour

Le code de retour est généralement, mais pas toujours un code masqué envoyé après l'exécution d'une commande DCV SM Command Line Interface (DCV SM CLI), qui décrit l'état de la commande. Vous pouvez utiliser la commande echo pour afficher le code envoyé par la dernière commande DCV SM CLI et utiliser ces codes pour déterminer si une commande a réussi ou si elle a échoué, et pourquoi une commande peut comporter une erreur. En plus des codes de retour, vous pouvez afficher plus de détails

(16)

Codes de retour

sur un échec en exécutant vos commandes avec le commutateur —debug. Ce commutateur génère un rapport détaillé indiquant les étapes que l'interface de ligne de commande DCV utilise pour traiter la commande et le résultat de chaque étape. Pour déterminer le code de retour d'une commande de l'interface de ligne de commande DCV SM, exécutez l'une des commandes suivantes immédiatement après l'exécution de la commande de l'interface de ligne de commande.

• Linux et macOS

$ echo $?

0

• Windows PowerShell

$ echo $lastexitcode 0

• Invite de commande Windows

$ echo %errorlevel%

0

Les codes de retour suivants apparaissent à la fin de l'exécution d'une commande CLI :

• 0La commande a été réussie. Aucune erreur n'a été générée par l'interface de ligne de commande ou par le service auquel la requête a été effectuée.

• 1Le fichier de configuration analysé vers l'interface de ligne de commande n'a pas été trouvé ou pourrait être endommagé.

• 2La commande entrée sur la ligne de commande n'a pas pu être analysée. Les erreurs d'analyse peuvent être dus, notamment, à des sous-commandes ou des arguments obligatoires manquants ou à l'utilisation de commandes ou d'arguments inconnus. Notez que cette signification de code de retour s'applique à toutes les commandes de l'interface de ligne de commande.

• 130Le processus a reçu un SIGINT (Ctrl+C).

• 252La syntaxe de commande n'était pas valide, un paramètre inconnu a été fourni ou une valeur de paramètre était incorrecte et a empêché l'exécution de la commande.

• 253L'environnement ou la configuration système n'était pas valide. Bien que la commande fournie soit valide de façon syntaxique, la configuration ou les informations d'identification manquantes ont empêché l'exécution de la commande.

• 254La commande a été correctement analysée et une demande a été envoyée au service spécifié, mais le service a renvoyé une erreur. Cela indique généralement une utilisation incorrecte de l'API ou d'autres problèmes spécifiques au service.

• 255Erreur générale de fourre-tout. La commande a peut-être correctement analysé, mais une erreur d'exécution non spécifiée s'est produite lors de l'exécution de la commande. Comme il s'agit d'un code d'erreur général, une erreur peut passer de 255 à un code de retour plus spécifique. Un code de retour de 255 ne doit pas être utilisé pour déterminer un cas d'erreur spécifique.

(17)

serveurs fermés

Référence CLI NICE DCV Session Manager

Cette section explique comment utiliser les commandes de l'interface de ligne de commande (CLI) NICE DCV.

Utilisez les commandes suivantes pour interagir avec le serveur NICE DCV.

• serveurs ouverts (p. 20)

• Describe-Serveurs (p. 17)

• serveurs fermés (p. 13)

Utilisez les commandes suivantes pour interagir avec la session NICE DCV.

• create-session (p. 14)

• Describe-sessions (p. 18)

• get-session-connection-données- (p. 19)

• captures d'écran de get-session (p. 19)

• autorisations de session de mise à jour (p. 21)

• supprimer une session (p. 16)

serveurs fermés

Ferme un ou plusieurs serveurs NICE DCV NICE DCV. Lorsque vous fermez un serveur NICE DCV, vous le rendez indisponible pour le placement de session NICE DCV. Vous ne pouvez pas créer de sessions NICE DCV sur des serveurs fermés. La fermeture d'un serveur garantit qu'aucune session n'est exécutée dessus et que les utilisateurs ne peuvent pas créer de nouvelles sessions dessus.

Rubriques

• Résumé (p. 13)

• Options (p. 13)

• Example (Exemple) (p. 14)

Résumé

close-servers --server-ids <value>

[--force]

Options

--server-ids

Liste des identifiants séparés par des virgules des serveurs NICE DCV à fermer.

(18)

Example (Exemple)

Type : Chaîne Obligatoire Oui --force

Opération qui force le serveur à fermer. Par défaut, l'option est désactivée.

Type : Booléen Obligatoire Non

Example (Exemple)

dcvsm close-server --server-ids "server123,server456"

create-session

Crée une nouvelle session NICE DCV avec les détails spécifiés.

Rubriques

• Options (p. 13)

Résumé

create-session --name <value>

--owner --type <value>

[--init-file-path <value>]

[--autorun-file <value>]

[--autorun-file-arguments <value>]

[--max-concurrents-clients <value>]

[--dcv-gl-enabled]

[--permissions-file <value>]

[--requirements <value>]

[--storage-root <value>]

Options

--name

Le nom de la session.

Type : Chaîne Obligatoire Oui --owner

Nom du propriétaire de la session.

(19)

Options

Type : Chaîne Obligatoire Oui --type

Le type de session. C'est soitConsoleouVirtual.

Type : Choice Obligatoire Oui --init_file_path

Chemin d'accès au script personnalisé sur le serveur NICE DCV à exécuter pour initialiser la session lors de sa création. Le chemin de fichier est relatif par rapport à l'optioninitrépertoire spécifié pour leagent.init_folderParamètre de configuration de l'agent.

Type : Chaîne Obligatoire Non --autorun_file

Chemin d'accès à un fichier sur le serveur hôte qui doit être exécuté au sein de la session.

Le chemin de fichier est relatif par rapport à l'optionautorunrépertoire spécifié pour leagent.autorun_folderParamètre de configuration de l'agent.

Type : Chaîne Obligatoire Non

--autorun_file_arguments

Les arguments de ligne de commande transmis àAutorunFilelorsqu'il est exécuté à l'intérieur de la session.

--max_concurrent_clients

Nombre maximal de clients NICE DCV simultanés. Si cela est fourni, il doit être compris entre 1 et 100.

Type : Entier Obligatoire Non --dcv_gl_enabled

Opération de configuration de la session virtuelle pour utiliser OpenGL matérielle. Par défaut, l'option est désactivée.

Type : Booléen Obligatoire Non --permissions_file

Chemin d'accès au fichier d'autorisations.

(20)

Example (Exemple)

--requirements

Configuration requise que le serveur doit respecter pour placer la session.

Type : Chaîne Obligatoire Non --storage_root

Chemin d'accès au dossier utilisé pour le stockage de session.

Example (Exemple)

dcvsm create-session --name session123 --owner sessionOwner --type Console --requirements "server:Host.Os.Family = 'windows'"

supprimer une session

Supprime la session NICE DCV spécifiée et la supprime du cache du broker.

Rubriques

• Options (p. 13)

Résumé

delete-session --session-id <value>

--owner <value>

[--force]

Options

--session-id

ID de la session à supprimer.

Propriétaire de la session à supprimer.

Type : Chaîne Obligatoire Oui

(21)

Example (Exemple)

--force

Opération permettant de s'assurer qu'une session est supprimée du cache du broker. Par défaut, l'option est désactivée.

Type : Booléen Obligatoire Non

Example (Exemple)

dcvsm delete-session --session-id session123 --owner sessionOwner --force

Describe-Serveurs

Décrivez le serveur NICE DCV spécifié.

Rubriques

• Options (p. 13)

Résumé

describe-servers [--server-ids <value>]

[--next-token <value>]

[--max-results <value>]

Options

--server-ids

Liste des identifiants séparés par des virgules des serveurs NICE DCV à décrire.

Type : Chaîne Obligatoire Non --next-token

Jeton à utiliser pour récupérer la page suivante de résultats.

Type : Chaîne Obligatoire Non --max-results

Nombre maximal de résultats à renvoyer par la demande en sortie paginée. S'il est fourni, il doit être un nombre compris entre 1 et 1000.

Type : Entier

(22)

Example (Exemple)

Obligatoire Non

Example (Exemple)

dcvsm describe-servers --server-ids "server123,server456"

Describe-sessions

Décrit un ou plusieurs serveurs NICE DCV NICE DCV.

Rubriques

• Options (p. 13)

Résumé

describe-sessions [--session-ids <value>]

[--next-token <value>]

[--owner <value>]

[--max-results <value>]

Options

--session-ids

Liste des ID séparés par des virgules des sessions NICE DCV à décrire.

Type : Chaîne Obligatoire Non --next-token

Jeton permettant de récupérer la page suivante de résultats.

Type : Chaîne Obligatoire Non --owner

Propriétaire de la session à décrire.

Type : Chaîne Obligatoire Non --max-results

Nombre de résultats à afficher. S'il est fourni, doit être compris entre 1 et 1 000.

Type : Entier

(23)

Example (Exemple)

Obligatoire Non

Example (Exemple)

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

get-session-connection-données-

Obtient les informations de connexion pour la connexion d'un utilisateur spécifique à une session NICE DCV spécifique.

Rubriques

• Options (p. 13)

Résumé

get-session-connection-data --session-id <value>

--user <value>

Options

--session-id

ID des sessions NICE DCV à partir desquelles vous pouvez obtenir les données de connexion.

Type : Chaîne Obligatoire Oui --user

Nom de l'utilisateur pour lequel afficher les informations de connexion.

Type : Booléen Obligatoire Oui

Example (Exemple)

./dcvsm get-session-connection-data --session-id session123 --user dcvuser

captures d'écran de get-session

Récupère des captures d'écran d'une ou de plusieurs sessions NICE DCV.

(24)

Résumé

Rubriques

• Options (p. 13)

Résumé

get-session-screenshots --session-ids <value>

Options

--session-ids

Liste des identifiants séparés par des virgules des sessions NICE DCV pour obtenir les captures d'écran.

Example (Exemple)

./dcvsm get-session-screenshots --session-id session123

serveurs ouverts

Ouvre un ou plusieurs serveurs NICE DCV NICE DCV. Avant de pouvoir créer des sessions sur un serveur NICE DCV, vous devez modifier l'état du serveur pour qu'il s'ouvre. Une fois le serveur NICE DCV ouvert, vous pouvez créer d'instances de sessions NICE DCV sur le serveur.

Rubriques

• Options (p. 13)

Résumé

open-servers

--server-ids <value>

Options

--server-ids

Liste des identifiants séparés par des virgules des serveurs NICE DCV à ouvrir.

Type : Chaîne

(25)

Example (Exemple)

Obligatoire Oui

Example (Exemple)

./dcvsm open-servers --server-ids "server123,server456"

autorisations de session de mise à jour

Met à jour les autorisations utilisateur pour une session NICE DCV spécifique.

Rubriques

• Options (p. 13)

Résumé

update-session-permissions --session-id <value>

--owner <value>

--permission-file <value>

Options

--session-id

ID de la session pour laquelle modifier les autorisations.

Le propriétaire de la session pour laquelle modifier les autorisations.

Type : Chaîne Obligatoire Oui --permission-file

Chemin d'accès au fichier d'autorisations.

Example (Exemple)

./dcvsm update-session-permissions --session-id session123

(26)

Example (Exemple)

--owner Owner --permission-file path_to_file

(27)

Notes de mise à jour

Notes de mise à jour et historique des documents pour NICE DCV

Cette page fournit les notes de mise à jour et l'historique des documents pour NICE DCV Session Manager.

Rubriques

• Notes de mise à jour de NICE DCV Session Manager (p. 23)

• Historique de document (p. 26)

Notes de mise à jour de NICE DCV Session Manager

Cette section fournit un aperçu des principales mises à jour, des versions de fonctionnalités et des

corrections de bogues pour NICE DCV Session Manager. Toutes les mises à jour sont organisées par date de sortie. Nous mettons régulièrement la documentation à jour pour prendre en compte les commentaires qui nous sont envoyés.

Rubriques

• 2022.1-13067 — 29 juin 2022 (p. 23)

• 2022.0-1952— 23 février 2022 (p. 24)

• 2021.3-11591 — 20 décembre 2021 (p. 24)

• 2021.2-1445— 18 novembre 2021 (p. 24)

• 2021.2-11190 — 11 octobre 2021 (p. 24)

• 2021.2-11042— 01 septembre 2021 (p. 25)

• 2021.1-10557 — 31 mai 2021 (p. 25)

• 2021.0-10242— 12 avril 2021 (p. 25)

• 2020.2-9662 — 4 décembre 2020 (p. 26)

• 2020.2-9508 — 11 novembre 2020 (p. 26)

2022.1-13067 — 29 juin 2022

Numéros de version Modifications et correctifs de bogues

• agent

• Agent : 592

• INTERFACE LIGNE LIGNE LIGNE LIGNE

• Ajout de la prise en charge de l'exécution du brokerAWSInstance Graviton

• Ajout de la prise en charge des agents et des courtiers pour Ubuntu 22.04.

(28)

2022.0-1952— 23 février 2022

• agent

• Agent : 520

• Ajout de la capacité de rotation des journaux à l'agent.

• Ajout du paramètre de configuration pour définir le répertoire d'origine Java dans le Broker.

• Amélioration du vidage des données du cache vers le disque dans le Broker.

• Correction de la validation d'URL dans la CLI.

2021.3-11591 — 20 décembre 2021

Numéros de version Nouvelles fonctions

• agent

• Agent : 453

• Ajout de la prise en charge de l'intégration avec la passerelle de connexion NICE DCV.

• Ajout de la ligne de l'agent pour Ubuntu 18.04 et Ubuntu 20.04

2021.2-1445— 18 novembre 2021

• agent

• Agent : 413

• Correction d'un problème de validation des noms de connexion qui incluent un domaine Windows.

2021.2-11190 — 11 octobre 2021

• agent

• Agent : 413

• Correction d'un problème dans l'interface de ligne de commande qui empêchait le lancement de sessions Windows.

(29)

2021.2-11042— 01 septembre 2021

Numéros de

version Nouvelles fonctions Modifications et correctifs de bogues

• agent

• Agent : 413

• NICE DCV Session Manager prend désormais en charge l'interface de ligne de commande (CLI). Vous pouvez créer et gérer des sessions NICE DCV dans l'interface de ligne de commande, au lieu d'appeler des API.

• NICE DCV Session Manager a introduit la persistance des données Broker. Pour une meilleure disponibilité, les courtiers peuvent conserver les informations sur l'état du serveur dans un magasin de données externe et restaurer les données au démarrage.

• Lors de l'enregistrement d'un serveur d'autorisation externe, vous pouvez désormais spécifier l'algorithme que le serveur d'autorisation utilise pour signer des jetons Web au format JSON.

Avec cette modification, vous pouvez utiliser Azure AD en tant que serveur d'autorisation externe.

2021.1-10557 — 31 mai 2021

Numéros de

version Nouvelles fonctions Modifications et correctifs de bogues

• agent

• Agent : 365

• NICE DCV Session Manager a ajouté la prise en charge des paramètres d'entrée transmis au fichier d'exécution automatique sous Linux.

• Les propriétés du serveur peuvent désormais être transmises en tant que conditions requises àCreateSessionsAPI.

• Nous avons résolu un problème avec le fichier autorun sous Windows.

2021.0-10242— 12 avril 2021

• agent : 183

• Agent : 318

• NICE DCV Session Manager a introduit les nouvelles API suivantes :

• OpenServers

• CloseServers

• DescribeServers

• GetSessionScreenshots

• Elle a également introduit les nouveaux paramètres de configuration suivants :

• Paramètres de l'agent :session-screenshot-max-width,session- screenshot-max-height,session-screenshot-format,create- sessions-queue-max-size, etcreate-sessions-queue-max- time-seconds.

(30)

2020.2-9662 — 4 décembre 2020

• Paramètres de

l'agent :agent.autorun_folder,max_virtual_sessions, etmax_concurrent_sessions_per_user.

2020.2-9662 — 4 décembre 2020

• agent 114

• Agent 211

• Nous avons résolu un problème avec les certificats TLS générés automatiquement qui empêchait le Broker de démarrer.

2020.2-9508 — 11 novembre 2020

• agent 78

• Agent 183

• La version initiale de NICE DCV Session Manager.

Historique de document

Le tableau suivant décrit la documentation de cette version de NICE DCV Session Manager.

Modification Description Date

NICE DCV Version 2022.1

NICE DCV Session Manager a été mis à jour pour NICE DCV 2022.1. Pour plus d'informations, consultez 2022.1-13067 — 29 juin 2022 (p. 23).

29 juin 2022

NICE DCV Session Manager a été mis à jour pour NICE DCV 2022.0. Pour plus d'informations, consultez 2022.0-1952— 23 février 2022 (p. 24).

23 février 2022

NICE DCV Session Manager a été mis à jour pour NICE DCV 2021.3. Pour plus d'informations, consultez 2021.3-11591 — 20 décembre 2021 (p. 24).

20 décembre 2021

NICE DCV Session Manager a été mis à jour pour NICE DCV 2021.2. Pour plus d'informations, consultez 2021.2-11042—

01 septembre 2021 (p. 25).

1 septembre 2021

NICE DCV Session Manager a été mis à jour pour NICE DCV 2021.1. Pour plus d'informations, consultez 2021.1-10557 — 31 mai 2021 (p. 25).

31 mai 2021

(31)

Historique de document

Modification Description Date

NICE DCV Session Manager a été mis à jour pour être compatible avec la version 2021.0 de NICE DCV. Pour plus d'informations, consultez 2021.0-10242—

12 avril 2021 (p. 25).

12 avril 2021

Première version de NICE DCV

Première publication de ce contenu. 11 novembre 2020

(32)

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.

NICE DCV Session Manager. Guide CLI

NICE DCV Session Manager

Guide CLI

NICE DCV Session Manager: Guide CLI

Table of Contents

Qu'est-ce que l'interface de ligne de commande NICE DCV Session Manager ?

Installation de l'interface de ligne de commande NICE DCV Session Manager

Conditions préalables à l'installation de NICE DCV Session Manager CLI

Installation de NICE DCV Session Manager CLI

Configuration de l'interface de ligne de commande NICE DCV Session Manager

Concepts de base de la configuration

Hiérarchie des paramètres de configuration

Options de ligne de commande

Variables d’environnement

Définir les variables d'environnement sur Linux ou macOS

Définir les variables d'environnement sous Windows

Définir les variables d'environnement avec PowerShell

Variables d'environnement prises en charge NICE DCV Session Manager

Fichier de configuration

Utilisation de l'interface de ligne

de commande NICE DCV Session Manager

Obtenir de l'aide

Structure de commande

Syntaxe

Types de paramètres

Chaîne

Chaîne

Booléen

Entier

Codes de retour

Référence CLI NICE DCV Session Manager

serveurs fermés

Résumé

Options

Example (Exemple)

create-session

Résumé

Options

Example (Exemple)

supprimer une session

Résumé

Options

Example (Exemple)

Describe-Serveurs

Résumé

Options

Example (Exemple)

Describe-sessions

Résumé

Options

Example (Exemple)

get-session-connection-données-

Résumé

Options

Example (Exemple)

captures d'écran de get-session

Résumé

Options

Example (Exemple)

serveurs ouverts

Résumé

Options

Example (Exemple)

autorisations de session de mise à jour

Résumé

Options

Example (Exemple)

Notes de mise à jour et historique des documents pour NICE DCV

Notes de mise à jour de NICE DCV Session Manager

2022.1-13067 — 29 juin 2022

2022.0-1952— 23 février 2022

2021.3-11591 — 20 décembre 2021

2021.2-1445— 18 novembre 2021

2021.2-11190 — 11 octobre 2021

2021.2-11042— 01 septembre 2021

2021.1-10557 — 31 mai 2021

2021.0-10242— 12 avril 2021

2020.2-9662 — 4 décembre 2020

2020.2-9508 — 11 novembre 2020

Historique de document