As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# Sintaxe de comando CLI
<a name="cli-command-syntax"></a>

Você pode usar os comandos da CLI usando a seguinte sintaxe:

```
aws-vpn-client <COMMAND> [OPTIONS]
```

A ferramenta CLI suporta os seguintes comandos.

```
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
```

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

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

Estabeleça uma conexão VPN com um perfil.

### Resumo
<a name="cli-cmd-connect-synopsis"></a>

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

### Opções
<a name="cli-cmd-connect-options"></a>

`--profile-name` (string)  
O nome do perfil a ser conectado. Essa opção é obrigatória.

`--auth-user-pass` (string)  
Caminho para um arquivo contendo o nome de usuário (linha 1), senha (linha 2) e código MFA opcional (linha 3). Essa opção não é obrigatória.

### Exemplos
<a name="cli-cmd-connect-examples"></a>

**Exemplo: conectar-se a um perfil VPN **

O `connect` exemplo a seguir estabelece uma conexão VPN com um perfil.

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

Saída:

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

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

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

Encerre uma conexão VPN ativa.

### Resumo
<a name="cli-cmd-disconnect-synopsis"></a>

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

### Opções
<a name="cli-cmd-disconnect-options"></a>

`--profile-name` (string)  
O nome do perfil conectado a ser desconectado. Essa opção é obrigatória.

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

**Exemplo: Desconectar-se de um perfil VPN **

O `disconnect` exemplo a seguir encerra uma conexão VPN. Não há nenhuma saída sobre o sucesso.

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

**Exemplo: erro de desconexão **

O `disconnect` exemplo a seguir mostra o erro quando o perfil não está conectado.

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

Saída:

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

## perfil de importação
<a name="cli-cmd-import-profile"></a>

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

Importe um perfil de conexão VPN.

### Resumo
<a name="cli-cmd-import-profile-synopsis"></a>

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

### Opções
<a name="cli-cmd-import-profile-options"></a>

`--profile-name` (string)  
Nome personalizado para o perfil importado. Essa opção é obrigatória.

`--config-path` (string)  
Caminho para o arquivo de configuração do OpenVPN (.ovpn). Essa opção é obrigatória.

`--global` (booliano)  
Importe como um perfil global disponível para todos os usuários. Essa opção exige privilégios de administrador.

### Exemplos
<a name="cli-cmd-import-profile-examples"></a>

**Exemplo: importar um perfil **

O `import-profile` exemplo a seguir importa um perfil de conexão VPN.

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

Saída:

```
{
  "status": "Success"
}
```

**Exemplo: importar um perfil global **

O `import-profile` exemplo a seguir importa um perfil global. Isso requer privilégios de administrador.

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

Saída:

```
{
  "status": "Success"
}
```

**Exemplo: erro de importação com caminho de arquivo inválido **

O `import-profile` exemplo a seguir mostra o erro quando o arquivo de configuração não é encontrado.

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

Saída:

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

## excluir perfil
<a name="cli-cmd-delete-profile"></a>

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

Exclua um perfil do cliente.

### Resumo
<a name="cli-cmd-delete-profile-synopsis"></a>

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

### Opções
<a name="cli-cmd-delete-profile-options"></a>

`--profile-name` (string)  
O nome do perfil a ser excluído. Essa opção é obrigatória.

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

**Exemplo: excluir um perfil **

O `delete-profile` exemplo a seguir exclui um perfil de VPN. Não há nenhuma saída sobre o sucesso.

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

**Exemplo: erro de exclusão com perfil inexistente **

O `delete-profile` exemplo a seguir mostra o erro quando o perfil não existe.

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

Saída:

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

## perfis de lista
<a name="cli-cmd-list-profiles"></a>

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

Liste todos os perfis de VPN.

### Resumo
<a name="cli-cmd-list-profiles-synopsis"></a>

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

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

**Exemplo: Listar todos os perfis de VPN **

O `list-profiles` exemplo a seguir lista todos os perfis de VPN importados.

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

Saída:

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

**nota**  
Os perfis globais (importados com`--global`) não têm um `owned-by` campo.

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

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

Recupere a configuração do OpenVPN para um perfil.

### Resumo
<a name="cli-cmd-get-config-synopsis"></a>

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

### Opções
<a name="cli-cmd-get-config-options"></a>

`--profile-name` (string)  
O nome do perfil para o qual recuperar a configuração. Essa opção é obrigatória.

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

