Sintaks perintah CLI

Anda dapat menggunakan perintah CLI dengan menggunakan sintaks berikut:

aws-vpn-client <COMMAND> [OPTIONS]

Alat CLI mendukung perintah berikut.

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

hubungkan

Deskripsi

Buat koneksi VPN ke profil.

Sinopsis

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

Opsi

--profile-name(string)

Nama profil untuk terhubung. Opsi ini diperlukan.

--auth-user-pass(string)

Jalur ke file yang berisi nama pengguna (baris 1), kata sandi (baris 2), dan kode MFA opsional (baris 3). Opsi ini tidak diperlukan.

Contoh

Contoh: Sambungkan ke profil VPN

connectContoh berikut membuat koneksi VPN ke profil.

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

Output:

{
  "status": "Connected"
}

memutuskan

Deskripsi

Hentikan koneksi VPN aktif.

Sinopsis

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

Opsi

--profile-name(string)

Nama profil yang terhubung untuk memutuskan sambungan. Opsi ini diperlukan.

Contoh

Contoh: Putuskan sambungan dari profil VPN

disconnectContoh berikut mengakhiri koneksi VPN. Tidak ada output dari kesuksesan.

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

Contoh: Kesalahan pemutusan

disconnectContoh berikut menunjukkan kesalahan saat profil tidak terhubung.

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

Output:

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

import-profil

Deskripsi

Impor profil koneksi VPN.

Sinopsis

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

Opsi

--profile-name(string)

Nama khusus untuk profil yang diimpor. Opsi ini diperlukan.

--config-path(string)

Jalur ke file konfigurasi OpenVPN (.ovpn). Opsi ini diperlukan.

--global(boolean)

Impor sebagai profil global yang tersedia untuk semua pengguna. Opsi ini memerlukan hak administrator.

Contoh

Contoh: Mengimpor profil

import-profileContoh berikut mengimpor profil koneksi VPN.

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

Output:

{
  "status": "Success"
}

Contoh: Mengimpor profil global

import-profileContoh berikut mengimpor profil global. Ini membutuhkan hak administrator.

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

Output:

{
  "status": "Success"
}

Contoh: Kesalahan impor dengan jalur file yang tidak valid

import-profileContoh berikut menunjukkan kesalahan ketika file konfigurasi tidak ditemukan.

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

Output:

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

hapus profil

Deskripsi

Hapus profil dari klien.

Sinopsis

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

Opsi

--profile-name(string)

Nama profil yang akan dihapus. Opsi ini diperlukan.

Contoh

Contoh: Menghapus profil

delete-profileContoh berikut menghapus profil VPN. Tidak ada output dari kesuksesan.

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

Contoh: Hapus kesalahan dengan profil yang tidak ada

delete-profileContoh berikut menunjukkan kesalahan ketika profil tidak ada.

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

Output:

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

list-profil

Deskripsi

Daftar semua profil VPN.

Sinopsis

aws-vpn-client list-profiles

Contoh

Contoh: Daftar semua profil VPN

list-profilesContoh berikut mencantumkan semua profil VPN yang diimpor.

aws-vpn-client list-profiles

Output:

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

catatan

Profil global (diimpor dengan--global) tidak memiliki owned-by bidang.

get-config

Deskripsi

Ambil konfigurasi OpenVPN untuk profil.

Sinopsis

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

Opsi

--profile-name(string)

Nama profil untuk mengambil konfigurasi. Opsi ini diperlukan.

Contoh

Contoh: Ambil konfigurasi OpenVPN

get-configContoh berikut mengambil konfigurasi OpenVPN untuk profil.

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

Output:

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

dapatkan status koneksi

Deskripsi

Dapatkan status koneksi saat ini untuk profil VPN.

Sinopsis

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

Opsi

--profile-name(string)

Nama profil untuk mengambil status koneksi. Opsi ini diperlukan.

--show-details(boolean)

Sertakan statistik byte koneksi dalam output.

Contoh

Contoh: Dapatkan status koneksi

get-connection-statusContoh berikut mengambil status koneksi untuk profil.

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

Output:

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

Contoh: Dapatkan status koneksi dengan detail

get-connection-statusContoh berikut mencakup statistik byte dengan menggunakan --show-details opsi.

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

Output:

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

daftar koneksi

Deskripsi

Daftar semua koneksi VPN aktif.

Sinopsis

aws-vpn-client list-connections

Contoh

Contoh: Daftar koneksi aktif

list-connectionsContoh berikut mencantumkan semua koneksi VPN aktif.

aws-vpn-client list-connections

Output:

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

Contoh: Tidak ada koneksi aktif

list-connectionsContoh berikut menunjukkan output ketika tidak ada koneksi aktif.

aws-vpn-client list-connections

Output:

[]

put-preferensi

Deskripsi

Tetapkan preferensi konfigurasi global. Sebagian besar pengaturan memerlukan hak administrator.

Sinopsis

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

Opsi

--key(string)

Nama kunci preferensi untuk disetel. Opsi ini diperlukan.

--value(string)

Nilai yang akan ditetapkan untuk kunci preferensi. Opsi ini diperlukan.

Kunci preferensi berikut tersedia:

enable-telemetry

Mengaktifkan atau menonaktifkan telemetri (true/false).

enable-user-profile-management

Mengizinkan atau melarang pengguna akhir untuk mengimpor atau menghapus profil (true/false).

max-connections

Jumlah maksimum koneksi bersamaan (integer, 1-5).

Contoh

Contoh: Tetapkan preferensi

put-preferenceContoh berikut menetapkan jumlah koneksi maksimum. Ini membutuhkan hak administrator. Tidak ada output dari kesuksesan.

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

Contoh: Kesalahan tanpa hak administrator

put-preferenceContoh berikut menunjukkan kesalahan saat Anda menjalankan perintah tanpa hak administrator.

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

Output:

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

Contoh: Kesalahan dengan nilai tidak valid

put-preferenceContoh berikut menunjukkan kesalahan saat Anda memberikan nilai yang tidak valid.

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

Output:

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

daftar preferensi

Deskripsi

Tampilkan semua preferensi konfigurasi global dan nilai saat ini.

Sinopsis

aws-vpn-client list-preferences

Contoh

Contoh: Daftar semua preferensi

list-preferencesContoh berikut menampilkan semua preferensi konfigurasi global dan nilainya saat ini.

aws-vpn-client list-preferences

Output:

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

kirim log-diagnostik

Deskripsi

Kumpulkan dan kirimkan log diagnostik AWS untuk pemecahan masalah.

Sinopsis

aws-vpn-client send-diagnostic-logs

Contoh

Contoh: Mengirim log diagnostik

send-diagnostic-logsContoh berikut mengumpulkan dan mengirimkan log diagnostik ke AWS.

aws-vpn-client send-diagnostic-logs

Output:

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

catatan

Bagikan reference-id nilai dengan AWS Dukungan saat melaporkan masalah.

Kode keluar

Alat AWS Client VPN CLI mengembalikan kode keluar berikut.

Kode keluar	Arti
0	Berhasil
1	Kesalahan umum
2	Sintaks perintah tidak valid