Obtenir des informations sur vos customer gateways

Vous pouvez obtenir des informations sur une ou plusieurs de vos customers gateways.

Par défaut, cette action décrit toutes vos customers gateways.

Si vous dépassez le nombre autorisé de requêtes identiques pour une durée configurée, le message d’erreur RequestLimitExceeded est renvoyé.

Cette procédure utilise uniquement AWS CLI. Des informations sur ces ressources sont également disponibles dans Cockpit. Pour en savoir plus, voir Interface utilisateur des connexions VPN (pour Cockpit v1) ou le dashboard Client Gateways (pour Cockpit v2-beta).

Pour obtenir des informations sur une ou plusieurs customer gateways, utilisez la commande describe-customer-gateways suivant cette syntaxe :

Exemple de requête
$ aws ec2 describe-customer-gateways \
    --profile YOUR_PROFILE \
    [--filters NOT_SPECIFIED] \
    --endpoint https://fcu.eu-west-2.outscale.com

Cette commande contient les attributs suivants que vous devez spécifier :

  • (optionnel) profile : Le profil nommé que vous voulez utiliser, créé pendant la configuration d’AWS CLI. Pour en savoir plus, voir Utiliser et configurer AWS CLI.

  • (optionnel) customer-gateway-ids : L’ID d’une ou plusieurs customer gateways sur lesquelles vous voulez obtenir des informations.

  • (optionnel) filters : Un ou plusieurs filtres, au format "Name=X,Values=Y".

    Vous pouvez spécifier plusieurs valeurs pour un même filtre en utilisant le format "Name=X,Values=Y, Z".

    Les filtres suivants sont disponibles :

    • state : L’état de la customer gateways (pending | available | deleting | deleted). Pour en savoir plus, voir À propos des customer gateways.

    • customer-gateway-id : L’ID de la customer gateway.

    • ip-address : L’IP publique de la customer gateway.

    • bgp-asn : Un Autonomous System Number (ASN) utilisé par le Border Gateway Protocol (BGP) pour atteindre votre customer gateway à travers internet. Pour en savoir plus, voir À propos des customer gateways. Pour en savoir plus, voir À propos des customer gateways

    • type : Le type de connexion VPN que la customer gateway supporte (toujours ipsec.1).

    • tag-key : La clé d’un tag associé à la ressource.

    • tag-value : La valeur d’un tag associé à la ressource.

    • tag:XXXX : La valeur d’un tag associé à la ressource, où XXXX est la clé du tag.

      Pour filtrer un tag dont la clé est XXXX et la valeur est YYYY, vous pouvez donc utiliser un des deux formats suivants :

      • --filters Name=tag-key,Values=XXXX Name=tag-value,Values=YYYY

      • --filters Name=tag:XXXX,Values=YYYY

  • endpoint : Le endpoint correspondant à la Région à laquelle vous voulez envoyer la requête.

La commande describe-customer-gateways renvoie les éléments suivants :

  • CustomerGateway : Informations à propos d’une ou plusieurs customer gateways. Cet élément contient les informations suivantes :

  • Tags : Un ou plusieurs tags associés à la customer gateway. Cet élément contient les informations suivantes :

    • Key : La clé du tag.

    • Value : La valeur du tag.

  • Type : Le type de connexion VPN que la customer gateway supporte (toujours ipsec.1).

  • State : L’état de la customer gateway (pending | available | deleting | deleted). Pour en savoir plus, voir À propos des customer gateways.

  • CustomerGatewayId : L’ID de la customer gateway.

  • BgpAsn : Un Autonomous System Number (ASN) utilisé par le Border Gateway Protocol (BGP) pour atteindre votre customer gateway à travers internet. Pour en savoir plus, voir À propos des customer gateways.

  • IpAddress : L’IP publique de la customer gateway.

Exemple de résultat
{
    "CustomerGateways": [
        {
            "Tags": [],
            "Type": "ipsec.1",
            "State": "available",
            "CustomerGatewayId": "cgw-73a7fba3",
            "BgpAsn": "65000",
            "IpAddress": "198.18.7.207"
        }
    ]
}

Pages connexes

Méthode API correspondante

AWS™ et Amazon Web Services™ sont des marques de commerce d'Amazon Technologies, Inc. ou de ses affiliées aux États-Unis et/ou dans les autres pays.