Utilisation en ligne de commande

Introduction

SN VPN Client Exclusive offre en standard un jeu d’options de ligne de commande, utilisables dans des scripts ou dans des fichiers batch. Ces options permettent d’effectuer diverses opérations comme : ouvrir ou fermer un tunnel VPN, importer ou exporter une configuration VPN, etc.

La syntaxe des options de ligne de commande est toujours la même :

"[répertoire_installation]\vpnconf.exe" [/option[:valeur]]

[répertoire_installation] est le répertoire dans lequel se trouve l’exécutable vpnconf.exe (soit le répertoire d’installation du logiciel SN VPN Client Exclusive).
Si la valeur contient des espaces (par exemple un répertoire), elle doit être encadrée par des guillemets.
Toutes les options disponibles sont détaillées ci-dessous.

IMPORTANT
La ligne de commande vpnconf.exe ne peut être lancée lorsque SN VPN Client Exclusive est démarré en mode TrustedConnect. Il convient de quitter le Panneau TrustedConnect pour utiliser les options en ligne de commande, avant de le relancer éventuellement.

La valeur NomTunnel utilisée pour les options /open, /status et /close est composée comme suit (il convient de remplacer le nom de IKEAuth, ChildSA ou TLS par le nom choisi dans la configuration) :

	NomTunnel
IKEv2	IKEAuth-ChildSA
SSL	TLS

IMPORTANT
Le nom de tunnel est sensible à la casse. Si le nom comporte des espaces, il convient de le mettre entre guillemets.

Différence entre import, importonce, add et replace

L’option /import permet d’importer une configuration VPN en démarrant en même temps SN VPN Client Exclusive, s’il n’est pas déjà démarré.

L’option /importonce permet d’importer une configuration VPN sans démarrer SN VPN Client Exclusive.

Lorsque SN VPN Client Exclusive est démarré, ces deux options importent simplement la configuration VPN.

Lorsque la configuration VPN courante (avant importation) du SN VPN Client Exclusive n’est pas vide, ces deux options affichent une pop-up qui demande à l’utilisateur s’il veut « Ajouter ou remplacer », c’est-à-dire ajouter la nouvelle configuration VPN ou remplacer l’ancienne par la nouvelle.

Les options /add et /replace permettent d’éviter cette demande à l’utilisateur : l’option /add ajoute systématiquement la configuration VPN, l’option /replace remplace systématiquement l’ancienne configuration par la nouvelle.

Option	Demande « Ajouter ou remplacer »	Lance le Client VPN s’il n’est pas démarré
/import	Oui	Oui
/importonce	Oui	Non
/add	Non : ajoute la configuration VPN	Non
/replace	Non : remplace la configuration VPN	Non

Lorsque l’accès au Panneau de Configuration est restreint aux administrateurs, il est nécessaire de lancer l’interpréteur de lignes de commandes (cmd, PowerShell, …) en tant qu’administrateur pour pouvoir utiliser les commandes d’importation ou d’exportation : /import, /importonce, /add, /replace, /export, /exportonce.

Importation

/import

Syntaxe :

"[répertoire_installation]\vpnconf.exe" /import:[NomFichierConfig]

Usage :

Cette option est utilisée pour importer une configuration VPN en démarrant SN VPN Client Exclusive.

Cette option peut être utilisée pour lancer le logiciel SN VPN Client Exclusive avec une configuration VPN donnée.

Si le Client VPN est en cours d’exécution, cette option importe et met à jour la configuration VPN sans arrêter le logiciel. Une fenêtre s’affiche pour demander si la configuration doit être ajoutée ou remplacée. Si un tunnel est ouvert au moment de l’importation, celui-ci est fermé et aucun tunnel n’est ouvert automatiquement.

[NomFichierConfig] est le chemin complet du fichier à importer. Il doit être encadré de guillemets s’il contient des espaces.

Exemple :

"C:\Program Files\Stormshield\Network VPN Client Exclusive\vpnconf.exe" /import:"C:\Users\Admin\Documents\mavpnconf.tgb"

