connect disconnect Profil importieren Profil löschen Profile auflisten get-config get-connection-status Verbindungen auflisten put-preference Listeneinstellungen send-diagnostic-logs Ausgangscodes

CLI-Befehlssyntax

Sie können CLI-Befehle verwenden, indem Sie die folgende Syntax verwenden:


aws-vpn-client <COMMAND> [OPTIONS]

Das CLI-Tool unterstützt die folgenden Befehle.

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

connect

Description

Stellen Sie eine VPN-Verbindung zu einem Profil her.

Syntax


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

Optionen

--profile-name (string): Der Name des Profils, mit dem eine Verbindung hergestellt werden soll. Diese Option ist erforderlich.
--auth-user-pass (string): Pfad zu einer Datei, die den Benutzernamen (Zeile 1), das Passwort (Zeile 2) und den optionalen MFA-Code (Zeile 3) enthält. Diese Option ist nicht erforderlich.

Beispiele

Beispiel: Stellen Sie eine Verbindung zu einem VPN-Profil her

Das folgende connect Beispiel stellt eine VPN-Verbindung zu einem Profil her.

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

Ausgabe:

{
  "status": "Connected"
}

disconnect

Description

Beenden Sie eine aktive VPN-Verbindung.

Syntax


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

Optionen

--profile-name (string): Der Name des verbundenen Profils, das getrennt werden soll. Diese Option ist erforderlich.

Beispiele

Beispiel: Trennen Sie die Verbindung zu einem VPN-Profil

Das folgende disconnect Beispiel beendet eine VPN-Verbindung. Bei Erfolg gibt es keine Ausgabe.

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

Beispiel: Fehler beim Trennen

Das folgende disconnect Beispiel zeigt den Fehler, wenn das Profil nicht verbunden ist.

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

Ausgabe:

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

Profil importieren

Description

Importieren Sie ein VPN-Verbindungsprofil.

Syntax


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

Optionen

--profile-name (string): Benutzerdefinierter Name für das importierte Profil. Diese Option ist erforderlich.
--config-path (string): Pfad zur OpenVPN-Konfigurationsdatei (.ovpn). Diese Option ist erforderlich.
--global(boolesch): Import als globales Profil, das allen Benutzern zur Verfügung steht. Für diese Option sind Administratorrechte erforderlich.

Beispiele

Beispiel: Ein Profil importieren

Das folgende import-profile Beispiel importiert ein VPN-Verbindungsprofil.

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

Ausgabe:

{
  "status": "Success"
}

Beispiel: Importieren Sie ein globales Profil

Das folgende import-profile Beispiel importiert ein globales Profil. Dies erfordert Administratorrechte.

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

Ausgabe:

{
  "status": "Success"
}

Beispiel: Importfehler mit ungültigem Dateipfad

Das folgende import-profile Beispiel zeigt den Fehler, wenn die Konfigurationsdatei nicht gefunden wird.

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

Ausgabe:

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

Profil löschen

Description

Löscht ein Profil vom Client.

Syntax


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

Optionen

--profile-name (string): Der Name des Profils, das gelöscht werden soll. Diese Option ist erforderlich.

Beispiele

Beispiel: Löschen Sie ein Profil

Das folgende delete-profile Beispiel löscht ein VPN-Profil. Bei Erfolg erfolgt keine Ausgabe.

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

Beispiel: Fehler beim Löschen mit einem nicht existierenden Profil

Das folgende delete-profile Beispiel zeigt den Fehler, wenn das Profil nicht existiert.

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

Ausgabe:

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

Profile auflisten

Description

Listet alle VPN-Profile auf.

Syntax


aws-vpn-client list-profiles

Beispiele

Beispiel: Alle VPN-Profile auflisten

Das folgende list-profiles Beispiel listet alle importierten VPN-Profile auf.

aws-vpn-client list-profiles

Ausgabe:

[
  {
    "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"
  }
]

Anmerkung

Globale Profile (importiert mit--global) haben kein owned-by Feld.

get-config

Description

Ruft die OpenVPN-Konfiguration für ein Profil ab.

Syntax


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

Optionen

--profile-name (string): Der Name des Profils, für das die Konfiguration abgerufen werden soll. Diese Option ist erforderlich.

Beispiele

Beispiel: Rufen Sie die OpenVPN-Konfiguration ab

