connexion déconnecter profil d'importation supprimer le profil listes de profils get-config obtenir l'état de la connexion liste-connexions préférence de mise préférences de liste envoyer des journaux de diagnostic Codes de sortie

Syntaxe des commandes CLI

Vous pouvez utiliser les commandes CLI à l'aide de la syntaxe suivante :


aws-vpn-client <COMMAND> [OPTIONS]

L'outil CLI prend en charge les commandes suivantes.

Usage: aws-vpn-client <COMMAND>

Commands:
  connect                Connect a profile through the AWS VPN Client
  disconnect             Disconnect a profile from the AWS VPN Client
  delete-profile         Delete a profile from the AWS VPN Client
  import-profile         Import a VPN connection profile
  list-profiles          List all VPN profiles
  get-config             Get configuration for a profile
  put-preference         Put a preference value
  list-preferences       List all preferences
  get-connection-status  Get the current connection status for a VPN profile
  list-connections       List all active VPN connections
  send-diagnostic-logs   Send diagnostic logs to AWS for troubleshooting
  help                   Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

connexion

Description

Établissez une connexion VPN à un profil.

Résumé


aws-vpn-client connect
  --profile-name <PROFILE>
  [--auth-user-pass <AUTH_USER_PASS>]

Options

--profile-name (chaîne): Le nom du profil à connecter. Cette option est obligatoire.
--auth-user-pass (chaîne): Chemin d'accès à un fichier contenant le nom d'utilisateur (ligne 1), le mot de passe (ligne 2) et le code MFA facultatif (ligne 3). Cette option n'est pas obligatoire.

Exemples

Exemple : connexion à un profil VPN

L'connectexemple suivant établit une connexion VPN à un profil.

aws-vpn-client connect --profile-name "Production-VPN"

Sortie :

{
  "status": "Connected"
}

déconnecter

Description

Mettez fin à une connexion VPN active.

Résumé


aws-vpn-client disconnect
  --profile-name <PROFILE_NAME>

Options

--profile-name (chaîne): Le nom du profil connecté à déconnecter. Cette option est obligatoire.

Exemples

Exemple : Déconnexion d'un profil VPN

L'disconnectexemple suivant met fin à une connexion VPN. Il n'y a aucun résultat en matière de réussite.

aws-vpn-client disconnect --profile-name "Production-VPN"

Exemple : erreur de déconnexion

L'disconnectexemple suivant montre l'erreur lorsque le profil n'est pas connecté.

aws-vpn-client disconnect --profile-name "Production-VPN"

Sortie :

{
  "status": "Error",
  "message": "Profile is not connected"
}

profil d'importation

Description

Importez un profil de connexion VPN.

Résumé


aws-vpn-client import-profile
  --profile-name <PROFILE_NAME>
  --config-path <CONFIG_PATH>
  [--global]

Options

--profile-name (chaîne): Nom personnalisé pour le profil importé. Cette option est obligatoire.
--config-path (chaîne): Chemin d'accès au fichier de configuration OpenVPN (.ovpn). Cette option est obligatoire.
--global(booléen): Importez en tant que profil global accessible à tous les utilisateurs. Cette option nécessite des privilèges d'administrateur.

Exemples

Exemple : importer un profil

L'import-profileexemple suivant importe un profil de connexion VPN.

aws-vpn-client import-profile --profile-name "Production-VPN" --config-path /path/to/vpn-config.ovpn

Sortie :

{
  "status": "Success"
}

Exemple : importer un profil global

L'import-profileexemple suivant importe un profil global. Cela nécessite des privilèges d'administrateur.

sudo aws-vpn-client import-profile --profile-name "Company-VPN" --config-path /path/to/config.ovpn --global

Sortie :

{
  "status": "Success"
}

Exemple : erreur d'importation avec chemin de fichier non valide

L'import-profileexemple suivant montre l'erreur lorsque le fichier de configuration est introuvable.