NOTE
Si la configuration VPN importée est protégée par un mot de passe, /import doit être accompagnée de l’option /pwd (voir ci-dessous)..

NOTE
Lorsque la configuration VPN courante n’est pas vide, le logiciel affiche une fenêtre qui demande à l’utilisateur s’il veut ajouter la configuration VPN importée ou remplacer l’ancienne configuration par la nouvelle. Pour éviter l’affichage de cette fenêtre, utiliser les options /add ou /replace (voir ci-dessous).

/importonce

Syntaxe :	"[répertoire_installation]\vpnconf.exe" /importonce:[NomFichierConfig]
Usage :	Même comportement que l’option /import, mais sans démarrer le Client VPN. [NomFichierConfig] est le chemin complet du fichier à importer. Il doit être encadré de guillemets s’il contient des espaces.
Retour :	Voir la note sur les codes retour ci-dessous. 0 : La commande s’est bien déroulée 1 : Le fichier n’a pas été trouvé 2 : La signature du fichier n’est pas correcte 3 : Le mot de passe n’est pas correct (la configuration est protégée) 4 : Le mot de passe est requis et n’a pas été obtenu (fenêtre de demande de mot de passe annulée)
Exemple :	"C:\Program Files\Stormshield\Network VPN Client Exclusive\vpnconf.exe" /importonce:"C:\Users\admin\Documents\mavpnconf.tgb"

NOTE
Lorsque la configuration VPN est vide, les options /import et /importonce ne demandent rien à l’utilisateur et « ajoutent » la configuration VPN.

NOTE
Lorsque la configuration VPN courante n’est pas vide, le logiciel affiche une fenêtre qui demande à l’utilisateur s’il veut ajouter la configuration VPN importée ou remplacer l’ancienne par celle importée. Pour éviter l’affichage de cette fenêtre, utiliser les options /add ou /replace (voir ci-dessous).

NOTE
La commande /importonce est préemptive et bloque la ligne de commande jusqu’à la fin de son exécution.
Elle retourne un code d’erreur dans la variable d’environnement ERRORLEVEL (cf. codes retour ci-dessus).
/importonce spécifié sans mot de passe affiche une boîte de dialogue à l’utilisateur si ce mot de passe est requis.

NOTE
Si l’utilisateur annule la question Ajouter/Remplacer, alors un code retour 1 est mis dans ERRORLEVEL (dans un script, l’utilisateur n’est de toute façon pas censé utiliser un /importonce s’il souhaite une exécution silencieuse).

/add

Syntaxe :	"[répertoire_installation]\vpnconf.exe" /add:[NomFichierConfig]
Usage :	Permet d’ajouter une configuration VPN. [NomFichierConfig] est le chemin complet du fichier à importer. Il doit être encadré de guillemets s’il contient des espaces.
Retour :	Voir la note sur les codes retour ci-dessous. 0 : La commande s’est bien déroulée 1 : Le fichier n’a pas été trouvé 2 : La signature du fichier n’est pas correcte 3 : Le mot de passe n’est pas correct (la configuration est protégée) 4 : Le mot de passe est requis et n’a pas été obtenu (fenêtre de demande de mot de passe annulée)
Exemple :	"C:\Program Files\Stormshield\Network VPN Client Exclusive\vpnconf.exe" /add:"C:\Users\Admin\Documents\mavpnconf.tgb"

NOTE
Si la configuration VPN importée est protégée par un mot de passe /add doit être accompagnée de l’option /pwd (voir ci-dessous).

NOTE
La commande /add est préemptive et bloque la ligne de commande jusqu’à la fin de son exécution.
Elle retourne un code d’erreur dans la variable ERRORLEVEL (cf. codes retour ci-dessus).
/add spécifié sans mot de passe affiche une boîte de dialogue à l’utilisateur si ce mot de passe est requis.

/replace

