NICE DCV Session Manager - Guida CLI
←
→
Trascrizione del contenuto della pagina
Se il tuo browser non visualizza correttamente la pagina, ti preghiamo di leggere il contenuto della pagina quaggiù
NICE DCV Session Manager
Guida CLINICE DCV Session Manager Guida CLI NICE DCV Session Manager: Guida CLI Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved. I marchi e il trade dress di Amazon non possono essere utilizzati in relazione ad alcun prodotto o servizio che non sia di Amazon, in alcun modo che possa causare confusione tra i clienti, né in alcun modo che possa denigrare o screditare Amazon. Tutti gli altri marchi non di proprietà di Amazon sono di proprietà delle rispettive aziende, che possono o meno essere associate, collegate o sponsorizzate da Amazon.
NICE DCV Session Manager Guida CLI
Table of Contents
Cos'è la CLI di Session Manager? ........................................................................................................ 1
Installazione ....................................................................................................................................... 2
Prerequisiti per l'installazione della CLI di NICE DCV Session Manager ............................................... 2
Installazione della CLI di NICE DCV Session Manager ..................................................................... 2
Configurazione ................................................................................................................................... 4
Informazioni di base sulle credenziali e sulla configurazione .............................................................. 4
Gerarchia delle impostazioni di configurazione ................................................................................ 4
Opzioni della riga di comando ...................................................................................................... 4
Variabili di ambiente ................................................................................................................... 5
Impostazione delle variabili di ambiente su Linux o macOS ....................................................... 6
Impostazione delle variabili di ambiente in Windows ................................................................. 6
Impostazione delle variabili di ambiente usando PowerShell ...................................................... 6
Variabili d'ambiente supportate da NICE DCV Session Manager ................................................ 6
File di configurazione .................................................................................................................. 7
Lavorare con la CLI ............................................................................................................................ 8
Utilizzo della guida ...................................................................................................................... 8
Struttura di comando ................................................................................................................... 9
Sintassi ............................................................................................................................. 9
Tipi di parametro ...................................................................................................................... 10
Stringa ............................................................................................................................ 10
Stringa ............................................................................................................................ 10
Booleano ......................................................................................................................... 10
Integer ............................................................................................................................. 10
Codici restituiti .......................................................................................................................... 10
Riferimento ai comandi CLI ................................................................................................................ 12
close-server ............................................................................................................................. 12
Riepilogo ......................................................................................................................... 12
Opzioni ............................................................................................................................ 12
Esempio .......................................................................................................................... 13
create-session .......................................................................................................................... 13
Riepilogo ......................................................................................................................... 12
Opzioni ............................................................................................................................ 12
Esempio .......................................................................................................................... 13
delete-session .......................................................................................................................... 15
Riepilogo ......................................................................................................................... 12
Opzioni ............................................................................................................................ 12
Esempio .......................................................................................................................... 13
describe-server ......................................................................................................................... 16
Riepilogo ......................................................................................................................... 12
Opzioni ............................................................................................................................ 12
Esempio .......................................................................................................................... 13
describe-sessioni ...................................................................................................................... 17
Riepilogo ......................................................................................................................... 12
Opzioni ............................................................................................................................ 12
Esempio .......................................................................................................................... 13
get-session-connection-data ........................................................................................................ 18
Riepilogo ......................................................................................................................... 12
Opzioni ............................................................................................................................ 12
Esempio .......................................................................................................................... 13
get-session-screenshot .............................................................................................................. 18
Riepilogo ......................................................................................................................... 12
Opzioni ............................................................................................................................ 12
Esempio .......................................................................................................................... 13
open server .............................................................................................................................. 19
iiiNICE DCV Session Manager Guida CLI
Riepilogo ......................................................................................................................... 12
Opzioni ............................................................................................................................ 12
Esempio .......................................................................................................................... 13
permessi update-session-session- ............................................................................................... 20
Riepilogo ......................................................................................................................... 12
Opzioni ............................................................................................................................ 12
Esempio .......................................................................................................................... 13
Note di rilascio e cronologia dei documenti ........................................................................................... 22
Note di rilascio ......................................................................................................................... 22
2021.3-11591 — 20 dicembre 2021 ..................................................................................... 22
2021.2-11445 — 18 novembre 2021 .................................................................................... 22
2021.2-11190 — 11 ottobre 2021 ........................................................................................ 23
2021.2-11042 — 01 settembre 2021 .................................................................................... 23
2021.1-10557 — 31 maggio 2021 ....................................................................................... 23
2021.0-10242 — 12 aprile 2021 .......................................................................................... 23
2020.2-9662 — 4 dicembre 2020 ........................................................................................ 24
...................................................................................................................................... 24
Cronologia dei documenti ........................................................................................................... 24
.................................................................................................................................................... xxvi
ivNICE DCV Session Manager Guida CLI
Cos'è l'interfaccia della riga di
comando di NICE DCV Session
Manager?
NICE DCV Session Manager è un insieme di pacchetti software installabili (un agente e un broker) e
un'interfaccia di programmazione delle applicazioni (API) che semplifica la creazione di applicazioni front-
end che creano e gestiscono in modo programmatico il ciclo di vita di NICE DCV sessioni su una flotta di
server DCV NICE.
È possibile utilizzare NICE DCV Session Manager Command Line Interface (CLI) per interagire con un
broker DCV Session Manager utilizzando i comandi nella shell a riga di comando.
• Shell Linux - Utilizza programmi shell comuni comebash,zsh, etcshper eseguire i comandi in Linux o
macOS.
• Riga di comando di Windows: esegui i comandi al prompt dei comandi di Windows o PowerShell.
È possibile utilizzare NICE DCV Session Manager CLI per creare e gestire il ciclo di vita delle sessioni
NICE DCV. Questi sono gestiti da un NICE DCV Session Manager.
1NICE DCV Session Manager Guida CLI
Prerequisiti per l'installazione della
CLI di NICE DCV Session Manager
Installazione dell'interfaccia a riga
di comando di NICE DCV Session
Manager
Questa sezione descrive come installare l'interfaccia a riga di comando (CLI) di NICE DCV Session
Manager su Linux, macOS e Windows.
Prerequisiti per l'installazione della CLI di NICE
DCV Session Manager
Questa sezione include i prerequisiti per l'installazione a riga di comando (CLI) di NICE DCV Session
Manager su Linux, macOS e Windows.
Linux and macOS
• Python versione 3.6 o successiva.
• Possibilità di estrarre o decomprimere un file scaricato e compresso. Se il sistema operativo non
dispone del comando unzip integrato, utilizzare un comando equivalente.
Windows
• Python versione 3.6 o successiva.
• Python deve essere impostato correttamente nella variabile di ambiente PATH per eseguire NICE
DCV Session Manager CLI utilizzando lo script di avvio.
Installazione della CLI di NICE DCV Session
Manager
Questa sezione descrive il processo di installazione dell'interfaccia a riga di comando (CLI) di NICE DCV
Session Manager su Linux, macOS e Windows.
Linux and macOS
Per installare NICE DCV Session Manager CLI su Linux e macOS NICE
1. Scarica il pacchetto compresso dalSito web NICE DCV.
2. Decomprimere il pacchetto scaricato. Se la distribuzione Linux non dispone di un comando di
decompressione integrato, utilizzare un comando equivalente per la decompressione. Il comando
di esempio seguente consente di decomprime il pacchetto e crea una directory denominatanice-
dcv-session-manager-cli-1.0.0-37sotto la directory attuale.
$ unzip nice-dcv-session-manager-cli-1.0.0-37.zip
2NICE DCV Session Manager Guida CLI
Installazione della CLI di NICE DCV Session Manager
3. Per convalidare il contenuto del file zip, eseguire il seguente comando all'interno della cartella
estratta nel passaggio precedente:
./dcvsm --version
Windows NICE DCV server
Per installare NICE DCV Session Manager CLI su Windows
1. Scarica il pacchetto compresso dalSito web NICE DCV.
2. Decomprimere il pacchetto scaricato.
3. Per convalidare il contenuto del file zip, esegui il comando seguente:
C:\> dcvsm --version
3NICE DCV Session Manager Guida CLI
Informazioni di base sulle credenziali e sulla configurazione
Configurazione dell'interfaccia
della riga di comando di NICE DCV
Session Manager
In questa sezione viene illustrato come configurare le impostazioni utilizzate dall'interfaccia a riga di
comando (CLI) di NICE DCV Session Manager per interagire con il broker.
Informazioni di base sulle credenziali e sulla
configurazione
Per lavorare con la CLI, è necessario registrare un client di Session Manager con il broker e generare
credenziali client. Segui il processo descritto nelDocumentazione di riferimento del broker.
La CLI di NICE DCV Session Manager dispone di una serie di parametri di configurazione che l'utente può
specificare. I parametri seguenti sono obbligatori:
• URL del broker
• ID client
• Password client
I parametri di configurazione possono essere definiti nei seguenti tre modi:
• Riga di comando
• Variabili di ambiente
• File di configurazione
Gerarchia delle impostazioni di configurazione
La CLI di DCV SM utilizza le credenziali e le impostazioni di configurazione che si trovano in più
posizioni. Tali includono le variabili di ambiente utente, il file di configurazione DCV SM locale o dichiarati
esplicitamente sulla riga di comando come un parametro. Alcune posizioni hanno la precedenza su altre.
L'interfaccia a riga di comando e le impostazioni di configurazione di NICE DCV Session Manager hanno la
precedenza nell'ordine seguente:
• Opzioni della riga di comando: sovrascrive le impostazioni in qualsiasi altra posizione.
• Variabili di ambiente: alcuni valori possono essere archiviati nelle variabili di ambiente del sistema.
• File di configurazione della CLI: specificare le opzioni nel file di configurazione.
Opzioni della riga di comando
Nell'interfaccia a riga di comando DCV SM è possibile utilizzare le seguenti opzioni della riga di comando
per ignorare le impostazioni di configurazione predefinite, qualsiasi impostazione del profilo corrispondente
o l'impostazione della variabile di ambiente per quel singolo comando. Non puoi utilizzare le opzioni della
4NICE DCV Session Manager Guida CLI
Variabili di ambiente
riga di comando per specificare direttamente le credenziali. Ogni opzione che accetta un argomento
richiede uno spazio o un simbolo di uguale ("=") che separa l'argomento dal nome dell'opzione.
--conf
Specifica il percorso del file di configurazione. Se non è definito, la CLI utilizzerà il file di configurazione
predefinito. Per ulteriori informazioni sul file di configurazione, consultaFile di configurazione (p. 7).
Type: Stringa
--broker-url
Specifica l'URL a cui inviare la richiesta.
Type: Stringa
--debug
Un interruttore booleano che abilita la registrazione di debug. Per impostazione predefinita, la CLI
di DCV SM fornisce informazioni pulite su eventuali successi o guasti relativi ai risultati dei comandi
nell'output del comando. L'opzione —debug fornisce i registri completi. Ciò include ulteriori informazioni
di diagnostica stderr sul funzionamento del comando che possono essere utili quando si risolvono i
motivi per cui un comando fornisce risultati imprevisti.
Type: Booleano
Type: Stringa
--no-verify-ssl
Con questa opzione, è possibile disabilitare la verifica del certificato SSL, ma è scoraggiata per motivi
di sicurezza. Per impostazione predefinita, la CLI di DCV SM utilizza SSL quando si comunica con i
servizi di broker.
Type: Booleano
--ca-bundle
Specifica il percorso personalizzato a un pacchetto di certificati personalizzati (un file con
un.pemestensione) della CA da utilizzare quando vengono stabilite le connessioni SSL/TLS
--auth-server-url
Specifica il nome host del server di autenticazione utilizzato per richiedere il token di accesso OAuth
2.0. Se non è specificato, viene utilizzato l'URL del broker.
Type: Stringa
--version
Visualizza la versione corrente del programma CLI DCV SM in esecuzione.
Type: Stringa
--help
Visualizza l'elenco delle opzioni e dei comandi della CLI DCV SM.
Type: Stringa
Variabili di ambiente
Le variabili di ambiente forniscono un altro modo per specificare alcune opzioni e credenziali di
configurazione.
L'esempio seguente descrive come configurare le variabili di ambiente per l'utente di default.
5NICE DCV Session Manager Guida CLI
Impostazione delle variabili di ambiente su Linux o macOS
Impostazione delle variabili di ambiente su Linux o
macOS
Eseguire i seguenti comandi per impostare le variabili di ambiente su Linux o macOS:
$ export DCV_SM_AUTH_SERVER_URL=https://example.com
$ export DCV_SM_CLIENT_ID=ExampleClientID
L'impostazione della variabile di ambiente modifica il valore utilizzato fino al termine della sessione della
shell o finché non imposti la variabile su un valore diverso. Puoi rendere le variabili persistenti nelle sessioni
future impostandole nello script di avvio della shell.
Impostazione delle variabili di ambiente in Windows
Eseguire i seguenti comandi per impostare le variabili di ambiente nel prompt dei comandi di Windows:
$ setx DCV_SM_AUTH_SERVER_URL https://example.com
$ setx DCV_SM_CLIENT_ID ExampleClientID
Utilizzo disetPer impostare una variabile di ambiente, il valore utilizzato viene modificato fino al termine
della sessione del prompt dei comandi corrente. In alternativa, finché non imposti la variabile su un valore
diverso. Utilizzo disetxPer impostare una variabile di ambiente, il valore utilizzato viene modificato nella
sessione del prompt dei comandi corrente e in tutte le sessioni del prompt dei comandi. Queste sessioni
create dopo aver eseguito il comando. Ciò non ha alcun impatto su altre shell di comando già in esecuzione
quando esegui il comando.
Impostazione delle variabili di ambiente usando
PowerShell
Eseguire i seguenti comandi per impostare le variabili di ambiente utilizzando PowerShell:
$ $Env:DCV_SM_AUTH_SERVER_URL="https://example.com"
$ $Env:DCV_SM_CLIENT_ID="ExampleClientID"
Se imposti una variabile di ambiente al prompt di PowerShell come mostrato negli esempi precedenti, il
valore viene salvato solo per la durata della sessione corrente. Per rendere persistente l'impostazione della
variabile di ambiente in tutte le sessioni di PowerShell e del prompt dei comandi, archiviala utilizzando
l'applicazione *System* in *Pannello di controllo*. In alternativa, puoi impostare la variabile per tutte
le sessioni future di PowerShell aggiungendola al tuo profilo PowerShell. Per ulteriori informazioni
sull'archiviazione delle variabili di ambiente o sulla loro persistenza durante la sessione, consultala
documentazione di PowerShell.
Variabili d'ambiente supportate da NICE DCV Session
Manager
NICE DCV Session Manager supporta le seguenti variabili di ambiente:
6NICE DCV Session Manager Guida CLI
File di configurazione
• DCV_SM_AUTH_SERVER_URL
Specifica il nome host del server di autenticazione utilizzato per richiedere il token di accesso OAuth 2.0.
Se definita, questa variabile di ambiente sostituisce il valore del file di configurazione.
• DCV_SM_CLIENT_ID
ID client univoco utilizzato dal client di Session Manager per recuperare un token di accesso OAuth 2.0.
• DCV_SM_CLIENT_PASSWORD
La password utilizzata dal client di Session Manager per recuperare un token di accesso OAuth 2.0.
• DCV_SM_OAUTH2_TOKEN
Il token di accesso utilizzato per effettuare una richiesta API.
File di configurazione
Il file di configurazione è il terzo modo per specificare alcune opzioni di configurazione e credenziali. Per
impostazione predefinita, viene fornito nel file zip all'indirizzo/conf/dcvsmcli.conf.
L'utente può specificare il percorso del file di configurazione nella riga di comando. Se l'utente non lo
specifica esplicitamente il file di configurazione, verrà letto per impostazione predefinita da una cartella
specifica a seconda dei sistemi operativi:
• Sistemi basati su Unix:$XDG_CONFIG_HOME/dcvsmcli.conf
• Sistemi Windows:%UserProfile%\dcvsmcli.conf
Se il file di configurazione non viene trovato, la CLI legge il file dal percorso/conf/
dcvsmcli.confFornito con il file zip. La struttura del file di configurazione è la seguente:
[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
[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
7NICE DCV Session Manager Guida CLI
Utilizzo della guida
Utilizzo della CLI di NICE DCV
Session Manager
Questa sezione presenta molte delle caratteristiche e delle opzioni comuni disponibili nell'interfaccia a riga
di comando di DCV SM (CLI) di DCV SM (CLI) di DCV SM.
Utilizzo della guida
Puoi richiedere assistenza su qualsiasi comando quando utilizzi l'interfaccia a riga di comando di DCV SM
(CLI di DCV SM). Per farlo, basta digitare --help al termine del nome di un comando.
Ad esempio, il comando seguente visualizza informazioni della Guida relative alle opzioni generali dell'CLI
di DCV SM e ai comandi di primo livello disponibili.
dcvsm --help
Il seguente esempio mostra l'output della guida a 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.
Tutti i comandi accettano —help per le informazioni di aiuto contestuale. Ad esempio, il comando seguente
visualizza informazioni della Guida relative al comando create-session.
8NICE DCV Session Manager Guida CLI
Struttura di comando
dcvsm create-session --help
Il seguente esempio mostra l'output dell'create-session --helpcomando.
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 [1NICE DCV Session Manager Guida CLI
Tipi di parametro
Gli argomenti possono assumere diversi tipi di valori di input. Questi includono numeri, stringhe, booleano.
Quanto supportato dipende dal comando specificato.
Tipi di parametro
Questa sezione descrive alcuni tipi di parametri comuni e il formato tipico richiesto. In caso di problemi con
la formattazione di un'opzione o un argomento per un comando specifico, consulta la guida inserendo —
help dopo il nome del comando. La guida per ciascun comando descrive la funzione e le opzioni accettate.
Stringa
I parametri stringa possono contenerelettere, numeri,spazio vuoto. Le stringhe che contengono spazi
vuoti devono essere racchiuse tra virgolette. Le stringhe possono essere circondate da virgolette singole,
virgolette doppie o senza di esse. Si consiglia di non utilizzare simboli perché possono causare risultati
imprevisti.
Stringa
Una o più stringhe separate da virgole e circondate da virgolette. Il seguente esempio mostra un elenco
di--session-ids.
dcvsm describe-sessions --session-ids "session123,session456"
Booleano
Binary Flag che attiva o disattiva un'opzione. Ad esempio, —debug describe-session ha un'opzione
booleana —debug che, quando specificata, chiama l'API che abilita il debug.
dcvsm --debug describe-sessions
Se non si specifica esplicitamente un'opzione booleana, è impostata su FALSE per impostazione
predefinita.
Integer
Numero intero senza firma.
dcvsm describe-sessions --max-results 2
Codici restituiti
Il codice restituito è solitamente ma non sempre un codice nascosto inviato dopo aver eseguito un
comando DCV SM Command Line Interface (DCV SM CLI), che descrive lo stato del comando. È possibile
utilizzare il comando echo per visualizzare il codice inviato dall'ultimo comando CLI DCV SM e utilizzare
questi codici per determinare se un comando ha avuto esito positivo o se è fallito e perché un comando
potrebbe presentare un errore. Oltre ai codici restituiti, è possibile visualizzare ulteriori dettagli su un
errore eseguendo i comandi con lo switch —debug. Questo switch produce un report dettagliato delle fasi
utilizzate da DCV SM CLI per elaborare il comando e su quale sia il risultato di ogni fase. Per determinare il
10NICE DCV Session Manager Guida CLI
Codici restituiti
codice restituito da un comando CLI di DCV SM, esegui uno di questi comandi subito dopo aver eseguito il
comando CLI.
• Linux e macOS
$ echo $?
0
• Windows PowerShell
$ echo $lastexitcode
0
• Prompt dei comandi di Windows
$ echo %errorlevel%
0
Al termine dell'esecuzione di un comando CLI vengono visualizzati i seguenti codici restituiti:
• 0Il comando ha avuto esito positivo. Non sono stati generati errori né dall'CLI né dal servizio a cui è stata
eseguita la richiesta.
• 1Il file di configurazione analizzato nella CLI non è stato trovato o potrebbe essere danneggiato.
• 2Non è stato analizzato il comando inserito nella riga di comando. Gli errori di analisi possono essere
causati, a titolo esemplificativo, dall'assenza di sottocomandi o argomenti richiesti oppure dall'utilizzo di
comandi o argomenti sconosciuti. Si noti che questo significato di codice restituito è applicabile a tutti i
comandi CLI.
• 130Il processo ha ricevuto SIGINT (Ctrl-C).
• 252La sintassi dei comandi non era valida, è stato fornito un parametro sconosciuto o un valore di
parametro non era corretto e impediva l'esecuzione del comando.
• 253L'ambiente o la configurazione del sistema non erano validi. Mentre il comando fornito potrebbe
essere sintatticamente valido, la configurazione o le credenziali mancanti hanno impedito l'esecuzione
del comando.
• 254Il comando è stato analizzato correttamente e è stata inviata una richiesta al servizio specificato, ma
il servizio ha restituito un errore. In genere ciò indica un utilizzo errato dell'API o altri problemi specifici
del servizio.
• 255Errore generale catch-all. Il comando potrebbe essere stato analizzato correttamente ma si è
verificato un errore di runtime non specificato durante l'esecuzione del comando. Poiché si tratta di un
codice di errore generale, un errore potrebbe passare da 255 a un codice restituito più specifico. Non è
necessario fare affidamento su un codice restituito di 255 per determinare un caso di errore specifico.
11NICE DCV Session Manager Guida CLI
close-server
Riferimento CLI di NICE DCV
Session Manager
Questa sezione spiega come utilizzare i comandi dell'interfaccia a riga di comando (CLI) di NICE DCV
Session Manager.
Utilizzare i seguenti comandi per interagire con il server NICE DCV.
• open server (p. 19)
• describe-server (p. 16)
• close-server (p. 12)
Utilizzare i seguenti comandi per interagire con la sessione NICE DCV.
• create-session (p. 13)
• describe-sessioni (p. 17)
• get-session-connection-data (p. 18)
• get-session-screenshot (p. 18)
• permessi update-session-session- (p. 20)
• delete-session (p. 15)
close-server
Chiude uno o più server DCV NICE. Quando chiudi un server NICE DCV, lo rendi non disponibile per il
posizionamento della sessione NICE DCV. Non è possibile creare sessioni NICE DCV su server chiusi. La
chiusura di un server garantisce che non siano in esecuzione sessioni e che gli utenti non possano creare
nuove sessioni su di esso.
Argomenti
• Riepilogo (p. 12)
• Opzioni (p. 12)
• Esempio (p. 13)
Riepilogo
close-servers
--server-ids
[--force]
Opzioni
--server-ids
L'elenco separato da virgole di ID dei server NICE DCV da chiudere.
12NICE DCV Session Manager Guida CLI
Esempio
Type: Stringa
: Sì
--force
Operazione che costringe la chiusura del server. Per impostazione predefinita, questa opzione è
disabilitata.
Type: Booleano
: No
Esempio
dcvsm close-server --server-ids "server123,server456"
create-session
Crea una nuova sessione NICE DCV con i dettagli specificati.
Argomenti
• Riepilogo (p. 12)
• Opzioni (p. 12)
• Esempio (p. 13)
Riepilogo
create-session
--name
--owner
--type
[--init-file-path ]
[--autorun-file ]
[--autorun-file-arguments ]
[--max-concurrents-clients ]
[--dcv-gl-enabled]
[--permissions-file ]
[--requirements ]
[--storage-root ]
Opzioni
--name
Il nome della sessione.
Type: Stringa
: Sì
--owner
Il nome del proprietario della sessione.
13NICE DCV Session Manager Guida CLI
Opzioni
Type: Stringa
: Sì
--type
Il tipo di sessione. O questo èConsoleoVirtual.
Type: Choice
: Sì
--init_file_path
Il percorso dello script personalizzato sul server NICE DCV da eseguire per l'inizializzazione della
sessione al momento della creazione. Il percorso del file è relativo rispetto alinitdirectory specificata
per ilagent.init_folderParametro di configurazione dell'agente.
Type: Stringa
: No
--autorun_file
Il percorso di un file sul server host da eseguire all'interno della sessione. Il percorso del file è relativo
rispetto alautorundirectory specificata per ilagent.autorun_folderParametro di configurazione
dell'agente.
Type: Stringa
: No
--autorun_file_arguments
Gli argomenti della riga di comando passati aAutorunFilequando viene eseguito all'interno della
sessione.
Type: Stringa
: No
--max_concurrent_clients
Numero massimo di client DCV NICE simultanei. Se previsto, questo deve essere costituito da un
numero di valori compreso tra 1 e 100.
Type: Integer
: No
--dcv_gl_enabled
Operazione per configurare la sessione virtuale per l'utilizzo di OpenGL basato su hardware. Questa
opzione è disabilitata per impostazione predefinita.
Type: Booleano
: No
--permissions_file
Il percorso del file di autorizzazioni.
Type: Stringa
: No
14NICE DCV Session Manager Guida CLI
Esempio
--requirements
I requisiti che il server deve soddisfare per posizionare la sessione.
Type: Stringa
: No
--storage_root
Il percorso della cartella usato per lo storage della sessione.
Type: Stringa
: No
Esempio
dcvsm create-session --name session123 --owner sessionOwner
--type Console --requirements "server:Host.Os.Family = 'windows'"
delete-session
Elimina la sessione NICE DCV specificata e la rimuove dalla cache del broker.
Argomenti
• Riepilogo (p. 12)
• Opzioni (p. 12)
• Esempio (p. 13)
Riepilogo
delete-session
--session-id
--owner
[--force]
Opzioni
--session-id
L'ID della sessione da eliminare.
Type: Stringa
: Sì
--owner
Il proprietario della sessione da eliminare.
Type: Stringa
: Sì
15NICE DCV Session Manager Guida CLI
Esempio
--force
Operazione per garantire che una sessione venga rimossa dalla cache del broker. Per impostazione
predefinita, questa opzione è disabilitata.
Type: Booleano
: No
Esempio
dcvsm delete-session --session-id session123 --owner sessionOwner
--force
describe-server
Descrivere il server NICE DCV specificato.
Argomenti
• Riepilogo (p. 12)
• Opzioni (p. 12)
• Esempio (p. 13)
Riepilogo
describe-servers
[--server-ids ]
[--next-token ]
[--max-results ]
Opzioni
--server-ids
L'elenco separato da virgole di ID dei server NICE DCV da descrivere.
Type: Stringa
: No
--next-token
Token usato per recuperare la pagina successiva di risultati.
Type: Stringa
: No
--max-results
Numero massimo di risultati da restituire dalla richiesta in output impaginato. Se fornito, questo deve
essere un numero compreso tra 1 e 1000.
Type: Integer
16NICE DCV Session Manager Guida CLI
Esempio
: No
Esempio
dcvsm describe-servers --server-ids "server123,server456"
describe-sessioni
Descrive uno o più server DCV NICE.
Argomenti
• Riepilogo (p. 12)
• Opzioni (p. 12)
• Esempio (p. 13)
Riepilogo
describe-sessions
[--session-ids ]
[--next-token ]
[--owner ]
[--max-results ]
Opzioni
--session-ids
L'elenco separato da virgole di ID delle sessioni NICE DCV da descrivere.
Type: Stringa
: No
--next-token
Token usato per recuperare la pagina successiva di risultati.
Type: Stringa
: No
--owner
Il proprietario della sessione da descrivere.
Type: Stringa
: No
--max-results
Numero di risultati da mostrare. Se previsto, deve essere costituito da un numero di
Type: Integer
17NICE DCV Session Manager Guida CLI
Esempio
: No
Esempio
dcvsm describe-sessions --session-ids "session123,session456"
get-session-connection-data
Ottiene informazioni di connessione per la connessione di un utente specifico a una sessione NICE DCV
specifica.
Argomenti
• Riepilogo (p. 12)
• Opzioni (p. 12)
• Esempio (p. 13)
Riepilogo
get-session-connection-data
--session-id
--user
Opzioni
--session-id
L'ID delle sessioni NICE DCV da cui ottenere i dati di connessione.
Type: Stringa
: Sì
--user
Il nome dell'utente per cui visualizzare le informazioni di connessione.
Type: Booleano
: Sì
Esempio
./dcvsm get-session-connection-data --session-id session123
--user dcvuser
get-session-screenshot
Ottiene screenshot di una o più sessioni NICE DCV.
18NICE DCV Session Manager Guida CLI
Riepilogo
Argomenti
• Riepilogo (p. 12)
• Opzioni (p. 12)
• Esempio (p. 13)
Riepilogo
get-session-screenshots
--session-ids
Opzioni
--session-ids
L'elenco separato da virgole di ID delle sessioni NICE DCV da cui ottenere gli screenshot.
Type: Stringa
: Sì
Esempio
./dcvsm get-session-screenshots --session-id session123
open server
Apre uno o più server DCV NICE. Prima di poter creare sessioni su un server NICE DCV, è necessario
modificare lo stato del server per l'apertura. Dopo l'apertura del server DCV NICE, puoi creare sessioni
DCV NICE sul server.
Argomenti
• Riepilogo (p. 12)
• Opzioni (p. 12)
• Esempio (p. 13)
Riepilogo
open-servers
--server-ids
Opzioni
--server-ids
L'elenco separato da virgole di ID dei server NICE DCV da aprire.
Type: Stringa
19NICE DCV Session Manager Guida CLI
Esempio
: Sì
Esempio
./dcvsm open-servers --server-ids "server123,server456"
permessi update-session-session-
Aggiorna le autorizzazioni utente per una sessione NICE DCV specifica.
Argomenti
• Riepilogo (p. 12)
• Opzioni (p. 12)
• Esempio (p. 13)
Riepilogo
update-session-permissions
--session-id
--owner
--permission-file
Opzioni
--session-id
L'ID della sessione per cui modificare le autorizzazioni.
Type: Stringa
: Sì
--owner
Il proprietario della sessione per cui modificare le autorizzazioni.
Type: Stringa
: Sì
--permission-file
Il percorso del file di autorizzazioni.
Type: Stringa
: Sì
Esempio
./dcvsm update-session-permissions --session-id session123
20NICE DCV Session Manager Guida CLI
Esempio
--owner Owner --permission-file path_to_file
21NICE DCV Session Manager Guida CLI
Note di rilascio
Note di rilascio e cronologia dei
documenti per NICE DCV Session
Manager
Questa pagina fornisce le note di rilascio e cronologia dei documenti per NICE DCV Session Manager.
Argomenti
• Note sulla versione di NICE DCV Session Manager (p. 22)
• Cronologia dei documenti (p. 24)
Note sulla versione di NICE DCV Session Manager
Questa sezione fornisce una panoramica dei principali aggiornamenti, release di funzionalità e correzioni di
bug per NICE DCV Session Manager. Tutti gli aggiornamenti sono organizzati in base alla data di rilascio.
Aggiorniamo la documentazione frequentemente per dare forma al feedback inviatoci.
Argomenti
• 2021.3-11591 — 20 dicembre 2021 (p. 22)
• 2021.2-11445 — 18 novembre 2021 (p. 22)
• 2021.2-11190 — 11 ottobre 2021 (p. 23)
• 2021.2-11042 — 01 settembre 2021 (p. 23)
• 2021.1-10557 — 31 maggio 2021 (p. 23)
• 2021.0-10242 — 12 aprile 2021 (p. 23)
• 2020.2-9662 — 4 dicembre 2020 (p. 24)
• 2020.2-9508 — 11 novembre 2020 (p. 24)
2021.3-11591 — 20 dicembre 2021
Numeri build Nuove caratteristiche di
• Broker: 307 • Aggiunto il supporto per l'integrazione con NICE
• Agente: 453 DCV Connection Gateway.
• CLIP: 92 • Aggiunto il supporto Broker per Ubuntu 18.04 e
Ubuntu 20.04.
2021.2-11445 — 18 novembre 2021
Numeri build Modifiche e correzioni di bug
• Broker: 288 • È stato risolto un problema con la convalida dei
• Agente: 413 nomi di accesso che includevano un dominio
Windows.
• CLIP: 54
22NICE DCV Session Manager Guida CLI
2021.2-11190 — 11 ottobre 2021
2021.2-11190 — 11 ottobre 2021
Numeri build Modifiche e correzioni di bug
• Broker: 254 • È stato risolto un problema nell'interfaccia della
• Agente: 413 riga di comando che impediva l'avvio di sessioni
di Windows.
• CLIP: 54
2021.2-11042 — 01 settembre 2021
Numeri build Nuove caratteristiche di Modifiche e correzioni di bug
• Broker: 254 • NICE DCV Session Manager • Quando si registra un server
• Agente: 413 ora offre il supporto di autorizzazione esterno,
dell'interfaccia a riga di è ora possibile specificare
• CLIP: 37
comando (CLI). È possibile l'algoritmo utilizzato dal server
creare e gestire sessioni di autorizzazione per firmare
NICE DCV nella CLI, invece di token Web formattati JSON.
chiamare le API. Con questa modifica, puoi
• NICE DCV Session Manager utilizzare Azure AD come
ha introdotto la persistenza server di autorizzazione
dei dati del broker. Per una esterno.
maggiore disponibilità, i
broker possono persistere le
informazioni sullo stato del
server su un data store esterno
e ripristinare i dati all'avvio.
2021.1-10557 — 31 maggio 2021
Numeri build Nuove caratteristiche di Modifiche e correzioni di bug
• Broker: 214 • NICE DCV Session Manager • Abbiamo risolto un problema
• Agente: 365 ha aggiunto il supporto per i con il file di esecuzione
parametri di input passati al file automatica su Windows.
di esecuzione automatica su
Linux.
• Le proprietà del server ora
possono essere passate come
requisiti per ilCrea sessioniAPI.
2021.0-10242 — 12 aprile 2021
Numeri build Modifiche e correzioni di bug
• Broker: 183 • NICE DCV Session Manager ha introdotto le
• Agente: 318 seguenti nuove API:
• OpenServers
23NICE DCV Session Manager Guida CLI
2020.2-9662 — 4 dicembre 2020
Numeri build Modifiche e correzioni di bug
• Chiudi server
• DescribeServers
• Ottieni screenshot della sessione
• Ha inoltre introdotto i seguenti nuovi parametri di
configurazione:
• Parametri broker:session-screenshot-
max-width,session-screenshot-
max-height,session-screenshot-
format,create-sessions-queue-max-
size, ecreate-sessions-queue-max-
time-seconds.
• Parametri
agente:agent.autorun_folder,max_virtual_sessions
emax_concurrent_sessions_per_user.
2020.2-9662 — 4 dicembre 2020
Numeri build Modifiche e correzioni di bug
• Broker: 114 • Abbiamo risolto un problema con i certificati TLS
• Agente: 211 generati automaticamente che impedivano l'avvio
del broker.
2020.2-9508 — 11 novembre 2020
Numeri build Modifiche e correzioni di bug
• Broker: 78 • La versione iniziale di NICE DCV Session
• Agente: 183 Manager.
Cronologia dei documenti
La tabella che segue descrive la documentazione per questa versione di NICE DCV Session Manager.
Modifica Descrizione Data
NICE DCV versione 2021.3 NICE DCV Session Manager è 20 dicembre 2021
stato aggiornato per NICE DCV
2021.3. Per ulteriori informazioni,
consultare 2021.3-11591 — 20
dicembre 2021 (p. 22).
NICE DCV versione 2021.2 NICE DCV Session Manager è 01 settembre 2021
stato aggiornato per NICE DCV
2021.2. Per ulteriori informazioni,
consultare 2021.2-11042 — 01
settembre 2021 (p. 23).
24NICE DCV Session Manager Guida CLI
Cronologia dei documenti
Modifica Descrizione Data
NICE DCV versione 2021.1 NICE DCV Session Manager è 31 maggio 2021
stato aggiornato per NICE DCV
2021.1. Per ulteriori informazioni,
consultare 2021.1-10557 — 31
maggio 2021 (p. 23).
NICE DCV versione 2021.0 NICE DCV Session Manager 12 Aprile 2021
è stato aggiornato per essere
compatibile con NICE DCV
versione 2021.0. Per ulteriori
informazioni, consultare
2021.0-10242 — 12 aprile
2021 (p. 23).
Versione iniziale di NICE Session La prima pubblicazione di questi 11 novembre 2020
Manager contenuti.
25NICE DCV Session Manager Guida CLI
Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una
traduzione e la versione originale in Inglese, quest'ultima prevarrà.
xxviPuoi anche leggere
