Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# Syntaxe des commandes CLI
<a name="cli-command-syntax"></a>

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
<a name="cli-cmd-connect"></a>

### Description
<a name="cli-cmd-connect-description"></a>

Établissez une connexion VPN à un profil.

### Résumé
<a name="cli-cmd-connect-synopsis"></a>

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

### Options
<a name="cli-cmd-connect-options"></a>

`--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
<a name="cli-cmd-connect-examples"></a>

**Exemple : connexion à un profil VPN **

L'`connect`exemple suivant établit une connexion VPN à un profil.

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

Sortie :

```
{
  "status": "Connected"
}
```

## déconnecter
<a name="cli-cmd-disconnect"></a>

### Description
<a name="cli-cmd-disconnect-description"></a>

Mettez fin à une connexion VPN active.

### Résumé
<a name="cli-cmd-disconnect-synopsis"></a>

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

### Options
<a name="cli-cmd-disconnect-options"></a>

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

### Exemples
<a name="cli-cmd-disconnect-examples"></a>

**Exemple : Déconnexion d'un profil VPN **

L'`disconnect`exemple 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'`disconnect`exemple 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
<a name="cli-cmd-import-profile"></a>

### Description
<a name="cli-cmd-import-profile-description"></a>

Importez un profil de connexion VPN.

### Résumé
<a name="cli-cmd-import-profile-synopsis"></a>

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

### Options
<a name="cli-cmd-import-profile-options"></a>

`--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
<a name="cli-cmd-import-profile-examples"></a>

**Exemple : importer un profil **

L'`import-profile`exemple 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-profile`exemple 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-profile`exemple 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
<a name="cli-cmd-delete-profile"></a>

### Description
<a name="cli-cmd-delete-profile-description"></a>

Supprimez un profil du client.

### Résumé
<a name="cli-cmd-delete-profile-synopsis"></a>

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

### Options
<a name="cli-cmd-delete-profile-options"></a>

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

### Exemples
<a name="cli-cmd-delete-profile-examples"></a>

**Exemple : supprimer un profil **

L'`delete-profile`exemple 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-profile`exemple 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
<a name="cli-cmd-list-profiles"></a>

### Description
<a name="cli-cmd-list-profiles-description"></a>

Répertoriez tous les profils VPN.

### Résumé
<a name="cli-cmd-list-profiles-synopsis"></a>

```
aws-vpn-client list-profiles
```

### Exemples
<a name="cli-cmd-list-profiles-examples"></a>

**Exemple : répertorier tous les profils VPN **

L'`list-profiles`exemple 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
<a name="cli-cmd-get-config"></a>

### Description
<a name="cli-cmd-get-config-description"></a>

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

### Résumé
<a name="cli-cmd-get-config-synopsis"></a>

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

### Options
<a name="cli-cmd-get-config-options"></a>

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

### Exemples
<a name="cli-cmd-get-config-examples"></a>

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

L'`get-config`exemple 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
<a name="cli-cmd-get-connection-status"></a>

### Description
<a name="cli-cmd-get-connection-status-description"></a>

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

### Résumé
<a name="cli-cmd-get-connection-status-synopsis"></a>

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

### Options
<a name="cli-cmd-get-connection-status-options"></a>

`--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
<a name="cli-cmd-get-connection-status-examples"></a>

**Exemple : Obtenir l'état de la connexion **

L'`get-connection-status`exemple 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-status`exemple suivant inclut des statistiques sur les octets à l'aide de l'`--show-details`option.

```
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
<a name="cli-cmd-list-connections"></a>

### Description
<a name="cli-cmd-list-connections-description"></a>

Répertoriez toutes les connexions VPN actives.

### Résumé
<a name="cli-cmd-list-connections-synopsis"></a>

```
aws-vpn-client list-connections
```

### Exemples
<a name="cli-cmd-list-connections-examples"></a>

**Exemple : répertorier les connexions actives **

L'`list-connections`exemple 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-connections`exemple suivant montre la sortie lorsqu'aucune connexion n'est active.

```
aws-vpn-client list-connections
```

Sortie :

```
[]
```

## préférence de mise
<a name="cli-cmd-put-preference"></a>

### Description
<a name="cli-cmd-put-preference-description"></a>

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

### Résumé
<a name="cli-cmd-put-preference-synopsis"></a>

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

### Options
<a name="cli-cmd-put-preference-options"></a>

`--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
<a name="cli-cmd-put-preference-examples"></a>

**Exemple : définir une préférence **

L'`put-preference`exemple 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-preference`exemple 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-preference`exemple 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
<a name="cli-cmd-list-preferences"></a>

### Description
<a name="cli-cmd-list-preferences-description"></a>

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

### Résumé
<a name="cli-cmd-list-preferences-synopsis"></a>

```
aws-vpn-client list-preferences
```

### Exemples
<a name="cli-cmd-list-preferences-examples"></a>

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

L'`list-preferences`exemple 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
<a name="cli-cmd-send-diagnostic-logs"></a>

### Description
<a name="cli-cmd-send-diagnostic-logs-description"></a>

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

### Résumé
<a name="cli-cmd-send-diagnostic-logs-synopsis"></a>

```
aws-vpn-client send-diagnostic-logs
```

### Exemples
<a name="cli-cmd-send-diagnostic-logs-examples"></a>

**Exemple : envoyer des journaux de diagnostic **

L'`send-diagnostic-logs`exemple 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
<a name="cli-cmd-exit-codes"></a>

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 |