aws-vpn-client import-profile --profile-name "test" --config-path /invalid/path.ovpn

Sortie :

{
  "status": "Error",
  "message": "Failed to read OpenVPN config file: No such file or directory (os error 2)"
}

supprimer le profil

Description

Supprimez un profil du client.

Résumé


aws-vpn-client delete-profile
  --profile-name <PROFILE_NAME>

Options

--profile-name (chaîne): Le nom du profil à supprimer. Cette option est obligatoire.

Exemples

Exemple : supprimer un profil

L'delete-profileexemple suivant supprime un profil VPN. Il n'y a aucun résultat en matière de réussite.

aws-vpn-client delete-profile --profile-name "Production-VPN"

Exemple : erreur de suppression avec profil inexistant

L'delete-profileexemple suivant montre l'erreur lorsque le profil n'existe pas.

aws-vpn-client delete-profile --profile-name "nonexistent"

Sortie :

{
  "status": "Error",
  "message": "Profile not found"
}

listes de profils

Description

Répertoriez tous les profils VPN.

Résumé


aws-vpn-client list-profiles

Exemples

Exemple : répertorier tous les profils VPN

L'list-profilesexemple suivant répertorie tous les profils VPN importés.

aws-vpn-client list-profiles

Sortie :

[
  {
    "profile-name": "Production-VPN",
    "owned-by": "jdoe",
    "auth-type": "saml",
    "imported-at": "2026-07-21T13:04:42-07:00"
  },
  {
    "profile-name": "Staging-VPN",
    "owned-by": "jdoe",
    "auth-type": "ma",
    "imported-at": "2026-07-22T10:30:00-07:00"
  }
]

Note

Les profils globaux (importés avec--global) ne comportent pas de owned-by champ.

get-config

Description

Récupérez la configuration OpenVPN pour un profil.

Résumé


aws-vpn-client get-config
  --profile-name <PROFILE_NAME>

Options

--profile-name (chaîne): Le nom du profil pour lequel récupérer la configuration. Cette option est obligatoire.

Exemples

Exemple : récupérer la configuration d'OpenVPN

L'get-configexemple suivant récupère la configuration OpenVPN pour un profil.

aws-vpn-client get-config --profile-name "Production-VPN"

Sortie :

client
dev tun
proto udp
remote cvpn-endpoint-0123456789abcdef0.prod.clientvpn.us-east-1.amazonaws.com 443
remote-random-hostname
resolv-retry infinite
nobind
remote-cert-tls server
cipher AES-256-GCM
verb 3
<ca>
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
</ca>
auth-user-pass
reneg-sec 0

obtenir l'état de la connexion

Description

Obtenez l'état actuel de la connexion pour un profil VPN.

Résumé


aws-vpn-client get-connection-status
  --profile-name <PROFILE_NAME>
  [--show-details]

Options

--profile-name (chaîne): Le nom du profil pour lequel vous souhaitez récupérer l'état de connexion. Cette option est obligatoire.
--show-details(booléen): Incluez des statistiques sur les octets de connexion dans la sortie.

Exemples

Exemple : Obtenir l'état de la connexion

L'get-connection-statusexemple suivant récupère l'état de connexion d'un profil.

aws-vpn-client get-connection-status --profile-name "Production-VPN"

Sortie :

{
  "connection-status": "Connected",
  "latest-connection-attempt": {
    "initiated-by": "jdoe",
    "updated-at": "2026-07-24T15:50:36-07:00"
  }
}

Exemple : obtenir l'état de la connexion avec les détails

L'get-connection-statusexemple suivant inclut des statistiques sur les octets à l'aide de l'--show-detailsoption.

aws-vpn-client get-connection-status --profile-name "Production-VPN" --show-details

Sortie :

{
  "connection-status": "Connected",
  "latest-connection-attempt": {
    "initiated-by": "jdoe",
    "updated-at": "2026-07-24T15:50:36-07:00",
    "details": {
      "tunnel-bytes-in": 0,
      "tunnel-bytes-out": 0,
      "transport-bytes-in": 9674,
      "transport-bytes-out": 11413
    }
  }
}