Syntaxe :	"[répertoire_installation]\vpnconf.exe" /replace:[NomFichierConfig]
Usage :	Permet d’ajouter une configuration VPN. [NomFichierConfig] est le chemin complet du fichier à importer. Il doit être encadré de guillemets s’il contient des espaces.
Retour :	Voir la note sur les codes retour ci-dessous. 0 : La commande s’est bien déroulée 1 : Le fichier n’a pas été trouvé 2 : La signature du fichier n’est pas correcte 3 : Le mot de passe n’est pas correct (la configuration est protégée) 4 : Le mot de passe est requis et n’a pas été obtenu (fenêtre de demande de mot de passe annulée)
Exemple :	"C:\Program Files\Stormshield\Network VPN Client Exclusive\vpnconf.exe" /replace:"C:\Users\Admin\Documents\mavpnconf.tgb"

NOTE
Si la configuration VPN importée est protégée par un mot de passe /replace doit être accompagnée de l’option /pwd (voir ci-dessous).

NOTE
La commande /replace est préemptive et bloque la ligne de commande jusqu’à la fin de son exécution.
Elle retourne un code d’erreur dans la variable ERRORLEVEL (cf. codes retour ci-dessus).
/replace spécifié sans mot de passe affiche une boîte de dialogue à l’utilisateur si ce mot de passe est requis.

/pwd

Syntaxe :

"[répertoire_installation]\vpnconf.exe" /pwd:[Mot_de_passe]

Usage :

Permet de spécifier un mot de passe pour les opérations d’importation et d’exportation des configurations VPN. Cette option est utilisée avec les options : /import, /importonce, /add, /replace, /export, /exportonce.

Dans la ligne de commande, l’option /pwd doit être spécifiée après les options d’importation ou d’exportation.

Lors de l’export du fichier de configuration, la longueur du mot de passe doit être supérieure ou égale à 16 caractères.

Exemple :

"C:\Program Files\Stormshield\Network VPN Client Exclusive\vpnconf.exe" /import:"C:\Users\Admin\Documents\mavpnconf.tgb" /pwd:monmdp

ASTUCE
D’un point de vue sécurité, il est recommandé de privilégier les options /importonce, /add et /replace pour des opérations de maintenance (versus l’option /import), puisque le logiciel est quitté immédiatement après leur exécution.

Exportation

/export

Syntaxe :

"[répertoire_installation]\vpnconf.exe" /export:[NomFichierConfig]

Usage :

Permet d’exporter une configuration VPN, en démarrant le logiciel Client VPN.

Si le logiciel est en cours d’exécution, l’option /export exporte la configuration VPN sans l’arrêter.

[NomFichierConfig] est le chemin complet du fichier à importer. Il doit être encadré de guillemets s’il contient des espaces.

/export peut être utilisé avec /pwd pour exporter une configuration VPN en la protégeant par un mot de passe.

Exemple :

"C:\Program Files\Stormshield\Network VPN Client Exclusive\vpnconf.exe" /export:"C:\Users\Admin\Documents\mavpnconf.tgb" /pwd:gq1aRe7fr8TGB2!5

/exportonce

Syntaxe :

"[répertoire_installation]\vpnconf.exe" /exportonce:[NomFichierConfig]

Usage :

Même comportement que l’option /export, mais sans démarrer le logiciel Client VPN.

Si le logiciel est en cours d’exécution, l’option /exportonce exporte la configuration VPN sans l’arrêter.

[NomFichierConfig] est le chemin complet du fichier à importer. Il doit être encadré de guillemets s’il contient des espaces.

/exportonce peut être utilisé avec /pwd pour exporter une configuration VPN en la protégeant par un mot de passe.

Exemple :

"C:\Program Files\Stormshield\Network VPN Client Exclusive\vpnconf.exe" /exportonce:"C:\Users\Admin\Documents\mavpnconf.tgb" /pwd: gq1aRe7fr8TGB2!5

Ouverture/fermeture d’un tunnel VPN

