connect desconectar perfil de importación eliminar perfil perfiles de lista get-config get-connection-status listas de conexiones preferencia de venta preferencias de lista registros de envío de diagnósticos Códigos de salida

Sintaxis de comandos de CLI

Puede usar los comandos de la CLI con la siguiente sintaxis:


aws-vpn-client <COMMAND> [OPTIONS]

La herramienta CLI admite los siguientes 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

connect

Description (Descripción)

Establezca una conexión VPN con un perfil.

Sinopsis


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

Opciones

--profile-name (cadena): El nombre del perfil que se va a conectar. Esta opción es obligatoria.
--auth-user-pass (cadena): Ruta a un archivo que contiene el nombre de usuario (línea 1), la contraseña (línea 2) y el código MFA opcional (línea 3). Esta opción no es obligatoria.

Ejemplos

Ejemplo: conectarse a un perfil de VPN

El siguiente connect ejemplo establece una conexión VPN con un perfil.

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

Salida:

{
  "status": "Connected"
}

desconectar

Description (Descripción)

Finalice una conexión VPN activa.

Sinopsis


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

Opciones

--profile-name (cadena): El nombre del perfil conectado que se va a desconectar. Esta opción es obligatoria.

Ejemplos

Ejemplo: desconectarse de un perfil de VPN

El siguiente disconnect ejemplo termina una conexión VPN. No hay ningún resultado en caso de éxito.

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

Ejemplo: error de desconexión

El siguiente disconnect ejemplo muestra el error cuando el perfil no está conectado.

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

Salida:

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

perfil de importación

Description (Descripción)

Importe un perfil de conexión VPN.

Sinopsis


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

Opciones

--profile-name (cadena): Nombre personalizado para el perfil importado. Esta opción es obligatoria.
--config-path (cadena): Ruta al archivo de configuración de OpenVPN (.ovpn). Esta opción es obligatoria.
--global (booleano): Importe como un perfil global disponible para todos los usuarios. Esta opción requiere privilegios de administrador.

Ejemplos

Ejemplo: importar un perfil

El siguiente import-profile ejemplo importa un perfil de conexión VPN.

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

Salida:

{
  "status": "Success"
}

Ejemplo: importar un perfil global

El siguiente import-profile ejemplo importa un perfil global. Esto requiere privilegios de administrador.

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

Salida:

{
  "status": "Success"
}

Ejemplo: error de importación con una ruta de archivo no válida

El siguiente import-profile ejemplo muestra el error cuando no se encuentra el archivo de configuración.

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

Salida:

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

eliminar perfil

Description (Descripción)

Eliminar un perfil del cliente.

Sinopsis


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

Opciones

--profile-name (cadena): El nombre del perfil que se va a eliminar. Esta opción es obligatoria.

Ejemplos

Ejemplo: eliminar un perfil

En el siguiente delete-profile ejemplo, se elimina un perfil de VPN. No hay ningún resultado en caso de éxito.

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

Ejemplo: error de eliminación con un perfil inexistente

El siguiente delete-profile ejemplo muestra el error cuando el perfil no existe.

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

Salida:

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

perfiles de lista

Description (Descripción)

Enumera todos los perfiles de VPN.

Sinopsis


aws-vpn-client list-profiles

Ejemplos

Ejemplo: Listar todos los perfiles de VPN

El siguiente list-profiles ejemplo muestra todos los perfiles de VPN importados.

aws-vpn-client list-profiles

Salida:

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

Los perfiles globales (importados con--global) no tienen ningún owned-by campo.

get-config

Description (Descripción)

Recupera la configuración de OpenVPN de un perfil.

Sinopsis


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

Opciones

--profile-name (cadena): El nombre del perfil cuya configuración se va a recuperar. Esta opción es obligatoria.

Ejemplos

Ejemplo: recuperar la configuración de OpenVPN

El siguiente get-config ejemplo recupera la configuración de OpenVPN para un perfil.

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

Salida:

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 (Descripción)

Obtenga el estado de conexión actual de un perfil de VPN.

Sinopsis


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

Opciones

--profile-name (cadena): El nombre del perfil para el que se va a recuperar el estado de la conexión. Esta opción es obligatoria.
--show-details (booleano): Incluya las estadísticas de bytes de conexión en la salida.

Ejemplos

Ejemplo: obtener el estado de la conexión

El siguiente get-connection-status ejemplo recupera el estado de conexión de un perfil.

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

Salida:

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

Ejemplo: obtenga el estado de la conexión con detalles

El siguiente get-connection-status ejemplo incluye estadísticas de bytes mediante la --show-details opción.

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

Salida:

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

listas de conexiones

Description (Descripción)

Enumera todas las conexiones VPN activas.

Sinopsis


aws-vpn-client list-connections

Ejemplos

Ejemplo: Listar las conexiones activas

El siguiente list-connections ejemplo muestra todas las conexiones VPN activas.

aws-vpn-client list-connections

Salida:

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

Ejemplo: No hay conexiones activas

El siguiente list-connections ejemplo muestra la salida cuando no hay conexiones activas.

aws-vpn-client list-connections

Salida:

[]

preferencia de venta

Description (Descripción)

Establezca una preferencia de configuración global. La mayoría de los ajustes requieren privilegios de administrador.

Sinopsis


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

Opciones

--key (cadena): El nombre de la clave de preferencias que se va a establecer. Esta opción es obligatoria.
--value (cadena): El valor que se va a establecer para la clave de preferencias. Esta opción es obligatoria.

Están disponibles las siguientes claves de preferencias:

enable-telemetry: Habilitar o deshabilitar la telemetría ()true/false.
enable-user-profile-management: Permitir o impedir que los usuarios finales importen o eliminen perfiles (). true/false
max-connections: Número máximo de conexiones simultáneas (entero, de 1 a 5).

Ejemplos

Ejemplo: establecer una preferencia

El siguiente put-preference ejemplo establece el número máximo de conexiones. Esto requiere privilegios de administrador. No se produce ningún resultado en caso de éxito.

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

Ejemplo: error sin privilegios de administrador

El siguiente put-preference ejemplo muestra el error al ejecutar el comando sin privilegios de administrador.

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

Salida:

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

Ejemplo: error con un valor no válido

El siguiente put-preference ejemplo muestra el error cuando se proporciona un valor no válido.

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

Salida:

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

preferencias de lista

Description (Descripción)

Muestra todas las preferencias de configuración globales y los valores actuales.

Sinopsis


aws-vpn-client list-preferences

Ejemplos

Ejemplo: Listar todas las preferencias

El siguiente list-preferences ejemplo muestra todas las preferencias de configuración globales y sus valores actuales.

aws-vpn-client list-preferences

Salida:

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

registros de envío de diagnósticos

Description (Descripción)

Recopile y envíe los registros de diagnóstico para la solución de problemas. AWS

Sinopsis


aws-vpn-client send-diagnostic-logs

Ejemplos

Ejemplo: enviar registros de diagnóstico

El siguiente send-diagnostic-logs ejemplo recopila y envía los registros de diagnóstico a AWS.

aws-vpn-client send-diagnostic-logs

Salida:

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

nota

Comparta el reference-id valor con el equipo de AWS soporte al informar sobre problemas.

Códigos de salida

La herramienta CLI de AWS Client VPN devuelve los siguientes códigos de salida.

Código de salida	Significado
0	Correcto
1	Error general
2	Sintaxis de comando no válida

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

Conéctese mediante un cliente AWS proporcionado

Windows