Das folgende get-config Beispiel ruft die OpenVPN-Konfiguration für ein Profil ab.

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

Ausgabe:

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

get-connection-status

Description

Ruft den aktuellen Verbindungsstatus für ein VPN-Profil ab.

Syntax


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

Optionen

--profile-name (string): Der Name des Profils, für das der Verbindungsstatus abgerufen werden soll. Diese Option ist erforderlich.
--show-details(boolesch): Schließt Verbindungsbyte-Statistiken in die Ausgabe ein.

Beispiele

Beispiel: Verbindungsstatus abrufen

Das folgende get-connection-status Beispiel ruft den Verbindungsstatus für ein Profil ab.

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

Ausgabe:

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

Beispiel: Verbindungsstatus mit Details abrufen

Das folgende get-connection-status Beispiel beinhaltet Byte-Statistiken mithilfe der --show-details Option.

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

Ausgabe:

{
  "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
    }
  }
}

Verbindungen auflisten

Description

Listet alle aktiven VPN-Verbindungen auf.

Syntax


aws-vpn-client list-connections

Beispiele

Beispiel: Listet aktive Verbindungen auf

Das folgende list-connections Beispiel listet alle aktiven VPN-Verbindungen auf.

aws-vpn-client list-connections

Ausgabe:

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

Beispiel: Keine aktiven Verbindungen

Das folgende list-connections Beispiel zeigt die Ausgabe, wenn keine aktiven Verbindungen bestehen.

aws-vpn-client list-connections

Ausgabe:

[]

put-preference

Description

Legen Sie eine globale Konfigurationspräferenz fest. Für die meisten Einstellungen sind Administratorrechte erforderlich.

Syntax


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

Optionen

--key (string): Der Name des Einstellungsschlüssels, der festgelegt werden soll. Diese Option ist erforderlich.
--value (string): Der Wert, der für den Einstellungsschlüssel festgelegt werden soll. Diese Option ist erforderlich.

Die folgenden Einstellungsschlüssel sind verfügbar:

enable-telemetry: Aktiviert oder deaktiviert Telemetrie (true/false).
enable-user-profile-management: Erlauben oder verbieten Sie Endbenutzern das Importieren oder Löschen von Profilen ()true/false.
max-connections: Maximale Anzahl gleichzeitiger Verbindungen (Ganzzahl, 1-5).

Beispiele

Beispiel: Legen Sie eine Präferenz fest

Im folgenden put-preference Beispiel wird die maximale Anzahl von Verbindungen festgelegt. Dies erfordert Administratorrechte. Bei Erfolg gibt es keine Ausgabe.

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

Beispiel: Fehler ohne Administratorrechte

Das folgende put-preference Beispiel zeigt den Fehler, wenn Sie den Befehl ohne Administratorrechte ausführen.

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

Ausgabe:

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

Beispiel: Fehler mit ungültigem Wert

Das folgende put-preference Beispiel zeigt den Fehler, wenn Sie einen ungültigen Wert angeben.

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

Ausgabe:

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

Listeneinstellungen

Description

Zeigt alle globalen Konfigurationseinstellungen und aktuellen Werte an.

Syntax


aws-vpn-client list-preferences

Beispiele

Beispiel: Alle Einstellungen auflisten

Im folgenden list-preferences Beispiel werden alle globalen Konfigurationseinstellungen und ihre aktuellen Werte angezeigt.

aws-vpn-client list-preferences

Ausgabe:

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

send-diagnostic-logs

Description

Sammeln Sie Diagnoseprotokolle und senden Sie sie zur Problembehandlung an. AWS

Syntax


aws-vpn-client send-diagnostic-logs

Beispiele

Beispiel: Diagnoseprotokolle senden

Im folgenden send-diagnostic-logs Beispiel werden Diagnoseprotokolle gesammelt und an AWS diese gesendet.

aws-vpn-client send-diagnostic-logs

Ausgabe:

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

Anmerkung

Teilen Sie dem AWS Support den reference-id Wert mit, wenn Sie Probleme melden.

Ausgangscodes

Das AWS Client VPN CLI-Tool gibt die folgenden Exit-Codes zurück.

Beendigungscode	Bedeutung
0	Success
1	Allgemeiner Fehler
2	Ungültige Befehlssyntax

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

Stellen Sie eine Verbindung mit einem AWS bereitgestellten Client her

Windows