Les options /stop, /closeall et /status ne peuvent être exécutées que si SN VPN Client Exclusive est déjà lancé et n’est pas démarré en mode TrustedConnect.

Les options /open et /close peuvent être exécutées sans que SN VPN Client Exclusive soit déjà lancé. Dans ce cas, le logiciel est lancé et ne quitte pas, mais il n’y a pas de code de retour pour connaître le résultat de l’exécution.

/stop

Syntaxe :	"[répertoire_installation]\vpnconf.exe" /stop
Usage :	Ferme tous les tunnels VPN ouverts, et arrête le logiciel Client VPN
Exemple :	"C:\Program Files\Stormshield\Network VPN Client Exclusive\vpnconf.exe" /stop

/open

Syntaxe :	"[répertoire_installation]\vpnconf.exe" /open:[NomTunnel]
Usage :	Permet d’ouvrir un tunnel VPN en ligne de commande.
Retour :	0 : Le tunnel est toujours fermé 2 : Le tunnel est maintenant ouvert Autres : Voir la liste des codes retours ci-dessous.
Exemple :	"C:\Program Files\Stormshield\Network VPN Client Exclusive\vpnconf.exe" /open:TgbTest-TgbTest @echo retour = %ERRORLEVEL% Pause

/status

Syntaxe :	"[répertoire_installation]\vpnconf.exe" /status:[NomTunnel]
Usage :	Permet d’obtenir l’état d’un tunnel VPN par ligne de commande.
Retour :	0 : Le tunnel VPN est fermé 1 : Le tunnel VPN est en cours d’ouverture 2 : Le tunnel VPN est ouvert 3 : Le tunnel VPN est en cours de fermeture 4 : Erreur dans l’ouverture du tunnel VPN Autres : Voir la liste des codes retours ci-dessous.
Exemple :	"C:\Program Files\Stormshield\Network VPN Client Exclusive\vpnconf.exe" /status:TgbTest-TgbTest @echo retour = %ERRORLEVEL% Pause

/close

Syntaxe :	"[répertoire_installation]\vpnconf.exe" /close:[NomTunnel]
Usage :	Permet de fermer un tunnel VPN par ligne de commande.
Retour :	0 : Le tunnel VPN est fermé Autres : Voir la liste des codes retours ci-dessous
Exemple :	"C:\Program Files\Stormshield\Network VPN Client Exclusive\vpnconf.exe" /close:TgbTest-TgbTest

/closeall

Syntaxe :	"[répertoire_installation]\vpnconf.exe" /closeall
Usage :	Permet de fermer tous les tunnels VPN ouverts.
Retour :	0 : Tous les tunnels VPN sont fermés Autres : Voir la liste des codes retours ci-dessous
Exemple :	"C:\Program Files\Stormshield\Network VPN Client Exclusive\vpnconf.exe" /closeall

Redémarrage

L’option /resetike ne peut être exécutée que si SN VPN Client Exclusive est déjà lancé et n’est pas démarré en mode TrustedConnect.

/resetike

Syntaxe :	"[répertoire_installation]\vpnconf.exe" /resetike
Usage :	Permet de redémarrer le service IKE en ligne de commande.
Retour :	0 : Le service IKE est redémarré Autres : Voir la liste des codes retours ci-dessous
Exemple :	"C:\Program Files\Stormshield\Network VPN Client Exclusive\vpnconf.exe" /resetike

Codes retours

Les options de ligne de commande (/open, /close, /status, /closeall, /resetike) peuvent retourner les codes suivants :

-1 :	Impossible d’exécuter la commande : le Client VPN n’est pas encore lancé.
100 à 499 :	Erreur interne (contacter le support).
500 :	Le tunnel VPN spécifié n’existe pas (attention à la casse !).
501 à 999 :	Erreur interne (contacter le support).
1000 à 1999 :	Autre problème d’accès au tunnel VPN.
1089 :	Pas de réponse de la passerelle.
1090 :	La passerelle refuse d'authentifier le client (IKE_AUTH Failed).