**Exemplo: Recuperar a configuração do OpenVPN **

O `get-config` exemplo a seguir recupera a configuração do OpenVPN para um perfil.

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

Saída:

```
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
```

## obter status de conexão
<a name="cli-cmd-get-connection-status"></a>

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

Obtenha o status atual da conexão de um perfil VPN.

### Resumo
<a name="cli-cmd-get-connection-status-synopsis"></a>

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

### Opções
<a name="cli-cmd-get-connection-status-options"></a>

`--profile-name` (string)  
O nome do perfil para o qual recuperar o status da conexão. Essa opção é obrigatória.

`--show-details` (booliano)  
Inclua estatísticas de bytes de conexão na saída.

### Exemplos
<a name="cli-cmd-get-connection-status-examples"></a>

**Exemplo: Obter status da conexão **

O `get-connection-status` exemplo a seguir recupera o status da conexão de um perfil.

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

Saída:

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

**Exemplo: Obter o status da conexão com detalhes **

O `get-connection-status` exemplo a seguir inclui estatísticas de bytes usando a `--show-details` opção.

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

Saída:

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

## conexões de lista
<a name="cli-cmd-list-connections"></a>

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

Liste todas as conexões VPN ativas.

### Resumo
<a name="cli-cmd-list-connections-synopsis"></a>

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

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

**Exemplo: Listar conexões ativas **

O `list-connections` exemplo a seguir lista todas as conexões VPN ativas.

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

Saída:

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

**Exemplo: Nenhuma conexão ativa **

O `list-connections` exemplo a seguir mostra a saída quando não há conexões ativas.

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

Saída:

```
[]
```

## preferência de venda
<a name="cli-cmd-put-preference"></a>

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

Defina uma preferência de configuração global. A maioria das configurações exige privilégios de administrador.

### Resumo
<a name="cli-cmd-put-preference-synopsis"></a>

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

### Opções
<a name="cli-cmd-put-preference-options"></a>

`--key` (string)  
O nome da chave de preferência a ser definida. Essa opção é obrigatória.

`--value` (string)  
O valor a ser definido para a chave de preferência. Essa opção é obrigatória.

As seguintes chaves de preferência estão disponíveis:

`enable-telemetry`  
Ativar ou desativar a telemetria ()true/false.

`enable-user-profile-management`  
Permitir ou proibir que usuários finais importem ou excluam perfis (true/false).

`max-connections`  
Número máximo de conexões simultâneas (número inteiro, 1-5).

### Exemplos
<a name="cli-cmd-put-preference-examples"></a>

**Exemplo: Definir uma preferência **

O `put-preference` exemplo a seguir define o número máximo de conexões. Isso requer privilégios de administrador. Não há nenhuma saída sobre o sucesso.

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

**Exemplo: Erro sem privilégios de administrador **

O `put-preference` exemplo a seguir mostra o erro quando você executa o comando sem privilégios de administrador.

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

Saída:

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

**Exemplo: Erro com valor inválido **

O `put-preference` exemplo a seguir mostra o erro quando você fornece um valor inválido.

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

Saída:

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

## preferências de lista
<a name="cli-cmd-list-preferences"></a>

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

Exibir todas as preferências de configuração global e os valores atuais.

### Resumo
<a name="cli-cmd-list-preferences-synopsis"></a>

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

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

**Exemplo: Listar todas as preferências **

O `list-preferences` exemplo a seguir exibe todas as preferências de configuração global e seus valores atuais.

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

Saída:

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

## enviar registros de diagnóstico
<a name="cli-cmd-send-diagnostic-logs"></a>

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

Colete e envie registros de diagnóstico AWS para solução de problemas.

### Resumo
<a name="cli-cmd-send-diagnostic-logs-synopsis"></a>

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

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

**Exemplo: Enviar registros de diagnóstico **

O `send-diagnostic-logs` exemplo a seguir coleta e envia registros de diagnóstico para o. AWS

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

Saída:

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

**nota**  
Compartilhe o `reference-id` valor com o AWS Suporte ao relatar problemas.

## Códigos de saída
<a name="cli-cmd-exit-codes"></a>

A ferramenta AWS Client VPN CLI retorna os seguintes códigos de saída.


| Código de saída | Significado | 
| --- | --- | 
| 0 | Bem-sucedida | 
| 1 | Erro geral | 
| 2 | Sintaxe de comando inválida |