liste-connexions

Description

Répertoriez toutes les connexions VPN actives.

Résumé


aws-vpn-client list-connections

Exemples

Exemple : répertorier les connexions actives

L'list-connectionsexemple suivant répertorie toutes les connexions VPN actives.

aws-vpn-client list-connections

Sortie :

[
  {
    "profile-name": "Production-VPN",
    "initiated-by": "jdoe",
    "connection-status": "Connected",
    "last-updated-at": "2026-07-24T15:50:36-07:00"
  }
]

Exemple : aucune connexion active

L'list-connectionsexemple suivant montre la sortie lorsqu'aucune connexion n'est active.

aws-vpn-client list-connections

Sortie :

[]

préférence de mise

Description

Définissez une préférence de configuration globale. La plupart des paramètres nécessitent des privilèges d'administrateur.

Résumé


aws-vpn-client put-preference
  --key <PREFERENCE_KEY>
  --value <PREFERENCE_VALUE>

Options

--key (chaîne): Le nom de la touche de préférence à définir. Cette option est obligatoire.
--value (chaîne): La valeur à définir pour la touche de préférence. Cette option est obligatoire.

Les touches de préférence disponibles sont les suivantes :

enable-telemetry: Activez ou désactivez la télémétrie ()true/false.
enable-user-profile-management: Autoriser ou interdire aux utilisateurs finaux d'importer ou de supprimer des profils (true/false).
max-connections: Nombre maximum de connexions simultanées (entier, 1 à 5).

Exemples

Exemple : définir une préférence

L'put-preferenceexemple suivant définit le nombre maximum de connexions. Cela nécessite des privilèges d'administrateur. Il n'y a aucun résultat en matière de réussite.

sudo aws-vpn-client put-preference --key max-connections --value 4

Exemple : erreur sans privilèges d'administrateur

L'put-preferenceexemple suivant montre l'erreur lorsque vous exécutez la commande sans privilèges d'administrateur.

aws-vpn-client put-preference --key max-connections --value 4

Sortie :

{
  "status": "Error",
  "message": "Permission denied: admin privileges required"
}

Exemple : erreur avec valeur non valide

L'put-preferenceexemple suivant montre l'erreur lorsque vous fournissez une valeur non valide.

sudo aws-vpn-client put-preference --key max-connections --value 8

Sortie :

{
  "status": "Error",
  "message": "Preference value is invalid"
}

préférences de liste

Description

Afficher toutes les préférences de configuration globales et les valeurs actuelles.

Résumé


aws-vpn-client list-preferences

Exemples

Exemple : Répertorier toutes les préférences

L'list-preferencesexemple suivant affiche toutes les préférences de configuration globales et leurs valeurs actuelles.

aws-vpn-client list-preferences

Sortie :

{
  "enable-telemetry": true,
  "enable-user-profile-management": true,
  "max-connections": 1
}

envoyer des journaux de diagnostic

Description

Collectez et envoyez les journaux de diagnostic à AWS des fins de dépannage.

Résumé


aws-vpn-client send-diagnostic-logs

Exemples

Exemple : envoyer des journaux de diagnostic

L'send-diagnostic-logsexemple suivant collecte et envoie des journaux de diagnostic à AWS.

aws-vpn-client send-diagnostic-logs

Sortie :

{
  "reference-id": "us-west-2:78ff6531-5dc4-c706-7149-e6cfd8adadc7/2026-07-24-16-03-55.zip"
}

Note

Partagez cette reference-id valeur avec le AWS support lorsque vous signalez des problèmes.

Codes de sortie

L'outil CLI AWS Client VPN renvoie les codes de sortie suivants.

Code de sortie	Signification
0	Succès
1	Erreur générale
2	Syntaxe de commande non valide

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Connectez-vous à l'aide d'un client AWS fourni

Windows